generated/googleapis/lib/speech/v1.dart

// Copyright 2017 Google LLC
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file or at
// https://developers.google.com/open-source/licenses/bsd

// This is a generated file (see the discoveryapis_generator project).

// ignore_for_file: camel_case_types
// ignore_for_file: comment_references
// ignore_for_file: deprecated_member_use_from_same_package
// ignore_for_file: doc_directive_unknown
// ignore_for_file: lines_longer_than_80_chars
// ignore_for_file: non_constant_identifier_names
// ignore_for_file: prefer_interpolation_to_compose_strings
// ignore_for_file: unintended_html_in_doc_comment
// ignore_for_file: unnecessary_brace_in_string_interps
// ignore_for_file: unnecessary_lambdas
// ignore_for_file: unnecessary_string_interpolations

/// Cloud Speech-to-Text API - v1
///
/// Converts audio to text by applying powerful neural network models.
///
/// For more information, see
/// <https://cloud.google.com/speech-to-text/docs/quickstart-protocol>
///
/// Create an instance of [SpeechApi] to access these resources:
///
/// - [OperationsResource]
/// - [ProjectsResource]
///   - [ProjectsLocationsResource]
///     - [ProjectsLocationsCustomClassesResource]
///     - [ProjectsLocationsPhraseSetsResource]
/// - [SpeechResource]
library;

import 'dart:async' as async;
import 'dart:convert' as convert;
import 'dart:core' as core;

import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
import 'package:http/http.dart' as http;

import '../shared.dart';
import '../src/user_agent.dart';

export 'package:_discoveryapis_commons/_discoveryapis_commons.dart'
    show ApiRequestError, DetailedApiRequestError;

/// Converts audio to text by applying powerful neural network models.
class SpeechApi {
  /// See, edit, configure, and delete your Google Cloud data and see the email
  /// address for your Google Account.
  static const cloudPlatformScope =
      'https://www.googleapis.com/auth/cloud-platform';

  final commons.ApiRequester _requester;

  OperationsResource get operations => OperationsResource(_requester);
  ProjectsResource get projects => ProjectsResource(_requester);
  SpeechResource get speech => SpeechResource(_requester);

  SpeechApi(
    http.Client client, {
    core.String rootUrl = 'https://speech.googleapis.com/',
    core.String servicePath = '',
  }) : _requester = commons.ApiRequester(
         client,
         rootUrl,
         servicePath,
         requestHeaders,
       );
}

class OperationsResource {
  final commons.ApiRequester _requester;

  OperationsResource(commons.ApiRequester client) : _requester = client;

  /// Gets the latest state of a long-running operation.
  ///
  /// Clients can use this method to poll the operation result at intervals as
  /// recommended by the API service.
  ///
  /// Request parameters:
  ///
  /// [name] - The name of the operation resource.
  /// Value must have pattern `^.*$`.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [Operation].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<Operation> get(core.String name, {core.String? $fields}) async {
    final queryParams_ = <core.String, core.List<core.String>>{
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/operations/' + core.Uri.encodeFull('$name');

    final response_ = await _requester.request(
      url_,
      'GET',
      queryParams: queryParams_,
    );
    return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
  }

  /// Lists operations that match the specified filter in the request.
  ///
  /// If the server doesn't support this method, it returns `UNIMPLEMENTED`.
  ///
  /// Request parameters:
  ///
  /// [filter] - The standard list filter.
  ///
  /// [name] - The name of the operation's parent resource.
  ///
  /// [pageSize] - The standard list page size.
  ///
  /// [pageToken] - The standard list page token.
  ///
  /// [returnPartialSuccess] - When set to `true`, operations that are reachable
  /// are returned as normal, and those that are unreachable are returned in the
  /// ListOperationsResponse.unreachable field. This can only be `true` when
  /// reading across collections. For example, when `parent` is set to
  /// `"projects/example/locations/-"`. This field is not supported by default
  /// and will result in an `UNIMPLEMENTED` error if set unless explicitly
  /// documented otherwise in service or product specific documentation.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [ListOperationsResponse].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<ListOperationsResponse> list({
    core.String? filter,
    core.String? name,
    core.int? pageSize,
    core.String? pageToken,
    core.bool? returnPartialSuccess,
    core.String? $fields,
  }) async {
    final queryParams_ = <core.String, core.List<core.String>>{
      'filter': ?filter == null ? null : [filter],
      'name': ?name == null ? null : [name],
      'pageSize': ?pageSize == null ? null : ['${pageSize}'],
      'pageToken': ?pageToken == null ? null : [pageToken],
      'returnPartialSuccess': ?returnPartialSuccess == null
          ? null
          : ['${returnPartialSuccess}'],
      'fields': ?$fields == null ? null : [$fields],
    };

    const url_ = 'v1/operations';

    final response_ = await _requester.request(
      url_,
      'GET',
      queryParams: queryParams_,
    );
    return ListOperationsResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>,
    );
  }
}

class ProjectsResource {
  final commons.ApiRequester _requester;

  ProjectsLocationsResource get locations =>
      ProjectsLocationsResource(_requester);

  ProjectsResource(commons.ApiRequester client) : _requester = client;
}

class ProjectsLocationsResource {
  final commons.ApiRequester _requester;

  ProjectsLocationsCustomClassesResource get customClasses =>
      ProjectsLocationsCustomClassesResource(_requester);
  ProjectsLocationsPhraseSetsResource get phraseSets =>
      ProjectsLocationsPhraseSetsResource(_requester);

  ProjectsLocationsResource(commons.ApiRequester client) : _requester = client;
}

class ProjectsLocationsCustomClassesResource {
  final commons.ApiRequester _requester;

  ProjectsLocationsCustomClassesResource(commons.ApiRequester client)
    : _requester = client;

  /// Create a custom class.
  ///
  /// [request] - The metadata request object.
  ///
  /// Request parameters:
  ///
  /// [parent] - 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.
  /// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [CustomClass].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<CustomClass> create(
    CreateCustomClassRequest request,
    core.String parent, {
    core.String? $fields,
  }) async {
    final body_ = convert.json.encode(request);
    final queryParams_ = <core.String, core.List<core.String>>{
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/customClasses';

    final response_ = await _requester.request(
      url_,
      'POST',
      body: body_,
      queryParams: queryParams_,
    );
    return CustomClass.fromJson(
      response_ as core.Map<core.String, core.dynamic>,
    );
  }

  /// Delete a custom class.
  ///
  /// Request parameters:
  ///
  /// [name] - 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.
  /// Value must have pattern
  /// `^projects/\[^/\]+/locations/\[^/\]+/customClasses/\[^/\]+$`.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [Empty].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<Empty> delete(core.String name, {core.String? $fields}) async {
    final queryParams_ = <core.String, core.List<core.String>>{
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/' + core.Uri.encodeFull('$name');

    final response_ = await _requester.request(
      url_,
      'DELETE',
      queryParams: queryParams_,
    );
    return Empty.fromJson(response_ as core.Map<core.String, core.dynamic>);
  }

  /// Get a custom class.
  ///
  /// Request parameters:
  ///
  /// [name] - Required. The name of the custom class to retrieve. Format:
  /// `projects/{project}/locations/{location}/customClasses/{custom_class}`
  /// Value must have pattern
  /// `^projects/\[^/\]+/locations/\[^/\]+/customClasses/\[^/\]+$`.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [CustomClass].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<CustomClass> get(
    core.String name, {
    core.String? $fields,
  }) async {
    final queryParams_ = <core.String, core.List<core.String>>{
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/' + core.Uri.encodeFull('$name');

    final response_ = await _requester.request(
      url_,
      'GET',
      queryParams: queryParams_,
    );
    return CustomClass.fromJson(
      response_ as core.Map<core.String, core.dynamic>,
    );
  }

  /// List custom classes.
  ///
  /// Request parameters:
  ///
  /// [parent] - 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.
  /// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
  ///
  /// [pageSize] - 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] - 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.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [ListCustomClassesResponse].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<ListCustomClassesResponse> list(
    core.String parent, {
    core.int? pageSize,
    core.String? pageToken,
    core.String? $fields,
  }) async {
    final queryParams_ = <core.String, core.List<core.String>>{
      'pageSize': ?pageSize == null ? null : ['${pageSize}'],
      'pageToken': ?pageToken == null ? null : [pageToken],
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/customClasses';

    final response_ = await _requester.request(
      url_,
      'GET',
      queryParams: queryParams_,
    );
    return ListCustomClassesResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>,
    );
  }

  /// Update a custom class.
  ///
  /// [request] - The metadata request object.
  ///
  /// Request parameters:
  ///
  /// [name] - The resource name of the custom class.
  /// Value must have pattern
  /// `^projects/\[^/\]+/locations/\[^/\]+/customClasses/\[^/\]+$`.
  ///
  /// [updateMask] - The list of fields to be updated.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [CustomClass].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<CustomClass> patch(
    CustomClass request,
    core.String name, {
    core.String? updateMask,
    core.String? $fields,
  }) async {
    final body_ = convert.json.encode(request);
    final queryParams_ = <core.String, core.List<core.String>>{
      'updateMask': ?updateMask == null ? null : [updateMask],
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/' + core.Uri.encodeFull('$name');

    final response_ = await _requester.request(
      url_,
      'PATCH',
      body: body_,
      queryParams: queryParams_,
    );
    return CustomClass.fromJson(
      response_ as core.Map<core.String, core.dynamic>,
    );
  }
}

class ProjectsLocationsPhraseSetsResource {
  final commons.ApiRequester _requester;

