/
TextTranslationSkill.xml
252 lines (252 loc) · 18 KB
/
TextTranslationSkill.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
<Type Name="TextTranslationSkill" FullName="Microsoft.Azure.Search.Models.TextTranslationSkill">
<TypeSignature Language="C#" Value="public class TextTranslationSkill : Microsoft.Azure.Search.Models.Skill" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TextTranslationSkill extends Microsoft.Azure.Search.Models.Skill" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.Models.TextTranslationSkill" />
<TypeSignature Language="VB.NET" Value="Public Class TextTranslationSkill
Inherits Skill" />
<TypeSignature Language="F#" Value="type TextTranslationSkill = class
 inherit Skill" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Search.Models.Skill</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonObject("#Microsoft.Skills.Text.TranslationSkill")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonObject("#Microsoft.Skills.Text.TranslationSkill")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
A skill to translate text from one language to another.
<see href="https://docs.microsoft.com/azure/search/cognitive-search-skill-text-translation" /></summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TextTranslationSkill ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.TextTranslationSkill.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the TextTranslationSkill class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TextTranslationSkill (System.Collections.Generic.IList<Microsoft.Azure.Search.Models.InputFieldMappingEntry> inputs, System.Collections.Generic.IList<Microsoft.Azure.Search.Models.OutputFieldMappingEntry> outputs, Microsoft.Azure.Search.Models.TextTranslationSkillLanguage defaultToLanguageCode, string name = default, string description = default, string context = default, Microsoft.Azure.Search.Models.TextTranslationSkillLanguage? defaultFromLanguageCode = default, Microsoft.Azure.Search.Models.TextTranslationSkillLanguage? suggestedFrom = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IList`1<class Microsoft.Azure.Search.Models.InputFieldMappingEntry> inputs, class System.Collections.Generic.IList`1<class Microsoft.Azure.Search.Models.OutputFieldMappingEntry> outputs, valuetype Microsoft.Azure.Search.Models.TextTranslationSkillLanguage defaultToLanguageCode, string name, string description, string context, valuetype System.Nullable`1<valuetype Microsoft.Azure.Search.Models.TextTranslationSkillLanguage> defaultFromLanguageCode, valuetype System.Nullable`1<valuetype Microsoft.Azure.Search.Models.TextTranslationSkillLanguage> suggestedFrom) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.TextTranslationSkill.#ctor(System.Collections.Generic.IList{Microsoft.Azure.Search.Models.InputFieldMappingEntry},System.Collections.Generic.IList{Microsoft.Azure.Search.Models.OutputFieldMappingEntry},Microsoft.Azure.Search.Models.TextTranslationSkillLanguage,System.String,System.String,System.String,System.Nullable{Microsoft.Azure.Search.Models.TextTranslationSkillLanguage},System.Nullable{Microsoft.Azure.Search.Models.TextTranslationSkillLanguage})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (inputs As IList(Of InputFieldMappingEntry), outputs As IList(Of OutputFieldMappingEntry), defaultToLanguageCode As TextTranslationSkillLanguage, Optional name As String = Nothing, Optional description As String = Nothing, Optional context As String = Nothing, Optional defaultFromLanguageCode As Nullable(Of TextTranslationSkillLanguage) = Nothing, Optional suggestedFrom As Nullable(Of TextTranslationSkillLanguage) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.TextTranslationSkill : System.Collections.Generic.IList<Microsoft.Azure.Search.Models.InputFieldMappingEntry> * System.Collections.Generic.IList<Microsoft.Azure.Search.Models.OutputFieldMappingEntry> * Microsoft.Azure.Search.Models.TextTranslationSkillLanguage * string * string * string * Nullable<Microsoft.Azure.Search.Models.TextTranslationSkillLanguage> * Nullable<Microsoft.Azure.Search.Models.TextTranslationSkillLanguage> -> Microsoft.Azure.Search.Models.TextTranslationSkill" Usage="new Microsoft.Azure.Search.Models.TextTranslationSkill (inputs, outputs, defaultToLanguageCode, name, description, context, defaultFromLanguageCode, suggestedFrom)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="inputs" Type="System.Collections.Generic.IList<Microsoft.Azure.Search.Models.InputFieldMappingEntry>" />
<Parameter Name="outputs" Type="System.Collections.Generic.IList<Microsoft.Azure.Search.Models.OutputFieldMappingEntry>" />
<Parameter Name="defaultToLanguageCode" Type="Microsoft.Azure.Search.Models.TextTranslationSkillLanguage" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="description" Type="System.String" />
<Parameter Name="context" Type="System.String" />
<Parameter Name="defaultFromLanguageCode" Type="System.Nullable<Microsoft.Azure.Search.Models.TextTranslationSkillLanguage>" />
<Parameter Name="suggestedFrom" Type="System.Nullable<Microsoft.Azure.Search.Models.TextTranslationSkillLanguage>" />
</Parameters>
<Docs>
<param name="inputs">Inputs of the skills could be a column in the
source data set, or the output of an upstream skill.</param>
<param 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.</param>
<param name="defaultToLanguageCode">The language code to translate
documents into for documents that don't specify the to language
explicitly. Possible values include: 'af', 'ar', 'bn', 'bs', 'bg',
'yue', 'ca', 'zh-Hans', 'zh-Hant', 'hr', 'cs', 'da', 'nl', 'en',
'et', 'fj', 'fil', 'fi', 'fr', 'de', 'el', 'ht', 'he', 'hi', 'mww',
'hu', 'is', 'id', 'it', 'ja', 'sw', 'tlh', 'ko', 'lv', 'lt', 'mg',
'ms', 'mt', 'nb', 'fa', 'pl', 'pt', 'otq', 'ro', 'ru', 'sm',
'sr-Cyrl', 'sr-Latn', 'sk', 'sl', 'es', 'sv', 'ty', 'ta', 'te',
'th', 'to', 'tr', 'uk', 'ur', 'vi', 'cy', 'yua'</param>
<param name="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 '#'.</param>
<param name="description">The description of the skill which
describes the inputs, outputs, and usage of the skill.</param>
<param name="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.</param>
<param name="defaultFromLanguageCode">The language code to
translate documents from for documents that don't specify the from
language explicitly. Possible values include: 'af', 'ar', 'bn',
'bs', 'bg', 'yue', 'ca', 'zh-Hans', 'zh-Hant', 'hr', 'cs', 'da',
'nl', 'en', 'et', 'fj', 'fil', 'fi', 'fr', 'de', 'el', 'ht', 'he',
'hi', 'mww', 'hu', 'is', 'id', 'it', 'ja', 'sw', 'tlh', 'ko', 'lv',
'lt', 'mg', 'ms', 'mt', 'nb', 'fa', 'pl', 'pt', 'otq', 'ro', 'ru',
'sm', 'sr-Cyrl', 'sr-Latn', 'sk', 'sl', 'es', 'sv', 'ty', 'ta',
'te', 'th', 'to', 'tr', 'uk', 'ur', 'vi', 'cy', 'yua'</param>
<param name="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. Possible values
include: 'af', 'ar', 'bn', 'bs', 'bg', 'yue', 'ca', 'zh-Hans',
'zh-Hant', 'hr', 'cs', 'da', 'nl', 'en', 'et', 'fj', 'fil', 'fi',
'fr', 'de', 'el', 'ht', 'he', 'hi', 'mww', 'hu', 'is', 'id', 'it',
'ja', 'sw', 'tlh', 'ko', 'lv', 'lt', 'mg', 'ms', 'mt', 'nb', 'fa',
'pl', 'pt', 'otq', 'ro', 'ru', 'sm', 'sr-Cyrl', 'sr-Latn', 'sk',
'sl', 'es', 'sv', 'ty', 'ta', 'te', 'th', 'to', 'tr', 'uk', 'ur',
'vi', 'cy', 'yua'</param>
<summary>
Initializes a new instance of the TextTranslationSkill class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DefaultFromLanguageCode">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Search.Models.TextTranslationSkillLanguage? DefaultFromLanguageCode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Search.Models.TextTranslationSkillLanguage> DefaultFromLanguageCode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.TextTranslationSkill.DefaultFromLanguageCode" />
<MemberSignature Language="VB.NET" Value="Public Property DefaultFromLanguageCode As Nullable(Of TextTranslationSkillLanguage)" />
<MemberSignature Language="F#" Value="member this.DefaultFromLanguageCode : Nullable<Microsoft.Azure.Search.Models.TextTranslationSkillLanguage> with get, set" Usage="Microsoft.Azure.Search.Models.TextTranslationSkill.DefaultFromLanguageCode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="defaultFromLanguageCode")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="defaultFromLanguageCode")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Search.Models.TextTranslationSkillLanguage></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the language code to translate documents from for
documents that don't specify the from language explicitly. Possible
values include: 'af', 'ar', 'bn', 'bs', 'bg', 'yue', 'ca',
'zh-Hans', 'zh-Hant', 'hr', 'cs', 'da', 'nl', 'en', 'et', 'fj',
'fil', 'fi', 'fr', 'de', 'el', 'ht', 'he', 'hi', 'mww', 'hu', 'is',
'id', 'it', 'ja', 'sw', 'tlh', 'ko', 'lv', 'lt', 'mg', 'ms', 'mt',
'nb', 'fa', 'pl', 'pt', 'otq', 'ro', 'ru', 'sm', 'sr-Cyrl',
'sr-Latn', 'sk', 'sl', 'es', 'sv', 'ty', 'ta', 'te', 'th', 'to',
'tr', 'uk', 'ur', 'vi', 'cy', 'yua'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DefaultToLanguageCode">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Search.Models.TextTranslationSkillLanguage DefaultToLanguageCode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Search.Models.TextTranslationSkillLanguage DefaultToLanguageCode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.TextTranslationSkill.DefaultToLanguageCode" />
<MemberSignature Language="VB.NET" Value="Public Property DefaultToLanguageCode As TextTranslationSkillLanguage" />
<MemberSignature Language="F#" Value="member this.DefaultToLanguageCode : Microsoft.Azure.Search.Models.TextTranslationSkillLanguage with get, set" Usage="Microsoft.Azure.Search.Models.TextTranslationSkill.DefaultToLanguageCode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="defaultToLanguageCode")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="defaultToLanguageCode")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.TextTranslationSkillLanguage</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the language code to translate documents into for
documents that don't specify the to language explicitly. Possible
values include: 'af', 'ar', 'bn', 'bs', 'bg', 'yue', 'ca',
'zh-Hans', 'zh-Hant', 'hr', 'cs', 'da', 'nl', 'en', 'et', 'fj',
'fil', 'fi', 'fr', 'de', 'el', 'ht', 'he', 'hi', 'mww', 'hu', 'is',
'id', 'it', 'ja', 'sw', 'tlh', 'ko', 'lv', 'lt', 'mg', 'ms', 'mt',
'nb', 'fa', 'pl', 'pt', 'otq', 'ro', 'ru', 'sm', 'sr-Cyrl',
'sr-Latn', 'sk', 'sl', 'es', 'sv', 'ty', 'ta', 'te', 'th', 'to',
'tr', 'uk', 'ur', 'vi', 'cy', 'yua'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SuggestedFrom">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Search.Models.TextTranslationSkillLanguage? SuggestedFrom { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Search.Models.TextTranslationSkillLanguage> SuggestedFrom" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.TextTranslationSkill.SuggestedFrom" />
<MemberSignature Language="VB.NET" Value="Public Property SuggestedFrom As Nullable(Of TextTranslationSkillLanguage)" />
<MemberSignature Language="F#" Value="member this.SuggestedFrom : Nullable<Microsoft.Azure.Search.Models.TextTranslationSkillLanguage> with get, set" Usage="Microsoft.Azure.Search.Models.TextTranslationSkill.SuggestedFrom" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="suggestedFrom")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="suggestedFrom")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Search.Models.TextTranslationSkillLanguage></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets 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. Possible values include: 'af', 'ar',
'bn', 'bs', 'bg', 'yue', 'ca', 'zh-Hans', 'zh-Hant', 'hr', 'cs',
'da', 'nl', 'en', 'et', 'fj', 'fil', 'fi', 'fr', 'de', 'el', 'ht',
'he', 'hi', 'mww', 'hu', 'is', 'id', 'it', 'ja', 'sw', 'tlh', 'ko',
'lv', 'lt', 'mg', 'ms', 'mt', 'nb', 'fa', 'pl', 'pt', 'otq', 'ro',
'ru', 'sm', 'sr-Cyrl', 'sr-Latn', 'sk', 'sl', 'es', 'sv', 'ty',
'ta', 'te', 'th', 'to', 'tr', 'uk', 'ur', 'vi', 'cy', 'yua'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public override void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.TextTranslationSkill.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Validate ()" />
<MemberSignature Language="F#" Value="override this.Validate : unit -> unit" Usage="textTranslationSkill.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Validate the object.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown if validation fails
</exception>
</Docs>
</Member>
</Members>
</Type>