@googleapis/translate 6.0.0 → 7.1.0

package/build/v3.d.ts

@@ -87,7 +87,7 @@ export declare namespace translate_v3 {
          */
         exampleCount?: number | null;
         /**
-         * Required. The resource name of the dataset, in form of `projects/{project-number-or-id\}/locations/{location_id\}/adaptiveMtDatasets/{dataset_id\}`
+         * Identifier. The resource name of the dataset, in form of `projects/{project-number-or-id\}/locations/{location_id\}/adaptiveMtDatasets/{dataset_id\}`
          */
         name?: string | null;
         /**
@@ -120,7 +120,7 @@ export declare namespace translate_v3 {
          */
         entryCount?: number | null;
         /**
-         * Required. The resource name of the file, in form of `projects/{project-number-or-id\}/locations/{location_id\}/adaptiveMtDatasets/{dataset\}/adaptiveMtFiles/{file\}`
+         * Identifier. The resource name of the file, in form of `projects/{project-number-or-id\}/locations/{location_id\}/adaptiveMtDatasets/{dataset\}/adaptiveMtFiles/{file\}`
          */
         name?: string | null;
         /**
@@ -137,7 +137,7 @@ export declare namespace translate_v3 {
          */
         createTime?: string | null;
         /**
-         * Required. The resource name of the file, in form of `projects/{project-number-or-id\}/locations/{location_id\}/adaptiveMtDatasets/{dataset\}/adaptiveMtFiles/{file\}/adaptiveMtSentences/{sentence\}`
+         * Identifier. The resource name of the file, in form of `projects/{project-number-or-id\}/locations/{location_id\}/adaptiveMtDatasets/{dataset\}/adaptiveMtFiles/{file\}/adaptiveMtSentences/{sentence\}`
          */
         name?: string | null;
         /**
@@ -260,12 +260,16 @@ export declare namespace translate_v3 {
          * 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 ISO-639 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 ISO-639 language code to use for translation of the input document. Specify up to 10 language codes here.
+         * Required. The ISO-639 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;
     }
@@ -300,11 +304,11 @@ export declare namespace translate_v3 {
          */
         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;
     }
