Interface RecognizerOrBuilder (4.9.0)

Version 4.9.0

• 4.50.0 (latest)
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.44.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.32.0
• 4.31.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.7.0
• 4.6.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.0
• 3.0.0
• 2.6.1
• 2.5.9
• 2.4.0
• 2.3.0
• 2.2.15

public interface RecognizerOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract boolean containsAnnotations(String key)

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.

map<string, string> annotations = 7;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAnnotations()

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type	Description
Map<String,String>

getAnnotationsCount()

public abstract int getAnnotationsCount()

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.

map<string, string> annotations = 7;

Returns
Type	Description
int

getAnnotationsMap()

public abstract Map<String,String> getAnnotationsMap()

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.

map<string, string> annotations = 7;

Returns
Type	Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public abstract String getAnnotationsOrDefault(String key, String defaultValue)

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.

map<string, string> annotations = 7;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getAnnotationsOrThrow(String key)

public abstract String getAnnotationsOrThrow(String key)

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.

map<string, string> annotations = 7;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Creation time.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Creation time.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDefaultRecognitionConfig()

public abstract RecognitionConfig getDefaultRecognitionConfig()

Default configuration to use for requests with this Recognizer. This can be overwritten by inline configuration in the RecognizeRequest.config field.

.google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;

Returns
Type	Description
RecognitionConfig	The defaultRecognitionConfig.

getDefaultRecognitionConfigOrBuilder()

public abstract RecognitionConfigOrBuilder getDefaultRecognitionConfigOrBuilder()

Default configuration to use for requests with this Recognizer. This can be overwritten by inline configuration in the RecognizeRequest.config field.

.google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;

Returns
Type	Description
RecognitionConfigOrBuilder

getDeleteTime()

public abstract Timestamp getDeleteTime()

Output only. The time at which this Recognizer was requested for deletion.

.google.protobuf.Timestamp delete_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The deleteTime.

getDeleteTimeOrBuilder()

public abstract TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. The time at which this Recognizer was requested for deletion.

.google.protobuf.Timestamp delete_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDisplayName()

public abstract String getDisplayName()

User-settable, human-readable name for the Recognizer. Must be 63 characters or less.

string display_name = 3;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

User-settable, human-readable name for the Recognizer. Must be 63 characters or less.

string display_name = 3;

Returns
Type	Description
ByteString	The bytes for displayName.

getEtag()

public abstract String getEtag()

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.

string etag = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

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.

string etag = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for etag.

getExpireTime()

public abstract Timestamp getExpireTime()

Output only. The time at which this Recognizer will be purged.

.google.protobuf.Timestamp expire_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The expireTime.

getExpireTimeOrBuilder()

public abstract TimestampOrBuilder getExpireTimeOrBuilder()

Output only. The time at which this Recognizer will be purged.

.google.protobuf.Timestamp expire_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getKmsKeyName()

public abstract String getKmsKeyName()

Output only. The KMS key name with which the Recognizer is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

string kms_key_name = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The kmsKeyName.

getKmsKeyNameBytes()

public abstract ByteString getKmsKeyNameBytes()

Output only. The KMS key name with which the Recognizer is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

string kms_key_name = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for kmsKeyName.

getKmsKeyVersionName()

public abstract String getKmsKeyVersionName()

Output only. The KMS key version name with which the Recognizer is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.

string kms_key_version_name = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The kmsKeyVersionName.

getKmsKeyVersionNameBytes()

public abstract ByteString getKmsKeyVersionNameBytes()

Output only. The KMS key version name with which the Recognizer is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.

string kms_key_version_name = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for kmsKeyVersionName.

getLanguageCodes(int index)

public abstract String getLanguageCodes(int index)

Required. The language of the supplied audio as a BCP-47 language tag. Supported languages for each model are listed at: https://cloud.google.com/speech-to-text/docs/languages If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio. When you create or update a Recognizer, these values are stored in normalized BCP-47 form. For example, "en-us" is stored as "en-US".

repeated string language_codes = 17 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The languageCodes at the given index.

getLanguageCodesBytes(int index)

public abstract ByteString getLanguageCodesBytes(int index)

Required. The language of the supplied audio as a BCP-47 language tag. Supported languages for each model are listed at: https://cloud.google.com/speech-to-text/docs/languages If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio. When you create or update a Recognizer, these values are stored in normalized BCP-47 form. For example, "en-us" is stored as "en-US".

repeated string language_codes = 17 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the languageCodes at the given index.

getLanguageCodesCount()

public abstract int getLanguageCodesCount()

