TextTranslationSkill interface

Package:

@azure/search-documents

A skill to translate text from one language to another.

Extends

BaseSearchIndexerSkill

Properties

defaultFromLanguageCode	The language code to translate documents from for documents that don't specify the from language explicitly.
defaultToLanguageCode	The language code to translate documents into for documents that don't specify the to language explicitly.
odatatype	Polymorphic discriminator, which specifies the different types this object can be
suggestedFrom	The language code to translate documents from when neither the fromLanguageCode input nor the defaultFromLanguageCode parameter are provided, and the automatic language detection is unsuccessful. Default is en.

Inherited Properties

context	Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document.
description	The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
name	The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'.
outputs	The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill.

Property Details

defaultFromLanguageCode

The language code to translate documents from for documents that don't specify the from language explicitly.

defaultFromLanguageCode?: "da" | "de" | "en" | "es" | "fi" | "fr" | "it" | "ko" | "pt" | "ar" | "cs" | "zh-Hans" | "zh-Hant" | "nl" | "el" | "hu" | "ja" | "pl" | "pt-PT" | "ru" | "sv" | "tr" | "bg" | "bs" | "ca" | "cy" | "et" | "ga" | "he" | "hi" | "hr" | "id" | "lt" | "lv" | "ms" | "nb" | "ro" | "sk" | "sl" | "sr-Cyrl" | "sr-Latn" | "th" | "uk" | "vi" | "af" | "fj" | "fil" | "ht" | "mww" | "is" | "mt" | "mi" | "fa" | "pa" | "sm" | "sw" | "to" | "ur" | "yua" | "pt-br" | "bn" | "yue" | "tlh" | "tlh-Latn" | "tlh-Piqd" | "mg" | "otq" | "ty" | "ta" | "te" | "kn" | "ml"

Property Value

"da" | "de" | "en" | "es" | "fi" | "fr" | "it" | "ko" | "pt" | "ar" | "cs" | "zh-Hans" | "zh-Hant" | "nl" | "el" | "hu" | "ja" | "pl" | "pt-PT" | "ru" | "sv" | "tr" | "bg" | "bs" | "ca" | "cy" | "et" | "ga" | "he" | "hi" | "hr" | "id" | "lt" | "lv" | "ms" | "nb" | "ro" | "sk" | "sl" | "sr-Cyrl" | "sr-Latn" | "th" | "uk" | "vi" | "af" | "fj" | "fil" | "ht" | "mww" | "is" | "mt" | "mi" | "fa" | "pa" | "sm" | "sw" | "to" | "ur" | "yua" | "pt-br" | "bn" | "yue" | "tlh" | "tlh-Latn" | "tlh-Piqd" | "mg" | "otq" | "ty" | "ta" | "te" | "kn" | "ml"

defaultToLanguageCode

The language code to translate documents into for documents that don't specify the to language explicitly.

defaultToLanguageCode: "da" | "de" | "en" | "es" | "fi" | "fr" | "it" | "ko" | "pt" | "ar" | "cs" | "zh-Hans" | "zh-Hant" | "nl" | "el" | "hu" | "ja" | "pl" | "pt-PT" | "ru" | "sv" | "tr" | "bg" | "bs" | "ca" | "cy" | "et" | "ga" | "he" | "hi" | "hr" | "id" | "lt" | "lv" | "ms" | "nb" | "ro" | "sk" | "sl" | "sr-Cyrl" | "sr-Latn" | "th" | "uk" | "vi" | "af" | "fj" | "fil" | "ht" | "mww" | "is" | "mt" | "mi" | "fa" | "pa" | "sm" | "sw" | "to" | "ur" | "yua" | "pt-br" | "bn" | "yue" | "tlh" | "tlh-Latn" | "tlh-Piqd" | "mg" | "otq" | "ty" | "ta" | "te" | "kn" | "ml"

Property Value

