View Source GoogleApi.Speech.V1.Api.Projects (google_api_speech v0.28.0)

API calls for all endpoints tagged Projects.

Summary

Functions

speech_projects_locations_custom_classes_create(connection, parent, optional_params \\ [], opts \\ [])

Create a custom class.

speech_projects_locations_custom_classes_delete(connection, name, optional_params \\ [], opts \\ [])

Delete a custom class.

speech_projects_locations_custom_classes_get(connection, name, optional_params \\ [], opts \\ [])

Get a custom class.

speech_projects_locations_custom_classes_list(connection, parent, optional_params \\ [], opts \\ [])

List custom classes.

speech_projects_locations_custom_classes_patch(connection, name, optional_params \\ [], opts \\ [])

Update a custom class.

speech_projects_locations_phrase_sets_create(connection, parent, optional_params \\ [], opts \\ [])

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.

speech_projects_locations_phrase_sets_delete(connection, name, optional_params \\ [], opts \\ [])

Delete a phrase set.

speech_projects_locations_phrase_sets_get(connection, name, optional_params \\ [], opts \\ [])

Get a phrase set.

speech_projects_locations_phrase_sets_list(connection, parent, optional_params \\ [], opts \\ [])

List phrase sets.

speech_projects_locations_phrase_sets_patch(connection, name, optional_params \\ [], opts \\ [])

Update a phrase set.

Functions

speech_projects_locations_custom_classes_create(connection, parent, optional_params \\ [], opts \\ [])

@spec speech_projects_locations_custom_classes_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Speech.V1.Model.CustomClass.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Create a custom class.

Parameters

connection (type: GoogleApi.Speech.V1.Connection.t) - Connection to server
parent (type: String.t) - 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 with matching us or eu location value.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Speech.V1.Model.CreateCustomClassRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Speech.V1.Model.CustomClass{}} on success
{:error, info} on failure

speech_projects_locations_custom_classes_delete(connection, name, optional_params \\ [], opts \\ [])

@spec speech_projects_locations_custom_classes_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Speech.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Delete a custom class.

Parameters

connection (type: GoogleApi.Speech.V1.Connection.t) - Connection to server
name (type: String.t) - 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 with matching us or eu location value.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Speech.V1.Model.Empty{}} on success
{:error, info} on failure

speech_projects_locations_custom_classes_get(connection, name, optional_params \\ [], opts \\ [])

@spec speech_projects_locations_custom_classes_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Speech.V1.Model.CustomClass.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get a custom class.

Parameters

connection (type: GoogleApi.Speech.V1.Connection.t) - Connection to server
name (type: String.t) - Required. The name of the custom class to retrieve. Format: projects/{project}/locations/{location}/customClasses/{custom_class}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Speech.V1.Model.CustomClass{}} on success
{:error, info} on failure

speech_projects_locations_custom_classes_list(connection, parent, optional_params \\ [], opts \\ [])

@spec speech_projects_locations_custom_classes_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Speech.V1.Model.ListCustomClassesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List custom classes.

Parameters

connection (type: GoogleApi.Speech.V1.Connection.t) - Connection to server
parent (type: String.t) - 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 with matching us or eu location value.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :pageSize (type: 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 (type: String.t) - 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.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Speech.V1.Model.ListCustomClassesResponse{}} on success
{:error, info} on failure

speech_projects_locations_custom_classes_patch(connection, name, optional_params \\ [], opts \\ [])

@spec speech_projects_locations_custom_classes_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Speech.V1.Model.CustomClass.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update a custom class.

Parameters

connection (type: GoogleApi.Speech.V1.Connection.t) - Connection to server
name (type: String.t) - The resource name of the custom class.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :updateMask (type: String.t) - The list of fields to be updated.
- :body (type: GoogleApi.Speech.V1.Model.CustomClass.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Speech.V1.Model.CustomClass{}} on success
{:error, info} on failure

speech_projects_locations_phrase_sets_create(connection, parent, optional_params \\ [], opts \\ [])

@spec speech_projects_locations_phrase_sets_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Speech.V1.Model.PhraseSet.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.Speech.V1.Connection.t) - Connection to server
parent (type: String.t) - Required. The parent resource where this phrase set will be created. Format: projects/{project}/locations/{location} 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 with matching us or eu location value.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Speech.V1.Model.CreatePhraseSetRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Speech.V1.Model.PhraseSet{}} on success
{:error, info} on failure

speech_projects_locations_phrase_sets_delete(connection, name, optional_params \\ [], opts \\ [])

@spec speech_projects_locations_phrase_sets_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Speech.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Delete a phrase set.

Parameters

connection (type: GoogleApi.Speech.V1.Connection.t) - Connection to server
name (type: String.t) - Required. The name of the phrase set to delete. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Speech.V1.Model.Empty{}} on success
{:error, info} on failure

speech_projects_locations_phrase_sets_get(connection, name, optional_params \\ [], opts \\ [])

@spec speech_projects_locations_phrase_sets_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Speech.V1.Model.PhraseSet.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get a phrase set.

Parameters

connection (type: GoogleApi.Speech.V1.Connection.t) - Connection to server
name (type: String.t) - Required. The name of the phrase set to retrieve. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set} 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 with matching us or eu location value.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Speech.V1.Model.PhraseSet{}} on success
{:error, info} on failure

speech_projects_locations_phrase_sets_list(connection, parent, optional_params \\ [], opts \\ [])

@spec speech_projects_locations_phrase_sets_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Speech.V1.Model.ListPhraseSetResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List phrase sets.

Parameters

connection (type: GoogleApi.Speech.V1.Connection.t) - Connection to server
parent (type: String.t) - Required. The parent, which owns this collection of phrase set. Format: projects/{project}/locations/{location} 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 with matching us or eu location value.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :pageSize (type: integer()) - The maximum number of phrase sets to return. The service may return fewer than this value. If unspecified, at most 50 phrase sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
- :pageToken (type: String.t) - A page token, received from a previous ListPhraseSet call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPhraseSet must match the call that provided the page token.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Speech.V1.Model.ListPhraseSetResponse{}} on success
{:error, info} on failure

speech_projects_locations_phrase_sets_patch(connection, name, optional_params \\ [], opts \\ [])

@spec speech_projects_locations_phrase_sets_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Speech.V1.Model.PhraseSet.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update a phrase set.

Parameters

connection (type: GoogleApi.Speech.V1.Connection.t) - Connection to server
name (type: String.t) - The resource name of the phrase set.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :updateMask (type: String.t) - The list of fields to be updated.
- :body (type: GoogleApi.Speech.V1.Model.PhraseSet.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Speech.V1.Model.PhraseSet{}} on success
{:error, info} on failure