  ProjectsLocationsPhraseSetsResource(commons.ApiRequester client)
    : _requester = client;

  /// 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.
  ///
  /// [request] - The metadata request object.
  ///
  /// Request parameters:
  ///
  /// [parent] - 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](https://cloud.google.com/speech-to-text/docs/endpoints)
  /// with matching `us` or `eu` location value.
  /// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [PhraseSet].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<PhraseSet> create(
    CreatePhraseSetRequest request,
    core.String parent, {
    core.String? $fields,
  }) async {
    final body_ = convert.json.encode(request);
    final queryParams_ = <core.String, core.List<core.String>>{
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/phraseSets';

    final response_ = await _requester.request(
      url_,
      'POST',
      body: body_,
      queryParams: queryParams_,
    );
    return PhraseSet.fromJson(response_ as core.Map<core.String, core.dynamic>);
  }

  /// Delete a phrase set.
  ///
  /// Request parameters:
  ///
  /// [name] - Required. The name of the phrase set to delete. Format:
  /// `projects/{project}/locations/{location}/phraseSets/{phrase_set}`
  /// Value must have pattern
  /// `^projects/\[^/\]+/locations/\[^/\]+/phraseSets/\[^/\]+$`.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [Empty].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<Empty> delete(core.String name, {core.String? $fields}) async {
    final queryParams_ = <core.String, core.List<core.String>>{
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/' + core.Uri.encodeFull('$name');

    final response_ = await _requester.request(
      url_,
      'DELETE',
      queryParams: queryParams_,
    );
    return Empty.fromJson(response_ as core.Map<core.String, core.dynamic>);
  }

  /// Get a phrase set.
  ///
  /// Request parameters:
  ///
  /// [name] - 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](https://cloud.google.com/speech-to-text/docs/endpoints)
  /// with matching `us` or `eu` location value.
  /// Value must have pattern
  /// `^projects/\[^/\]+/locations/\[^/\]+/phraseSets/\[^/\]+$`.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [PhraseSet].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<PhraseSet> get(core.String name, {core.String? $fields}) async {
    final queryParams_ = <core.String, core.List<core.String>>{
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/' + core.Uri.encodeFull('$name');

    final response_ = await _requester.request(
      url_,
      'GET',
      queryParams: queryParams_,
    );
    return PhraseSet.fromJson(response_ as core.Map<core.String, core.dynamic>);
  }

  /// List phrase sets.
  ///
  /// Request parameters:
  ///
  /// [parent] - 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](https://cloud.google.com/speech-to-text/docs/endpoints)
  /// with matching `us` or `eu` location value.
  /// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
  ///
  /// [pageSize] - 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] - 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.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [ListPhraseSetResponse].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<ListPhraseSetResponse> list(
    core.String parent, {
    core.int? pageSize,
    core.String? pageToken,
    core.String? $fields,
  }) async {
    final queryParams_ = <core.String, core.List<core.String>>{
      'pageSize': ?pageSize == null ? null : ['${pageSize}'],
      'pageToken': ?pageToken == null ? null : [pageToken],
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/phraseSets';

    final response_ = await _requester.request(
      url_,
      'GET',
      queryParams: queryParams_,
    );
    return ListPhraseSetResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>,
    );
  }

  /// Update a phrase set.
  ///
  /// [request] - The metadata request object.
  ///
  /// Request parameters:
  ///
  /// [name] - The resource name of the phrase set.
  /// Value must have pattern
  /// `^projects/\[^/\]+/locations/\[^/\]+/phraseSets/\[^/\]+$`.
  ///
  /// [updateMask] - The list of fields to be updated.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [PhraseSet].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<PhraseSet> patch(
    PhraseSet request,
    core.String name, {
    core.String? updateMask,
    core.String? $fields,
  }) async {
    final body_ = convert.json.encode(request);
    final queryParams_ = <core.String, core.List<core.String>>{
      'updateMask': ?updateMask == null ? null : [updateMask],
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/' + core.Uri.encodeFull('$name');

    final response_ = await _requester.request(
      url_,
      'PATCH',
      body: body_,
      queryParams: queryParams_,
    );
    return PhraseSet.fromJson(response_ as core.Map<core.String, core.dynamic>);
  }
}

class SpeechResource {
  final commons.ApiRequester _requester;

  SpeechResource(commons.ApiRequester client) : _requester = client;

  /// Performs asynchronous speech recognition: receive results via the
  /// google.longrunning.Operations interface.
  ///
  /// Returns either an `Operation.error` or an `Operation.response` which
  /// contains a `LongRunningRecognizeResponse` message. For more information on
  /// asynchronous speech recognition, see the
  /// \[how-to\](https://cloud.google.com/speech-to-text/docs/async-recognize).
  ///
  /// [request] - The metadata request object.
  ///
  /// Request parameters:
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [Operation].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<Operation> longrunningrecognize(
    LongRunningRecognizeRequest request, {
    core.String? $fields,
  }) async {
    final body_ = convert.json.encode(request);
    final queryParams_ = <core.String, core.List<core.String>>{
      'fields': ?$fields == null ? null : [$fields],
    };

    const url_ = 'v1/speech:longrunningrecognize';

    final response_ = await _requester.request(
      url_,
      'POST',
      body: body_,
      queryParams: queryParams_,
    );
    return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
  }

  /// Performs synchronous speech recognition: receive results after all audio
  /// has been sent and processed.
  ///
  /// [request] - The metadata request object.
  ///
  /// Request parameters:
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [RecognizeResponse].
  ///
  /// Completes with a [commons.ApiRequestError] if the API endpoint returned an
  /// error.
  ///
  /// If the used [http.Client] completes with an error when making a REST call,
  /// this method will complete with the same error.
  async.Future<RecognizeResponse> recognize(
    RecognizeRequest request, {
    core.String? $fields,
  }) async {
    final body_ = convert.json.encode(request);
    final queryParams_ = <core.String, core.List<core.String>>{
      'fields': ?$fields == null ? null : [$fields],
    };

    const url_ = 'v1/speech:recognize';

    final response_ = await _requester.request(
      url_,
      'POST',
      body: body_,
      queryParams: queryParams_,
    );
    return RecognizeResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>,
    );
  }
}

class ABNFGrammar {
  /// All declarations and rules of an ABNF grammar broken up into multiple
  /// strings that will end up concatenated.
  core.List<core.String>? abnfStrings;

  ABNFGrammar({this.abnfStrings});

  ABNFGrammar.fromJson(core.Map json_)
    : this(
        abnfStrings: (json_['abnfStrings'] as core.List?)
            ?.map((value) => value as core.String)
            .toList(),
      );

  core.Map<core.String, core.dynamic> toJson() {
    final abnfStrings = this.abnfStrings;
    return {'abnfStrings': ?abnfStrings};
  }
}

/// An item of the class.
class ClassItem {
  /// The class item's value.
  core.String? value;

  ClassItem({this.value});

  ClassItem.fromJson(core.Map json_)
    : this(value: json_['value'] as core.String?);

  core.Map<core.String, core.dynamic> toJson() {
    final value = this.value;
    return {'value': ?value};
  }
}

/// Message sent by the client for the `CreateCustomClass` method.
class CreateCustomClassRequest {
  /// The custom class to create.
  ///
  /// Required.
  CustomClass? customClass;

  /// 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.
  ///
  /// Required.
  core.String? customClassId;

  CreateCustomClassRequest({this.customClass, this.customClassId});

  CreateCustomClassRequest.fromJson(core.Map json_)
    : this(
        customClass: json_.containsKey('customClass')
            ? CustomClass.fromJson(
                json_['customClass'] as core.Map<core.String, core.dynamic>,
              )
            : null,
        customClassId: json_['customClassId'] as core.String?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final customClass = this.customClass;
    final customClassId = this.customClassId;
    return {'customClass': ?customClass, 'customClassId': ?customClassId};
  }
}

/// Message sent by the client for the `CreatePhraseSet` method.
class CreatePhraseSetRequest {
  /// The phrase set to create.
  ///
  /// Required.
  PhraseSet? phraseSet;

  /// 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.
  ///
  /// Required.
  core.String? phraseSetId;

  CreatePhraseSetRequest({this.phraseSet, this.phraseSetId});

  CreatePhraseSetRequest.fromJson(core.Map json_)
    : this(
        phraseSet: json_.containsKey('phraseSet')
            ? PhraseSet.fromJson(
                json_['phraseSet'] as core.Map<core.String, core.dynamic>,
              )
            : null,
        phraseSetId: json_['phraseSetId'] as core.String?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final phraseSet = this.phraseSet;
    final phraseSetId = this.phraseSetId;
    return {'phraseSet': ?phraseSet, 'phraseSetId': ?phraseSetId};
  }
}

/// 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.
class CustomClass {
  /// 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.
  ///
  /// Output only.
  core.Map<core.String, core.String>? annotations;

  /// If this custom class is a resource, the custom_class_id is the resource id
  /// of the CustomClass.
  ///
  /// Case sensitive.
  core.String? customClassId;

  /// The time at which this resource was requested for deletion.
  ///
  /// This field is not used.
  ///
  /// Output only.
  core.String? deleteTime;

  /// User-settable, human-readable name for the CustomClass.
  ///
  /// Must be 63 characters or less. This field is not used.
  ///
  /// Output only.
  core.String? displayName;

  /// 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.
  ///
  /// Output only.
  core.String? etag;

  /// The time at which this resource will be purged.
  ///
  /// This field is not used.
  ///
  /// Output only.
  core.String? expireTime;

  /// A collection of class items.
  core.List<ClassItem>? items;

