translates
Creates, updates, deletes, gets or lists a translates resource.
Overview
| Name | translates |
| Type | Resource |
| Id | azure.ai_translation_document.translates |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
translate | exec | targetLanguage, endpoint, document | sourceLanguage, category, allowFallback | Submit a single document translation request to the Document Translation service. Use this API to submit a single translation request to the Document Translation Service. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
endpoint | string | The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: ) |
targetLanguage | string | Specifies the language of the output document. The target language must be one of the supported languages included in the translation scope. For example if you want to translate the document in German language, then use targetLanguage=de. Required. |
allowFallback | boolean | Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. Possible values are: true (default) or false. Default value is None. |
category | string | A string specifying the category (domain) of the translation. This parameter is used to get translations from a customized system built with Custom Translator. Add the Category ID from your Custom Translator project details to this parameter to use your deployed customized system. Default value is: general. Default value is None. |
sourceLanguage | string | Specifies source language of the input document. If this parameter isn't specified, automatic language detection is applied to determine the source language. For example if the source document is written in English, then use sourceLanguage=en. Default value is None. |
Lifecycle Methods
- translate
Submit a single document translation request to the Document Translation service. Use this API to submit a single translation request to the Document Translation Service.
EXEC azure.ai_translation_document.translates.translate
@targetLanguage='{{ targetLanguage }}' --required,
@endpoint='{{ endpoint }}' --required,
@sourceLanguage='{{ sourceLanguage }}',
@category='{{ category }}',
@allowFallback={{ allowFallback }}
@@json=
'{
"document": "{{ document }}",
"glossary": "{{ glossary }}"
}'
;