Cloud Speech-to-Text v2 API - Class Recognizer (1.0.0-beta07)

public sealed class Recognizer : IMessage<Recognizer>, IEquatable<Recognizer>, IDeepCloneable<Recognizer>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Speech-to-Text v2 API class Recognizer.

A Recognizer message. Stores recognition configuration and metadata.

Inheritance

object > Recognizer

Implements

IMessage Recognizer, IEquatable Recognizer, IDeepCloneable Recognizer, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Speech.V2

Assembly

Google.Cloud.Speech.V2.dll

Constructors

Recognizer()

public Recognizer()

Recognizer(Recognizer)

public Recognizer(Recognizer other)

Parameter
Name	Description
`other`	`Recognizer`

Properties

Annotations

public MapField<string, string> Annotations { get; }

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.

Property Value
Type	Description
`MapFieldstringstring`

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Creation time.

Property Value
Type	Description
`Timestamp`

DefaultRecognitionConfig

public RecognitionConfig DefaultRecognitionConfig { get; set; }

Default configuration to use for requests with this Recognizer. This can be overwritten by inline configuration in the [RecognizeRequest.config][google.cloud.speech.v2.RecognizeRequest.config] field.

Property Value
Type	Description
`RecognitionConfig`

DeleteTime

public Timestamp DeleteTime { get; set; }

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

Property Value
Type	Description
`Timestamp`

DisplayName

public string DisplayName { get; set; }

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

Property Value
Type	Description
`string`

Etag

public string Etag { get; set; }

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.

Property Value
Type	Description
`string`

ExpireTime

public Timestamp ExpireTime { get; set; }

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

Property Value
Type	Description
`Timestamp`

KmsKeyName

public string KmsKeyName { get; set; }

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}.

Property Value
Type	Description
`string`

KmsKeyNameAsCryptoKeyName

public CryptoKeyName KmsKeyNameAsCryptoKeyName { get; set; }

CryptoKeyName-typed view over the KmsKeyName resource name property.

Property Value
Type	Description
`CryptoKeyName`

KmsKeyVersionName

public string KmsKeyVersionName { get; set; }

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}.

Property Value
Type	Description
`string`

KmsKeyVersionNameAsCryptoKeyVersionName

public CryptoKeyVersionName KmsKeyVersionNameAsCryptoKeyVersionName { get; set; }

CryptoKeyVersionName-typed view over the KmsKeyVersionName resource name property.

Property Value
Type	Description
`CryptoKeyVersionName`

LanguageCodes

[Obsolete]
public RepeatedField<string> LanguageCodes { get; }

Optional. This field is now deprecated. Prefer the [language_codes][google.cloud.speech.v2.RecognitionConfig.language_codes] field in the [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig] message.

The language of the supplied audio as a BCP-47 language tag.

Supported languages for each model are listed in the Table of Supported Models.

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".

Property Value
Type	Description
`RepeatedFieldstring`

Model

[Obsolete]
public string Model { get; set; }

Optional. This field is now deprecated. Prefer the [model][google.cloud.speech.v2.RecognitionConfig.model] field in the [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig] message.

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

Guidance for choosing which model to use can be found in the Transcription Models Documentation and the models supported in each region can be found in the Table Of Supported Models.

Property Value
Type	Description
`string`

Name

public string Name { get; set; }

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

Property Value
Type	Description
`string`

RecognizerName

public RecognizerName RecognizerName { get; set; }

RecognizerName-typed view over the Name resource name property.

Property Value
Type	Description
`RecognizerName`

Reconciling

public bool Reconciling { get; set; }

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

Property Value
Type	Description
`bool`

State

public Recognizer.Types.State State { get; set; }

Output only. The Recognizer lifecycle state.

Property Value
Type	Description
`RecognizerTypesState`

Uid

public string Uid { get; set; }

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

Property Value
Type	Description
`string`

UpdateTime

public Timestamp UpdateTime { get; set; }

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

Property Value
Type	Description
`Timestamp`