  /// 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}`.
  ///
  /// Output only.
  core.String? kmsKeyName;

  /// 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}`.
  ///
  /// Output only.
  core.String? kmsKeyVersionName;

  /// The resource name of the custom class.
  core.String? name;

  /// Whether or not this CustomClass is in the process of being updated.
  ///
  /// This field is not used.
  ///
  /// Output only.
  core.bool? reconciling;

  /// The CustomClass lifecycle state.
  ///
  /// This field is not used.
  ///
  /// Output only.
  /// Possible string values are:
  /// - "STATE_UNSPECIFIED" : Unspecified state. This is only used/useful for
  /// distinguishing unset values.
  /// - "ACTIVE" : The normal and active state.
  /// - "DELETED" : This CustomClass has been deleted.
  core.String? state;

  /// System-assigned unique identifier for the CustomClass.
  ///
  /// This field is not used.
  ///
  /// Output only.
  core.String? uid;

  CustomClass({
    this.annotations,
    this.customClassId,
    this.deleteTime,
    this.displayName,
    this.etag,
    this.expireTime,
    this.items,
    this.kmsKeyName,
    this.kmsKeyVersionName,
    this.name,
    this.reconciling,
    this.state,
    this.uid,
  });

  CustomClass.fromJson(core.Map json_)
    : this(
        annotations:
            (json_['annotations'] as core.Map<core.String, core.dynamic>?)?.map(
              (key, value) => core.MapEntry(key, value as core.String),
            ),
        customClassId: json_['customClassId'] as core.String?,
        deleteTime: json_['deleteTime'] as core.String?,
        displayName: json_['displayName'] as core.String?,
        etag: json_['etag'] as core.String?,
        expireTime: json_['expireTime'] as core.String?,
        items: (json_['items'] as core.List?)
            ?.map(
              (value) => ClassItem.fromJson(
                value as core.Map<core.String, core.dynamic>,
              ),
            )
            .toList(),
        kmsKeyName: json_['kmsKeyName'] as core.String?,
        kmsKeyVersionName: json_['kmsKeyVersionName'] as core.String?,
        name: json_['name'] as core.String?,
        reconciling: json_['reconciling'] as core.bool?,
        state: json_['state'] as core.String?,
        uid: json_['uid'] as core.String?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final annotations = this.annotations;
    final customClassId = this.customClassId;
    final deleteTime = this.deleteTime;
    final displayName = this.displayName;
    final etag = this.etag;
    final expireTime = this.expireTime;
    final items = this.items;
    final kmsKeyName = this.kmsKeyName;
    final kmsKeyVersionName = this.kmsKeyVersionName;
    final name = this.name;
    final reconciling = this.reconciling;
    final state = this.state;
    final uid = this.uid;
    return {
      'annotations': ?annotations,
      'customClassId': ?customClassId,
      'deleteTime': ?deleteTime,
      'displayName': ?displayName,
      'etag': ?etag,
      'expireTime': ?expireTime,
      'items': ?items,
      'kmsKeyName': ?kmsKeyName,
      'kmsKeyVersionName': ?kmsKeyVersionName,
      'name': ?name,
      'reconciling': ?reconciling,
      'state': ?state,
      'uid': ?uid,
    };
  }
}

/// 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); }
typedef Empty = $Empty;

/// A single replacement configuration.
class Entry {
  /// Whether the search is case sensitive.
  core.bool? caseSensitive;

  /// What to replace with.
  ///
  /// Max length is 100 characters.
  core.String? replace;

  /// What to replace.
  ///
  /// Max length is 100 characters.
  core.String? search;

  Entry({this.caseSensitive, this.replace, this.search});

  Entry.fromJson(core.Map json_)
    : this(
        caseSensitive: json_['caseSensitive'] as core.bool?,
        replace: json_['replace'] as core.String?,
        search: json_['search'] as core.String?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final caseSensitive = this.caseSensitive;
    final replace = this.replace;
    final search = this.search;
    return {
      'caseSensitive': ?caseSensitive,
      'replace': ?replace,
      'search': ?search,
    };
  }
}

/// Message returned to the client by the `ListCustomClasses` method.
class ListCustomClassesResponse {
  /// The custom classes.
  core.List<CustomClass>? customClasses;

  /// A token, which can be sent as `page_token` to retrieve the next page.
  ///
  /// If this field is omitted, there are no subsequent pages.
  core.String? nextPageToken;

  ListCustomClassesResponse({this.customClasses, this.nextPageToken});

  ListCustomClassesResponse.fromJson(core.Map json_)
    : this(
        customClasses: (json_['customClasses'] as core.List?)
            ?.map(
              (value) => CustomClass.fromJson(
                value as core.Map<core.String, core.dynamic>,
              ),
            )
            .toList(),
        nextPageToken: json_['nextPageToken'] as core.String?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final customClasses = this.customClasses;
    final nextPageToken = this.nextPageToken;
    return {'customClasses': ?customClasses, 'nextPageToken': ?nextPageToken};
  }
}

/// The response message for Operations.ListOperations.
class ListOperationsResponse {
  /// The standard List next-page token.
  core.String? nextPageToken;

  /// A list of operations that matches the specified filter in the request.
  core.List<Operation>? operations;

  /// Unordered list.
  ///
  /// Unreachable resources. Populated when the request sets
  /// `ListOperationsRequest.return_partial_success` and reads across
  /// collections. For example, when attempting to list all resources across all
  /// supported locations.
  core.List<core.String>? unreachable;

  ListOperationsResponse({
    this.nextPageToken,
    this.operations,
    this.unreachable,
  });

  ListOperationsResponse.fromJson(core.Map json_)
    : this(
        nextPageToken: json_['nextPageToken'] as core.String?,
        operations: (json_['operations'] as core.List?)
            ?.map(
              (value) => Operation.fromJson(
                value as core.Map<core.String, core.dynamic>,
              ),
            )
            .toList(),
        unreachable: (json_['unreachable'] as core.List?)
            ?.map((value) => value as core.String)
            .toList(),
      );

  core.Map<core.String, core.dynamic> toJson() {
    final nextPageToken = this.nextPageToken;
    final operations = this.operations;
    final unreachable = this.unreachable;
    return {
      'nextPageToken': ?nextPageToken,
      'operations': ?operations,
      'unreachable': ?unreachable,
    };
  }
}

/// Message returned to the client by the `ListPhraseSet` method.
class ListPhraseSetResponse {
  /// A token, which can be sent as `page_token` to retrieve the next page.
  ///
  /// If this field is omitted, there are no subsequent pages.
  core.String? nextPageToken;

  /// The phrase set.
  core.List<PhraseSet>? phraseSets;

  ListPhraseSetResponse({this.nextPageToken, this.phraseSets});

  ListPhraseSetResponse.fromJson(core.Map json_)
    : this(
        nextPageToken: json_['nextPageToken'] as core.String?,
        phraseSets: (json_['phraseSets'] as core.List?)
            ?.map(
              (value) => PhraseSet.fromJson(
                value as core.Map<core.String, core.dynamic>,
              ),
            )
            .toList(),
      );

  core.Map<core.String, core.dynamic> toJson() {
    final nextPageToken = this.nextPageToken;
    final phraseSets = this.phraseSets;
    return {'nextPageToken': ?nextPageToken, 'phraseSets': ?phraseSets};
  }
}

/// The top-level message sent by the client for the `LongRunningRecognize`
/// method.
class LongRunningRecognizeRequest {
  /// The audio data to be recognized.
  ///
  /// Required.
  RecognitionAudio? audio;

  /// Provides information to the recognizer that specifies how to process the
  /// request.
  ///
  /// Required.
  RecognitionConfig? config;

  /// Specifies an optional destination for the recognition results.
  ///
  /// Optional.
  TranscriptOutputConfig? outputConfig;

  LongRunningRecognizeRequest({this.audio, this.config, this.outputConfig});

  LongRunningRecognizeRequest.fromJson(core.Map json_)
    : this(
        audio: json_.containsKey('audio')
            ? RecognitionAudio.fromJson(
                json_['audio'] as core.Map<core.String, core.dynamic>,
              )
            : null,
        config: json_.containsKey('config')
            ? RecognitionConfig.fromJson(
                json_['config'] as core.Map<core.String, core.dynamic>,
              )
            : null,
        outputConfig: json_.containsKey('outputConfig')
            ? TranscriptOutputConfig.fromJson(
                json_['outputConfig'] as core.Map<core.String, core.dynamic>,
              )
            : null,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final audio = this.audio;
    final config = this.config;
    final outputConfig = this.outputConfig;
    return {'audio': ?audio, 'config': ?config, 'outputConfig': ?outputConfig};
  }
}

/// This resource represents a long-running operation that is the result of a
/// network API call.
class Operation {
  /// If the value is `false`, it means the operation is still in progress.
  ///
  /// If `true`, the operation is completed, and either `error` or `response` is
  /// available.
  core.bool? done;

  /// The error result of the operation in case of failure or cancellation.
  Status? error;

  /// Service-specific metadata associated with the operation.
  ///
  /// It typically contains progress information and common metadata such as
  /// create time. Some services might not provide such metadata. Any method
  /// that returns a long-running operation should document the metadata type,
  /// if any.
  ///
  /// The values for Object must be JSON objects. It can consist of `num`,
  /// `String`, `bool` and `null` as well as `Map` and `List` values.
  core.Map<core.String, core.Object?>? metadata;

  /// The server-assigned name, which is only unique within the same service
  /// that originally returns it.
  ///
  /// If you use the default HTTP mapping, the `name` should be a resource name
  /// ending with `operations/{unique_id}`.
  core.String? name;