@@ -397,6 +401,10 @@ export declare namespace translate_v3 {
          * The content of the input stored as a string.
          */
         content?: string | null;
+        /**
+         * Optional. The document configuration of the input.
+         */
+        documentInputConfig?: Schema$DocumentInputConfig;
         /**
          * Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. See https://cloud.google.com/translate/docs/advanced/labels for more information.
          */
@@ -585,7 +593,7 @@ export declare namespace translate_v3 {
          */
         languagePair?: Schema$LanguageCodePair;
         /**
-         * Required. The resource name of the glossary. Glossary names have the form `projects/{project-number-or-id\}/locations/{location-id\}/glossaries/{glossary-id\}`.
+         * Identifier. The resource name of the glossary. Glossary names have the form `projects/{project-number-or-id\}/locations/{location-id\}/glossaries/{glossary-id\}`.
          */
         name?: string | null;
         /**
@@ -750,7 +758,7 @@ export declare namespace translate_v3 {
      */
     export interface Schema$LanguageCodesSet {
         /**
-         * The ISO-639 language code(s) for terms defined in the glossary. All entries are unique. The list contains at least two entries. Expected to be an exact match for GlossaryTerm.language_code.
+         * Optional. The ISO-639 language code(s) for terms defined in the glossary. All entries are unique. The list contains at least two entries. Expected to be an exact match for GlossaryTerm.language_code.
          */
         languageCodes?: string[] | null;
     }
@@ -883,6 +891,10 @@ export declare namespace translate_v3 {
          * 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.
@@ -922,7 +934,7 @@ export declare namespace translate_v3 {
          */
         createTime?: string | null;
         /**
-         * The dataset from which the model is trained, in form of `projects/{project-number-or-id\}/locations/{location_id\}/datasets/{dataset_id\}`
+         * Required. The dataset from which the model is trained, in form of `projects/{project-number-or-id\}/locations/{location_id\}/datasets/{dataset_id\}`
          */
         dataset?: string | null;
         /**
@@ -1035,6 +1047,45 @@ export declare namespace translate_v3 {
          */
         referenceSentencePairs?: Schema$ReferenceSentencePair[];
     }
+    /**
+     * 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;
+    }
     /**
      * A single romanization response.
      */
@@ -1057,7 +1108,7 @@ export declare namespace translate_v3 {
          */
         contents?: string[] | null;
         /**
-         * Optional. The ISO-639 language code of the input text if known, for example, "hi" or "zh". If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language for each content in the response.
+         * Optional. The ISO-639 language code of the input text if known, for example, "hi" or "zh". Supported language codes are listed in [Language Support](https://cloud.google.com/translate/docs/languages#roman). If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language for each content in the response.
          */
         sourceLanguageCode?: string | null;
     }
@@ -1162,11 +1213,11 @@ export declare namespace translate_v3 {
          */
         model?: string | null;
         /**
-         * Optional. The ISO-639 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 ISO-639 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 ISO-639 language code to use for translation of the input document, set to one of the language codes listed in Language Support.
+         * Required. The ISO-639 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;
     }
@@ -1235,11 +1286,11 @@ export declare namespace translate_v3 {
          */
         model?: string | null;
         /**
-         * Optional. The ISO-639 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 ISO-639 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 ISO-639 language code to use for translation of the input text, set to one of the language codes listed in Language Support.
+         * Required. The ISO-639 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;
         /**
@@ -1342,6 +1393,7 @@ export declare namespace translate_v3 {
          *       // request body parameters
          *       // {
          *       //   "content": "my_content",
+         *       //   "documentInputConfig": {},
          *       //   "labels": {},
          *       //   "mimeType": "my_mimeType",
          *       //   "model": "my_model"
@@ -1770,6 +1822,7 @@ export declare namespace translate_v3 {
          *       //   "inputConfigs": [],
          *       //   "models": {},
          *       //   "outputConfig": {},
+         *       //   "pdfNativeOnly": false,
          *       //   "sourceLanguageCode": "my_sourceLanguageCode",
          *       //   "targetLanguageCodes": []
          *       // }
@@ -1928,6 +1981,7 @@ export declare namespace translate_v3 {
          *       // request body parameters
          *       // {
          *       //   "content": "my_content",
+         *       //   "documentInputConfig": {},
          *       //   "labels": {},
          *       //   "mimeType": "my_mimeType",
          *       //   "model": "my_model"
@@ -2128,7 +2182,7 @@ export declare namespace translate_v3 {
          *
          *   // 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',
@@ -2166,6 +2220,79 @@ export declare namespace translate_v3 {
         list(params: Params$Resource$Projects$Locations$List, options: MethodOptions | BodyResponseCallback<Schema$ListLocationsResponse>, callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
         list(params: Params$Resource$Projects$Locations$List, callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
         list(callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
+        /**
+         * 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('v3');
+         *
+         * 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;
         /**
          * Romanize input text written in non-Latin scripts to Latin text.
          * @example
@@ -2464,7 +2591,7 @@ export declare namespace translate_v3 {
     }
     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[];
         /**
@@ -2484,6 +2611,16 @@ export declare namespace translate_v3 {
          */
         pageToken?: string;
     }
+    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$Romanizetext 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\}`.
@@ -4259,9 +4396,9 @@ export declare namespace translate_v3 {
          *
          *   // Do the magic
          *   const res = await translate.projects.locations.glossaries.patch({
-         *     // Required. The resource name of the glossary. Glossary names have the form `projects/{project-number-or-id\}/locations/{location-id\}/glossaries/{glossary-id\}`.
+         *     // Identifier. The resource name of the glossary. Glossary names have the form `projects/{project-number-or-id\}/locations/{location-id\}/glossaries/{glossary-id\}`.
          *     name: 'projects/my-project/locations/my-location/glossaries/my-glossarie',
-         *     // The list of fields to be updated. Currently only `display_name` and 'input_config'
+         *     // The list of fields to be updated. Currently, only `display_name` and `input_config` are supported.
          *     updateMask: 'placeholder-value',
          *
          *     // Request body metadata
@@ -4352,11 +4489,11 @@ export declare namespace translate_v3 {
     }
     export interface Params$Resource$Projects$Locations$Glossaries$Patch extends StandardParameters {
         /**
-         * Required. The resource name of the glossary. Glossary names have the form `projects/{project-number-or-id\}/locations/{location-id\}/glossaries/{glossary-id\}`.
+         * Identifier. The resource name of the glossary. Glossary names have the form `projects/{project-number-or-id\}/locations/{location-id\}/glossaries/{glossary-id\}`.
          */
         name?: string;
         /**
-         * The list of fields to be updated. Currently only `display_name` and 'input_config'
+         * The list of fields to be updated. Currently, only `display_name` and `input_config` are supported.
          */
         updateMask?: string;
         /**
@@ -5348,13 +5485,16 @@ export declare namespace translate_v3 {
          *     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": []
          *   // }
          * }
          *
@@ -5491,6 +5631,10 @@ export declare namespace translate_v3 {
          * 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 {
         /**

package/build/v3.js

@@ -422,6 +422,38 @@ var translate_v3;
                 return (0, googleapis_common_1.createAPIRequest)(parameters);
             }
         }
+        refineText(paramsOrCallback, optionsOrCallback, callback) {
+            let params = (paramsOrCallback ||
+                {});
+            let options = (optionsOrCallback || {});
+            if (typeof paramsOrCallback === 'function') {
+                callback = paramsOrCallback;
+                params = {};
+                options = {};
+            }
+            if (typeof optionsOrCallback === 'function') {
+                callback = optionsOrCallback;
+                options = {};
+            }
+            const rootUrl = options.rootUrl || 'https://translation.googleapis.com/';
+            const parameters = {
+                options: Object.assign({
+                    url: (rootUrl + '/v3/{+parent}:refineText').replace(/([^:]\/)\/+/g, '$1'),
+                    method: 'POST',
+                    apiVersion: '',
+                }, options),
+                params,
+                requiredParams: ['parent'],
+                pathParams: ['parent'],
+                context: this.context,
+            };
+            if (callback) {
+                (0, googleapis_common_1.createAPIRequest)(parameters, callback);
+            }
+            else {
+                return (0, googleapis_common_1.createAPIRequest)(parameters);
+            }
+        }
         romanizeText(paramsOrCallback, optionsOrCallback, callback) {
             let params = (paramsOrCallback ||
                 {});