Required. The language of the supplied audio as a BCP-47 language tag. Supported languages for each model are listed at: https://cloud.google.com/speech-to-text/docs/languages If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio. When you create or update a Recognizer, these values are stored in normalized BCP-47 form. For example, "en-us" is stored as "en-US".

repeated string language_codes = 17 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The count of languageCodes.

getLanguageCodesList()

public abstract List<String> getLanguageCodesList()

Required. The language of the supplied audio as a BCP-47 language tag. Supported languages for each model are listed at: https://cloud.google.com/speech-to-text/docs/languages If additional languages are provided, recognition result will contain recognition in the most likely language detected. The recognition result will include the language tag of the language detected in the audio. When you create or update a Recognizer, these values are stored in normalized BCP-47 form. For example, "en-us" is stored as "en-US".

repeated string language_codes = 17 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<String>	A list containing the languageCodes.

getModel()

public abstract String getModel()

Required. Which model to use for recognition requests. Select the model best suited to your domain to get best results. Supported models:

• latest_long Best for long form content like media or conversation.
• latest_short Best for short form content like commands or single shot directed speech. When using this model, the service will stop transcribing audio after the first utterance is detected and completed. When using this model, SEPARATE_RECOGNITION_PER_CHANNEL is not supported; multi-channel audio is accepted, but only the first channel will be processed and transcribed.
• telephony Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate).
• medical_conversation For conversations between a medical provider—for example, a doctor or nurse—and a patient. Use this model when both a provider and a patient are speaking. Words uttered by each speaker are automatically detected and labeled in the returned transcript. For supported features please see medical models documentation.
• medical_dictation For dictated notes spoken by a single medical provider—for example, a doctor dictating notes about a patient's blood test results. For supported features please see medical models documentation.
• usm The next generation of Speech-to-Text models from Google.

string model = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The model.

getModelBytes()

public abstract ByteString getModelBytes()

Required. Which model to use for recognition requests. Select the model best suited to your domain to get best results. Supported models:

• latest_long Best for long form content like media or conversation.
• latest_short Best for short form content like commands or single shot directed speech. When using this model, the service will stop transcribing audio after the first utterance is detected and completed. When using this model, SEPARATE_RECOGNITION_PER_CHANNEL is not supported; multi-channel audio is accepted, but only the first channel will be processed and transcribed.
• telephony Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate).
• medical_conversation For conversations between a medical provider—for example, a doctor or nurse—and a patient. Use this model when both a provider and a patient are speaking. Words uttered by each speaker are automatically detected and labeled in the returned transcript. For supported features please see medical models documentation.
• medical_dictation For dictated notes spoken by a single medical provider—for example, a doctor dictating notes about a patient's blood test results. For supported features please see medical models documentation.
• usm The next generation of Speech-to-Text models from Google.

string model = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for model.

getName()

public abstract String getName()

Output only. The resource name of the Recognizer. Format: projects/{project}/locations/{location}/recognizers/{recognizer}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. The resource name of the Recognizer. Format: projects/{project}/locations/{location}/recognizers/{recognizer}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for name.

getReconciling()

public abstract boolean getReconciling()

Output only. Whether or not this Recognizer is in the process of being updated.

bool reconciling = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The reconciling.

getState()

public abstract Recognizer.State getState()

Output only. The Recognizer lifecycle state.

.google.cloud.speech.v2.Recognizer.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Recognizer.State	The state.

getStateValue()

public abstract int getStateValue()

Output only. The Recognizer lifecycle state.

.google.cloud.speech.v2.Recognizer.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for state.

getUid()

public abstract String getUid()

Output only. System-assigned unique identifier for the Recognizer.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. System-assigned unique identifier for the Recognizer.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for uid.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The most recent time this Recognizer was modified.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The most recent time this Recognizer was modified.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Creation time.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasDefaultRecognitionConfig()

public abstract boolean hasDefaultRecognitionConfig()

Default configuration to use for requests with this Recognizer. This can be overwritten by inline configuration in the RecognizeRequest.config field.

.google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;

Returns
Type	Description
boolean	Whether the defaultRecognitionConfig field is set.

hasDeleteTime()

public abstract boolean hasDeleteTime()

Output only. The time at which this Recognizer was requested for deletion.

.google.protobuf.Timestamp delete_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the deleteTime field is set.

hasExpireTime()

public abstract boolean hasExpireTime()

Output only. The time at which this Recognizer will be purged.

.google.protobuf.Timestamp expire_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the expireTime field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The most recent time this Recognizer was modified.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.