public final class Recognizer extends GeneratedMessageV3 implements RecognizerOrBuilder
A Recognizer message. Stores recognition configuration and metadata.
Protobuf type google.cloud.speech.v2.Recognizer
Static Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DEFAULT_RECOGNITION_CONFIG_FIELD_NUMBER
public static final int DEFAULT_RECOGNITION_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
EXPIRE_TIME_FIELD_NUMBER
public static final int EXPIRE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
KMS_KEY_NAME_FIELD_NUMBER
public static final int KMS_KEY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
KMS_KEY_VERSION_NAME_FIELD_NUMBER
public static final int KMS_KEY_VERSION_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LANGUAGE_CODES_FIELD_NUMBER
public static final int LANGUAGE_CODES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MODEL_FIELD_NUMBER
public static final int MODEL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RECONCILING_FIELD_NUMBER
public static final int RECONCILING_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Recognizer getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Recognizer.Builder newBuilder()
newBuilder(Recognizer prototype)
public static Recognizer.Builder newBuilder(Recognizer prototype)
public static Recognizer parseDelimitedFrom(InputStream input)
public static Recognizer parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Recognizer parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Recognizer parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Recognizer parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Recognizer parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Recognizer parseFrom(CodedInputStream input)
public static Recognizer parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Recognizer parseFrom(InputStream input)
public static Recognizer parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Recognizer parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Recognizer parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Recognizer> parser()
Methods
containsAnnotations(String key)
public 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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAnnotations()
public Map<String,String> getAnnotations()
getAnnotationsCount()
public 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 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;
getAnnotationsOrDefault(String key, String defaultValue)
public 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;
getAnnotationsOrThrow(String key)
public 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
|
getCreateTime()
public 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 TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Creation time.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Recognizer getDefaultInstanceForType()
getDefaultRecognitionConfig()
public 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;
getDefaultRecognitionConfigOrBuilder()
public 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;
getDeleteTime()
public 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 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];
getDisplayName()
public 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 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()
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 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 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 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];
getKmsKeyName()
public 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 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 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 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 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 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 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 ProtocolStringList 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];
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 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()
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 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.
|
getParserForType()
public Parser<Recognizer> getParserForType()
Overrides
getReconciling()
public 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getState()
public Recognizer.State getState()
Output only. The Recognizer lifecycle state.
.google.cloud.speech.v2.Recognizer.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public 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()
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 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.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUpdateTime()
public 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 TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The most recent time this Recognizer was modified.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public 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 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 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 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 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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Recognizer.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Recognizer.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Recognizer.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
