Cloud Speech-to-Text API . projects . locations . customClasses

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Create a custom class.

Args:
  parent: string, Required. The parent resource where this custom class will be created. Format: `projects/{project}/locations/{location}/customClasses` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. (required)
  body: object, The request body.
    The object takes the form of:

{ # Message sent by the client for the `CreateCustomClass` method.
  "customClass": { # A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases. # Required. The custom class to create.
    "annotations": { # 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.
      "a_key": "A String",
    },
    "customClassId": "A String", # If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
    "deleteTime": "A String", # Output only. The time at which this resource was requested for deletion. This field is not used.
    "displayName": "A String", # Output only. User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.
    "etag": "A 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.
    "expireTime": "A String", # Output only. The time at which this resource will be purged. This field is not used.
    "items": [ # A collection of class items.
      { # An item of the class.
        "value": "A String", # The class item's value.
      },
    ],
    "kmsKeyName": "A String", # Output only. The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
    "kmsKeyVersionName": "A String", # Output only. The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
    "name": "A String", # The resource name of the custom class.
    "reconciling": True or False, # Output only. Whether or not this CustomClass is in the process of being updated. This field is not used.
    "state": "A String", # Output only. The CustomClass lifecycle state. This field is not used.
    "uid": "A String", # Output only. System-assigned unique identifier for the CustomClass. This field is not used.
  },
  "customClassId": "A String", # Required. The ID to use for the custom class, which will become the final component of the custom class' 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.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.
  "annotations": { # 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.
    "a_key": "A String",
  },
  "customClassId": "A String", # If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
  "deleteTime": "A String", # Output only. The time at which this resource was requested for deletion. This field is not used.
  "displayName": "A String", # Output only. User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.
  "etag": "A 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.
  "expireTime": "A String", # Output only. The time at which this resource will be purged. This field is not used.
  "items": [ # A collection of class items.
    { # An item of the class.
      "value": "A String", # The class item's value.
    },
  ],
  "kmsKeyName": "A String", # Output only. The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
  "kmsKeyVersionName": "A String", # Output only. The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
  "name": "A String", # The resource name of the custom class.
  "reconciling": True or False, # Output only. Whether or not this CustomClass is in the process of being updated. This field is not used.
  "state": "A String", # Output only. The CustomClass lifecycle state. This field is not used.
  "uid": "A String", # Output only. System-assigned unique identifier for the CustomClass. This field is not used.
}

delete(name, x__xgafv=None)

Delete a custom class.

Args:
  name: string, Required. The name of the custom class to delete. Format: `projects/{project}/locations/{location}/customClasses/{custom_class}` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Get a custom class.

Args:
  name: string, Required. The name of the custom class to retrieve. Format: `projects/{project}/locations/{location}/customClasses/{custom_class}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.
  "annotations": { # 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.
    "a_key": "A String",
  },
  "customClassId": "A String", # If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
  "deleteTime": "A String", # Output only. The time at which this resource was requested for deletion. This field is not used.
  "displayName": "A String", # Output only. User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.
  "etag": "A 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.
  "expireTime": "A String", # Output only. The time at which this resource will be purged. This field is not used.
  "items": [ # A collection of class items.
    { # An item of the class.
      "value": "A String", # The class item's value.
    },
  ],
  "kmsKeyName": "A String", # Output only. The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
  "kmsKeyVersionName": "A String", # Output only. The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
  "name": "A String", # The resource name of the custom class.
  "reconciling": True or False, # Output only. Whether or not this CustomClass is in the process of being updated. This field is not used.
  "state": "A String", # Output only. The CustomClass lifecycle state. This field is not used.
  "uid": "A String", # Output only. System-assigned unique identifier for the CustomClass. This field is not used.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

List custom classes.

Args:
  parent: string, Required. The parent, which owns this collection of custom classes. Format: `projects/{project}/locations/{location}/customClasses` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. (required)
  pageSize: integer, The maximum number of custom classes to return. The service may return fewer than this value. If unspecified, at most 50 custom classes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, A page token, received from a previous `ListCustomClass` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomClass` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message returned to the client by the `ListCustomClasses` method.
  "customClasses": [ # The custom classes.
    { # A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.
      "annotations": { # 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.
        "a_key": "A String",
      },
      "customClassId": "A String", # If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
      "deleteTime": "A String", # Output only. The time at which this resource was requested for deletion. This field is not used.
      "displayName": "A String", # Output only. User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.
      "etag": "A 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.
      "expireTime": "A String", # Output only. The time at which this resource will be purged. This field is not used.
      "items": [ # A collection of class items.
        { # An item of the class.
          "value": "A String", # The class item's value.
        },
      ],
      "kmsKeyName": "A String", # Output only. The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
      "kmsKeyVersionName": "A String", # Output only. The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
      "name": "A String", # The resource name of the custom class.
      "reconciling": True or False, # Output only. Whether or not this CustomClass is in the process of being updated. This field is not used.
      "state": "A String", # Output only. The CustomClass lifecycle state. This field is not used.
      "uid": "A String", # Output only. System-assigned unique identifier for the CustomClass. This field is not used.
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

patch(name, body=None, updateMask=None, x__xgafv=None)

Update a custom class.

Args:
  name: string, The resource name of the custom class. (required)
  body: object, The request body.
    The object takes the form of:

{ # A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.
  "annotations": { # 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.
    "a_key": "A String",
  },
  "customClassId": "A String", # If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
  "deleteTime": "A String", # Output only. The time at which this resource was requested for deletion. This field is not used.
  "displayName": "A String", # Output only. User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.
  "etag": "A 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.
  "expireTime": "A String", # Output only. The time at which this resource will be purged. This field is not used.
  "items": [ # A collection of class items.
    { # An item of the class.
      "value": "A String", # The class item's value.
    },
  ],
  "kmsKeyName": "A String", # Output only. The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
  "kmsKeyVersionName": "A String", # Output only. The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
  "name": "A String", # The resource name of the custom class.
  "reconciling": True or False, # Output only. Whether or not this CustomClass is in the process of being updated. This field is not used.
  "state": "A String", # Output only. The CustomClass lifecycle state. This field is not used.
  "uid": "A String", # Output only. System-assigned unique identifier for the CustomClass. This field is not used.
}

  updateMask: string, The list of fields to be updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.
  "annotations": { # 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.
    "a_key": "A String",
  },
  "customClassId": "A String", # If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
  "deleteTime": "A String", # Output only. The time at which this resource was requested for deletion. This field is not used.
  "displayName": "A String", # Output only. User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.
  "etag": "A 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.
  "expireTime": "A String", # Output only. The time at which this resource will be purged. This field is not used.
  "items": [ # A collection of class items.
    { # An item of the class.
      "value": "A String", # The class item's value.
    },
  ],
  "kmsKeyName": "A String", # Output only. The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
  "kmsKeyVersionName": "A String", # Output only. The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
  "name": "A String", # The resource name of the custom class.
  "reconciling": True or False, # Output only. Whether or not this CustomClass is in the process of being updated. This field is not used.
  "state": "A String", # Output only. The CustomClass lifecycle state. This field is not used.
  "uid": "A String", # Output only. System-assigned unique identifier for the CustomClass. This field is not used.
}