  /// The normal, successful response of the operation.
  ///
  /// If the original method returns no data on success, such as `Delete`, the
  /// response is `google.protobuf.Empty`. If the original method is standard
  /// `Get`/`Create`/`Update`, the response should be the resource. For other
  /// methods, the response should have the type `XxxResponse`, where `Xxx` is
  /// the original method name. For example, if the original method name is
  /// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
  ///
  /// The values for Object must be JSON objects. It can consist of `num`,
  /// `String`, `bool` and `null` as well as `Map` and `List` values.
  core.Map<core.String, core.Object?>? response;

  Operation({this.done, this.error, this.metadata, this.name, this.response});

  Operation.fromJson(core.Map json_)
    : this(
        done: json_['done'] as core.bool?,
        error: json_.containsKey('error')
            ? Status.fromJson(
                json_['error'] as core.Map<core.String, core.dynamic>,
              )
            : null,
        metadata: json_.containsKey('metadata')
            ? json_['metadata'] as core.Map<core.String, core.dynamic>
            : null,
        name: json_['name'] as core.String?,
        response: json_.containsKey('response')
            ? json_['response'] as core.Map<core.String, core.dynamic>
            : null,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final done = this.done;
    final error = this.error;
    final metadata = this.metadata;
    final name = this.name;
    final response = this.response;
    return {
      'done': ?done,
      'error': ?error,
      'metadata': ?metadata,
      'name': ?name,
      'response': ?response,
    };
  }
}

/// A phrases containing words and phrase "hints" so that the speech recognition
/// is more likely to recognize them.
///
/// This can be used to improve the accuracy for specific words and phrases, for
/// example, if specific commands are typically spoken by the user. This can
/// also be used to add additional words to the vocabulary of the recognizer.
/// See [usage limits](https://cloud.google.com/speech-to-text/quotas#content).
/// List items can also include pre-built or custom classes containing groups of
/// words that represent common concepts that occur in natural language. For
/// example, rather than providing a phrase hint for every month of the year
/// (e.g. "i was born in january", "i was born in febuary", ...), use the
/// pre-built `$MONTH` class improves the likelihood of correctly transcribing
/// audio that includes months (e.g. "i was born in $month"). To refer to
/// pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`.
/// To refer to custom classes that were defined inline in the request, set the
/// class's `custom_class_id` to a string unique to all class resources and
/// inline classes. Then use the class' id wrapped in $`{...}` e.g.
/// "${my-months}". To refer to custom classes resources, use the class' id
/// wrapped in `${}` (e.g. `${my-months}`). 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.
class Phrase {
  /// 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.
  core.double? boost;

  /// The phrase itself.
  core.String? value;

  Phrase({this.boost, this.value});

  Phrase.fromJson(core.Map json_)
    : this(
        boost: (json_['boost'] as core.num?)?.toDouble(),
        value: json_['value'] as core.String?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final boost = this.boost;
    final value = this.value;
    return {'boost': ?boost, 'value': ?value};
  }
}

/// Provides "hints" to the speech recognizer to favor specific words and
/// phrases in the results.
class PhraseSet {
  /// 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.
  ///
  /// Output only.
  core.Map<core.String, core.String>? annotations;

  /// 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.
  core.double? boost;

  /// The time at which this resource was requested for deletion.
  ///
  /// This field is not used.
  ///
  /// Output only.
  core.String? deleteTime;

  /// User-settable, human-readable name for the PhraseSet.
  ///
  /// Must be 63 characters or less. This field is not used.
  ///
  /// Output only.
  core.String? displayName;

  /// 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.
  ///
  /// Output only.
  core.String? etag;

  /// The time at which this resource will be purged.
  ///
  /// This field is not used.
  ///
  /// Output only.
  core.String? expireTime;

  /// 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}`.
  ///
  /// Output only.
  core.String? kmsKeyName;

  /// 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}`.
  ///
  /// Output only.
  core.String? kmsKeyVersionName;

  /// The resource name of the phrase set.
  core.String? name;

  /// A list of word and phrases.
  core.List<Phrase>? phrases;

  /// Whether or not this PhraseSet is in the process of being updated.
  ///
  /// This field is not used.
  ///
  /// Output only.
  core.bool? reconciling;

  /// The CustomClass lifecycle state.
  ///
  /// This field is not used.
  ///
  /// Output only.
  /// Possible string values are:
  /// - "STATE_UNSPECIFIED" : Unspecified state. This is only used/useful for
  /// distinguishing unset values.
  /// - "ACTIVE" : The normal and active state.
  /// - "DELETED" : This CustomClass has been deleted.
  core.String? state;

  /// System-assigned unique identifier for the PhraseSet.
  ///
  /// This field is not used.
  ///
  /// Output only.
  core.String? uid;

  PhraseSet({
    this.annotations,
    this.boost,
    this.deleteTime,
    this.displayName,
    this.etag,
    this.expireTime,
    this.kmsKeyName,
    this.kmsKeyVersionName,
    this.name,
    this.phrases,
    this.reconciling,
    this.state,
    this.uid,
  });

  PhraseSet.fromJson(core.Map json_)
    : this(
        annotations:
            (json_['annotations'] as core.Map<core.String, core.dynamic>?)?.map(
              (key, value) => core.MapEntry(key, value as core.String),
            ),
        boost: (json_['boost'] as core.num?)?.toDouble(),
        deleteTime: json_['deleteTime'] as core.String?,
        displayName: json_['displayName'] as core.String?,
        etag: json_['etag'] as core.String?,
        expireTime: json_['expireTime'] as core.String?,
        kmsKeyName: json_['kmsKeyName'] as core.String?,
        kmsKeyVersionName: json_['kmsKeyVersionName'] as core.String?,
        name: json_['name'] as core.String?,
        phrases: (json_['phrases'] as core.List?)
            ?.map(
              (value) =>
                  Phrase.fromJson(value as core.Map<core.String, core.dynamic>),
            )
            .toList(),
        reconciling: json_['reconciling'] as core.bool?,
        state: json_['state'] as core.String?,
        uid: json_['uid'] as core.String?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final annotations = this.annotations;
    final boost = this.boost;
    final deleteTime = this.deleteTime;
    final displayName = this.displayName;
    final etag = this.etag;
    final expireTime = this.expireTime;
    final kmsKeyName = this.kmsKeyName;
    final kmsKeyVersionName = this.kmsKeyVersionName;
    final name = this.name;
    final phrases = this.phrases;
    final reconciling = this.reconciling;
    final state = this.state;
    final uid = this.uid;
    return {
      'annotations': ?annotations,
      'boost': ?boost,
      'deleteTime': ?deleteTime,
      'displayName': ?displayName,
      'etag': ?etag,
      'expireTime': ?expireTime,
      'kmsKeyName': ?kmsKeyName,
      'kmsKeyVersionName': ?kmsKeyVersionName,
      'name': ?name,
      'phrases': ?phrases,
      'reconciling': ?reconciling,
      'state': ?state,
      'uid': ?uid,
    };
  }
}

/// Contains audio data in the encoding specified in the `RecognitionConfig`.
///
/// Either `content` or `uri` must be supplied. Supplying both or neither
/// returns google.rpc.Code.INVALID_ARGUMENT. See
/// [content limits](https://cloud.google.com/speech-to-text/quotas#content).
class RecognitionAudio {
  /// The audio data bytes encoded as specified in `RecognitionConfig`.
  ///
  /// Note: as with all bytes fields, proto buffers use a pure binary
  /// representation, whereas JSON representations use base64.
  core.String? content;
  core.List<core.int> get contentAsBytes => convert.base64.decode(content!);

  set contentAsBytes(core.List<core.int> bytes_) {
    content = convert.base64
        .encode(bytes_)
        .replaceAll('/', '_')
        .replaceAll('+', '-');
  }

  /// URI that points to a file that contains audio data bytes as specified in
  /// `RecognitionConfig`.
  ///
  /// The file must not be compressed (for example, gzip). Currently, only
  /// Google Cloud Storage URIs are supported, which must be specified in the
  /// following format: `gs://bucket_name/object_name` (other URI formats return
  /// google.rpc.Code.INVALID_ARGUMENT). For more information, see
  /// [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
  core.String? uri;

  RecognitionAudio({this.content, this.uri});

  RecognitionAudio.fromJson(core.Map json_)
    : this(
        content: json_['content'] as core.String?,
        uri: json_['uri'] as core.String?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final content = this.content;
    final uri = this.uri;
    return {'content': ?content, 'uri': ?uri};
  }
}

/// Provides information to the recognizer that specifies how to process the
/// request.
class RecognitionConfig {
  /// Speech adaptation configuration improves the accuracy of speech
  /// recognition.
  ///
  /// For more information, see the
  /// [speech adaptation](https://cloud.google.com/speech-to-text/docs/adaptation)
  /// documentation. When speech adaptation is set it supersedes the
  /// `speech_contexts` field.
  SpeechAdaptation? adaptation;

  /// A list of up to 3 additional
  /// \[BCP-47\](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags,
  /// listing possible alternative languages of the supplied audio.
  ///
  /// See
  /// [Language Support](https://cloud.google.com/speech-to-text/docs/languages)
  /// for a list of the currently supported language codes. If alternative
  /// languages are listed, recognition result will contain recognition in the
  /// most likely language detected including the main language_code. The
  /// recognition result will include the language tag of the language detected
  /// in the audio. Note: This feature is only supported for Voice Command and
  /// Voice Search use cases and performance may vary for other use cases (e.g.,
  /// phone call transcription).
  core.List<core.String>? alternativeLanguageCodes;

