C# Class Systran.TranslationClientLib.Api.TranslationApi

Represents a collection of functions to interact with the API endpoints
Inheritance: ITranslationApi
ファイルを表示 Open project: SYSTRAN/translation-api-csharp-client Class Usage Examples

Public Methods

Method Description
GetBasePath ( String basePath ) : String

Gets the base path of the API client.

SetBasePath ( String basePath ) : void

Sets the base path of the API client.

TranslationApi ( ApiClient apiClient = null ) : System

Initializes a new instance of the TranslationApi class.

TranslationApi ( String basePath ) : System

Initializes a new instance of the TranslationApi class.

TranslationBatchCancelGet ( string BatchId, string Callback ) : BatchCancel

Batch Cancel Cancel a translation batch\n

TranslationBatchCancelGetAsync ( string BatchId, string Callback ) : Task

Batch Cancel Cancel a translation batch\n

TranslationBatchCloseGet ( string BatchId, string Callback ) : BatchClose

Batch Close Close a translation batch\n

TranslationBatchCloseGetAsync ( string BatchId, string Callback ) : Task

Batch Close Close a translation batch\n

TranslationBatchCreateGet ( string Callback ) : BatchCreate

Batch Create Create a new translation batch\n

TranslationBatchCreateGetAsync ( string Callback ) : Task

Batch Create Create a new translation batch\n

TranslationBatchStatusGet ( string BatchId, string Callback ) : BatchStatus

Batch Status Get the status of a translation batch\n

TranslationBatchStatusGetAsync ( string BatchId, string Callback ) : Task

Batch Status Get the status of a translation batch\n

TranslationProfileGet ( string Source, string Target, List Id, string Callback ) : ProfilesResponse

List of profiles List of profiles available for translation.\n

TranslationProfileGetAsync ( string Source, string Target, List Id, string Callback ) : Task

List of profiles List of profiles available for translation.\n

TranslationSupportedLanguagesGet ( List Source, List Target, string Callback ) : SupportedLanguageResponse

Supported Languages List of language pairs in which translation is supported.\n\nThis list can be limited to a specific source language or target language.\n

TranslationSupportedLanguagesGetAsync ( List Source, List Target, string Callback ) : Task

Supported Languages List of language pairs in which translation is supported.\n\nThis list can be limited to a specific source language or target language.\n

TranslationTranslateCancelGet ( string RequestId, string Callback ) : TranslationCancel

Translate Cancel Cancel an asynchronous translation request\n

TranslationTranslateCancelGetAsync ( string RequestId, string Callback ) : Task

Translate Cancel Cancel an asynchronous translation request\n

TranslationTranslateFileGet ( string Input, string Source, string Target, string Format, int Profile, bool WithSource, bool WithAnnotations, string WithDictionary, string WithCorpus, List Options, string Encoding, bool Async, string BatchId, string Callback ) : TranslationFileResponse

Translate File Translate a file from source language to target language\n\n\n* In asynchronous mode (async=true), the response will be a JSON containing a request identifier. This identifier can then be used to poll the request status and its result when completed.\n\n ```\n {\n \"requestId\": \"54a3d860e62ea467b136eddb\" /* Request identifier to use to get the status,\n the result of the request and to cancel it */\n \"error\": \"\", /* Error at request level */\n }\n ```\n\n* In synchronous mode, the response will be either:\n\n * The **translated document**, directly, if `source` parameters was not `auto` and `withSource` was not true\n * A `multipart/mixed` document with the following parts:\n\n 1. **Detected language**, if request was done with `auto` source language\n\n * Header:\n\n `part-name: detectedLanguage`\n\n * Body: JSON document\n ```\n {\n detectedLanguage: \"string\"\n detectedLanguageConfidence : number\n }\n ```\n\n 2. **Source document**, if request was done with `withSource`:\n\n * Header: `part-name: source`\n * Body: Source document\n\n 3. **Translated document**\n\n * Header: `part-name: output`\n\n * Body: Translated document\n

