REST Resource: projects.locations.phraseSets

资源:PhraseSet

为语音识别器提供“提示”以支持结果中的特定字词和短语。

JSON 表示法
{
  "name": string,
  "phrases": [
    {
      object (Phrase)
    }
  ],
  "boost": number,
  "kmsKeyName": string,
  "kmsKeyVersionName": string,
  "uid": string,
  "displayName": string,
  "state": enum (State),
  "deleteTime": string,
  "expireTime": string,
  "annotations": {
    string: string,
    ...
  },
  "etag": string,
  "reconciling": boolean
}
字段
name

string

短语集的资源名称。

phrases[]

object (Phrase)

字词和短语的列表。

boost

number

提示加成。正值会提高识别特定短语的概率,而不是其他发音类似的短语。提升越大,出现假正例识别的几率也越高。负提升值对应于反偏差。未启用反偏差功能,因此系统会直接忽略负向加权。虽然 boost 可以接受各种正值,但在大多数使用情形下,最好使用介于 0(不含)和 20 之间的值。我们建议您使用二分搜索方法来找到适合您使用情形的最佳值,并在请求中添加带提升和不带提升的短语。

kmsKeyName

string

仅限输出。用于加密 PhraseSet 内容的 KMS 密钥名称。格式应为 projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}。

kmsKeyVersionName

string

仅限输出。用于加密 PhraseSet 内容的 KMS 密钥版本名称。格式应为 projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}。

uid

string

仅限输出。系统为 PhraseSet 分配的唯一标识符。此字段未使用。

displayName

string

仅限输出。用户可设置的 PhraseSet 人类可读名称。不得超过 63 个字符。此字段未使用。

state

enum (State)

仅限输出。CustomClass 生命周期状态。此字段未使用。

deleteTime

string (Timestamp format)

仅限输出。请求删除相应资源的时间。此字段未使用。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

expireTime

string (Timestamp format)

仅限输出。相应资源将被清除的时间。此字段未使用。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

annotations

map (key: string, value: string)

仅限输出。允许用户存储少量任意数据。键和值都不得超过 63 个字符。最多 100 条注释。此字段未使用。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

etag

string

仅限输出。此校验和由服务器根据其他字段的值计算得出。可在更新、取消删除和删除请求中发送,以确保客户端在继续操作之前具有最新值。此字段未使用。

reconciling

boolean

仅限输出。相应 PhraseSet 是否正在更新。此字段未使用。

短语

包含字词和短语“提示”的短语,以便语音识别更有可能识别出它们。该字段可用于提高识别特定字词和短语的准确度,例如,在用户经常说出特定指令的情况下。该字段也可以用于向识别器的词汇表中添加更多字词。请参阅使用限制。

列表项还可以包含预构建或自定义的类,这些类包含表示自然语言中常见概念的字词组。例如,使用预建的 $MONTH 类,而不是为一年中的每个月份提供短语提示(例如“我出生于 1 月”“我出生于 2 月”等),可以提高正确转录包含月份的音频的可能性(例如“我出生于 $month”)。如需引用预构建的类,请使用以 $ 开头的类符号,例如 $MONTH。如需引用在请求中内嵌定义的自定义类,请将该类的 customClassId 设置为对所有类资源和内嵌类而言唯一的字符串。然后,使用封装在 ${...} 中的类的 ID,例如“${my-months}”。如需引用自定义类资源,请使用封装在 ${} 中的类的 ID(例如 ${my-months})。

Speech-to-Text 支持三个位置:global、us(美国北美)和 eu(欧洲)。如果您要调用 speech.googleapis.com 端点,请使用 global 位置。如需指定区域,请使用与 us 或 eu 位置值相匹配的区域端点。

JSON 表示法
{
  "value": string,
  "boost": number
}
字段
value

string

短语本身。

boost

number

提示加成。替换在短语集级别设置的提升值。正值会提高识别特定短语的概率,而不是其他发音类似的短语。提升越大,出现假正例识别的几率也越高。负值提升将直接被忽略。虽然 boost 可以接受各种正值,但对于大多数使用情形,最好使用介于 0 到 20 之间的值。我们建议您使用二分搜索方法来找到适合您使用情形的最佳值,并在请求中添加带提升和不带提升的短语。

州

定义了 CustomClass 生命周期的一系列状态。

枚举
STATE_UNSPECIFIED 未指定状态。此值仅用于区分未设置的值。
ACTIVE 正常且有效状态。
DELETED 此 CustomClass 已被删除。

方法

create

创建一组短语提示。

delete

删除短语集。

get

获取短语集。

list

列出短语集。

patch

更新短语集。