"da" | "de" | "en" | "es" | "fi" | "fr" | "it" | "ko" | "pt" | "ar" | "cs" | "zh-Hans" | "zh-Hant" | "nl" | "el" | "hu" | "ja" | "pl" | "pt-PT" | "ru" | "sv" | "tr" | "bg" | "bs" | "ca" | "cy" | "et" | "ga" | "he" | "hi" | "hr" | "id" | "lt" | "lv" | "ms" | "nb" | "ro" | "sk" | "sl" | "sr-Cyrl" | "sr-Latn" | "th" | "uk" | "vi" | "af" | "fj" | "fil" | "ht" | "mww" | "is" | "mt" | "mi" | "fa" | "pa" | "sm" | "sw" | "to" | "ur" | "yua" | "pt-br" | "bn" | "yue" | "tlh" | "tlh-Latn" | "tlh-Piqd" | "mg" | "otq" | "ty" | "ta" | "te" | "kn" | "ml"

odatatype

Polymorphic discriminator, which specifies the different types this object can be

odatatype: "#Microsoft.Skills.Text.TranslationSkill"

Property Value

"#Microsoft.Skills.Text.TranslationSkill"

suggestedFrom

The language code to translate documents from when neither the fromLanguageCode input nor the defaultFromLanguageCode parameter are provided, and the automatic language detection is unsuccessful. Default is en.

suggestedFrom?: "da" | "de" | "en" | "es" | "fi" | "fr" | "it" | "ko" | "pt" | "ar" | "cs" | "zh-Hans" | "zh-Hant" | "nl" | "el" | "hu" | "ja" | "pl" | "pt-PT" | "ru" | "sv" | "tr" | "bg" | "bs" | "ca" | "cy" | "et" | "ga" | "he" | "hi" | "hr" | "id" | "lt" | "lv" | "ms" | "nb" | "ro" | "sk" | "sl" | "sr-Cyrl" | "sr-Latn" | "th" | "uk" | "vi" | "af" | "fj" | "fil" | "ht" | "mww" | "is" | "mt" | "mi" | "fa" | "pa" | "sm" | "sw" | "to" | "ur" | "yua" | "pt-br" | "bn" | "yue" | "tlh" | "tlh-Latn" | "tlh-Piqd" | "mg" | "otq" | "ty" | "ta" | "te" | "kn" | "ml"

Property Value

"da" | "de" | "en" | "es" | "fi" | "fr" | "it" | "ko" | "pt" | "ar" | "cs" | "zh-Hans" | "zh-Hant" | "nl" | "el" | "hu" | "ja" | "pl" | "pt-PT" | "ru" | "sv" | "tr" | "bg" | "bs" | "ca" | "cy" | "et" | "ga" | "he" | "hi" | "hr" | "id" | "lt" | "lv" | "ms" | "nb" | "ro" | "sk" | "sl" | "sr-Cyrl" | "sr-Latn" | "th" | "uk" | "vi" | "af" | "fj" | "fil" | "ht" | "mww" | "is" | "mt" | "mi" | "fa" | "pa" | "sm" | "sw" | "to" | "ur" | "yua" | "pt-br" | "bn" | "yue" | "tlh" | "tlh-Latn" | "tlh-Piqd" | "mg" | "otq" | "ty" | "ta" | "te" | "kn" | "ml"

Inherited Property Details

context

Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document.

context?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.context

description

The description of the skill which describes the inputs, outputs, and usage of the skill.

description?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.description

inputs

Inputs of the skills could be a column in the source data set, or the output of an upstream skill.

inputs: InputFieldMappingEntry[]

Property Value

InputFieldMappingEntry[]

Inherited From BaseSearchIndexerSkill.inputs

name

The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'.

name?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.name

outputs

The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill.

outputs: OutputFieldMappingEntry[]

Property Value

OutputFieldMappingEntry[]

Inherited From BaseSearchIndexerSkill.outputs