  /// The number of channels in the input audio data.
  ///
  /// ONLY set this for MULTI-CHANNEL recognition. Valid values for LINEAR16,
  /// OGG_OPUS and FLAC are `1`-`8`. Valid value for MULAW, AMR, AMR_WB and
  /// SPEEX_WITH_HEADER_BYTE is only `1`. If `0` or omitted, defaults to one
  /// channel (mono). Note: We only recognize the first channel by default. To
  /// perform independent recognition on each channel set
  /// `enable_separate_recognition_per_channel` to 'true'.
  core.int? audioChannelCount;

  /// Config to enable speaker diarization and set additional parameters to make
  /// diarization better suited for your application.
  ///
  /// Note: When this is enabled, we send all the words from the beginning of
  /// the audio for the top alternative in every consecutive STREAMING
  /// responses. This is done in order to improve our speaker tags as our models
  /// learn to identify the speakers in the conversation over time. For
  /// non-streaming requests, the diarization results will be provided only in
  /// the top alternative of the FINAL SpeechRecognitionResult.
  SpeakerDiarizationConfig? diarizationConfig;

  /// If 'true', adds punctuation to recognition result hypotheses.
  ///
  /// This feature is only available in select languages. Setting this for
  /// requests in other languages has no effect at all. The default 'false'
  /// value does not add punctuation to result hypotheses.
  core.bool? enableAutomaticPunctuation;

  /// This needs to be set to `true` explicitly and `audio_channel_count` \> 1
  /// to get each channel recognized separately.
  ///
  /// The recognition result will contain a `channel_tag` field to state which
  /// channel that result belongs to. If this is not true, we will only
  /// recognize the first channel. The request is billed cumulatively for all
  /// channels recognized: `audio_channel_count` multiplied by the length of the
  /// audio.
  core.bool? enableSeparateRecognitionPerChannel;

  /// The spoken emoji behavior for the call If not set, uses default behavior
  /// based on model of choice If 'true', adds spoken emoji formatting for the
  /// request.
  ///
  /// This will replace spoken emojis with the corresponding Unicode symbols in
  /// the final transcript. If 'false', spoken emojis are not replaced.
  core.bool? enableSpokenEmojis;

  /// The spoken punctuation behavior for the call If not set, uses default
  /// behavior based on model of choice e.g. command_and_search will enable
  /// spoken punctuation by default If 'true', replaces spoken punctuation with
  /// the corresponding symbols in the request.
  ///
  /// For example, "how are you question mark" becomes "how are you?". See
  /// https://cloud.google.com/speech-to-text/docs/spoken-punctuation for
  /// support. If 'false', spoken punctuation is not replaced.
  core.bool? enableSpokenPunctuation;

  /// If `true`, the top result includes a list of words and the confidence for
  /// those words.
  ///
  /// If `false`, no word-level confidence information is returned. The default
  /// is `false`.
  core.bool? enableWordConfidence;

  /// If `true`, the top result includes a list of words and the start and end
  /// time offsets (timestamps) for those words.
  ///
  /// If `false`, no word-level time offset information is returned. The default
  /// is `false`.
  core.bool? enableWordTimeOffsets;

  /// Encoding of audio data sent in all `RecognitionAudio` messages.
  ///
  /// This field is optional for `FLAC` and `WAV` audio files and required for
  /// all other audio formats. For details, see AudioEncoding.
  /// Possible string values are:
  /// - "ENCODING_UNSPECIFIED" : Not specified.
  /// - "LINEAR16" : Uncompressed 16-bit signed little-endian samples (Linear
  /// PCM).
  /// - "FLAC" : `FLAC` (Free Lossless Audio Codec) is the recommended encoding
  /// because it is lossless--therefore recognition is not compromised--and
  /// requires only about half the bandwidth of `LINEAR16`. `FLAC` stream
  /// encoding supports 16-bit and 24-bit samples, however, not all fields in
  /// `STREAMINFO` are supported.
  /// - "MULAW" : 8-bit samples that compand 14-bit audio samples using G.711
  /// PCMU/mu-law.
  /// - "AMR" : Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must
  /// be 8000.
  /// - "AMR_WB" : Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must
  /// be 16000.
  /// - "OGG_OPUS" : Opus encoded audio frames in Ogg container
  /// ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be
  /// one of 8000, 12000, 16000, 24000, or 48000.
  /// - "SPEEX_WITH_HEADER_BYTE" : Although the use of lossy encodings is not
  /// recommended, if a very low bitrate encoding is required, `OGG_OPUS` is
  /// highly preferred over Speex encoding. The [Speex](https://speex.org/)
  /// encoding supported by Cloud Speech API has a header byte in each block, as
  /// in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP
  /// Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574).
  /// The stream is a sequence of blocks, one block per RTP packet. Each block
  /// starts with a byte containing the length of the block, in bytes, followed
  /// by one or more frames of Speex data, padded to an integral number of bytes
  /// (octets) as specified in RFC 5574. In other words, each RTP header is
  /// replaced with a single byte containing the block length. Only Speex
  /// wideband is supported. `sample_rate_hertz` must be 16000.
  /// - "MP3" : MP3 audio. MP3 encoding is a Beta feature and only available in
  /// v1p1beta1. Support all standard MP3 bitrates (which range from 32-320
  /// kbps). When using this encoding, `sample_rate_hertz` has to match the
  /// sample rate of the file being used.
  /// - "WEBM_OPUS" : Opus encoded audio frames in WebM container
  /// ([WebM](https://www.webmproject.org/docs/container/)). `sample_rate_hertz`
  /// must be one of 8000, 12000, 16000, 24000, or 48000.
  /// - "ALAW" : 8-bit samples that compand 13-bit audio samples using G.711
  /// PCMU/a-law.
  core.String? encoding;

  /// The language of the supplied audio as a
  /// \[BCP-47\](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
  ///
  /// Example: "en-US". See
  /// [Language Support](https://cloud.google.com/speech-to-text/docs/languages)
  /// for a list of the currently supported language codes.
  ///
  /// Required.
  core.String? languageCode;

  /// Maximum number of recognition hypotheses to be returned.
  ///
  /// Specifically, the maximum number of `SpeechRecognitionAlternative`
  /// messages within each `SpeechRecognitionResult`. The server may return
  /// fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0`
  /// or `1` will return a maximum of one. If omitted, will return a maximum of
  /// one.
  core.int? maxAlternatives;

  /// Metadata regarding this request.
  RecognitionMetadata? metadata;

  /// Which model to select for the given request.
  ///
  /// Select the model best suited to your domain to get best results. If a
  /// model is not explicitly specified, then we auto-select a model based on
  /// the parameters in the RecognitionConfig. *Model* *Description* latest_long
  /// Best for long form content like media or conversation. latest_short Best
  /// for short form content like commands or single shot directed speech.
  /// command_and_search Best for short queries such as voice commands or voice
  /// search. phone_call Best for audio that originated from a phone call
  /// (typically recorded at an 8khz sampling rate). video Best for audio that
  /// originated from video or includes multiple speakers. Ideally the audio is
  /// recorded at a 16khz or greater sampling rate. This is a premium model that
  /// costs more than the standard rate. default Best for audio that is not one
  /// of the specific audio models. For example, long-form audio. Ideally the
  /// audio is high-fidelity, recorded at a 16khz or greater sampling rate.
  /// medical_conversation Best for audio that originated from a conversation
  /// between a medical provider and patient. medical_dictation Best for audio
  /// that originated from dictation notes by a medical provider.
  core.String? model;

  /// If set to `true`, the server will attempt to filter out profanities,
  /// replacing all but the initial character in each filtered word with
  /// asterisks, e.g. "f***".
  ///
  /// If set to `false` or omitted, profanities won't be filtered out.
  core.bool? profanityFilter;

  /// Sample rate in Hertz of the audio data sent in all `RecognitionAudio`
  /// messages.
  ///
  /// Valid values are: 8000-48000. 16000 is optimal. For best results, set the
  /// sampling rate of the audio source to 16000 Hz. If that's not possible, use
  /// the native sample rate of the audio source (instead of re-sampling). This
  /// field is optional for FLAC and WAV audio files, but is required for all
  /// other audio formats. For details, see AudioEncoding.
  core.int? sampleRateHertz;

  /// Array of SpeechContext.
  ///
  /// A means to provide context to assist the speech recognition. For more
  /// information, see
  /// [speech adaptation](https://cloud.google.com/speech-to-text/docs/adaptation).
  core.List<SpeechContext>? speechContexts;

  /// Use transcription normalization to automatically replace parts of the
  /// transcript with phrases of your choosing.
  ///
  /// For StreamingRecognize, this normalization only applies to stable partial
  /// transcripts (stability \> 0.8) and final transcripts.
  ///
  /// Optional.
  TranscriptNormalization? transcriptNormalization;

  /// Set to true to use an enhanced model for speech recognition.
  ///
  /// If `use_enhanced` is set to true and the `model` field is not set, then an
  /// appropriate enhanced model is chosen if an enhanced model exists for the
  /// audio. If `use_enhanced` is true and an enhanced version of the specified
  /// model does not exist, then the speech is recognized using the standard
  /// version of the specified model.
  core.bool? useEnhanced;

  RecognitionConfig({
    this.adaptation,
    this.alternativeLanguageCodes,
    this.audioChannelCount,
    this.diarizationConfig,
    this.enableAutomaticPunctuation,
    this.enableSeparateRecognitionPerChannel,
    this.enableSpokenEmojis,
    this.enableSpokenPunctuation,
    this.enableWordConfidence,
    this.enableWordTimeOffsets,
    this.encoding,
    this.languageCode,
    this.maxAlternatives,
    this.metadata,
    this.model,
    this.profanityFilter,
    this.sampleRateHertz,
    this.speechContexts,
    this.transcriptNormalization,
    this.useEnhanced,
  });

