phrase_sets

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

Overview

Name	phrase_sets
Type	Resource
Id	google.speech.phrase_sets

Fields

The following fields are returned by SELECT queries:

get

Successful response

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 (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.
deleteTime	string (google-datetime)	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 (google-datetime)	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.

list

Successful response

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 (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.
deleteTime	string (google-datetime)	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 (google-datetime)	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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, phraseSetsId		Get a phrase set.
list	select	projectsId, locationsId	pageSize, pageToken	List phrase sets.
create	insert	projectsId, locationsId		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.
patch	update	projectsId, locationsId, phraseSetsId	updateMask	Update a phrase set.
delete	delete	projectsId, locationsId, phraseSetsId		Delete a phrase set.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
phraseSetsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Get a phrase set.

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

list

List phrase sets.

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

INSERT examples

create

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.

INSERT INTO google.speech.phrase_sets (
data__phraseSetId,
data__phraseSet,
projectsId,
locationsId
)
SELECT 
'{{ phraseSetId }}',
'{{ phraseSet }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
annotations,
boost,
deleteTime,
displayName,
etag,
expireTime,
kmsKeyName,
kmsKeyVersionName,
phrases,
reconciling,
state,
uid
;

Manifest

# Description fields are for documentation purposes
- name: phrase_sets
  props:
    - name: projectsId
      value: string
      description: Required parameter for the phrase_sets resource.
    - name: locationsId
      value: string
      description: Required parameter for the phrase_sets resource.
    - name: phraseSetId
      value: string
      description: >
        Required. The ID to use for the phrase set, which will become the final component of the phrase set's resource name. This value should restrict to letters, numbers, and hyphens, with the first character a letter, the last a letter or a number, and be 4-63 characters.
        
    - name: phraseSet
      value: object
      description: >
        Required. The phrase set to create.
        

UPDATE examples

patch

Update a phrase set.

UPDATE google.speech.phrase_sets
SET 
data__name = '{{ name }}',
data__phrases = '{{ phrases }}',
data__boost = {{ boost }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND phraseSetsId = '{{ phraseSetsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
annotations,
boost,
deleteTime,
displayName,
etag,
expireTime,
kmsKeyName,
kmsKeyVersionName,
phrases,
reconciling,
state,
uid;

DELETE examples

delete

Delete a phrase set.

DELETE FROM google.speech.phrase_sets
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND phraseSetsId = '{{ phraseSetsId }}' --required;