TranslationTranslateFileGetAsync ( string Input, string Source, string Target, string Format, int Profile, bool WithSource, bool WithAnnotations, string WithDictionary, string WithCorpus, List Options, string Encoding, bool Async, string BatchId, string Callback ) : Task

Translate File Translate a file from source language to target language\n\n\n* In asynchronous mode (async=true), the response will be a JSON containing a request identifier. This identifier can then be used to poll the request status and its result when completed.\n\n ```\n {\n \"requestId\": \"54a3d860e62ea467b136eddb\" /* Request identifier to use to get the status,\n the result of the request and to cancel it */\n \"error\": \"\", /* Error at request level */\n }\n ```\n\n* In synchronous mode, the response will be either:\n\n * The **translated document**, directly, if `source` parameters was not `auto` and `withSource` was not true\n * A `multipart/mixed` document with the following parts:\n\n 1. **Detected language**, if request was done with `auto` source language\n\n * Header:\n\n `part-name: detectedLanguage`\n\n * Body: JSON document\n ```\n {\n detectedLanguage: \"string\"\n detectedLanguageConfidence : number\n }\n ```\n\n 2. **Source document**, if request was done with `withSource`:\n\n * Header: `part-name: source`\n * Body: Source document\n\n 3. **Translated document**\n\n * Header: `part-name: output`\n\n * Body: Translated document\n

TranslationTranslateGet ( List Input, string Source, string Target, string Format, int Profile, bool WithSource, bool WithAnnotations, string WithDictionary, string WithCorpus, bool BackTranslation, List Options, string Encoding, bool Async, string BatchId, string Callback ) : TranslationResponse

Translate Translate text from source language to target language\n

TranslationTranslateGetAsync ( List Input, string Source, string Target, string Format, int Profile, bool WithSource, bool WithAnnotations, string WithDictionary, string WithCorpus, bool BackTranslation, List Options, string Encoding, bool Async, string BatchId, string Callback ) : Task

Translate Translate text from source language to target language\n

TranslationTranslateResultGet ( string RequestId, string Callback ) : String

Translate Result Get the result of an asynchronous translation request\n\nDepending on the initial request, the response can have multiple formats:\n* `/translation/translate` initiated request\n\n → the response will be a JSON document (model below)\n\n* `/translation/translate/file` initiated request\n\n → the response will be either:\n\n * The **translated document**, directly, if `source` parameters was not `auto` and `withSource` was not true\n * A `multipart/mixed` document with the following parts:\n\n 1. **Detected language**, if request was done with `auto` source language\n\n * Header:\n\n `part-name: detectedLanguage`\n\n * Body: JSON document\n ```\n {\n detectedLanguage: \"string\"\n detectedLanguageConfidence : number\n }\n ```\n\n 2. **Source document**, if request was done with `withSource`:\n\n * Header: `part-name: source`\n * Body: Source document\n\n 3. **Translated document**\n\n * Header: `part-name: output`\n\n * Body: Translated document\n\nAn error can occur in the following cases:\n* Invalid request ID\n* No result available (see request status for more information)\n* Unable to retrieve the result\n* ...\n

TranslationTranslateResultGetAsync ( string RequestId, string Callback ) : Task

Translate Result Get the result of an asynchronous translation request\n\nDepending on the initial request, the response can have multiple formats:\n* `/translation/translate` initiated request\n\n → the response will be a JSON document (model below)\n\n* `/translation/translate/file` initiated request\n\n → the response will be either:\n\n * The **translated document**, directly, if `source` parameters was not `auto` and `withSource` was not true\n * A `multipart/mixed` document with the following parts:\n\n 1. **Detected language**, if request was done with `auto` source language\n\n * Header:\n\n `part-name: detectedLanguage`\n\n * Body: JSON document\n ```\n {\n detectedLanguage: \"string\"\n detectedLanguageConfidence : number\n }\n ```\n\n 2. **Source document**, if request was done with `withSource`:\n\n * Header: `part-name: source`\n * Body: Source document\n\n 3. **Translated document**\n\n * Header: `part-name: output`\n\n * Body: Translated document\n\nAn error can occur in the following cases:\n* Invalid request ID\n* No result available (see request status for more information)\n* Unable to retrieve the result\n* ...\n

