As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Speech v2 API¶

class google.cloud.speech_v2.types.AccessMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The access metadata for a particular region. This can be applied if the org policy for the given project disallows a particular region.

constraint_type¶

Describes the different types of constraints that are applied.

Type: google.cloud.speech_v2.types.AccessMetadata.ConstraintType

class ConstraintType(value)[source]¶

Bases: proto.enums.Enum

Describes the different types of constraints that can be applied on a region.

Values:

CONSTRAINT_TYPE_UNSPECIFIED (0):: Unspecified constraint applied.
RESOURCE_LOCATIONS_ORG_POLICY_CREATE_CONSTRAINT (1):: The project’s org policy disallows the given region.

class google.cloud.speech_v2.types.AutoDetectDecodingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Automatically detected decoding parameters. Supported for the following encodings:

WAV_LINEAR16: 16-bit signed little-endian PCM samples in a WAV container.
WAV_MULAW: 8-bit companded mulaw samples in a WAV container.
WAV_ALAW: 8-bit companded alaw samples in a WAV container.
RFC4867_5_AMR: AMR frames with an rfc4867.5 header.
RFC4867_5_AMRWB: AMR-WB frames with an rfc4867.5 header.
FLAC: FLAC frames in the “native FLAC” container format.
MP3: MPEG audio frames with optional (ignored) ID3 metadata.
OGG_OPUS: Opus audio frames in an Ogg container.
WEBM_OPUS: Opus audio frames in a WebM container.
MP4_AAC: AAC audio frames in an MP4 container.
M4A_AAC: AAC audio frames in an M4A container.
MOV_AAC: AAC audio frames in an MOV container.

class google.cloud.speech_v2.types.BatchRecognizeFileMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Metadata about a single file in a batch for BatchRecognize.

uri¶

Cloud Storage URI for the audio file.

This field is a member of oneof audio_source.

Type: str

config¶

Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the [config_mask][google.cloud.speech.v2.BatchRecognizeFileMetadata.config_mask] field can be used to override parts of the [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] of the Recognizer resource as well as the [config][google.cloud.speech.v2.BatchRecognizeRequest.config] at the request level.

Type: google.cloud.speech_v2.types.RecognitionConfig

config_mask¶

The list of fields in [config][google.cloud.speech.v2.BatchRecognizeFileMetadata.config] that override the values in the [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] of the recognizer during this recognition request. If no mask is provided, all non-default valued fields in [config][google.cloud.speech.v2.BatchRecognizeFileMetadata.config] override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (*) is provided, [config][google.cloud.speech.v2.BatchRecognizeFileMetadata.config] completely overrides and replaces the config in the recognizer for this recognition request.

Type: google.protobuf.field_mask_pb2.FieldMask

class google.cloud.speech_v2.types.BatchRecognizeFileResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Final results for a single file.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

error¶

Error if one was encountered.

Type: google.rpc.status_pb2.Status

metadata¶

Type: google.cloud.speech_v2.types.RecognitionResponseMetadata

cloud_storage_result¶

