Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. contactcenterinsights
  5. contactcenterinsights/v1
  6. getPhraseMatcher

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.contactcenterinsights/v1.getPhraseMatcher

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Gets a phrase matcher.

    Using getPhraseMatcher

    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 getPhraseMatcher(args: GetPhraseMatcherArgs, opts?: InvokeOptions): Promise<GetPhraseMatcherResult>
function getPhraseMatcherOutput(args: GetPhraseMatcherOutputArgs, opts?: InvokeOptions): Output<GetPhraseMatcherResult>
    def get_phrase_matcher(location: Optional[str] = None,
                       phrase_matcher_id: Optional[str] = None,
                       project: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetPhraseMatcherResult
def get_phrase_matcher_output(location: Optional[pulumi.Input[str]] = None,
                       phrase_matcher_id: Optional[pulumi.Input[str]] = None,
                       project: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetPhraseMatcherResult]
    func LookupPhraseMatcher(ctx *Context, args *LookupPhraseMatcherArgs, opts ...InvokeOption) (*LookupPhraseMatcherResult, error)
func LookupPhraseMatcherOutput(ctx *Context, args *LookupPhraseMatcherOutputArgs, opts ...InvokeOption) LookupPhraseMatcherResultOutput

    > Note: This function is named LookupPhraseMatcher in the Go SDK.

    public static class GetPhraseMatcher 
{
    public static Task<GetPhraseMatcherResult> InvokeAsync(GetPhraseMatcherArgs args, InvokeOptions? opts = null)
    public static Output<GetPhraseMatcherResult> Invoke(GetPhraseMatcherInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPhraseMatcherResult> getPhraseMatcher(GetPhraseMatcherArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:contactcenterinsights/v1:getPhraseMatcher
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Location string
    PhraseMatcherId string
    Project string
    Location string
    PhraseMatcherId string
    Project string
    location String
    phraseMatcherId String
    project String
    location string
    phraseMatcherId string
    project string
    location String
    phraseMatcherId String
    project String

    getPhraseMatcher Result

    The following output properties are available:

    ActivationUpdateTime string
    The most recent time at which the activation status was updated.
    Active bool
    Applies the phrase matcher only when it is active.
    DisplayName string
    The human-readable name of the phrase matcher.
    Name string
    The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
    PhraseMatchRuleGroups List<Pulumi.GoogleNative.Contactcenterinsights.V1.Outputs.GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroupResponse>
    A list of phase match rule groups that are included in this matcher.
    RevisionCreateTime string
    The timestamp of when the revision was created. It is also the create time when a new matcher is added.
    RevisionId string
    Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
    RoleMatch string
    The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
    Type string
    The type of this phrase matcher.
    UpdateTime string
    The most recent time at which the phrase matcher was updated.
    VersionTag string
    The customized version tag to use for the phrase matcher. If not specified, it will default to revision_id.
    ActivationUpdateTime string
    The most recent time at which the activation status was updated.
    Active bool
    Applies the phrase matcher only when it is active.
    DisplayName string
    The human-readable name of the phrase matcher.
    Name string
    The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
    PhraseMatchRuleGroups []GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroupResponse
    A list of phase match rule groups that are included in this matcher.
    RevisionCreateTime string
    The timestamp of when the revision was created. It is also the create time when a new matcher is added.
    RevisionId string
    Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
    RoleMatch string
    The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
    Type string
    The type of this phrase matcher.
    UpdateTime string
    The most recent time at which the phrase matcher was updated.
    VersionTag string
    The customized version tag to use for the phrase matcher. If not specified, it will default to revision_id.
    activationUpdateTime String
    The most recent time at which the activation status was updated.
    active Boolean
    Applies the phrase matcher only when it is active.
    displayName String
    The human-readable name of the phrase matcher.
    name String
    The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
    phraseMatchRuleGroups List<GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroupResponse>
    A list of phase match rule groups that are included in this matcher.
    revisionCreateTime String
    The timestamp of when the revision was created. It is also the create time when a new matcher is added.
    revisionId String
    Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
    roleMatch String
    The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
    type String
    The type of this phrase matcher.
    updateTime String
    The most recent time at which the phrase matcher was updated.
    versionTag String
    The customized version tag to use for the phrase matcher. If not specified, it will default to revision_id.
    activationUpdateTime string
    The most recent time at which the activation status was updated.
    active boolean
    Applies the phrase matcher only when it is active.
    displayName string
    The human-readable name of the phrase matcher.
    name string
    The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
    phraseMatchRuleGroups GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroupResponse[]
    A list of phase match rule groups that are included in this matcher.
    revisionCreateTime string
    The timestamp of when the revision was created. It is also the create time when a new matcher is added.
    revisionId string
    Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
    roleMatch string
    The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
    type string
    The type of this phrase matcher.
    updateTime string
    The most recent time at which the phrase matcher was updated.
    versionTag string
    The customized version tag to use for the phrase matcher. If not specified, it will default to revision_id.
    activation_update_time str
    The most recent time at which the activation status was updated.
    active bool
    Applies the phrase matcher only when it is active.
    display_name str
    The human-readable name of the phrase matcher.
    name str
    The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
    phrase_match_rule_groups Sequence[GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroupResponse]
    A list of phase match rule groups that are included in this matcher.
    revision_create_time str
    The timestamp of when the revision was created. It is also the create time when a new matcher is added.
    revision_id str
    Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
    role_match str
    The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
    type str
    The type of this phrase matcher.
    update_time str
    The most recent time at which the phrase matcher was updated.
    version_tag str
    The customized version tag to use for the phrase matcher. If not specified, it will default to revision_id.
    activationUpdateTime String
    The most recent time at which the activation status was updated.
    active Boolean
    Applies the phrase matcher only when it is active.
    displayName String
    The human-readable name of the phrase matcher.
    name String
    The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
    phraseMatchRuleGroups List<Property Map>
    A list of phase match rule groups that are included in this matcher.
    revisionCreateTime String
    The timestamp of when the revision was created. It is also the create time when a new matcher is added.
    revisionId String
    Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
    roleMatch String
    The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
    type String
    The type of this phrase matcher.
    updateTime String
    The most recent time at which the phrase matcher was updated.
    versionTag String
    The customized version tag to use for the phrase matcher. If not specified, it will default to revision_id.

    Supporting Types

    GoogleCloudContactcenterinsightsV1ExactMatchConfigResponse

    CaseSensitive bool
    Whether to consider case sensitivity when performing an exact match.
    CaseSensitive bool
    Whether to consider case sensitivity when performing an exact match.
    caseSensitive Boolean
    Whether to consider case sensitivity when performing an exact match.
    caseSensitive boolean
    Whether to consider case sensitivity when performing an exact match.
    case_sensitive bool
    Whether to consider case sensitivity when performing an exact match.
    caseSensitive Boolean
    Whether to consider case sensitivity when performing an exact match.

    GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfigResponse

    exactMatchConfig Property Map
    The configuration for the exact match rule.

    GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroupResponse

    PhraseMatchRules List<Pulumi.GoogleNative.Contactcenterinsights.V1.Inputs.GoogleCloudContactcenterinsightsV1PhraseMatchRuleResponse>
    A list of phrase match rules that are included in this group.
    Type string
    The type of this phrase match rule group.
    PhraseMatchRules []GoogleCloudContactcenterinsightsV1PhraseMatchRuleResponse
    A list of phrase match rules that are included in this group.
    Type string
    The type of this phrase match rule group.
    phraseMatchRules List<GoogleCloudContactcenterinsightsV1PhraseMatchRuleResponse>
    A list of phrase match rules that are included in this group.
    type String
    The type of this phrase match rule group.
    phraseMatchRules GoogleCloudContactcenterinsightsV1PhraseMatchRuleResponse[]
    A list of phrase match rules that are included in this group.
    type string
    The type of this phrase match rule group.
    phrase_match_rules Sequence[GoogleCloudContactcenterinsightsV1PhraseMatchRuleResponse]
    A list of phrase match rules that are included in this group.
    type str
    The type of this phrase match rule group.
    phraseMatchRules List<Property Map>
    A list of phrase match rules that are included in this group.
    type String
    The type of this phrase match rule group.

    GoogleCloudContactcenterinsightsV1PhraseMatchRuleResponse

    Config Pulumi.GoogleNative.Contactcenterinsights.V1.Inputs.GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfigResponse
    Provides additional information about the rule that specifies how to apply the rule.
    Negated bool
    Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
    Query string
    The phrase to be matched.
    Config GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfigResponse
    Provides additional information about the rule that specifies how to apply the rule.
    Negated bool
    Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
    Query string
    The phrase to be matched.
    config GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfigResponse
    Provides additional information about the rule that specifies how to apply the rule.
    negated Boolean
    Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
    query String
    The phrase to be matched.
    config GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfigResponse
    Provides additional information about the rule that specifies how to apply the rule.
    negated boolean
    Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
    query string
    The phrase to be matched.
    config GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfigResponse
    Provides additional information about the rule that specifies how to apply the rule.
    negated bool
    Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
    query str
    The phrase to be matched.
    config Property Map
    Provides additional information about the rule that specifies how to apply the rule.
    negated Boolean
    Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
    query String
    The phrase to be matched.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native