TranslationTranslateStatusGet ( string RequestId, string Callback ) : TranslationStatus

Translate Status Get the status of an asynchronous translation request\n\nThe translation result is available when the value of the status field is `finished`.\n\nThe translation request is unsuccessful when the value of the status field is `error`.\n

TranslationTranslateStatusGetAsync ( string RequestId, string Callback ) : Task

Translate Status Get the status of an asynchronous translation request\n\nThe translation result is available when the value of the status field is `finished`.\n\nThe translation request is unsuccessful when the value of the status field is `error`.\n

Method Details

GetBasePath() public method

Gets the base path of the API client.
public GetBasePath ( String basePath ) : String
basePath String
return String

SetBasePath() public method

Sets the base path of the API client.
public SetBasePath ( String basePath ) : void
basePath String
return void

TranslationApi() public method

Initializes a new instance of the TranslationApi class.
public TranslationApi ( ApiClient apiClient = null ) : System
apiClient Systran.TranslationClientLib.Client.ApiClient
return System

TranslationApi() public method

Initializes a new instance of the TranslationApi class.
public TranslationApi ( String basePath ) : System
basePath String
return System

TranslationBatchCancelGet() public method

Batch Cancel Cancel a translation batch\n
public TranslationBatchCancelGet ( string BatchId, string Callback ) : BatchCancel
BatchId string Batch Identifier\n
Callback string Javascript callback function name for JSONP Support\n
return Systran.TranslationClientLib.Model.BatchCancel

TranslationBatchCancelGetAsync() public method

Batch Cancel Cancel a translation batch\n
public TranslationBatchCancelGetAsync ( string BatchId, string Callback ) : Task
BatchId string Batch Identifier\n
Callback string Javascript callback function name for JSONP Support\n
return Task

TranslationBatchCloseGet() public method

Batch Close Close a translation batch\n
public TranslationBatchCloseGet ( string BatchId, string Callback ) : BatchClose
BatchId string Batch Identifier\n
Callback string Javascript callback function name for JSONP Support\n
return Systran.TranslationClientLib.Model.BatchClose

TranslationBatchCloseGetAsync() public method

Batch Close Close a translation batch\n
public TranslationBatchCloseGetAsync ( string BatchId, string Callback ) : Task
BatchId string Batch Identifier\n
Callback string Javascript callback function name for JSONP Support\n
return Task

TranslationBatchCreateGet() public method

Batch Create Create a new translation batch\n
public TranslationBatchCreateGet ( string Callback ) : BatchCreate
Callback string Javascript callback function name for JSONP Support\n
return Systran.TranslationClientLib.Model.BatchCreate

TranslationBatchCreateGetAsync() public method

Batch Create Create a new translation batch\n
public TranslationBatchCreateGetAsync ( string Callback ) : Task
Callback string Javascript callback function name for JSONP Support\n
return Task

TranslationBatchStatusGet() public method

Batch Status Get the status of a translation batch\n
public TranslationBatchStatusGet ( string BatchId, string Callback ) : BatchStatus
BatchId string Batch Identifier\n
Callback string Javascript callback function name for JSONP Support\n
return Systran.TranslationClientLib.Model.BatchStatus

TranslationBatchStatusGetAsync() public method

Batch Status Get the status of a translation batch\n
public TranslationBatchStatusGetAsync ( string BatchId, string Callback ) : Task
BatchId string Batch Identifier\n
Callback string Javascript callback function name for JSONP Support\n
return Task

TranslationProfileGet() public method

List of profiles List of profiles available for translation.\n
public TranslationProfileGet ( string Source, string Target, List Id, string Callback ) : ProfilesResponse
Source string Source language code of the profile
Target string Target Language code of the profile\n
Id List Identifier of the profile\n
Callback string Javascript callback function name for JSONP Support\n
return Systran.TranslationClientLib.Model.ProfilesResponse

TranslationProfileGetAsync() public method

