chore: update docs/dyn , add static discovery files to discovery_cache/documents (#1111)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/78f53313-0c78-4a29-8841-f031665a4c6a/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/translate_v3beta1.projects.locations.html b/docs/dyn/translate_v3beta1.projects.locations.html
index 98538e9..66f7de6 100644
--- a/docs/dyn/translate_v3beta1.projects.locations.html
+++ b/docs/dyn/translate_v3beta1.projects.locations.html
@@ -100,7 +100,7 @@
<code><a href="#getSupportedLanguages">getSupportedLanguages(parent, model=None, displayLanguageCode=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of supported languages for translation.</p>
<p class="toc_element">
- <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists information about the supported locations for this service.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -119,22 +119,19 @@
The object takes the form of:
{ # The batch translation request.
- "sourceLanguageCode": "A String", # Required. Source language code.
"glossaries": { # Optional. Glossaries to be applied for translation. It's keyed by target language code.
"a_key": { # Configures which glossary should be used for a specific target language, and defines options for applying that glossary.
- "glossary": "A String", # Required. Specifies the glossary used for this translation. Use this format: projects/*/locations/*/glossaries/*
"ignoreCase": True or False, # Optional. Indicates match is case-insensitive. Default value is false if missing.
+ "glossary": "A String", # Required. Specifies the glossary used for this translation. Use this format: projects/*/locations/*/glossaries/*
},
},
- "targetLanguageCodes": [ # Required. Specify up to 10 language codes here.
- "A String",
- ],
- "labels": { # 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/labels for more information.
- "a_key": "A String",
- },
"models": { # Optional. The models to use for translation. Map's key is target language code. Map's value is model name. Value can be a built-in general model, or an AutoML Translation model. The value format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, `projects/{project-number-or-id}/locations/{location-id}/models/general/base` If the map is empty or a specific model is not requested for a language pair, then default google model (nmt) is used.
"a_key": "A String",
},
+ "targetLanguageCodes": [ # Required. Specify up to 10 language codes here.
+ "A String",
+ ],
+ "sourceLanguageCode": "A String", # Required. Source language code.
"inputConfigs": [ # Required. Input configurations. The total number of files matched should be <= 1000. The total content size should be <= 100M Unicode codepoints. The files must use UTF-8 encoding.
{ # Input configuration for BatchTranslateText request.
"mimeType": "A String", # Optional. Can be "text/plain" or "text/html". For `.tsv`, "text/html" is used if mime_type is missing. For `.html`, this field must be "text/html" or empty. For `.txt`, this field must be "text/plain" or empty.
@@ -143,6 +140,9 @@
},
},
],
+ "labels": { # 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/labels for more information.
+ "a_key": "A String",
+ },
"outputConfig": { # Output configuration for BatchTranslateText request. # 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.
"gcsDestination": { # The Google Cloud Storage location for the output content. # Google Cloud Storage destination for output content. For every single input file (for example, gs://a/b/c.[extension]), we generate at most 2 * n output files. (n is the # of target_language_codes in the BatchTranslateTextRequest). Output files (tsv) generated are compliant with RFC 4180 except that record delimiters are '\n' instead of '\r\n'. We don't provide any way to change record delimiters. While the input files are being processed, we write/update an index file 'index.csv' under 'output_uri_prefix' (for example, gs://translation-test/index.csv) The index file is generated/updated as new files are being translated. The format is: input_file,target_language_code,translations_file,errors_file, glossary_translations_file,glossary_errors_file input_file is one file we matched using gcs_source.input_uri. target_language_code is provided in the request. translations_file contains the translations. (details provided below) errors_file contains the errors during processing of the file. (details below). Both translations_file and errors_file could be empty strings if we have no content to output. glossary_translations_file and glossary_errors_file are always empty strings if the input_file is tsv. They could also be empty if we have no content to output. Once a row is present in index.csv, the input/output matching never changes. Callers should also expect all the content in input_file are processed and ready to be consumed (that is, no partial output file is written). Since index.csv will be keeping updated during the process, please make sure there is no custom retention policy applied on the output bucket that may avoid file updating. (https://cloud.google.com/storage/docs/bucket-lock?hl=en#retention-policy) The format of translations_file (for target language code 'trg') is: gs://translation_test/a_b_c_'trg'_translations.[extension] If the input file extension is tsv, the output has the following columns: Column 1: ID of the request provided in the input, if it's not provided in the input, then the input row number is used (0-based). Column 2: source sentence. Column 3: translation without applying a glossary. Empty string if there is an error. Column 4 (only present if a glossary is provided in the request): translation after applying the glossary. Empty string if there is an error applying the glossary. Could be same string as column 3 if there is no glossary applied. If input file extension is a txt or html, the translation is directly written to the output file. If glossary is requested, a separate glossary_translations_file has format of gs://translation_test/a_b_c_'trg'_glossary_translations.[extension] The format of errors file (for target language code 'trg') is: gs://translation_test/a_b_c_'trg'_errors.[extension] If the input file extension is tsv, errors_file contains the following: Column 1: ID of the request provided in the input, if it's not provided in the input, then the input row number is used (0-based). Column 2: source sentence. Column 3: Error detail for the translation. Could be empty. Column 4 (only present if a glossary is provided in the request): Error when applying the glossary. If the input file extension is txt or html, glossary_error_file will be generated that contains error details. glossary_error_file has format of gs://translation_test/a_b_c_'trg'_glossary_errors.[extension]
"outputUriPrefix": "A String", # Required. There must be no files under 'output_uri_prefix'. 'output_uri_prefix' must end with "/" and start with "gs://", otherwise an INVALID_ARGUMENT (400) error is returned.
@@ -159,23 +159,23 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "name": "A String", # 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}`.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
"response": { # The normal response of the operation in case of success. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # 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.
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "done": True or False, # 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.
+ "name": "A String", # 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}`.
}</pre>
</div>
@@ -194,12 +194,12 @@
The object takes the form of:
{ # The request message for language detection.
- "content": "A String", # The content of the input stored as a string.
- "model": "A String", # Optional. The language detection model to be used. Format: `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}` Only one language detection model is currently supported: `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default`. If not specified, the default model is used.
"mimeType": "A String", # Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".
"labels": { # 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/labels for more information.
"a_key": "A String",
},
+ "content": "A String", # The content of the input stored as a string.
+ "model": "A String", # Optional. The language detection model to be used. Format: `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}` Only one language detection model is currently supported: `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default`. If not specified, the default model is used.
}
x__xgafv: string, V1 error format.
@@ -213,8 +213,8 @@
{ # The response message for language detection.
"languages": [ # A list of detected languages sorted by detection confidence in descending order. The most probable language first.
{ # The response message for language detection.
- "confidence": 3.14, # The confidence of the detection result for this language.
"languageCode": "A String", # The BCP-47 language code of source content in the request, detected automatically.
+ "confidence": 3.14, # The confidence of the detection result for this language.
},
],
}</pre>
@@ -235,15 +235,15 @@
An object of the form:
{ # A resource that represents Google Cloud Platform location.
- "metadata": { # Service-specific metadata. For example the available capacity at the given location.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
"labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
"a_key": "A String",
},
+ "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
"locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
"displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+ "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>
@@ -267,22 +267,22 @@
"languages": [ # A list of supported language responses. This list contains an entry for each language the Translation API supports.
{ # A single supported language response corresponds to information related to one supported language.
"languageCode": "A String", # Supported language code, generally consisting of its ISO 639-1 identifier, for example, 'en', 'ja'. In certain cases, BCP-47 codes including language and region identifiers are returned (for example, 'zh-TW' and 'zh-CN')
+ "supportTarget": True or False, # Can be used as target language.
"supportSource": True or False, # Can be used as source language.
"displayName": "A String", # Human readable name of the language localized in the display language specified in the request.
- "supportTarget": True or False, # Can be used as target language.
},
],
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists information about the supported locations for this service.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
- pageSize: integer, The standard list page size.
filter: string, The standard list filter.
+ pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
x__xgafv: string, V1 error format.
Allowed values
@@ -296,15 +296,15 @@
"nextPageToken": "A String", # The standard List next-page token.
"locations": [ # A list of locations that matches the specified filter in the request.
{ # A resource that represents Google Cloud Platform location.
- "metadata": { # Service-specific metadata. For example the available capacity at the given location.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
"labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
"a_key": "A String",
},
+ "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
"locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
"displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+ "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
},
],
}</pre>
@@ -334,20 +334,20 @@
The object takes the form of:
{ # The request message for synchronous translation.
- "targetLanguageCode": "A String", # 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.
- "glossaryConfig": { # Configures which glossary should be used for a specific target language, and defines options for applying that glossary. # Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.
- "glossary": "A String", # Required. Specifies the glossary used for this translation. Use this format: projects/*/locations/*/glossaries/*
- "ignoreCase": True or False, # Optional. Indicates match is case-insensitive. Default value is false if missing.
- },
- "labels": { # 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/labels for more information.
- "a_key": "A String",
- },
"contents": [ # Required. The content of the input in string format. We recommend the total content be less than 30k codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.
"A String",
],
- "sourceLanguageCode": "A String", # 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.
"model": "A String", # Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, `projects/{project-number-or-id}/locations/{location-id}/models/general/base` For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If missing, the system decides which google base model to use.
+ "targetLanguageCode": "A String", # 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.
+ "glossaryConfig": { # Configures which glossary should be used for a specific target language, and defines options for applying that glossary. # Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.
+ "ignoreCase": True or False, # Optional. Indicates match is case-insensitive. Default value is false if missing.
+ "glossary": "A String", # Required. Specifies the glossary used for this translation. Use this format: projects/*/locations/*/glossaries/*
+ },
"mimeType": "A String", # Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".
+ "sourceLanguageCode": "A String", # 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.
+ "labels": { # 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/labels for more information.
+ "a_key": "A String",
+ },
}
x__xgafv: string, V1 error format.
@@ -359,26 +359,26 @@
An object of the form:
{
- "glossaryTranslations": [ # Text translation responses if a glossary is provided in the request. This can be the same as `translations` if no terms apply. This field has the same length as `contents`.
- { # A single translation response.
- "translatedText": "A String", # Text translated into the target language.
- "glossaryConfig": { # Configures which glossary should be used for a specific target language, and defines options for applying that glossary. # The `glossary_config` used for this translation.
- "glossary": "A String", # Required. Specifies the glossary used for this translation. Use this format: projects/*/locations/*/glossaries/*
- "ignoreCase": True or False, # Optional. Indicates match is case-insensitive. Default value is false if missing.
- },
- "detectedLanguageCode": "A String", # The BCP-47 language code of source text in the initial request, detected automatically, if no source language was passed within the initial request. If the source language was passed, auto-detection of the language does not occur and this field is empty.
- "model": "A String", # Only present when `model` is present in the request. `model` here is normalized to have project number. For example: If the `model` requested in TranslationTextRequest is `projects/{project-id}/locations/{location-id}/models/general/nmt` then `model` here would be normalized to `projects/{project-number}/locations/{location-id}/models/general/nmt`.
- },
- ],
"translations": [ # Text translation responses with no glossary applied. This field has the same length as `contents`.
{ # A single translation response.
- "translatedText": "A String", # Text translated into the target language.
"glossaryConfig": { # Configures which glossary should be used for a specific target language, and defines options for applying that glossary. # The `glossary_config` used for this translation.
- "glossary": "A String", # Required. Specifies the glossary used for this translation. Use this format: projects/*/locations/*/glossaries/*
"ignoreCase": True or False, # Optional. Indicates match is case-insensitive. Default value is false if missing.
+ "glossary": "A String", # Required. Specifies the glossary used for this translation. Use this format: projects/*/locations/*/glossaries/*
},
"detectedLanguageCode": "A String", # The BCP-47 language code of source text in the initial request, detected automatically, if no source language was passed within the initial request. If the source language was passed, auto-detection of the language does not occur and this field is empty.
"model": "A String", # Only present when `model` is present in the request. `model` here is normalized to have project number. For example: If the `model` requested in TranslationTextRequest is `projects/{project-id}/locations/{location-id}/models/general/nmt` then `model` here would be normalized to `projects/{project-number}/locations/{location-id}/models/general/nmt`.
+ "translatedText": "A String", # Text translated into the target language.
+ },
+ ],
+ "glossaryTranslations": [ # Text translation responses if a glossary is provided in the request. This can be the same as `translations` if no terms apply. This field has the same length as `contents`.
+ { # A single translation response.
+ "glossaryConfig": { # Configures which glossary should be used for a specific target language, and defines options for applying that glossary. # The `glossary_config` used for this translation.
+ "ignoreCase": True or False, # Optional. Indicates match is case-insensitive. Default value is false if missing.
+ "glossary": "A String", # Required. Specifies the glossary used for this translation. Use this format: projects/*/locations/*/glossaries/*
+ },
+ "detectedLanguageCode": "A String", # The BCP-47 language code of source text in the initial request, detected automatically, if no source language was passed within the initial request. If the source language was passed, auto-detection of the language does not occur and this field is empty.
+ "model": "A String", # Only present when `model` is present in the request. `model` here is normalized to have project number. For example: If the `model` requested in TranslationTextRequest is `projects/{project-id}/locations/{location-id}/models/general/nmt` then `model` here would be normalized to `projects/{project-number}/locations/{location-id}/models/general/nmt`.
+ "translatedText": "A String", # Text translated into the target language.
},
],
}</pre>