Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. speech
  5. speech/v1
  6. getPhraseSet

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.speech/v1.getPhraseSet

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

    Get a phrase set.

    Using getPhraseSet

    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 getPhraseSet(args: GetPhraseSetArgs, opts?: InvokeOptions): Promise<GetPhraseSetResult>
function getPhraseSetOutput(args: GetPhraseSetOutputArgs, opts?: InvokeOptions): Output<GetPhraseSetResult>
    def get_phrase_set(location: Optional[str] = None,
                   phrase_set_id: Optional[str] = None,
                   project: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetPhraseSetResult
def get_phrase_set_output(location: Optional[pulumi.Input[str]] = None,
                   phrase_set_id: Optional[pulumi.Input[str]] = None,
                   project: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetPhraseSetResult]
    func LookupPhraseSet(ctx *Context, args *LookupPhraseSetArgs, opts ...InvokeOption) (*LookupPhraseSetResult, error)
func LookupPhraseSetOutput(ctx *Context, args *LookupPhraseSetOutputArgs, opts ...InvokeOption) LookupPhraseSetResultOutput

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

    public static class GetPhraseSet 
{
    public static Task<GetPhraseSetResult> InvokeAsync(GetPhraseSetArgs args, InvokeOptions? opts = null)
    public static Output<GetPhraseSetResult> Invoke(GetPhraseSetInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPhraseSetResult> getPhraseSet(GetPhraseSetArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:speech/v1:getPhraseSet
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Location string
    PhraseSetId string
    Project string
    Location string
    PhraseSetId string
    Project string
    location String
    phraseSetId String
    project String
    location string
    phraseSetId string
    project string
    location String
    phraseSetId String
    project String

    getPhraseSet Result

    The following output properties are available:

    Annotations Dictionary<string, string>
    Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations. This field is not used.
    Boost double
    Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though boost can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
    DeleteTime string
    The time at which this resource was requested for deletion. This field is not used.
    DisplayName string
    User-settable, human-readable name for the PhraseSet. Must be 63 characters or less. This field is not used.
    Etag string
    This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding. This field is not used.
    ExpireTime string
    The time at which this resource will be purged. This field is not used.
    KmsKeyName string
    The KMS key name with which the content of the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
    KmsKeyVersionName string
    The KMS key version name with which content of the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.
    Name string
    The resource name of the phrase set.
    Phrases List<Pulumi.GoogleNative.Speech.V1.Outputs.PhraseResponse>
    A list of word and phrases.
    Reconciling bool
    Whether or not this PhraseSet is in the process of being updated. This field is not used.
    State string
    The CustomClass lifecycle state. This field is not used.
    Uid string
    System-assigned unique identifier for the PhraseSet. This field is not used.
    Annotations map[string]string
    Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations. This field is not used.
    Boost float64
    Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though boost can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
    DeleteTime string
    The time at which this resource was requested for deletion. This field is not used.
    DisplayName string
    User-settable, human-readable name for the PhraseSet. Must be 63 characters or less. This field is not used.
    Etag string
    This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding. This field is not used.
    ExpireTime string
    The time at which this resource will be purged. This field is not used.
    KmsKeyName string
    The KMS key name with which the content of the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
    KmsKeyVersionName string
    The KMS key version name with which content of the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.
    Name string
    The resource name of the phrase set.
    Phrases []PhraseResponse
    A list of word and phrases.
    Reconciling bool
    Whether or not this PhraseSet is in the process of being updated. This field is not used.
    State string
    The CustomClass lifecycle state. This field is not used.
    Uid string
    System-assigned unique identifier for the PhraseSet. This field is not used.
    annotations Map<String,String>
    Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations. This field is not used.
    boost Double
    Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though boost can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
    deleteTime String
    The time at which this resource was requested for deletion. This field is not used.
    displayName String
    User-settable, human-readable name for the PhraseSet. Must be 63 characters or less. This field is not used.
    etag String
    This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding. This field is not used.
    expireTime String
    The time at which this resource will be purged. This field is not used.
    kmsKeyName String
    The KMS key name with which the content of the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
    kmsKeyVersionName String
    The KMS key version name with which content of the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.
    name String
    The resource name of the phrase set.
    phrases List<PhraseResponse>
    A list of word and phrases.
    reconciling Boolean
    Whether or not this PhraseSet is in the process of being updated. This field is not used.
    state String
    The CustomClass lifecycle state. This field is not used.
    uid String
    System-assigned unique identifier for the PhraseSet. This field is not used.
    annotations {[key: string]: string}
    Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations. This field is not used.
    boost number
    Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though boost can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
    deleteTime string
    The time at which this resource was requested for deletion. This field is not used.
    displayName string
    User-settable, human-readable name for the PhraseSet. Must be 63 characters or less. This field is not used.
    etag string
    This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding. This field is not used.
    expireTime string
    The time at which this resource will be purged. This field is not used.
    kmsKeyName string
    The KMS key name with which the content of the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
    kmsKeyVersionName string
    The KMS key version name with which content of the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.
    name string
    The resource name of the phrase set.
    phrases PhraseResponse[]
    A list of word and phrases.
    reconciling boolean
    Whether or not this PhraseSet is in the process of being updated. This field is not used.
    state string
    The CustomClass lifecycle state. This field is not used.
    uid string
    System-assigned unique identifier for the PhraseSet. This field is not used.
    annotations Mapping[str, str]
    Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations. This field is not used.
    boost float
    Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though boost can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
    delete_time str
    The time at which this resource was requested for deletion. This field is not used.
    display_name str
    User-settable, human-readable name for the PhraseSet. Must be 63 characters or less. This field is not used.
    etag str
    This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding. This field is not used.
    expire_time str
    The time at which this resource will be purged. This field is not used.
    kms_key_name str
    The KMS key name with which the content of the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
    kms_key_version_name str
    The KMS key version name with which content of the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.
    name str
    The resource name of the phrase set.
    phrases Sequence[PhraseResponse]
    A list of word and phrases.
    reconciling bool
    Whether or not this PhraseSet is in the process of being updated. This field is not used.
    state str
    The CustomClass lifecycle state. This field is not used.
    uid str
    System-assigned unique identifier for the PhraseSet. This field is not used.
    annotations Map<String>
    Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations. This field is not used.
    boost Number
    Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though boost can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
    deleteTime String
    The time at which this resource was requested for deletion. This field is not used.
    displayName String
    User-settable, human-readable name for the PhraseSet. Must be 63 characters or less. This field is not used.
    etag String
    This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding. This field is not used.
    expireTime String
    The time at which this resource will be purged. This field is not used.
    kmsKeyName String
    The KMS key name with which the content of the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
    kmsKeyVersionName String
    The KMS key version name with which content of the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.
    name String
    The resource name of the phrase set.
    phrases List<Property Map>
    A list of word and phrases.
    reconciling Boolean
    Whether or not this PhraseSet is in the process of being updated. This field is not used.
    state String
    The CustomClass lifecycle state. This field is not used.
    uid String
    System-assigned unique identifier for the PhraseSet. This field is not used.

    Supporting Types

    PhraseResponse

    Boost double
    Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though boost can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
    Value string
    The phrase itself.
    Boost float64
    Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though boost can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
    Value string
    The phrase itself.
    boost Double
    Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though boost can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
    value String
    The phrase itself.
    boost number
    Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though boost can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
    value string
    The phrase itself.
    boost float
    Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though boost can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
    value str
    The phrase itself.
    boost Number
    Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though boost can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
    value String
    The phrase itself.

    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