-
Notifications
You must be signed in to change notification settings - Fork 255
/
ExtractKeyPhrasesAction.xml
149 lines (149 loc) · 8.5 KB
/
ExtractKeyPhrasesAction.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
<Type Name="ExtractKeyPhrasesAction" FullName="Azure.AI.TextAnalytics.ExtractKeyPhrasesAction">
<TypeSignature Language="C#" Value="public class ExtractKeyPhrasesAction" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ExtractKeyPhrasesAction extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.AI.TextAnalytics.ExtractKeyPhrasesAction" />
<TypeSignature Language="VB.NET" Value="Public Class ExtractKeyPhrasesAction" />
<TypeSignature Language="F#" Value="type ExtractKeyPhrasesAction = class" />
<AssemblyInfo>
<AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
<AssemblyVersion>5.1.0.0</AssemblyVersion>
<AssemblyVersion>5.1.1.0</AssemblyVersion>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
<AssemblyVersion>5.3.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Configurations that allow callers to specify details about how to execute
an Extract KeyPhrases action in a set of documents.
For example, set model version and disable service logging.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ExtractKeyPhrasesAction ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.ExtractKeyPhrasesAction.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
<AssemblyVersion>5.3.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the <see cref="T:Azure.AI.TextAnalytics.ExtractKeyPhrasesAction" />
class which allows callers to specify details about how to execute
an Extract KeyPhrases action in a set of documents.
For example, set model version and disable service logging.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ExtractKeyPhrasesAction (Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.ExtractKeyPhrasesAction.#ctor(Azure.AI.TextAnalytics.TextAnalyticsRequestOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (options As TextAnalyticsRequestOptions)" />
<MemberSignature Language="F#" Value="new Azure.AI.TextAnalytics.ExtractKeyPhrasesAction : Azure.AI.TextAnalytics.TextAnalyticsRequestOptions -> Azure.AI.TextAnalytics.ExtractKeyPhrasesAction" Usage="new Azure.AI.TextAnalytics.ExtractKeyPhrasesAction options" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
<AssemblyVersion>5.3.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" />
</Parameters>
<Docs>
<param name="options">To be added.</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.AI.TextAnalytics.ExtractKeyPhrasesAction" />
class based on the values of a <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" />.
It sets the <see cref="P:Azure.AI.TextAnalytics.ExtractKeyPhrasesAction.ModelVersion" /> and <see cref="P:Azure.AI.TextAnalytics.ExtractKeyPhrasesAction.DisableServiceLogs" /> properties.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ActionName">
<MemberSignature Language="C#" Value="public string ActionName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ActionName" />
<MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.ExtractKeyPhrasesAction.ActionName" />
<MemberSignature Language="VB.NET" Value="Public Property ActionName As String" />
<MemberSignature Language="F#" Value="member this.ActionName : string with get, set" Usage="Azure.AI.TextAnalytics.ExtractKeyPhrasesAction.ActionName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
<AssemblyVersion>5.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a name for this action. If not provided, the service will generate one.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DisableServiceLogs">
<MemberSignature Language="C#" Value="public bool? DisableServiceLogs { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> DisableServiceLogs" />
<MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.ExtractKeyPhrasesAction.DisableServiceLogs" />
<MemberSignature Language="VB.NET" Value="Public Property DisableServiceLogs As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.DisableServiceLogs : Nullable<bool> with get, set" Usage="Azure.AI.TextAnalytics.ExtractKeyPhrasesAction.DisableServiceLogs" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
<AssemblyVersion>5.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
The default value of this property is 'false'. This means, the Language service logs your input text for 48 hours,
solely to allow for troubleshooting issues.
Setting this property to true, disables input logging and may limit our ability to investigate issues that occur.
<para>
Please see Cognitive Services Compliance and Privacy notes at <see href="https://aka.ms/cs-compliance" /> for additional details,
and Microsoft Responsible AI principles at <see href="https://www.microsoft.com/ai/responsible-ai" />.
</para></summary>
<value>To be added.</value>
<remarks>
This property only applies for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer.
</remarks>
</Docs>
</Member>
<Member MemberName="ModelVersion">
<MemberSignature Language="C#" Value="public string ModelVersion { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ModelVersion" />
<MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.ExtractKeyPhrasesAction.ModelVersion" />
<MemberSignature Language="VB.NET" Value="Public Property ModelVersion As String" />
<MemberSignature Language="F#" Value="member this.ModelVersion : string with get, set" Usage="Azure.AI.TextAnalytics.ExtractKeyPhrasesAction.ModelVersion" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
<AssemblyVersion>5.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value that, if set, indicates the version of the Language service
model that will be used to generate the result. For supported
model versions, see operation-specific documentation, for example:
<see href="https://docs.microsoft.com/azure/cognitive-services/language-service/concepts/model-lifecycle#available-versions" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>