  RecognitionConfig.fromJson(core.Map json_)
    : this(
        adaptation: json_.containsKey('adaptation')
            ? SpeechAdaptation.fromJson(
                json_['adaptation'] as core.Map<core.String, core.dynamic>,
              )
            : null,
        alternativeLanguageCodes:
            (json_['alternativeLanguageCodes'] as core.List?)
                ?.map((value) => value as core.String)
                .toList(),
        audioChannelCount: json_['audioChannelCount'] as core.int?,
        diarizationConfig: json_.containsKey('diarizationConfig')
            ? SpeakerDiarizationConfig.fromJson(
                json_['diarizationConfig']
                    as core.Map<core.String, core.dynamic>,
              )
            : null,
        enableAutomaticPunctuation:
            json_['enableAutomaticPunctuation'] as core.bool?,
        enableSeparateRecognitionPerChannel:
            json_['enableSeparateRecognitionPerChannel'] as core.bool?,
        enableSpokenEmojis: json_['enableSpokenEmojis'] as core.bool?,
        enableSpokenPunctuation: json_['enableSpokenPunctuation'] as core.bool?,
        enableWordConfidence: json_['enableWordConfidence'] as core.bool?,
        enableWordTimeOffsets: json_['enableWordTimeOffsets'] as core.bool?,
        encoding: json_['encoding'] as core.String?,
        languageCode: json_['languageCode'] as core.String?,
        maxAlternatives: json_['maxAlternatives'] as core.int?,
        metadata: json_.containsKey('metadata')
            ? RecognitionMetadata.fromJson(
                json_['metadata'] as core.Map<core.String, core.dynamic>,
              )
            : null,
        model: json_['model'] as core.String?,
        profanityFilter: json_['profanityFilter'] as core.bool?,
        sampleRateHertz: json_['sampleRateHertz'] as core.int?,
        speechContexts: (json_['speechContexts'] as core.List?)
            ?.map(
              (value) => SpeechContext.fromJson(
                value as core.Map<core.String, core.dynamic>,
              ),
            )
            .toList(),
        transcriptNormalization: json_.containsKey('transcriptNormalization')
            ? TranscriptNormalization.fromJson(
                json_['transcriptNormalization']
                    as core.Map<core.String, core.dynamic>,
              )
            : null,
        useEnhanced: json_['useEnhanced'] as core.bool?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final adaptation = this.adaptation;
    final alternativeLanguageCodes = this.alternativeLanguageCodes;
    final audioChannelCount = this.audioChannelCount;
    final diarizationConfig = this.diarizationConfig;
    final enableAutomaticPunctuation = this.enableAutomaticPunctuation;
    final enableSeparateRecognitionPerChannel =
        this.enableSeparateRecognitionPerChannel;
    final enableSpokenEmojis = this.enableSpokenEmojis;
    final enableSpokenPunctuation = this.enableSpokenPunctuation;
    final enableWordConfidence = this.enableWordConfidence;
    final enableWordTimeOffsets = this.enableWordTimeOffsets;
    final encoding = this.encoding;
    final languageCode = this.languageCode;
    final maxAlternatives = this.maxAlternatives;
    final metadata = this.metadata;
    final model = this.model;
    final profanityFilter = this.profanityFilter;
    final sampleRateHertz = this.sampleRateHertz;
    final speechContexts = this.speechContexts;
    final transcriptNormalization = this.transcriptNormalization;
    final useEnhanced = this.useEnhanced;
    return {
      'adaptation': ?adaptation,
      'alternativeLanguageCodes': ?alternativeLanguageCodes,
      'audioChannelCount': ?audioChannelCount,
      'diarizationConfig': ?diarizationConfig,
      'enableAutomaticPunctuation': ?enableAutomaticPunctuation,
      'enableSeparateRecognitionPerChannel':
          ?enableSeparateRecognitionPerChannel,
      'enableSpokenEmojis': ?enableSpokenEmojis,
      'enableSpokenPunctuation': ?enableSpokenPunctuation,
      'enableWordConfidence': ?enableWordConfidence,
      'enableWordTimeOffsets': ?enableWordTimeOffsets,
      'encoding': ?encoding,
      'languageCode': ?languageCode,
      'maxAlternatives': ?maxAlternatives,
      'metadata': ?metadata,
      'model': ?model,
      'profanityFilter': ?profanityFilter,
      'sampleRateHertz': ?sampleRateHertz,
      'speechContexts': ?speechContexts,
      'transcriptNormalization': ?transcriptNormalization,
      'useEnhanced': ?useEnhanced,
    };
  }
}

/// Description of audio data to be recognized.
class RecognitionMetadata {
  /// Description of the content.
  ///
  /// Eg. "Recordings of federal supreme court hearings from 2012".
  core.String? audioTopic;

  /// The industry vertical to which this speech recognition request most
  /// closely applies.
  ///
  /// This is most indicative of the topics contained in the audio. Use the
  /// 6-digit NAICS code to identify the industry vertical - see
  /// https://www.naics.com/search/.
  core.int? industryNaicsCodeOfAudio;

  /// The use case most closely describing the audio content to be recognized.
  /// Possible string values are:
  /// - "INTERACTION_TYPE_UNSPECIFIED" : Use case is either unknown or is
  /// something other than one of the other values below.
  /// - "DISCUSSION" : Multiple people in a conversation or discussion. For
  /// example in a meeting with two or more people actively participating.
  /// Typically all the primary people speaking would be in the same room (if
  /// not, see PHONE_CALL)
  /// - "PRESENTATION" : One or more persons lecturing or presenting to others,
  /// mostly uninterrupted.
  /// - "PHONE_CALL" : A phone-call or video-conference in which two or more
  /// people, who are not in the same room, are actively participating.
  /// - "VOICEMAIL" : A recorded message intended for another person to listen
  /// to.
  /// - "PROFESSIONALLY_PRODUCED" : Professionally produced audio (eg. TV Show,
  /// Podcast).
  /// - "VOICE_SEARCH" : Transcribe spoken questions and queries into text.
  /// - "VOICE_COMMAND" : Transcribe voice commands, such as for controlling a
  /// device.
  /// - "DICTATION" : Transcribe speech to text to create a written document,
  /// such as a text-message, email or report.
  core.String? interactionType;

  /// The audio type that most closely describes the audio being recognized.
  /// Possible string values are:
  /// - "MICROPHONE_DISTANCE_UNSPECIFIED" : Audio type is not known.
  /// - "NEARFIELD" : The audio was captured from a closely placed microphone.
  /// Eg. phone, dictaphone, or handheld microphone. Generally if there speaker
  /// is within 1 meter of the microphone.
  /// - "MIDFIELD" : The speaker if within 3 meters of the microphone.
  /// - "FARFIELD" : The speaker is more than 3 meters away from the microphone.
  core.String? microphoneDistance;

  /// The original media the speech was recorded on.
  /// Possible string values are:
  /// - "ORIGINAL_MEDIA_TYPE_UNSPECIFIED" : Unknown original media type.
  /// - "AUDIO" : The speech data is an audio recording.
  /// - "VIDEO" : The speech data originally recorded on a video.
  core.String? originalMediaType;

  /// Mime type of the original audio file.
  ///
  /// For example `audio/m4a`, `audio/x-alaw-basic`, `audio/mp3`, `audio/3gpp`.
  /// A list of possible audio mime types is maintained at
  /// http://www.iana.org/assignments/media-types/media-types.xhtml#audio
  core.String? originalMimeType;

  /// The device used to make the recording.
  ///
  /// Examples 'Nexus 5X' or 'Polycom SoundStation IP 6000' or 'POTS' or 'VoIP'
  /// or 'Cardioid Microphone'.
  core.String? recordingDeviceName;

  /// The type of device the speech was recorded with.
  /// Possible string values are:
  /// - "RECORDING_DEVICE_TYPE_UNSPECIFIED" : The recording device is unknown.
  /// - "SMARTPHONE" : Speech was recorded on a smartphone.
  /// - "PC" : Speech was recorded using a personal computer or tablet.
  /// - "PHONE_LINE" : Speech was recorded over a phone line.
  /// - "VEHICLE" : Speech was recorded in a vehicle.
  /// - "OTHER_OUTDOOR_DEVICE" : Speech was recorded outdoors.
  /// - "OTHER_INDOOR_DEVICE" : Speech was recorded indoors.
  core.String? recordingDeviceType;

  RecognitionMetadata({
    this.audioTopic,
    this.industryNaicsCodeOfAudio,
    this.interactionType,
    this.microphoneDistance,
    this.originalMediaType,
    this.originalMimeType,
    this.recordingDeviceName,
    this.recordingDeviceType,
  });

