-
Notifications
You must be signed in to change notification settings - Fork 256
/
TextAnalyticsResult.xml
122 lines (122 loc) · 5.93 KB
/
TextAnalyticsResult.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
<Type Name="TextAnalyticsResult" FullName="Azure.AI.TextAnalytics.TextAnalyticsResult">
<TypeSignature Language="C#" Value="public class TextAnalyticsResult" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TextAnalyticsResult extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.AI.TextAnalytics.TextAnalyticsResult" />
<TypeSignature Language="VB.NET" Value="Public Class TextAnalyticsResult" />
<TypeSignature Language="F#" Value="type TextAnalyticsResult = class" />
<AssemblyInfo>
<AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<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>
Base type for results of Text Analytics operations corresponding to a
document. If the operation is unsuccessful, the Id and
Error properties will be populated, but not others.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Error">
<MemberSignature Language="C#" Value="public Azure.AI.TextAnalytics.TextAnalyticsError Error { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.AI.TextAnalytics.TextAnalyticsError Error" />
<MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.TextAnalyticsResult.Error" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Error As TextAnalyticsError" />
<MemberSignature Language="F#" Value="member this.Error : Azure.AI.TextAnalytics.TextAnalyticsError" Usage="Azure.AI.TextAnalytics.TextAnalyticsResult.Error" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
<AssemblyVersion>5.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.TextAnalytics.TextAnalyticsError</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the error explaining why the operation failed on this
document. This property will have a value only when the document
cannot be processed.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasError">
<MemberSignature Language="C#" Value="public bool HasError { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool HasError" />
<MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.TextAnalyticsResult.HasError" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property HasError As Boolean" />
<MemberSignature Language="F#" Value="member this.HasError : bool" Usage="Azure.AI.TextAnalytics.TextAnalyticsResult.HasError" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
<AssemblyVersion>5.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Indicates that the document was not successfully processed and an error was returned for this document.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public string Id { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Id" />
<MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.TextAnalyticsResult.Id" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Id As String" />
<MemberSignature Language="F#" Value="member this.Id : string" Usage="Azure.AI.TextAnalytics.TextAnalyticsResult.Id" />
<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 the unique identifier for the document that generated
the result.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Statistics">
<MemberSignature Language="C#" Value="public Azure.AI.TextAnalytics.TextDocumentStatistics Statistics { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.AI.TextAnalytics.TextDocumentStatistics Statistics" />
<MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.TextAnalyticsResult.Statistics" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Statistics As TextDocumentStatistics" />
<MemberSignature Language="F#" Value="member this.Statistics : Azure.AI.TextAnalytics.TextDocumentStatistics" Usage="Azure.AI.TextAnalytics.TextAnalyticsResult.Statistics" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
<AssemblyVersion>5.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.TextAnalytics.TextDocumentStatistics</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets statistics about the document and how it was processed by
the service. This property will have a value when IncludeStatistics
is set to true in the client call.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>