List of profiles List of profiles available for translation.\n
public TranslationProfileGetAsync ( string Source, string Target, List Id, string Callback ) : Task
Source string Source language code of the profile
Target string Target Language code of the profile\n
Id List Identifier of the profile\n
Callback string Javascript callback function name for JSONP Support\n
return Task

TranslationSupportedLanguagesGet() public method

Supported Languages List of language pairs in which translation is supported.\n\nThis list can be limited to a specific source language or target language.\n
public TranslationSupportedLanguagesGet ( List Source, List Target, string Callback ) : SupportedLanguageResponse
Source List Language code of the source text\n
Target List Language code into which to translate the source text\n
Callback string Javascript callback function name for JSONP Support\n
return Systran.TranslationClientLib.Model.SupportedLanguageResponse

TranslationSupportedLanguagesGetAsync() public method

Supported Languages List of language pairs in which translation is supported.\n\nThis list can be limited to a specific source language or target language.\n
public TranslationSupportedLanguagesGetAsync ( List Source, List Target, string Callback ) : Task
Source List Language code of the source text\n
Target List Language code into which to translate the source text\n
Callback string Javascript callback function name for JSONP Support\n
return Task

TranslationTranslateCancelGet() public method

Translate Cancel Cancel an asynchronous translation request\n
public TranslationTranslateCancelGet ( string RequestId, string Callback ) : TranslationCancel
RequestId string Request Identifier\n
Callback string Javascript callback function name for JSONP Support\n
return Systran.TranslationClientLib.Model.TranslationCancel

TranslationTranslateCancelGetAsync() public method

Translate Cancel Cancel an asynchronous translation request\n
public TranslationTranslateCancelGetAsync ( string RequestId, string Callback ) : Task
RequestId string Request Identifier\n
Callback string Javascript callback function name for JSONP Support\n
return Task

TranslationTranslateFileGet() public method