Recognition results written to Cloud Storage. This is populated only when [GcsOutputConfig][google.cloud.speech.v2.GcsOutputConfig] is set in the [RecognitionOutputConfig][[google.cloud.speech.v2.RecognitionOutputConfig].

This field is a member of oneof result.

Type: google.cloud.speech_v2.types.CloudStorageResult

inline_result¶

Recognition results. This is populated only when [InlineOutputConfig][google.cloud.speech.v2.InlineOutputConfig] is set in the [RecognitionOutputConfig][[google.cloud.speech.v2.RecognitionOutputConfig].

This field is a member of oneof result.

Type: google.cloud.speech_v2.types.InlineResult

uri¶

Deprecated. Use cloud_storage_result.native_format_uri instead.

Type: str

transcript¶

Deprecated. Use inline_result.transcript instead.

Type: google.cloud.speech_v2.types.BatchRecognizeResults

class google.cloud.speech_v2.types.BatchRecognizeMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Operation metadata for [BatchRecognize][google.cloud.speech.v2.Speech.BatchRecognize].

transcription_metadata¶

Map from provided filename to the transcription metadata for that file.

Type: MutableMapping[str, google.cloud.speech_v2.types.BatchRecognizeTranscriptionMetadata]

class TranscriptionMetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.speech_v2.types.BatchRecognizeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for the [BatchRecognize][google.cloud.speech.v2.Speech.BatchRecognize] method.

recognizer¶

Required. The name of the Recognizer to use during recognition. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}. The {recognizer} segment may be set to _ to use an empty implicit Recognizer.

Type: str

config¶

Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the [config_mask][google.cloud.speech.v2.BatchRecognizeRequest.config_mask] field can be used to override parts of the [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] of the Recognizer resource.

Type: google.cloud.speech_v2.types.RecognitionConfig

config_mask¶

The list of fields in [config][google.cloud.speech.v2.BatchRecognizeRequest.config] that override the values in the [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] of the recognizer during this recognition request. If no mask is provided, all given fields in [config][google.cloud.speech.v2.BatchRecognizeRequest.config] override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (*) is provided, [config][google.cloud.speech.v2.BatchRecognizeRequest.config] completely overrides and replaces the config in the recognizer for this recognition request.

Type: google.protobuf.field_mask_pb2.FieldMask

files¶

Audio files with file metadata for ASR. The maximum number of files allowed to be specified is 15.

Type: MutableSequence[google.cloud.speech_v2.types.BatchRecognizeFileMetadata]

recognition_output_config¶

Configuration options for where to output the transcripts of each file.

Type: google.cloud.speech_v2.types.RecognitionOutputConfig

processing_strategy¶

Processing strategy to use for this request.

Type: google.cloud.speech_v2.types.BatchRecognizeRequest.ProcessingStrategy

class ProcessingStrategy(value)[source]¶

Bases: proto.enums.Enum

Possible processing strategies for batch requests.

Values:

PROCESSING_STRATEGY_UNSPECIFIED (0):: Default value for the processing strategy. The request is processed as soon as its received.
DYNAMIC_BATCHING (1):: If selected, processes the request during lower utilization periods for a price discount. The request is fulfilled within 24 hours.

class google.cloud.speech_v2.types.BatchRecognizeResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response message for [BatchRecognize][google.cloud.speech.v2.Speech.BatchRecognize] that is packaged into a longrunning [Operation][google.longrunning.Operation].

results¶

Map from filename to the final result for that file.

Type: MutableMapping[str, google.cloud.speech_v2.types.BatchRecognizeFileResult]

total_billed_duration¶

When available, billed audio seconds for the corresponding request.

Type: google.protobuf.duration_pb2.Duration

class ResultsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.speech_v2.types.BatchRecognizeResults(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Output type for Cloud Storage of BatchRecognize transcripts. Though this proto isn’t returned in this API anywhere, the Cloud Storage transcripts will be this proto serialized and should be parsed as such.

results¶

Sequential list of transcription results corresponding to sequential portions of audio.

Type: MutableSequence[google.cloud.speech_v2.types.SpeechRecognitionResult]

metadata¶

Metadata about the recognition.

Type: google.cloud.speech_v2.types.RecognitionResponseMetadata

class google.cloud.speech_v2.types.BatchRecognizeTranscriptionMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Metadata about transcription for a single file (for example, progress percent).

progress_percent¶

How much of the file has been transcribed so far.

Type: int

error¶

Error if one was encountered.

Type: google.rpc.status_pb2.Status

uri¶

The Cloud Storage URI to which recognition results will be written.

Type: str

class google.cloud.speech_v2.types.CloudStorageResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Final results written to Cloud Storage.

uri¶

The Cloud Storage URI to which recognition results were written.

Type: str

vtt_format_uri¶

The Cloud Storage URI to which recognition results were written as VTT formatted captions. This is populated only when VTT output is requested.

Type: str

srt_format_uri¶

The Cloud Storage URI to which recognition results were written as SRT formatted captions. This is populated only when SRT output is requested.

Type: str

class google.cloud.speech_v2.types.Config(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Message representing the config for the Speech-to-Text API. This includes an optional KMS key with which incoming data will be encrypted.

name¶

Output only. Identifier. The name of the config resource. There is exactly one config resource per project per location. The expected format is projects/{project}/locations/{location}/config.

Type: str

kms_key_name¶

Optional. An optional KMS key name that if present, will be used to encrypt Speech-to-Text resources at-rest. Updating this key will not encrypt existing resources using this key; only new resources will be encrypted using this key. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

Type: str

update_time¶

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

Type: google.protobuf.timestamp_pb2.Timestamp

class google.cloud.speech_v2.types.CreateCustomClassRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for the [CreateCustomClass][google.cloud.speech.v2.Speech.CreateCustomClass] method.

custom_class¶

Required. The CustomClass to create.

Type: google.cloud.speech_v2.types.CustomClass

validate_only¶

If set, validate the request and preview the CustomClass, but do not actually create it.

Type: bool

custom_class_id¶

The ID to use for the CustomClass, which will become the final component of the CustomClass’s resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

Type: str

parent¶

Required. The project and location where this CustomClass will be created. The expected format is projects/{project}/locations/{location}.

Type: str

class google.cloud.speech_v2.types.CreatePhraseSetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for the [CreatePhraseSet][google.cloud.speech.v2.Speech.CreatePhraseSet] method.

phrase_set¶

Required. The PhraseSet to create.

Type: google.cloud.speech_v2.types.PhraseSet

validate_only¶

If set, validate the request and preview the PhraseSet, but do not actually create it.

Type: bool

phrase_set_id¶

The ID to use for the PhraseSet, which will become the final component of the PhraseSet’s resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

Type: str

parent¶

Required. The project and location where this PhraseSet will be created. The expected format is projects/{project}/locations/{location}.

Type: str

class google.cloud.speech_v2.types.CreateRecognizerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for the [CreateRecognizer][google.cloud.speech.v2.Speech.CreateRecognizer] method.

recognizer¶

Required. The Recognizer to create.

Type: google.cloud.speech_v2.types.Recognizer

validate_only¶

If set, validate the request and preview the Recognizer, but do not actually create it.

Type: bool

recognizer_id¶

The ID to use for the Recognizer, which will become the final component of the Recognizer’s resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

Type: str

parent¶

Required. The project and location where this Recognizer will be created. The expected format is projects/{project}/locations/{location}.

Type: str

class google.cloud.speech_v2.types.CustomClass(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

CustomClass for biasing in speech recognition. Used to define a set of words or phrases that represents a common concept or theme likely to appear in your audio, for example a list of passenger ship names.

name¶

Output only. Identifier. The resource name of the CustomClass. Format: projects/{project}/locations/{location}/customClasses/{custom_class}.

Type: str

uid¶

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

Type: str

display_name¶

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

Type: str

items¶

A collection of class items.

Type: MutableSequence[google.cloud.speech_v2.types.CustomClass.ClassItem]

state¶

Output only. The CustomClass lifecycle state.

Type: google.cloud.speech_v2.types.CustomClass.State

create_time¶

Output only. Creation time.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

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

Type: google.protobuf.timestamp_pb2.Timestamp

delete_time¶

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

Type: google.protobuf.timestamp_pb2.Timestamp

expire_time¶

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

Type: google.protobuf.timestamp_pb2.Timestamp

annotations¶

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

Type: MutableMapping[str, str]

etag¶

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.

Type: str

reconciling¶

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

Type: bool

kms_key_name¶

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

Type: str

kms_key_version_name¶

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

Type: str

class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class ClassItem(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

An item of the class.

value¶

The class item’s value.

Type: str

class State(value)[source]¶

Bases: proto.enums.Enum

Set of states that define the lifecycle of a CustomClass.

Values:

STATE_UNSPECIFIED (0):: Unspecified state. This is only used/useful for distinguishing unset values.
ACTIVE (2):: The normal and active state.
DELETED (4):: This CustomClass has been deleted.

class google.cloud.speech_v2.types.DeleteCustomClassRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for the [DeleteCustomClass][google.cloud.speech.v2.Speech.DeleteCustomClass] method.

name¶

Required. The name of the CustomClass to delete. Format: projects/{project}/locations/{location}/customClasses/{custom_class}

Type: str

validate_only¶

If set, validate the request and preview the deleted CustomClass, but do not actually delete it.

Type: bool

allow_missing¶

If set to true, and the CustomClass is not found, the request will succeed and be a no-op (no Operation is recorded in this case).

Type: bool

etag¶

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.

Type: str

class google.cloud.speech_v2.types.DeletePhraseSetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for the [DeletePhraseSet][google.cloud.speech.v2.Speech.DeletePhraseSet] method.

name¶

Required. The name of the PhraseSet to delete. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}

Type: str

validate_only¶

If set, validate the request and preview the deleted PhraseSet, but do not actually delete it.

Type: bool

allow_missing¶

If set to true, and the PhraseSet is not found, the request will succeed and be a no-op (no Operation is recorded in this case).

Type: bool

etag¶

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.

Type: str

class google.cloud.speech_v2.types.DeleteRecognizerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for the [DeleteRecognizer][google.cloud.speech.v2.Speech.DeleteRecognizer] method.

name¶

Required. The name of the Recognizer to delete. Format: projects/{project}/locations/{location}/recognizers/{recognizer}

Type: str

validate_only¶

If set, validate the request and preview the deleted Recognizer, but do not actually delete it.

Type: bool

allow_missing¶

If set to true, and the Recognizer is not found, the request will succeed and be a no-op (no Operation is recorded in this case).

Type: bool

etag¶

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.

Type: str

class google.cloud.speech_v2.types.ExplicitDecodingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Explicitly specified decoding parameters.

encoding¶

Required. Encoding of the audio data sent for recognition.

Type: google.cloud.speech_v2.types.ExplicitDecodingConfig.AudioEncoding

sample_rate_hertz¶

Sample rate in Hertz of the audio data sent for recognition. Valid values are: 8000-48000. 16000 is optimal. For best results, set the sampling rate of the audio source to 16000 Hz. If that’s not possible, use the native sample rate of the audio source (instead of re-sampling). Supported for the following encodings:

LINEAR16: Headerless 16-bit signed little-endian PCM samples.
MULAW: Headerless 8-bit companded mulaw samples.
ALAW: Headerless 8-bit companded alaw samples.

Type: int

audio_channel_count¶

Number of channels present in the audio data sent for recognition. Supported for the following encodings:

LINEAR16: Headerless 16-bit signed little-endian PCM samples.
MULAW: Headerless 8-bit companded mulaw samples.
ALAW: Headerless 8-bit companded alaw samples.

The maximum allowed value is 8.

Type: int

class AudioEncoding(value)[source]¶

Bases: proto.enums.Enum

Supported audio data encodings.

Values:

AUDIO_ENCODING_UNSPECIFIED (0):: Default value. This value is unused.
LINEAR16 (1):: Headerless 16-bit signed little-endian PCM samples.
MULAW (2):: Headerless 8-bit companded mulaw samples.
ALAW (3):: Headerless 8-bit companded alaw samples.

class google.cloud.speech_v2.types.GcsOutputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Output configurations for Cloud Storage.

uri¶

The Cloud Storage URI prefix with which recognition results will be written.

Type: str

class google.cloud.speech_v2.types.GetConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for the [GetConfig][google.cloud.speech.v2.Speech.GetConfig] method.

name¶

Required. The name of the config to retrieve. There is exactly one config resource per project per location. The expected format is projects/{project}/locations/{location}/config.

Type: str

class google.cloud.speech_v2.types.GetCustomClassRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for the [GetCustomClass][google.cloud.speech.v2.Speech.GetCustomClass] method.

name¶

Required. The name of the CustomClass to retrieve. The expected format is projects/{project}/locations/{location}/customClasses/{custom_class}.

Type: str

class google.cloud.speech_v2.types.GetPhraseSetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for the [GetPhraseSet][google.cloud.speech.v2.Speech.GetPhraseSet] method.

name¶

Required. The name of the PhraseSet to retrieve. The expected format is projects/{project}/locations/{location}/phraseSets/{phrase_set}.

Type: str

class google.cloud.speech_v2.types.GetRecognizerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for the [GetRecognizer][google.cloud.speech.v2.Speech.GetRecognizer] method.

name¶

Required. The name of the Recognizer to retrieve. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}.

Type: str

class google.cloud.speech_v2.types.InlineOutputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Output configurations for inline response.

class google.cloud.speech_v2.types.InlineResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Final results returned inline in the recognition response.

transcript¶

The transcript for the audio file.

Type: google.cloud.speech_v2.types.BatchRecognizeResults

vtt_captions¶

The transcript for the audio file as VTT formatted captions. This is populated only when VTT output is requested.

Type: str

srt_captions¶

The transcript for the audio file as SRT formatted captions. This is populated only when SRT output is requested.

Type: str

class google.cloud.speech_v2.types.LanguageMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The metadata about locales available in a given region. Currently this is just the models that are available for each locale

models¶

Map of locale (language code) -> models

Type: MutableMapping[str, google.cloud.speech_v2.types.ModelMetadata]

class ModelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.speech_v2.types.ListCustomClassesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for the [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] method.

parent¶

Required. The project and location of CustomClass resources to list. The expected format is projects/{project}/locations/{location}.

Type: str

page_size¶

Number of results per requests. A valid page_size ranges from 0 to 100 inclusive. If the page_size is zero or unspecified, a page size of 5 will be chosen. If the page size exceeds 100, it will be coerced down to 100. Note that a call might return fewer results than the requested page size.

Type: int

page_token¶

A page token, received from a previous [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] must match the call that provided the page token.

Type: str

show_deleted¶

Whether, or not, to show resources that have been deleted.

Type: bool

class google.cloud.speech_v2.types.ListCustomClassesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response message for the [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] method.

custom_classes¶

The list of requested CustomClasses.

Type: MutableSequence[google.cloud.speech_v2.types.CustomClass]

next_page_token¶

A token, which can be sent as [page_token][google.cloud.speech.v2.ListCustomClassesRequest.page_token] to retrieve the next page. If this field is omitted, there are no subsequent pages. This token expires after 72 hours.

Type: str

class google.cloud.speech_v2.types.ListPhraseSetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for the [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] method.

parent¶

Required. The project and location of PhraseSet resources to list. The expected format is projects/{project}/locations/{location}.

Type: str

page_size¶

The maximum number of PhraseSets to return. The service may return fewer than this value. If unspecified, at most 5 PhraseSets will be returned. The maximum value is 100; values above 100 will be coerced to 100.

Type: int

page_token¶

A page token, received from a previous [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] must match the call that provided the page token.

Type: str

show_deleted¶

Whether, or not, to show resources that have been deleted.

Type: bool

class google.cloud.speech_v2.types.ListPhraseSetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response message for the [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] method.

phrase_sets¶

The list of requested PhraseSets.

Type: MutableSequence[google.cloud.speech_v2.types.PhraseSet]

next_page_token¶

A token, which can be sent as [page_token][google.cloud.speech.v2.ListPhraseSetsRequest.page_token] to retrieve the next page. If this field is omitted, there are no subsequent pages. This token expires after 72 hours.

Type: str

class google.cloud.speech_v2.types.ListRecognizersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for the [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] method.

parent¶

Required. The project and location of Recognizers to list. The expected format is projects/{project}/locations/{location}.

Type: str

page_size¶

The maximum number of Recognizers to return. The service may return fewer than this value. If unspecified, at most 5 Recognizers will be returned. The maximum value is 100; values above 100 will be coerced to 100.

Type: int

page_token¶

A page token, received from a previous [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] must match the call that provided the page token.

Type: str

show_deleted¶

Whether, or not, to show resources that have been deleted.

Type: bool

class google.cloud.speech_v2.types.ListRecognizersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response message for the [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] method.

recognizers¶

The list of requested Recognizers.

Type: MutableSequence[google.cloud.speech_v2.types.Recognizer]

next_page_token¶

A token, which can be sent as [page_token][google.cloud.speech.v2.ListRecognizersRequest.page_token] to retrieve the next page. If this field is omitted, there are no subsequent pages. This token expires after 72 hours.

Type: str

class google.cloud.speech_v2.types.LocationsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Main metadata for the Locations API for STT V2. Currently this is just the metadata about locales, models, and features

languages¶

Information about available locales, models, and features represented in the hierarchical structure of locales -> models -> features

Type: google.cloud.speech_v2.types.LanguageMetadata

access_metadata¶

Information about access metadata for the region and given project.

Type: google.cloud.speech_v2.types.AccessMetadata

class google.cloud.speech_v2.types.ModelFeature(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Representes a singular feature of a model. If the feature is recognizer, the release_state of the feature represents the release_state of the model

feature¶

The name of the feature (Note: the feature can be recognizer)

Type: str

release_state¶

The release state of the feature

Type: str

class google.cloud.speech_v2.types.ModelFeatures(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Represents the collection of features belonging to a model

model_feature¶

Repeated field that contains all features of the model

Type: MutableSequence[google.cloud.speech_v2.types.ModelFeature]

class google.cloud.speech_v2.types.ModelMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The metadata about the models in a given region for a specific locale. Currently this is just the features of the model

model_features¶

Map of the model name -> features of that model

Type: MutableMapping[str, google.cloud.speech_v2.types.ModelFeatures]

class ModelFeaturesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.speech_v2.types.NativeOutputFileFormatConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Output configurations for serialized BatchRecognizeResults protos.

class google.cloud.speech_v2.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Represents the metadata of a long-running operation.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

create_time¶

The time the operation was created.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

The time the operation was last updated.

Type: google.protobuf.timestamp_pb2.Timestamp

resource¶

The resource path for the target of the operation.

Type: str

method¶

The method that triggered the operation.

Type: str

kms_key_name¶

The KMS key name with which the content of the Operation is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

Type: str

kms_key_version_name¶

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

Type: str

batch_recognize_request¶

The BatchRecognizeRequest that spawned the Operation.