@googleapis/translate 6.0.0 → 7.1.0

package/v3beta1.ts

@@ -178,12 +178,16 @@ export namespace translate_v3beta1 {
      * Required. Output configuration. If 2 input configs match to the same file (that is, same input path), we don't generate output for duplicate inputs.
      */
     outputConfig?: Schema$BatchDocumentOutputConfig;
+    /**
+     * Optional. If true, only native pdf pages will be translated.
+     */
+    pdfNativeOnly?: boolean | null;
     /**
      * Required. The BCP-47 language code of the input document if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in [Language Support](https://cloud.google.com/translate/docs/languages).
      */
     sourceLanguageCode?: string | null;
     /**
-     * Required. The BCP-47 language code to use for translation of the input document. Specify up to 10 language codes here.
+     * Required. The BCP-47 language code to use for translation of the input document. Specify up to 10 language codes here. Supported language codes are listed in [Language Support](https://cloud.google.com/translate/docs/languages).
      */
     targetLanguageCodes?: string[] | null;
   }
@@ -212,11 +216,11 @@ export namespace translate_v3beta1 {
      */
     outputConfig?: Schema$OutputConfig;
     /**
-     * Required. Source language code.
+     * Required. Source language code. Supported language codes are listed in [Language Support](https://cloud.google.com/translate/docs/languages).
      */
     sourceLanguageCode?: string | null;
     /**
-     * Required. Specify up to 10 language codes here.
+     * Required. Specify up to 10 language codes here. Supported language codes are listed in [Language Support](https://cloud.google.com/translate/docs/languages).
      */
     targetLanguageCodes?: string[] | null;
   }
@@ -451,6 +455,10 @@ export namespace translate_v3beta1 {
      * A list of operations that matches the specified filter in the request.
      */
     operations?: Schema$Operation[];
+    /**
+     * 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.
+     */
+    unreachable?: string[] | null;
   }
   /**
    * A resource that represents a Google Cloud location.
@@ -511,6 +519,45 @@ export namespace translate_v3beta1 {
      */
     gcsDestination?: Schema$GcsDestination;
   }
+  /**
+   * A single refinement entry for RefineTextRequest.
+   */
+  export interface Schema$RefinementEntry {
+    /**
+     * Required. The original translation of the source text.
+     */
+    originalTranslation?: string | null;
+    /**
+     * Required. The source text to be refined.
+     */
+    sourceText?: string | null;
+  }
+  /**
+   * Request message for RefineText.
+   */
+  export interface Schema$RefineTextRequest {
+    /**
+     * Required. The source texts and original translations in the source and target languages.
+     */
+    refinementEntries?: Schema$RefinementEntry[];
+    /**
+     * Required. The BCP-47 language code of the source text in the request, for example, "en-US".
+     */
+    sourceLanguageCode?: string | null;
+    /**
+     * Required. The BCP-47 language code for translation output, for example, "zh-CN".
+     */
+    targetLanguageCode?: string | null;
+  }
+  /**
+   * Response message for RefineText.
+   */
+  export interface Schema$RefineTextResponse {
+    /**
+     * The refined translations obtained from the original translations.
+     */
+    refinedTranslations?: string[] | null;
+  }
   /**
    * 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).
    */
@@ -599,11 +646,11 @@ export namespace translate_v3beta1 {
      */
     model?: string | null;
     /**
-     * Optional. The BCP-47 language code of the input document if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response. Source language must be specified if the request contains a glossary or a custom model.
+     * Optional. The BCP-47 language code of the input document if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in [Language Support](https://cloud.google.com/translate/docs/languages). If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response. Source language must be specified if the request contains a glossary or a custom model.
      */
     sourceLanguageCode?: string | null;
     /**
-     * Required. The BCP-47 language code to use for translation of the input document, set to one of the language codes listed in Language Support.
+     * Required. The BCP-47 language code to use for translation of the input document, set to one of the language codes listed in [Language Support](https://cloud.google.com/translate/docs/languages).
      */
     targetLanguageCode?: string | null;
   }