  RecognitionMetadata.fromJson(core.Map json_)
    : this(
        audioTopic: json_['audioTopic'] as core.String?,
        industryNaicsCodeOfAudio:
            json_['industryNaicsCodeOfAudio'] as core.int?,
        interactionType: json_['interactionType'] as core.String?,
        microphoneDistance: json_['microphoneDistance'] as core.String?,
        originalMediaType: json_['originalMediaType'] as core.String?,
        originalMimeType: json_['originalMimeType'] as core.String?,
        recordingDeviceName: json_['recordingDeviceName'] as core.String?,
        recordingDeviceType: json_['recordingDeviceType'] as core.String?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final audioTopic = this.audioTopic;
    final industryNaicsCodeOfAudio = this.industryNaicsCodeOfAudio;
    final interactionType = this.interactionType;
    final microphoneDistance = this.microphoneDistance;
    final originalMediaType = this.originalMediaType;
    final originalMimeType = this.originalMimeType;
    final recordingDeviceName = this.recordingDeviceName;
    final recordingDeviceType = this.recordingDeviceType;
    return {
      'audioTopic': ?audioTopic,
      'industryNaicsCodeOfAudio': ?industryNaicsCodeOfAudio,
      'interactionType': ?interactionType,
      'microphoneDistance': ?microphoneDistance,
      'originalMediaType': ?originalMediaType,
      'originalMimeType': ?originalMimeType,
      'recordingDeviceName': ?recordingDeviceName,
      'recordingDeviceType': ?recordingDeviceType,
    };
  }
}

/// The top-level message sent by the client for the `Recognize` method.
class RecognizeRequest {
  /// The audio data to be recognized.
  ///
  /// Required.
  RecognitionAudio? audio;

  /// Provides information to the recognizer that specifies how to process the
  /// request.
  ///
  /// Required.
  RecognitionConfig? config;

  RecognizeRequest({this.audio, this.config});

  RecognizeRequest.fromJson(core.Map json_)
    : this(
        audio: json_.containsKey('audio')
            ? RecognitionAudio.fromJson(
                json_['audio'] as core.Map<core.String, core.dynamic>,
              )
            : null,
        config: json_.containsKey('config')
            ? RecognitionConfig.fromJson(
                json_['config'] as core.Map<core.String, core.dynamic>,
              )
            : null,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final audio = this.audio;
    final config = this.config;
    return {'audio': ?audio, 'config': ?config};
  }
}

/// The only message returned to the client by the `Recognize` method.
///
/// It contains the result as zero or more sequential `SpeechRecognitionResult`
/// messages.
class RecognizeResponse {
  /// The ID associated with the request.
  ///
  /// This is a unique ID specific only to the given request.
  core.String? requestId;

  /// Sequential list of transcription results corresponding to sequential
  /// portions of audio.
  core.List<SpeechRecognitionResult>? results;

  /// Provides information on adaptation behavior in response
  SpeechAdaptationInfo? speechAdaptationInfo;

  /// When available, billed audio seconds for the corresponding request.
  core.String? totalBilledTime;

  /// Whether request used legacy asr models (was not automatically migrated to
  /// use conformer models).
  core.bool? usingLegacyModels;

  RecognizeResponse({
    this.requestId,
    this.results,
    this.speechAdaptationInfo,
    this.totalBilledTime,
    this.usingLegacyModels,
  });

  RecognizeResponse.fromJson(core.Map json_)
    : this(
        requestId: json_['requestId'] as core.String?,
        results: (json_['results'] as core.List?)
            ?.map(
              (value) => SpeechRecognitionResult.fromJson(
                value as core.Map<core.String, core.dynamic>,
              ),
            )
            .toList(),
        speechAdaptationInfo: json_.containsKey('speechAdaptationInfo')
            ? SpeechAdaptationInfo.fromJson(
                json_['speechAdaptationInfo']
                    as core.Map<core.String, core.dynamic>,
              )
            : null,
        totalBilledTime: json_['totalBilledTime'] as core.String?,
        usingLegacyModels: json_['usingLegacyModels'] as core.bool?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final requestId = this.requestId;
    final results = this.results;
    final speechAdaptationInfo = this.speechAdaptationInfo;
    final totalBilledTime = this.totalBilledTime;
    final usingLegacyModels = this.usingLegacyModels;
    return {
      'requestId': ?requestId,
      'results': ?results,
      'speechAdaptationInfo': ?speechAdaptationInfo,
      'totalBilledTime': ?totalBilledTime,
      'usingLegacyModels': ?usingLegacyModels,
    };
  }
}

/// Config to enable speaker diarization.
class SpeakerDiarizationConfig {
  /// If 'true', enables speaker detection for each recognized word in the top
  /// alternative of the recognition result using a speaker_label provided in
  /// the WordInfo.
  core.bool? enableSpeakerDiarization;

  /// Maximum number of speakers in the conversation.
  ///
  /// This range gives you more flexibility by allowing the system to
  /// automatically determine the correct number of speakers. If not set, the
  /// default value is 6.
  core.int? maxSpeakerCount;

  /// Minimum number of speakers in the conversation.
  ///
  /// This range gives you more flexibility by allowing the system to
  /// automatically determine the correct number of speakers. If not set, the
  /// default value is 2.
  core.int? minSpeakerCount;

  /// Unused.
  ///
  /// Output only.
  @core.Deprecated(
    'Not supported. Member documentation may have more information.',
  )
  core.int? speakerTag;

  SpeakerDiarizationConfig({
    this.enableSpeakerDiarization,
    this.maxSpeakerCount,
    this.minSpeakerCount,
    this.speakerTag,
  });

  SpeakerDiarizationConfig.fromJson(core.Map json_)
    : this(
        enableSpeakerDiarization:
            json_['enableSpeakerDiarization'] as core.bool?,
        maxSpeakerCount: json_['maxSpeakerCount'] as core.int?,
        minSpeakerCount: json_['minSpeakerCount'] as core.int?,
        speakerTag: json_['speakerTag'] as core.int?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final enableSpeakerDiarization = this.enableSpeakerDiarization;
    final maxSpeakerCount = this.maxSpeakerCount;
    final minSpeakerCount = this.minSpeakerCount;
    final speakerTag = this.speakerTag;
    return {
      'enableSpeakerDiarization': ?enableSpeakerDiarization,
      'maxSpeakerCount': ?maxSpeakerCount,
      'minSpeakerCount': ?minSpeakerCount,
      'speakerTag': ?speakerTag,
    };
  }
}

/// Speech adaptation configuration.
class SpeechAdaptation {
  /// Augmented Backus-Naur form (ABNF) is a standardized grammar notation
  /// comprised by a set of derivation rules.
  ///
  /// See specifications: https://www.w3.org/TR/speech-grammar
  ABNFGrammar? abnfGrammar;

  /// A collection of custom classes.
  ///
  /// To specify the classes inline, leave the class' `name` blank and fill in
  /// the rest of its fields, giving it a unique `custom_class_id`. Refer to the
  /// inline defined class in phrase hints by its `custom_class_id`.
  core.List<CustomClass>? customClasses;

  /// A collection of phrase set resource names to use.
  core.List<core.String>? phraseSetReferences;

  /// A collection of phrase sets.
  ///
  /// To specify the hints inline, leave the phrase set's `name` blank and fill
  /// in the rest of its fields. Any phrase set can use any custom class.
  core.List<PhraseSet>? phraseSets;

  SpeechAdaptation({
    this.abnfGrammar,
    this.customClasses,
    this.phraseSetReferences,
    this.phraseSets,
  });

  SpeechAdaptation.fromJson(core.Map json_)
    : this(
        abnfGrammar: json_.containsKey('abnfGrammar')
            ? ABNFGrammar.fromJson(
                json_['abnfGrammar'] as core.Map<core.String, core.dynamic>,
              )
            : null,
        customClasses: (json_['customClasses'] as core.List?)
            ?.map(
              (value) => CustomClass.fromJson(
                value as core.Map<core.String, core.dynamic>,
              ),
            )
            .toList(),
        phraseSetReferences: (json_['phraseSetReferences'] as core.List?)
            ?.map((value) => value as core.String)
            .toList(),
        phraseSets: (json_['phraseSets'] as core.List?)
            ?.map(
              (value) => PhraseSet.fromJson(
                value as core.Map<core.String, core.dynamic>,
              ),
            )
            .toList(),
      );

  core.Map<core.String, core.dynamic> toJson() {
    final abnfGrammar = this.abnfGrammar;
    final customClasses = this.customClasses;
    final phraseSetReferences = this.phraseSetReferences;
    final phraseSets = this.phraseSets;
    return {
      'abnfGrammar': ?abnfGrammar,
      'customClasses': ?customClasses,
      'phraseSetReferences': ?phraseSetReferences,
      'phraseSets': ?phraseSets,
    };
  }
}

/// Information on speech adaptation use in results
class SpeechAdaptationInfo {
  /// Whether there was a timeout when applying speech adaptation.
  ///
  /// If true, adaptation had no effect in the response transcript.
  core.bool? adaptationTimeout;

  /// If set, returns a message specifying which part of the speech adaptation
  /// request timed out.
  core.String? timeoutMessage;

  SpeechAdaptationInfo({this.adaptationTimeout, this.timeoutMessage});

  SpeechAdaptationInfo.fromJson(core.Map json_)
    : this(
        adaptationTimeout: json_['adaptationTimeout'] as core.bool?,
        timeoutMessage: json_['timeoutMessage'] as core.String?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final adaptationTimeout = this.adaptationTimeout;
    final timeoutMessage = this.timeoutMessage;
    return {
      'adaptationTimeout': ?adaptationTimeout,
      'timeoutMessage': ?timeoutMessage,
    };
  }
}

/// Provides "hints" to the speech recognizer to favor specific words and
/// phrases in the results.
class SpeechContext {
  /// 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 and 20. We recommend using a binary search approach
  /// to finding the optimal value for your use case.
  core.double? boost;

