Google Native
getParticipant
Retrieves a conversation participant.
Using getParticipant
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getParticipant(args: GetParticipantArgs, opts?: InvokeOptions): Promise<GetParticipantResult>
function getParticipantOutput(args: GetParticipantOutputArgs, opts?: InvokeOptions): Output<GetParticipantResult>
def get_participant(conversation_id: Optional[str] = None,
location: Optional[str] = None,
participant_id: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetParticipantResult
def get_participant_output(conversation_id: Optional[pulumi.Input[str]] = None,
location: Optional[pulumi.Input[str]] = None,
participant_id: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetParticipantResult]
func LookupParticipant(ctx *Context, args *LookupParticipantArgs, opts ...InvokeOption) (*LookupParticipantResult, error)
func LookupParticipantOutput(ctx *Context, args *LookupParticipantOutputArgs, opts ...InvokeOption) LookupParticipantResultOutput
> Note: This function is named LookupParticipant
in the Go SDK.
public static class GetParticipant
{
public static Task<GetParticipantResult> InvokeAsync(GetParticipantArgs args, InvokeOptions? opts = null)
public static Output<GetParticipantResult> Invoke(GetParticipantInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetParticipantResult> getParticipant(GetParticipantArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: google-native:dialogflow/v2:getParticipant
Arguments:
# Arguments dictionary
The following arguments are supported:
- Conversation
Id string - Location string
- Participant
Id string - Project string
- Conversation
Id string - Location string
- Participant
Id string - Project string
- conversation
Id String - location String
- participant
Id String - project String
- conversation
Id string - location string
- participant
Id string - project string
- conversation_
id str - location str
- participant_
id str - project str
- conversation
Id String - location String
- participant
Id String - project String
getParticipant Result
The following output properties are available:
- Documents
Metadata Dictionary<string, string>Filters Optional. Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be
documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" }
- Name string
Optional. The unique identifier of this participant. Format:
projects//locations//conversations//participants/
.- Role string
Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
- Sip
Recording stringMedia Label Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated.
- Documents
Metadata map[string]stringFilters Optional. Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be
documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" }
- Name string
Optional. The unique identifier of this participant. Format:
projects//locations//conversations//participants/
.- Role string
Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
- Sip
Recording stringMedia Label Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated.
- documents
Metadata Map<String,String>Filters Optional. Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be
documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" }
- name String
Optional. The unique identifier of this participant. Format:
projects//locations//conversations//participants/
.- role String
Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
- sip
Recording StringMedia Label Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated.
- documents
Metadata {[key: string]: string}Filters Optional. Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be
documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" }
- name string
Optional. The unique identifier of this participant. Format:
projects//locations//conversations//participants/
.- role string
Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
- sip
Recording stringMedia Label Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated.
- documents_
metadata_ Mapping[str, str]filters Optional. Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be
documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" }
- name str
Optional. The unique identifier of this participant. Format:
projects//locations//conversations//participants/
.- role str
Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
- sip_
recording_ strmedia_ label Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated.
- documents
Metadata Map<String>Filters Optional. Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be
documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" }
- name String
Optional. The unique identifier of this participant. Format:
projects//locations//conversations//participants/
.- role String
Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
- sip
Recording StringMedia Label Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated.
Package Details
- Repository
- https://github.com/pulumi/pulumi-google-native
- License
- Apache-2.0