-
Notifications
You must be signed in to change notification settings - Fork 256
/
KeyPhraseExtractionSkill.xml
179 lines (179 loc) · 12.1 KB
/
KeyPhraseExtractionSkill.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
<Type Name="KeyPhraseExtractionSkill" FullName="Microsoft.Azure.Search.Models.KeyPhraseExtractionSkill">
<TypeSignature Language="C#" Value="public class KeyPhraseExtractionSkill : Microsoft.Azure.Search.Models.Skill" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit KeyPhraseExtractionSkill extends Microsoft.Azure.Search.Models.Skill" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.Models.KeyPhraseExtractionSkill" />
<TypeSignature Language="VB.NET" Value="Public Class KeyPhraseExtractionSkill
Inherits Skill" />
<TypeSignature Language="F#" Value="type KeyPhraseExtractionSkill = 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.KeyPhraseExtractionSkill")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonObject("#Microsoft.Skills.Text.KeyPhraseExtractionSkill")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
A skill that uses text analytics for key phrase extraction.
<see href="https://docs.microsoft.com/azure/search/cognitive-search-skill-keyphrases" /></summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public KeyPhraseExtractionSkill ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.KeyPhraseExtractionSkill.#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 KeyPhraseExtractionSkill class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public KeyPhraseExtractionSkill (System.Collections.Generic.IList<Microsoft.Azure.Search.Models.InputFieldMappingEntry> inputs, System.Collections.Generic.IList<Microsoft.Azure.Search.Models.OutputFieldMappingEntry> outputs, string name = default, string description = default, string context = default, Microsoft.Azure.Search.Models.KeyPhraseExtractionSkillLanguage? defaultLanguageCode = default, int? maxKeyPhraseCount = 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, string name, string description, string context, valuetype System.Nullable`1<valuetype Microsoft.Azure.Search.Models.KeyPhraseExtractionSkillLanguage> defaultLanguageCode, valuetype System.Nullable`1<int32> maxKeyPhraseCount) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.KeyPhraseExtractionSkill.#ctor(System.Collections.Generic.IList{Microsoft.Azure.Search.Models.InputFieldMappingEntry},System.Collections.Generic.IList{Microsoft.Azure.Search.Models.OutputFieldMappingEntry},System.String,System.String,System.String,System.Nullable{Microsoft.Azure.Search.Models.KeyPhraseExtractionSkillLanguage},System.Nullable{System.Int32})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (inputs As IList(Of InputFieldMappingEntry), outputs As IList(Of OutputFieldMappingEntry), Optional name As String = Nothing, Optional description As String = Nothing, Optional context As String = Nothing, Optional defaultLanguageCode As Nullable(Of KeyPhraseExtractionSkillLanguage) = Nothing, Optional maxKeyPhraseCount As Nullable(Of Integer) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.KeyPhraseExtractionSkill : System.Collections.Generic.IList<Microsoft.Azure.Search.Models.InputFieldMappingEntry> * System.Collections.Generic.IList<Microsoft.Azure.Search.Models.OutputFieldMappingEntry> * string * string * string * Nullable<Microsoft.Azure.Search.Models.KeyPhraseExtractionSkillLanguage> * Nullable<int> -> Microsoft.Azure.Search.Models.KeyPhraseExtractionSkill" Usage="new Microsoft.Azure.Search.Models.KeyPhraseExtractionSkill (inputs, outputs, name, description, context, defaultLanguageCode, maxKeyPhraseCount)" />
<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="name" Type="System.String" />
<Parameter Name="description" Type="System.String" />
<Parameter Name="context" Type="System.String" />
<Parameter Name="defaultLanguageCode" Type="System.Nullable<Microsoft.Azure.Search.Models.KeyPhraseExtractionSkillLanguage>" />
<Parameter Name="maxKeyPhraseCount" Type="System.Nullable<System.Int32>" />
</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="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="defaultLanguageCode">A value indicating which language
code to use. Default is en. Possible values include: 'da', 'nl',
'en', 'fi', 'fr', 'de', 'it', 'ja', 'ko', 'no', 'pl', 'pt-PT',
'pt-BR', 'ru', 'es', 'sv'</param>
<param name="maxKeyPhraseCount">A number indicating how many key
phrases to return. If absent, all identified key phrases will be
returned.</param>
<summary>
Initializes a new instance of the KeyPhraseExtractionSkill class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DefaultLanguageCode">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Search.Models.KeyPhraseExtractionSkillLanguage? DefaultLanguageCode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Search.Models.KeyPhraseExtractionSkillLanguage> DefaultLanguageCode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.KeyPhraseExtractionSkill.DefaultLanguageCode" />
<MemberSignature Language="VB.NET" Value="Public Property DefaultLanguageCode As Nullable(Of KeyPhraseExtractionSkillLanguage)" />
<MemberSignature Language="F#" Value="member this.DefaultLanguageCode : Nullable<Microsoft.Azure.Search.Models.KeyPhraseExtractionSkillLanguage> with get, set" Usage="Microsoft.Azure.Search.Models.KeyPhraseExtractionSkill.DefaultLanguageCode" />
<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="defaultLanguageCode")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="defaultLanguageCode")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Search.Models.KeyPhraseExtractionSkillLanguage></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value indicating which language code to use. Default
is en. Possible values include: 'da', 'nl', 'en', 'fi', 'fr', 'de',
'it', 'ja', 'ko', 'no', 'pl', 'pt-PT', 'pt-BR', 'ru', 'es', 'sv'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxKeyPhraseCount">
<MemberSignature Language="C#" Value="public int? MaxKeyPhraseCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> MaxKeyPhraseCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.KeyPhraseExtractionSkill.MaxKeyPhraseCount" />
<MemberSignature Language="VB.NET" Value="Public Property MaxKeyPhraseCount As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.MaxKeyPhraseCount : Nullable<int> with get, set" Usage="Microsoft.Azure.Search.Models.KeyPhraseExtractionSkill.MaxKeyPhraseCount" />
<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="maxKeyPhraseCount")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="maxKeyPhraseCount")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a number indicating how many key phrases to return. If
absent, all identified key phrases will be returned.
</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.KeyPhraseExtractionSkill.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Validate ()" />
<MemberSignature Language="F#" Value="override this.Validate : unit -> unit" Usage="keyPhraseExtractionSkill.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>