Class: Google::Cloud::Speech::V2::Recognizer
- Inherits:
-
Object
- Object
- Google::Cloud::Speech::V2::Recognizer
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/speech/v2/cloud_speech.rb
Overview
A Recognizer message. Stores recognition configuration and metadata.
Defined Under Namespace
Modules: State Classes: AnnotationsEntry
Instance Attribute Summary collapse
-
#annotations ⇒ ::Google::Protobuf::Map{::String => ::String}
Allows users to store small amounts of arbitrary data.
-
#create_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#default_recognition_config ⇒ ::Google::Cloud::Speech::V2::RecognitionConfig
Default configuration to use for requests with this Recognizer.
-
#delete_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#display_name ⇒ ::String
User-settable, human-readable name for the Recognizer.
-
#etag ⇒ ::String
readonly
Output only.
-
#expire_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#kms_key_name ⇒ ::String
readonly
Output only.
-
#kms_key_version_name ⇒ ::String
readonly
Output only.
-
#language_codes ⇒ ::Array<::String>
Required.
-
#model ⇒ ::String
Required.
-
#name ⇒ ::String
readonly
Output only.
-
#reconciling ⇒ ::Boolean
readonly
Output only.
-
#state ⇒ ::Google::Cloud::Speech::V2::Recognizer::State
readonly
Output only.
-
#uid ⇒ ::String
readonly
Output only.
-
#update_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
Instance Attribute Details
#annotations ⇒ ::Google::Protobuf::Map{::String => ::String}
Returns 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.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 348 class Recognizer include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class AnnotationsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Set of states that define the lifecycle of a Recognizer. module State # The default value. This value is used if the state is omitted. STATE_UNSPECIFIED = 0 # The Recognizer is active and ready for use. ACTIVE = 2 # This Recognizer has been deleted. DELETED = 4 end end |
#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. Creation time.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 348 class Recognizer include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class AnnotationsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Set of states that define the lifecycle of a Recognizer. module State # The default value. This value is used if the state is omitted. STATE_UNSPECIFIED = 0 # The Recognizer is active and ready for use. ACTIVE = 2 # This Recognizer has been deleted. DELETED = 4 end end |
#default_recognition_config ⇒ ::Google::Cloud::Speech::V2::RecognitionConfig
Returns Default configuration to use for requests with this Recognizer. This can be overwritten by inline configuration in the RecognizeRequest.config field.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 348 class Recognizer include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class AnnotationsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Set of states that define the lifecycle of a Recognizer. module State # The default value. This value is used if the state is omitted. STATE_UNSPECIFIED = 0 # The Recognizer is active and ready for use. ACTIVE = 2 # This Recognizer has been deleted. DELETED = 4 end end |
#delete_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The time at which this Recognizer was requested for deletion.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 348 class Recognizer include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class AnnotationsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Set of states that define the lifecycle of a Recognizer. module State # The default value. This value is used if the state is omitted. STATE_UNSPECIFIED = 0 # The Recognizer is active and ready for use. ACTIVE = 2 # This Recognizer has been deleted. DELETED = 4 end end |
#display_name ⇒ ::String
Returns User-settable, human-readable name for the Recognizer. Must be 63 characters or less.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 348 class Recognizer include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class AnnotationsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Set of states that define the lifecycle of a Recognizer. module State # The default value. This value is used if the state is omitted. STATE_UNSPECIFIED = 0 # The Recognizer is active and ready for use. ACTIVE = 2 # This Recognizer has been deleted. DELETED = 4 end end |
#etag ⇒ ::String (readonly)
Returns 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.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 348 class Recognizer include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class AnnotationsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Set of states that define the lifecycle of a Recognizer. module State # The default value. This value is used if the state is omitted. STATE_UNSPECIFIED = 0 # The Recognizer is active and ready for use. ACTIVE = 2 # This Recognizer has been deleted. DELETED = 4 end end |
#expire_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The time at which this Recognizer will be purged.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 348 class Recognizer include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class AnnotationsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Set of states that define the lifecycle of a Recognizer. module State # The default value. This value is used if the state is omitted. STATE_UNSPECIFIED = 0 # The Recognizer is active and ready for use. ACTIVE = 2 # This Recognizer has been deleted. DELETED = 4 end end |
#kms_key_name ⇒ ::String (readonly)
Returns 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}
.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 348 class Recognizer include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class AnnotationsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Set of states that define the lifecycle of a Recognizer. module State # The default value. This value is used if the state is omitted. STATE_UNSPECIFIED = 0 # The Recognizer is active and ready for use. ACTIVE = 2 # This Recognizer has been deleted. DELETED = 4 end end |
#kms_key_version_name ⇒ ::String (readonly)
Returns 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}
.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 348 class Recognizer include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class AnnotationsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Set of states that define the lifecycle of a Recognizer. module State # The default value. This value is used if the state is omitted. STATE_UNSPECIFIED = 0 # The Recognizer is active and ready for use. ACTIVE = 2 # This Recognizer has been deleted. DELETED = 4 end end |
#language_codes ⇒ ::Array<::String>
Returns Required. The language of the supplied audio as a BCP-47 language tag.
Supported languages:
en-US
en-GB
fr-FR
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".
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 348 class Recognizer include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class AnnotationsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Set of states that define the lifecycle of a Recognizer. module State # The default value. This value is used if the state is omitted. STATE_UNSPECIFIED = 0 # The Recognizer is active and ready for use. ACTIVE = 2 # This Recognizer has been deleted. DELETED = 4 end end |
#model ⇒ ::String
Returns 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.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 348 class Recognizer include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class AnnotationsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Set of states that define the lifecycle of a Recognizer. module State # The default value. This value is used if the state is omitted. STATE_UNSPECIFIED = 0 # The Recognizer is active and ready for use. ACTIVE = 2 # This Recognizer has been deleted. DELETED = 4 end end |
#name ⇒ ::String (readonly)
Returns Output only. The resource name of the Recognizer.
Format: projects/{project}/locations/{location}/recognizers/{recognizer}
.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 348 class Recognizer include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class AnnotationsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Set of states that define the lifecycle of a Recognizer. module State # The default value. This value is used if the state is omitted. STATE_UNSPECIFIED = 0 # The Recognizer is active and ready for use. ACTIVE = 2 # This Recognizer has been deleted. DELETED = 4 end end |
#reconciling ⇒ ::Boolean (readonly)
Returns Output only. Whether or not this Recognizer is in the process of being updated.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 348 class Recognizer include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class AnnotationsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Set of states that define the lifecycle of a Recognizer. module State # The default value. This value is used if the state is omitted. STATE_UNSPECIFIED = 0 # The Recognizer is active and ready for use. ACTIVE = 2 # This Recognizer has been deleted. DELETED = 4 end end |
#state ⇒ ::Google::Cloud::Speech::V2::Recognizer::State (readonly)
Returns Output only. The Recognizer lifecycle state.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 348 class Recognizer include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class AnnotationsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Set of states that define the lifecycle of a Recognizer. module State # The default value. This value is used if the state is omitted. STATE_UNSPECIFIED = 0 # The Recognizer is active and ready for use. ACTIVE = 2 # This Recognizer has been deleted. DELETED = 4 end end |
#uid ⇒ ::String (readonly)
Returns Output only. System-assigned unique identifier for the Recognizer.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 348 class Recognizer include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class AnnotationsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Set of states that define the lifecycle of a Recognizer. module State # The default value. This value is used if the state is omitted. STATE_UNSPECIFIED = 0 # The Recognizer is active and ready for use. ACTIVE = 2 # This Recognizer has been deleted. DELETED = 4 end end |
#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The most recent time this Recognizer was modified.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 348 class Recognizer include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class AnnotationsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Set of states that define the lifecycle of a Recognizer. module State # The default value. This value is used if the state is omitted. STATE_UNSPECIFIED = 0 # The Recognizer is active and ready for use. ACTIVE = 2 # This Recognizer has been deleted. DELETED = 4 end end |