phrase_sets

Creates, updates, deletes, gets or lists a phrase_sets resource.

Overview

Name	phrase_sets
Type	Resource
Id	google.speech.phrase_sets

Fields

Name	Datatype	Description
name	string	The resource name of the phrase set.
annotations	object	Output only. 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	Output only. The time at which this resource was requested for deletion. This field is not used.
displayName	string	Output only. User-settable, human-readable name for the PhraseSet. Must be 63 characters or less. This field is not used.
etag	string	Output only. 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	Output only. The time at which this resource will be purged. This field is not used.
kmsKeyName	string	Output only. 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	Output only. 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}.
phrases	array	A list of word and phrases.
reconciling	boolean	Output only. Whether or not this PhraseSet is in the process of being updated. This field is not used.
state	string	Output only. The CustomClass lifecycle state. This field is not used.
uid	string	Output only. System-assigned unique identifier for the PhraseSet. This field is not used.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, phraseSetsId, projectsId	Get a phrase set.
list	SELECT	locationsId, projectsId	List phrase sets.
create	INSERT	locationsId, projectsId	Create a set of phrase hints. Each item in the set can be a single word or a multi-word phrase. The items in the PhraseSet are favored by the recognition model when you send a call that includes the PhraseSet.
delete	DELETE	locationsId, phraseSetsId, projectsId	Delete a phrase set.
patch	UPDATE	locationsId, phraseSetsId, projectsId	Update a phrase set.

SELECT examples

List phrase sets.

SELECT
name,
annotations,
boost,
deleteTime,
displayName,
etag,
expireTime,
kmsKeyName,
kmsKeyVersionName,
phrases,
reconciling,
state,
uid
FROM google.speech.phrase_sets
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new phrase_sets resource.

All Properties

/*+ create */
INSERT INTO google.speech.phrase_sets (
locationsId,
projectsId,
phraseSetId,
phraseSet
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ phraseSetId }}',
'{{ phraseSet }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: phraseSetId
      value: string
    - name: phraseSet
      value:
        - name: name
          value: string
        - name: phrases
          value:
            - - name: value
                value: string
              - name: boost
                value: number
        - name: boost
          value: number
        - name: kmsKeyName
          value: string
        - name: kmsKeyVersionName
          value: string
        - name: uid
          value: string
        - name: displayName
          value: string
        - name: state
          value: string
        - name: deleteTime
          value: string
        - name: expireTime
          value: string
        - name: annotations
          value: object
        - name: etag
          value: string
        - name: reconciling
          value: boolean

UPDATE example

Updates a phrase_sets resource.

/*+ update */
UPDATE google.speech.phrase_sets
SET 
name = '{{ name }}',
phrases = '{{ phrases }}',
boost = number
WHERE 
locationsId = '{{ locationsId }}'
AND phraseSetsId = '{{ phraseSetsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified phrase_sets resource.

/*+ delete */
DELETE FROM google.speech.phrase_sets
WHERE locationsId = '{{ locationsId }}'
AND phraseSetsId = '{{ phraseSetsId }}'
AND projectsId = '{{ projectsId }}';