PhraseSet class

PhraseSet for biasing in speech recognition. A PhraseSet is used to provide "hints" to the speech recognizer to favor specific words and phrases in the results.

Inheritance
  • Object
  • GeneratedMessage
  • PhraseSet

Constructors

PhraseSet({String? name, String? uid, Iterable<PhraseSet_Phrase>? phrases, double? boost, String? displayName, Timestamp? createTime, Timestamp? updateTime, Timestamp? deleteTime, Timestamp? expireTime, Map<String, String>? annotations, String? etag, bool? reconciling, String? kmsKeyName, String? kmsKeyVersionName, PhraseSet_State? state})
factory
PhraseSet.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
PhraseSet.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

annotations Map<String, String>
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.
no setter
boost double
Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Valid boost values are between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
getter/setter pair
createTime Timestamp
Output only. Creation time.
getter/setter pair
deleteTime Timestamp
Output only. The time at which this resource was requested for deletion.
getter/setter pair
displayName String
User-settable, human-readable name for the PhraseSet. Must be 63 characters or less.
getter/setter pair
etag String
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.
getter/setter pair
eventPlugin → EventPlugin?
Subclasses can override this getter to be notified of changes to protobuf fields.
no setterinherited
expireTime Timestamp
Output only. The time at which this resource will be purged.
getter/setter pair
hashCode int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setteroverride
isFrozen bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
kmsKeyName String
Output only. The KMS key name with which the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
getter/setter pair
kmsKeyVersionName String
Output only. The KMS key version name with which the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.
getter/setter pair
name String
Output only. The resource name of the PhraseSet. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}.
getter/setter pair
phrases List<PhraseSet_Phrase>
A list of word and phrases.
no setter
reconciling bool
Output only. Whether or not this PhraseSet is in the process of being updated.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
state PhraseSet_State
Output only. The PhraseSet lifecycle state.
getter/setter pair
uid String
Output only. System-assigned unique identifier for the PhraseSet.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
updateTime Timestamp
Output only. The most recent time this resource was modified.
getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearBoost() → void
clearCreateTime() → void
clearDeleteTime() → void
clearDisplayName() → void
clearEtag() → void
clearExpireTime() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearKmsKeyName() → void
clearKmsKeyVersionName() → void
clearName() → void
clearReconciling() → void
clearState() → void
clearUid() → void
clearUpdateTime() → void
clone() PhraseSet
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(PhraseSet)) PhraseSet
Apply updates to a copy of this message.
override
createEmptyInstance() PhraseSet
Creates an empty instance of the same message type as this.
override
createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) Map<K, V>
Creates a Map representing a map field.
inherited
createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) List<T>
Creates List implementing a mutable repeated field.
inherited
ensureCreateTime() Timestamp
ensureDeleteTime() Timestamp
ensureExpireTime() Timestamp
ensureUpdateTime() Timestamp
extensionsAreInitialized() bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) int?
inherited
hasBoost() bool
hasCreateTime() bool
hasDeleteTime() bool
hasDisplayName() bool
hasEtag() bool
hasExpireTime() bool
hasExtension(Extension extension) bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) bool
Whether this message has a field associated with tagNumber.
inherited
hasKmsKeyName() bool
hasKmsKeyVersionName() bool
hasName() bool
hasReconciling() bool
hasRequiredFields() bool
Whether the message has required fields.
inherited
hasState() bool
hasUid() bool
hasUpdateTime() bool
isInitialized() bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() String
Returns a String representation of this message.
inherited
writeToBuffer() Uint8List
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
inherited
writeToJson() String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

create() PhraseSet
createRepeated() → PbList<PhraseSet>
getDefault() PhraseSet