---
title: "POST /v1/{+parent}/phraseSets"
method: POST
path: "/v1/{+parent}/phraseSets"
tags: ["projects"]
---

# POST /v1/{+parent}/phraseSets

`POST /v1/{+parent}/phraseSets`

Create a set of phrase hints. Each item in the set can be a single word or a multi-word phrase. The items in the PhraseSet are favored by the recognition model when you send a call that includes the PhraseSet.

## Path parameters

- `parent` string, required

## Request body

- CreatePhraseSetRequest — Message sent by the client for the `CreatePhraseSet` method.
  - `phraseSetId` string — Required. The ID to use for the phrase set, which will become the final component of the phrase set's resource name. This value should restrict to letters, numbers, and hyphens, with the first character a letter, the last a letter or a number, and be 4-63 characters.
  - `phraseSet` PhraseSet — Provides "hints" to the speech recognizer to favor specific words and phrases in the results.
    - `annotations` object — Output only. 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. This field is not used.
    - `reconciling` boolean — Output only. Whether or not this PhraseSet is in the process of being updated. This field is not used.
    - `name` string — The resource name of the phrase set.
    - `kmsKeyName` string — Output only. The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the PhraseSet is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
    - `state` 'STATE_UNSPECIFIED' | 'ACTIVE' | 'DELETED' — Output only. The CustomClass lifecycle state. This field is not used.
    - `expireTime` string, google-datetime — Output only. The time at which this resource will be purged. This field is not used.
    - `phrases` Phrase[] — A list of word and phrases.
      - `boost` number, float — Hint Boost. Overrides the boost set at the phrase set level. 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. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 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.
      - `value` string — The phrase itself.
    - `kmsKeyVersionName` string — Output only. The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which content of the PhraseSet is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
    - `uid` string — Output only. System-assigned unique identifier for the PhraseSet. This field is not used.
    - `boost` number, float — 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. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values 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.
    - `displayName` string — Output only. User-settable, human-readable name for the PhraseSet. Must be 63 characters or less. This field is not used.
    - `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. This field is not used.
    - `deleteTime` string, google-datetime — Output only. The time at which this resource was requested for deletion. This field is not used.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/speech.md) · [All operations](https://skmtc.net/google/apis/speech/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/speech/versions/11b892dab9f9/schema)