@@ -629,7 +676,7 @@ export namespace translate_v3beta1 {
     model?: string | null;
   }
   /**
-   * ----------------------------------------------------------------------------- Configures which glossary should be used for a specific target language, and defines options for applying that glossary.
+   * Configures which glossary should be used for a specific target language, and defines options for applying that glossary.
    */
   export interface Schema$TranslateTextGlossaryConfig {
     /**
@@ -670,11 +717,11 @@ export namespace translate_v3beta1 {
      */
     model?: string | null;
     /**
-     * Optional. The BCP-47 language code of the input text if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response.
+     * Optional. The BCP-47 language code of the input text if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in [Language Support](https://cloud.google.com/translate/docs/languages). If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response.
      */
     sourceLanguageCode?: string | null;
     /**
-     * Required. The BCP-47 language code to use for translation of the input text, set to one of the language codes listed in Language Support.
+     * Required. The BCP-47 language code to use for translation of the input text, set to one of the language codes listed in [Language Support](https://cloud.google.com/translate/docs/languages).
      */
     targetLanguageCode?: string | null;
   }
@@ -1188,8 +1235,7 @@ export namespace translate_v3beta1 {
     }
   }
 
-  export interface Params$Resource$Projects$Detectlanguage
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Detectlanguage extends StandardParameters {
     /**
      * Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id\}/locations/{location-id\}` or `projects/{project-number-or-id\}`. For global calls, use `projects/{project-number-or-id\}/locations/global` or `projects/{project-number-or-id\}`. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned.
      */
@@ -1200,8 +1246,7 @@ export namespace translate_v3beta1 {
      */
     requestBody?: Schema$DetectLanguageRequest;
   }
-  export interface Params$Resource$Projects$Getsupportedlanguages
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Getsupportedlanguages extends StandardParameters {
     /**
      * Optional. The language to use to return localized, human readable names of supported languages. If missing, then display names are not returned in a response.
      */
@@ -1215,8 +1260,7 @@ export namespace translate_v3beta1 {
      */
     parent?: string;
   }
-  export interface Params$Resource$Projects$Translatetext
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Translatetext extends StandardParameters {
     /**
      * Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id\}` or `projects/{project-number-or-id\}/locations/{location-id\}`. For global calls, use `projects/{project-number-or-id\}/locations/global` or `projects/{project-number-or-id\}`. Non-global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
      */
@@ -1291,6 +1335,7 @@ export namespace translate_v3beta1 {
      *       //   "inputConfigs": [],
      *       //   "models": {},
      *       //   "outputConfig": {},
+     *       //   "pdfNativeOnly": false,
      *       //   "sourceLanguageCode": "my_sourceLanguageCode",
      *       //   "targetLanguageCodes": []
      *       // }
@@ -2039,7 +2084,7 @@ export namespace translate_v3beta1 {
      *
      *   // Do the magic
      *   const res = await translate.projects.locations.list({
-     *     // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
+     *     // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.
      *     extraLocationTypes: 'placeholder-value',
      *     // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
      *     filter: 'placeholder-value',
@@ -2156,6 +2201,156 @@ export namespace translate_v3beta1 {
       }
     }
 
+    /**
+     * Refines the input translated text to improve the quality.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/translate.googleapis.com
+     * // - Login into gcloud by running:
+     * //   ```sh
+     * //   $ gcloud auth application-default login
+     * //   ```
+     * // - Install the npm module by running:
+     * //   ```sh
+     * //   $ npm install googleapis
+     * //   ```
+     *
+     * const {google} = require('googleapis');
+     * const translate = google.translate('v3beta1');
+     *
+     * async function main() {
+     *   const auth = new google.auth.GoogleAuth({
+     *     // Scopes can be specified either as an array or as a single, space-delimited string.
+     *     scopes: [
+     *       'https://www.googleapis.com/auth/cloud-platform',
+     *       'https://www.googleapis.com/auth/cloud-translation',
+     *     ],
+     *   });
+     *
+     *   // Acquire an auth client, and bind it to all future calls
+     *   const authClient = await auth.getClient();
+     *   google.options({auth: authClient});
+     *
+     *   // Do the magic
+     *   const res = await translate.projects.locations.refineText({
+     *     // Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id\}/locations/{location-id\}`. For global calls, use `projects/{project-number-or-id\}/locations/global` or `projects/{project-number-or-id\}`.
+     *     parent: 'projects/my-project/locations/my-location',
+     *
+     *     // Request body metadata
+     *     requestBody: {
+     *       // request body parameters
+     *       // {
+     *       //   "refinementEntries": [],
+     *       //   "sourceLanguageCode": "my_sourceLanguageCode",
+     *       //   "targetLanguageCode": "my_targetLanguageCode"
+     *       // }
+     *     },
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "refinedTranslations": []
+     *   // }
+     * }
+     *
+     * main().catch(e => {
+     *   console.error(e);
+     *   throw e;
+     * });
+     *
+     * ```
+     *
+     * @param params - Parameters for request
+     * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+     * @param callback - Optional callback that handles the response.
+     * @returns A promise if used with async/await, or void if used with a callback.
+     */
+    refineText(
+      params: Params$Resource$Projects$Locations$Refinetext,
+      options: StreamMethodOptions
+    ): Promise<GaxiosResponseWithHTTP2<Readable>>;
+    refineText(
+      params?: Params$Resource$Projects$Locations$Refinetext,
+      options?: MethodOptions
+    ): Promise<GaxiosResponseWithHTTP2<Schema$RefineTextResponse>>;
+    refineText(
+      params: Params$Resource$Projects$Locations$Refinetext,
+      options: StreamMethodOptions | BodyResponseCallback<Readable>,
+      callback: BodyResponseCallback<Readable>
+    ): void;
+    refineText(
+      params: Params$Resource$Projects$Locations$Refinetext,
+      options: MethodOptions | BodyResponseCallback<Schema$RefineTextResponse>,
+      callback: BodyResponseCallback<Schema$RefineTextResponse>
+    ): void;
+    refineText(
+      params: Params$Resource$Projects$Locations$Refinetext,
+      callback: BodyResponseCallback<Schema$RefineTextResponse>
+    ): void;
+    refineText(callback: BodyResponseCallback<Schema$RefineTextResponse>): void;
+    refineText(
+      paramsOrCallback?:
+        | Params$Resource$Projects$Locations$Refinetext
+        | BodyResponseCallback<Schema$RefineTextResponse>
+        | BodyResponseCallback<Readable>,
+      optionsOrCallback?:
+        | MethodOptions
+        | StreamMethodOptions
+        | BodyResponseCallback<Schema$RefineTextResponse>
+        | BodyResponseCallback<Readable>,
+      callback?:
+        | BodyResponseCallback<Schema$RefineTextResponse>
+        | BodyResponseCallback<Readable>
+    ):
+      | void
+      | Promise<GaxiosResponseWithHTTP2<Schema$RefineTextResponse>>
+      | Promise<GaxiosResponseWithHTTP2<Readable>> {
+      let params = (paramsOrCallback ||
+        {}) as Params$Resource$Projects$Locations$Refinetext;
+      let options = (optionsOrCallback || {}) as MethodOptions;
+
+      if (typeof paramsOrCallback === 'function') {
+        callback = paramsOrCallback;
+        params = {} as Params$Resource$Projects$Locations$Refinetext;
+        options = {};
+      }
+
+      if (typeof optionsOrCallback === 'function') {
+        callback = optionsOrCallback;
+        options = {};
+      }
+
+      const rootUrl = options.rootUrl || 'https://translation.googleapis.com/';
+      const parameters = {
+        options: Object.assign(
+          {
+            url: (rootUrl + '/v3beta1/{+parent}:refineText').replace(
+              /([^:]\/)\/+/g,
+              '$1'
+            ),
+            method: 'POST',
+            apiVersion: '',
+          },
+          options
+        ),
+        params,
+        requiredParams: ['parent'],
+        pathParams: ['parent'],
+        context: this.context,
+      };
+      if (callback) {
+        createAPIRequest<Schema$RefineTextResponse>(
+          parameters,
+          callback as BodyResponseCallback<unknown>
+        );
+      } else {
+        return createAPIRequest<Schema$RefineTextResponse>(parameters);
+      }
+    }
+
     /**
      * Translates documents in synchronous mode.
      * @example
@@ -2481,8 +2676,7 @@ export namespace translate_v3beta1 {
     }
   }
 
-  export interface Params$Resource$Projects$Locations$Batchtranslatedocument
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Batchtranslatedocument extends StandardParameters {
     /**
      * Required. Location to make a regional call. Format: `projects/{project-number-or-id\}/locations/{location-id\}`. The `global` location is not supported for batch translation. Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.
      */
@@ -2493,8 +2687,7 @@ export namespace translate_v3beta1 {
      */
     requestBody?: Schema$BatchTranslateDocumentRequest;
   }
-  export interface Params$Resource$Projects$Locations$Batchtranslatetext
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Batchtranslatetext extends StandardParameters {
     /**
      * Required. Location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id\}/locations/{location-id\}`. The `global` location is not supported for batch translation. Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.
      */
@@ -2505,8 +2698,7 @@ export namespace translate_v3beta1 {
      */
     requestBody?: Schema$BatchTranslateTextRequest;
   }
-  export interface Params$Resource$Projects$Locations$Detectlanguage
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Detectlanguage extends StandardParameters {
     /**
      * Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id\}/locations/{location-id\}` or `projects/{project-number-or-id\}`. For global calls, use `projects/{project-number-or-id\}/locations/global` or `projects/{project-number-or-id\}`. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned.
      */
@@ -2517,15 +2709,13 @@ export namespace translate_v3beta1 {
      */
     requestBody?: Schema$DetectLanguageRequest;
   }
-  export interface Params$Resource$Projects$Locations$Get
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Get extends StandardParameters {
     /**
      * Resource name for the location.
      */
     name?: string;
   }
-  export interface Params$Resource$Projects$Locations$Getsupportedlanguages
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Getsupportedlanguages extends StandardParameters {
     /**
      * Optional. The language to use to return localized, human readable names of supported languages. If missing, then display names are not returned in a response.
      */
@@ -2539,10 +2729,9 @@ export namespace translate_v3beta1 {
      */
     parent?: string;
   }
-  export interface Params$Resource$Projects$Locations$List
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$List extends StandardParameters {
     /**
-     * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
+     * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.
      */
     extraLocationTypes?: string[];
     /**
@@ -2562,8 +2751,18 @@ export namespace translate_v3beta1 {
      */
     pageToken?: string;
   }
-  export interface Params$Resource$Projects$Locations$Translatedocument
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Refinetext extends StandardParameters {
+    /**
+     * Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id\}/locations/{location-id\}`. For global calls, use `projects/{project-number-or-id\}/locations/global` or `projects/{project-number-or-id\}`.
+     */
+    parent?: string;
+
+    /**
+     * Request body metadata
+     */
+    requestBody?: Schema$RefineTextRequest;
+  }
+  export interface Params$Resource$Projects$Locations$Translatedocument extends StandardParameters {
     /**
      * Required. Location to make a regional call. Format: `projects/{project-number-or-id\}/locations/{location-id\}`. For global calls, use `projects/{project-number-or-id\}/locations/global`. Non-global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have the same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
      */
@@ -2574,8 +2773,7 @@ export namespace translate_v3beta1 {
      */
     requestBody?: Schema$TranslateDocumentRequest;
   }
-  export interface Params$Resource$Projects$Locations$Translatetext
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Translatetext extends StandardParameters {
     /**
      * Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id\}` or `projects/{project-number-or-id\}/locations/{location-id\}`. For global calls, use `projects/{project-number-or-id\}/locations/global` or `projects/{project-number-or-id\}`. Non-global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
      */
@@ -3185,8 +3383,7 @@ export namespace translate_v3beta1 {
     }
   }
 
-  export interface Params$Resource$Projects$Locations$Glossaries$Create
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Glossaries$Create extends StandardParameters {
     /**
      * Required. The project name.
      */
@@ -3197,22 +3394,19 @@ export namespace translate_v3beta1 {
      */
     requestBody?: Schema$Glossary;
   }
-  export interface Params$Resource$Projects$Locations$Glossaries$Delete
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Glossaries$Delete extends StandardParameters {
     /**
      * Required. The name of the glossary to delete.
      */
     name?: string;
   }
-  export interface Params$Resource$Projects$Locations$Glossaries$Get
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Glossaries$Get extends StandardParameters {
     /**
      * Required. The name of the glossary to retrieve.
      */
     name?: string;
   }
-  export interface Params$Resource$Projects$Locations$Glossaries$List
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Glossaries$List extends StandardParameters {
     /**
      * Optional. Filter specifying constraints of a list operation. Specify the constraint by the format of "key=value", where key must be "src" or "tgt", and the value must be a valid language code. For multiple restrictions, concatenate them by "AND" (uppercase only), such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used here, which means using 'en-US' and 'en' can lead to different results, which depends on the language code you used when you create the glossary. For the unidirectional glossaries, the "src" and "tgt" add restrictions on the source and target language code separately. For the equivalent term set glossaries, the "src" and/or "tgt" add restrictions on the term set. For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional glossaries which exactly match the source language code as "en-US" and the target language code "zh-CN", but all equivalent term set glossaries which contain "en-US" and "zh-CN" in their language set will be picked. If missing, no filtering is performed.
      */
@@ -3699,13 +3893,16 @@ export namespace translate_v3beta1 {
      *     pageSize: 'placeholder-value',
      *     // The standard list page token.
      *     pageToken: 'placeholder-value',
+     *     // 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.
+     *     returnPartialSuccess: 'placeholder-value',
      *   });
      *   console.log(res.data);
      *
      *   // Example response
      *   // {
      *   //   "nextPageToken": "my_nextPageToken",
-     *   //   "operations": []
+     *   //   "operations": [],
+     *   //   "unreachable": []
      *   // }
      * }
      *
@@ -3959,8 +4156,7 @@ export namespace translate_v3beta1 {
     }
   }
 
-  export interface Params$Resource$Projects$Locations$Operations$Cancel
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Operations$Cancel extends StandardParameters {
     /**
      * The name of the operation resource to be cancelled.
      */
@@ -3971,22 +4167,19 @@ export namespace translate_v3beta1 {
      */
     requestBody?: Schema$CancelOperationRequest;
   }
-  export interface Params$Resource$Projects$Locations$Operations$Delete
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Operations$Delete extends StandardParameters {
     /**
      * The name of the operation resource to be deleted.
      */
     name?: string;
   }
-  export interface Params$Resource$Projects$Locations$Operations$Get
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Operations$Get extends StandardParameters {
     /**
      * The name of the operation resource.
      */
     name?: string;
   }
-  export interface Params$Resource$Projects$Locations$Operations$List
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Operations$List extends StandardParameters {
     /**
      * The standard list filter.
      */
@@ -4003,9 +4196,12 @@ export namespace translate_v3beta1 {
      * The standard list page token.
      */
     pageToken?: string;
+    /**
+     * 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.
+     */
+    returnPartialSuccess?: boolean;
   }
-  export interface Params$Resource$Projects$Locations$Operations$Wait
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Operations$Wait extends StandardParameters {
     /**
      * The name of the operation resource to wait on.
      */