Translate File Translate a file from source language to target language\n\n\n* In asynchronous mode (async=true), the response will be a JSON containing a request identifier. This identifier can then be used to poll the request status and its result when completed.\n\n ```\n {\n \"requestId\": \"54a3d860e62ea467b136eddb\" /* Request identifier to use to get the status,\n the result of the request and to cancel it */\n \"error\": \"\", /* Error at request level */\n }\n ```\n\n* In synchronous mode, the response will be either:\n\n * The **translated document**, directly, if `source` parameters was not `auto` and `withSource` was not true\n * A `multipart/mixed` document with the following parts:\n\n 1. **Detected language**, if request was done with `auto` source language\n\n * Header:\n\n `part-name: detectedLanguage`\n\n * Body: JSON document\n ```\n {\n detectedLanguage: \"string\"\n detectedLanguageConfidence : number\n }\n ```\n\n 2. **Source document**, if request was done with `withSource`:\n\n * Header: `part-name: source`\n * Body: Source document\n\n 3. **Translated document**\n\n * Header: `part-name: output`\n\n * Body: Translated document\n
public TranslationTranslateFileGet ( string Input, string Source, string Target, string Format, int Profile, bool WithSource, bool WithAnnotations, string WithDictionary, string WithCorpus, List Options, string Encoding, bool Async, string BatchId, string Callback ) : TranslationFileResponse
Input string Input file\n
Source string Source language code ([details](#description_langage_code_values)) or `auto`.\n\nWhen the value is set to `auto`, the language will be automatically detected, used to enhance the translation, and returned in output.\n
Target string Target language code ([details](#description_langage_code_values))
Format string Format of the source text.\n\nValid values are `text` for plain text, `html` for HTML pages, and `auto` for automatic detection. The MIME type of file format supported by SYSTRAN can also be used (application/vnd.openxmlformats, application/vnd.oasis.opendocument, ...)\n
Profile int Profile id\n
WithSource bool If `true`, the source will also be sent back in the response message. It can be useful when used with the withAnnotations option to align the source document with the translated document\n
WithAnnotations bool If `true`, different annotations will be provided in the translated document. If the option 'withSource' is used, the annotations will also be provided in the source document. It will provide segments, tokens, not found words,...\n
WithDictionary string User Dictionary or/and Normalization Dictionary ids to be applied to the translation result. Each dictionary 'id' has to be separate by a comma.\n
WithCorpus string Corpus to be applied to the translation result. Each corpus 'id' has to be separate by a comma.\n
Options List Additional options.\n\nAn option can be a JSON object containing a set of key/value generic options supported by the translator. It can also be a string with the syntax '<key>:<value>' to pass a key/value generic option to the translator.\n
Encoding string Encoding. `base64` can be useful to send binary documents in the JSON body. Please note that another alternative is to use translateFile\n
Async bool If `true`, the translation is performed asynchronously.\n\nThe \"/translate/status\" service must be used to wait for the completion of the request and the \"translate/result\" service must be used to get the final result. The \"/translate/cancel\" can be used to cancel the request.\n
BatchId string Batch Identifier\n
Callback string Javascript callback function name for JSONP Support\n
return Systran.TranslationClientLib.Model.TranslationFileResponse

TranslationTranslateFileGetAsync() public method

Translate File Translate a file from source language to target language\n\n\n* In asynchronous mode (async=true), the response will be a JSON containing a request identifier. This identifier can then be used to poll the request status and its result when completed.\n\n ```\n {\n \"requestId\": \"54a3d860e62ea467b136eddb\" /* Request identifier to use to get the status,\n the result of the request and to cancel it */\n \"error\": \"\", /* Error at request level */\n }\n ```\n\n* In synchronous mode, the response will be either:\n\n * The **translated document**, directly, if `source` parameters was not `auto` and `withSource` was not true\n * A `multipart/mixed` document with the following parts:\n\n 1. **Detected language**, if request was done with `auto` source language\n\n * Header:\n\n `part-name: detectedLanguage`\n\n * Body: JSON document\n ```\n {\n detectedLanguage: \"string\"\n detectedLanguageConfidence : number\n }\n ```\n\n 2. **Source document**, if request was done with `withSource`:\n\n * Header: `part-name: source`\n * Body: Source document\n\n 3. **Translated document**\n\n * Header: `part-name: output`\n\n * Body: Translated document\n
public TranslationTranslateFileGetAsync ( string Input, string Source, string Target, string Format, int Profile, bool WithSource, bool WithAnnotations, string WithDictionary, string WithCorpus, List Options, string Encoding, bool Async, string BatchId, string Callback ) : Task
Input string Input file\n
Source string Source language code ([details](#description_langage_code_values)) or `auto`.\n\nWhen the value is set to `auto`, the language will be automatically detected, used to enhance the translation, and returned in output.\n
Target string Target language code ([details](#description_langage_code_values))
Format string Format of the source text.\n\nValid values are `text` for plain text, `html` for HTML pages, and `auto` for automatic detection. The MIME type of file format supported by SYSTRAN can also be used (application/vnd.openxmlformats, application/vnd.oasis.opendocument, ...)\n
Profile int Profile id\n
WithSource bool If `true`, the source will also be sent back in the response message. It can be useful when used with the withAnnotations option to align the source document with the translated document\n
WithAnnotations bool If `true`, different annotations will be provided in the translated document. If the option 'withSource' is used, the annotations will also be provided in the source document. It will provide segments, tokens, not found words,...\n
WithDictionary string User Dictionary or/and Normalization Dictionary ids to be applied to the translation result. Each dictionary 'id' has to be separate by a comma.\n
WithCorpus string Corpus to be applied to the translation result. Each corpus 'id' has to be separate by a comma.\n
Options List Additional options.\n\nAn option can be a JSON object containing a set of key/value generic options supported by the translator. It can also be a string with the syntax '<key>:<value>' to pass a key/value generic option to the translator.\n
Encoding string Encoding. `base64` can be useful to send binary documents in the JSON body. Please note that another alternative is to use translateFile\n
Async bool If `true`, the translation is performed asynchronously.\n\nThe \"/translate/status\" service must be used to wait for the completion of the request and the \"translate/result\" service must be used to get the final result. The \"/translate/cancel\" can be used to cancel the request.\n
BatchId string Batch Identifier\n
Callback string Javascript callback function name for JSONP Support\n
return Task

TranslationTranslateGet() public method

Translate Translate text from source language to target language\n
public TranslationTranslateGet ( List Input, string Source, string Target, string Format, int Profile, bool WithSource, bool WithAnnotations, string WithDictionary, string WithCorpus, bool BackTranslation, List Options, string Encoding, bool Async, string BatchId, string Callback ) : TranslationResponse
Input List Input text (this parameter can be repeated)\n
Source string Source language code ([details](#description_langage_code_values)) or `auto`.\n\nWhen the value is set to `auto`, the language will be automatically detected, used to enhance the translation, and returned in output.\n
Target string Target language code ([details](#description_langage_code_values))
Format string Format of the source text.\n\nValid values are `text` for plain text, `html` for HTML pages, and `auto` for automatic detection. The MIME type of file format supported by SYSTRAN can also be used (application/vnd.openxmlformats, application/vnd.oasis.opendocument, ...)\n
Profile int Profile id\n
WithSource bool If `true`, the source will also be sent back in the response message. It can be useful when used with the withAnnotations option to align the source document with the translated document\n
WithAnnotations bool If `true`, different annotations will be provided in the translated document. If the option 'withSource' is used, the annotations will also be provided in the source document. It will provide segments, tokens, not found words,...\n
WithDictionary string User Dictionary or/and Normalization Dictionary ids to be applied to the translation result. Each dictionary 'id' has to be separate by a comma.\n
WithCorpus string Corpus to be applied to the translation result. Each corpus 'id' has to be separate by a comma.\n
BackTranslation bool If `true`, the translated text will be translated back in source language\n
Options List Additional options.\n\nAn option can be a JSON object containing a set of key/value generic options supported by the translator. It can also be a string with the syntax '<key>:<value>' to pass a key/value generic option to the translator.\n
Encoding string Encoding. `base64` can be useful to send binary documents in the JSON body. Please note that another alternative is to use translateFile\n
Async bool If `true`, the translation is performed asynchronously.\n\nThe \"/translate/status\" service must be used to wait for the completion of the request and the \"translate/result\" service must be used to get the final result. The \"/translate/cancel\" can be used to cancel the request.\n
BatchId string Batch Identifier\n
Callback string Javascript callback function name for JSONP Support\n
return Systran.TranslationClientLib.Model.TranslationResponse

TranslationTranslateGetAsync() public method

Translate Translate text from source language to target language\n
public TranslationTranslateGetAsync ( List Input, string Source, string Target, string Format, int Profile, bool WithSource, bool WithAnnotations, string WithDictionary, string WithCorpus, bool BackTranslation, List Options, string Encoding, bool Async, string BatchId, string Callback ) : Task
Input List Input text (this parameter can be repeated)\n
Source string Source language code ([details](#description_langage_code_values)) or `auto`.\n\nWhen the value is set to `auto`, the language will be automatically detected, used to enhance the translation, and returned in output.\n
Target string Target language code ([details](#description_langage_code_values))
Format string Format of the source text.\n\nValid values are `text` for plain text, `html` for HTML pages, and `auto` for automatic detection. The MIME type of file format supported by SYSTRAN can also be used (application/vnd.openxmlformats, application/vnd.oasis.opendocument, ...)\n
Profile int Profile id\n
WithSource bool If `true`, the source will also be sent back in the response message. It can be useful when used with the withAnnotations option to align the source document with the translated document\n
WithAnnotations bool If `true`, different annotations will be provided in the translated document. If the option 'withSource' is used, the annotations will also be provided in the source document. It will provide segments, tokens, not found words,...\n
WithDictionary string User Dictionary or/and Normalization Dictionary ids to be applied to the translation result. Each dictionary 'id' has to be separate by a comma.\n
WithCorpus string Corpus to be applied to the translation result. Each corpus 'id' has to be separate by a comma.\n
BackTranslation bool If `true`, the translated text will be translated back in source language\n
Options List Additional options.\n\nAn option can be a JSON object containing a set of key/value generic options supported by the translator. It can also be a string with the syntax '<key>:<value>' to pass a key/value generic option to the translator.\n
Encoding string Encoding. `base64` can be useful to send binary documents in the JSON body. Please note that another alternative is to use translateFile\n
Async bool If `true`, the translation is performed asynchronously.\n\nThe \"/translate/status\" service must be used to wait for the completion of the request and the \"translate/result\" service must be used to get the final result. The \"/translate/cancel\" can be used to cancel the request.\n
BatchId string Batch Identifier\n
Callback string Javascript callback function name for JSONP Support\n
return Task

TranslationTranslateResultGet() public method

Translate Result Get the result of an asynchronous translation request\n\nDepending on the initial request, the response can have multiple formats:\n* `/translation/translate` initiated request\n\n &#x2192; the response will be a JSON document (model below)\n\n* `/translation/translate/file` initiated request\n\n &#x2192; the response will be either:\n\n * The **translated document**, directly, if `source` parameters was not `auto` and `withSource` was not true\n * A `multipart/mixed` document with the following parts:\n\n 1. **Detected language**, if request was done with `auto` source language\n\n * Header:\n\n `part-name: detectedLanguage`\n\n * Body: JSON document\n ```\n {\n detectedLanguage: \"string\"\n detectedLanguageConfidence : number\n }\n ```\n\n 2. **Source document**, if request was done with `withSource`:\n\n * Header: `part-name: source`\n * Body: Source document\n\n 3. **Translated document**\n\n * Header: `part-name: output`\n\n * Body: Translated document\n\nAn error can occur in the following cases:\n* Invalid request ID\n* No result available (see request status for more information)\n* Unable to retrieve the result\n* ...\n
public TranslationTranslateResultGet ( string RequestId, string Callback ) : String
RequestId string Request Identifier\n
Callback string Javascript callback function name for JSONP Support\n
return String

TranslationTranslateResultGetAsync() public method

Translate Result Get the result of an asynchronous translation request\n\nDepending on the initial request, the response can have multiple formats:\n* `/translation/translate` initiated request\n\n &#x2192; the response will be a JSON document (model below)\n\n* `/translation/translate/file` initiated request\n\n &#x2192; the response will be either:\n\n * The **translated document**, directly, if `source` parameters was not `auto` and `withSource` was not true\n * A `multipart/mixed` document with the following parts:\n\n 1. **Detected language**, if request was done with `auto` source language\n\n * Header:\n\n `part-name: detectedLanguage`\n\n * Body: JSON document\n ```\n {\n detectedLanguage: \"string\"\n detectedLanguageConfidence : number\n }\n ```\n\n 2. **Source document**, if request was done with `withSource`:\n\n * Header: `part-name: source`\n * Body: Source document\n\n 3. **Translated document**\n\n * Header: `part-name: output`\n\n * Body: Translated document\n\nAn error can occur in the following cases:\n* Invalid request ID\n* No result available (see request status for more information)\n* Unable to retrieve the result\n* ...\n
public TranslationTranslateResultGetAsync ( string RequestId, string Callback ) : Task
RequestId string Request Identifier\n
Callback string Javascript callback function name for JSONP Support\n
return Task

TranslationTranslateStatusGet() public method

Translate Status Get the status of an asynchronous translation request\n\nThe translation result is available when the value of the status field is `finished`.\n\nThe translation request is unsuccessful when the value of the status field is `error`.\n
public TranslationTranslateStatusGet ( string RequestId, string Callback ) : TranslationStatus
RequestId string Request Identifier\n
Callback string Javascript callback function name for JSONP Support\n
return Systran.TranslationClientLib.Model.TranslationStatus

TranslationTranslateStatusGetAsync() public method

Translate Status Get the status of an asynchronous translation request\n\nThe translation result is available when the value of the status field is `finished`.\n\nThe translation request is unsuccessful when the value of the status field is `error`.\n
public TranslationTranslateStatusGetAsync ( string RequestId, string Callback ) : Task
RequestId string Request Identifier\n
Callback string Javascript callback function name for JSONP Support\n
return Task