  /// A list of strings containing words and phrases "hints" so that the speech
  /// recognition is more likely to recognize them.
  ///
  /// This can be used to improve the accuracy for specific words and phrases,
  /// for example, if specific commands are typically spoken by the user. This
  /// can also be used to add additional words to the vocabulary of the
  /// recognizer. See
  /// [usage limits](https://cloud.google.com/speech-to-text/quotas#content).
  /// List items can also be set to classes for groups of words that represent
  /// common concepts that occur in natural language. For example, rather than
  /// providing phrase hints for every month of the year, using the $MONTH class
  /// improves the likelihood of correctly transcribing audio that includes
  /// months.
  core.List<core.String>? phrases;

  SpeechContext({this.boost, this.phrases});

  SpeechContext.fromJson(core.Map json_)
    : this(
        boost: (json_['boost'] as core.num?)?.toDouble(),
        phrases: (json_['phrases'] as core.List?)
            ?.map((value) => value as core.String)
            .toList(),
      );

  core.Map<core.String, core.dynamic> toJson() {
    final boost = this.boost;
    final phrases = this.phrases;
    return {'boost': ?boost, 'phrases': ?phrases};
  }
}

/// Alternative hypotheses (a.k.a. n-best list).
class SpeechRecognitionAlternative {
  /// The confidence estimate between 0.0 and 1.0.
  ///
  /// A higher number indicates an estimated greater likelihood that the
  /// recognized words are correct. This field is set only for the top
  /// alternative of a non-streaming result or, of a streaming result where
  /// `is_final=true`. This field is not guaranteed to be accurate and users
  /// should not rely on it to be always provided. The default of 0.0 is a
  /// sentinel value indicating `confidence` was not set.
  core.double? confidence;

  /// Transcript text representing the words that the user spoke.
  ///
  /// In languages that use spaces to separate words, the transcript might have
  /// a leading space if it isn't the first result. You can concatenate each
  /// result to obtain the full transcript without using a separator.
  core.String? transcript;

  /// A list of word-specific information for each recognized word.
  ///
  /// Note: When `enable_speaker_diarization` is true, you will see all the
  /// words from the beginning of the audio.
  core.List<WordInfo>? words;

  SpeechRecognitionAlternative({this.confidence, this.transcript, this.words});

  SpeechRecognitionAlternative.fromJson(core.Map json_)
    : this(
        confidence: (json_['confidence'] as core.num?)?.toDouble(),
        transcript: json_['transcript'] as core.String?,
        words: (json_['words'] as core.List?)
            ?.map(
              (value) => WordInfo.fromJson(
                value as core.Map<core.String, core.dynamic>,
              ),
            )
            .toList(),
      );

  core.Map<core.String, core.dynamic> toJson() {
    final confidence = this.confidence;
    final transcript = this.transcript;
    final words = this.words;
    return {
      'confidence': ?confidence,
      'transcript': ?transcript,
      'words': ?words,
    };
  }
}

/// A speech recognition result corresponding to a portion of the audio.
class SpeechRecognitionResult {
  /// May contain one or more recognition hypotheses (up to the maximum
  /// specified in `max_alternatives`).
  ///
  /// These alternatives are ordered in terms of accuracy, with the top (first)
  /// alternative being the most probable, as ranked by the recognizer.
  core.List<SpeechRecognitionAlternative>? alternatives;

  /// For multi-channel audio, this is the channel number corresponding to the
  /// recognized result for the audio from that channel.
  ///
  /// For audio_channel_count = N, its output values can range from '1' to 'N'.
  core.int? channelTag;

  /// The \[BCP-47\](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag
  /// of the language in this result.
  ///
  /// This language code was detected to have the most likelihood of being
  /// spoken in the audio.
  ///
  /// Output only.
  core.String? languageCode;

  /// Time offset of the end of this result relative to the beginning of the
  /// audio.
  core.String? resultEndTime;

  SpeechRecognitionResult({
    this.alternatives,
    this.channelTag,
    this.languageCode,
    this.resultEndTime,
  });

  SpeechRecognitionResult.fromJson(core.Map json_)
    : this(
        alternatives: (json_['alternatives'] as core.List?)
            ?.map(
              (value) => SpeechRecognitionAlternative.fromJson(
                value as core.Map<core.String, core.dynamic>,
              ),
            )
            .toList(),
        channelTag: json_['channelTag'] as core.int?,
        languageCode: json_['languageCode'] as core.String?,
        resultEndTime: json_['resultEndTime'] as core.String?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final alternatives = this.alternatives;
    final channelTag = this.channelTag;
    final languageCode = this.languageCode;
    final resultEndTime = this.resultEndTime;
    return {
      'alternatives': ?alternatives,
      'channelTag': ?channelTag,
      'languageCode': ?languageCode,
      'resultEndTime': ?resultEndTime,
    };
  }
}

/// The `Status` type defines a logical error model that is suitable for
/// different programming environments, including REST APIs and RPC APIs.
///
/// It is used by [gRPC](https://github.com/grpc). Each `Status` message
/// contains three pieces of data: error code, error message, and error details.
/// You can find out more about this error model and how to work with it in the
/// [API Design Guide](https://cloud.google.com/apis/design/errors).
typedef Status = $Status00;

/// Transcription normalization configuration.
///
/// Use transcription normalization to automatically replace parts of the
/// transcript with phrases of your choosing. For StreamingRecognize, this
/// normalization only applies to stable partial transcripts (stability \> 0.8)
/// and final transcripts.
class TranscriptNormalization {
  /// A list of replacement entries.
  ///
  /// We will perform replacement with one entry at a time. For example, the
  /// second entry in \["cat" =\> "dog", "mountain cat" =\> "mountain dog"\]
  /// will never be applied because we will always process the first entry
  /// before it. At most 100 entries.
  core.List<Entry>? entries;

  TranscriptNormalization({this.entries});

  TranscriptNormalization.fromJson(core.Map json_)
    : this(
        entries: (json_['entries'] as core.List?)
            ?.map(
              (value) =>
                  Entry.fromJson(value as core.Map<core.String, core.dynamic>),
            )
            .toList(),
      );

  core.Map<core.String, core.dynamic> toJson() {
    final entries = this.entries;
    return {'entries': ?entries};
  }
}

/// Specifies an optional destination for the recognition results.
class TranscriptOutputConfig {
  /// Specifies a Cloud Storage URI for the recognition results.
  ///
  /// Must be specified in the format: `gs://bucket_name/object_name`, and the
  /// bucket must already exist.
  core.String? gcsUri;

  TranscriptOutputConfig({this.gcsUri});

  TranscriptOutputConfig.fromJson(core.Map json_)
    : this(gcsUri: json_['gcsUri'] as core.String?);

  core.Map<core.String, core.dynamic> toJson() {
    final gcsUri = this.gcsUri;
    return {'gcsUri': ?gcsUri};
  }
}

/// Word-specific information for recognized words.
class WordInfo {
  /// The confidence estimate between 0.0 and 1.0.
  ///
  /// A higher number indicates an estimated greater likelihood that the
  /// recognized words are correct. This field is set only for the top
  /// alternative of a non-streaming result or, of a streaming result where
  /// `is_final=true`. This field is not guaranteed to be accurate and users
  /// should not rely on it to be always provided. The default of 0.0 is a
  /// sentinel value indicating `confidence` was not set.
  core.double? confidence;

  /// Time offset relative to the beginning of the audio, and corresponding to
  /// the end of the spoken word.
  ///
  /// This field is only set if `enable_word_time_offsets=true` and only in the
  /// top hypothesis. This is an experimental feature and the accuracy of the
  /// time offset can vary.
  core.String? endTime;

  /// A label value assigned for every unique speaker within the audio.
  ///
  /// This field specifies which speaker was detected to have spoken this word.
  /// For some models, like medical_conversation this can be actual speaker
  /// role, for example "patient" or "provider", but generally this would be a
  /// number identifying a speaker. This field is only set if
  /// enable_speaker_diarization = 'true' and only for the top alternative.
  ///
  /// Output only.
  core.String? speakerLabel;

  /// A distinct integer value is assigned for every speaker within the audio.
  ///
  /// This field specifies which one of those speakers was detected to have
  /// spoken this word. Value ranges from '1' to diarization_speaker_count.
  /// speaker_tag is set if enable_speaker_diarization = 'true' and only for the
  /// top alternative. Note: Use speaker_label instead.
  ///
  /// Output only.
  @core.Deprecated(
    'Not supported. Member documentation may have more information.',
  )
  core.int? speakerTag;

  /// Time offset relative to the beginning of the audio, and corresponding to
  /// the start of the spoken word.
  ///
  /// This field is only set if `enable_word_time_offsets=true` and only in the
  /// top hypothesis. This is an experimental feature and the accuracy of the
  /// time offset can vary.
  core.String? startTime;

  /// The word corresponding to this set of information.
  core.String? word;

  WordInfo({
    this.confidence,
    this.endTime,
    this.speakerLabel,
    this.speakerTag,
    this.startTime,
    this.word,
  });

  WordInfo.fromJson(core.Map json_)
    : this(
        confidence: (json_['confidence'] as core.num?)?.toDouble(),
        endTime: json_['endTime'] as core.String?,
        speakerLabel: json_['speakerLabel'] as core.String?,
        speakerTag: json_['speakerTag'] as core.int?,
        startTime: json_['startTime'] as core.String?,
        word: json_['word'] as core.String?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final confidence = this.confidence;
    final endTime = this.endTime;
    final speakerLabel = this.speakerLabel;
    final speakerTag = this.speakerTag;
    final startTime = this.startTime;
    final word = this.word;
    return {
      'confidence': ?confidence,
      'endTime': ?endTime,
      'speakerLabel': ?speakerLabel,
      'speakerTag': ?speakerTag,
      'startTime': ?startTime,
      'word': ?word,
    };
  }
}