-
Notifications
You must be signed in to change notification settings - Fork 260
/
QuestionAnsweringModelFactory.xml
226 lines (226 loc) · 21.3 KB
/
QuestionAnsweringModelFactory.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
<Type Name="QuestionAnsweringModelFactory" FullName="Azure.AI.Language.QuestionAnswering.QuestionAnsweringModelFactory">
<TypeSignature Language="C#" Value="public static class QuestionAnsweringModelFactory" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit QuestionAnsweringModelFactory extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.AI.Language.QuestionAnswering.QuestionAnsweringModelFactory" />
<TypeSignature Language="VB.NET" Value="Public Class QuestionAnsweringModelFactory" />
<TypeSignature Language="F#" Value="type QuestionAnsweringModelFactory = class" />
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.QuestionAnswering</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> Model factory for read-only models. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AnswersFromTextResult">
<MemberSignature Language="C#" Value="public static Azure.AI.Language.QuestionAnswering.AnswersFromTextResult AnswersFromTextResult (System.Collections.Generic.IEnumerable<Azure.AI.Language.QuestionAnswering.TextAnswer> answers = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.AI.Language.QuestionAnswering.AnswersFromTextResult AnswersFromTextResult(class System.Collections.Generic.IEnumerable`1<class Azure.AI.Language.QuestionAnswering.TextAnswer> answers) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.QuestionAnswering.QuestionAnsweringModelFactory.AnswersFromTextResult(System.Collections.Generic.IEnumerable{Azure.AI.Language.QuestionAnswering.TextAnswer})" />
<MemberSignature Language="VB.NET" Value="Public Shared Function AnswersFromTextResult (Optional answers As IEnumerable(Of TextAnswer) = Nothing) As AnswersFromTextResult" />
<MemberSignature Language="F#" Value="static member AnswersFromTextResult : seq<Azure.AI.Language.QuestionAnswering.TextAnswer> -> Azure.AI.Language.QuestionAnswering.AnswersFromTextResult" Usage="Azure.AI.Language.QuestionAnswering.QuestionAnsweringModelFactory.AnswersFromTextResult answers" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.QuestionAnswering</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.Language.QuestionAnswering.AnswersFromTextResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="answers" Type="System.Collections.Generic.IEnumerable<Azure.AI.Language.QuestionAnswering.TextAnswer>" />
</Parameters>
<Docs>
<param name="answers"> Represents the answer results. </param>
<summary> Initializes a new instance of AnswersFromTextResult. </summary>
<returns> A new <see cref="T:Azure.AI.Language.QuestionAnswering.AnswersFromTextResult" /> instance for mocking. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AnswerSpan">
<MemberSignature Language="C#" Value="public static Azure.AI.Language.QuestionAnswering.AnswerSpan AnswerSpan (string text = default, double? confidence = default, int? offset = default, int? length = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.AI.Language.QuestionAnswering.AnswerSpan AnswerSpan(string text, valuetype System.Nullable`1<float64> confidence, valuetype System.Nullable`1<int32> offset, valuetype System.Nullable`1<int32> length) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.QuestionAnswering.QuestionAnsweringModelFactory.AnswerSpan(System.String,System.Nullable{System.Double},System.Nullable{System.Int32},System.Nullable{System.Int32})" />
<MemberSignature Language="VB.NET" Value="Public Shared Function AnswerSpan (Optional text As String = Nothing, Optional confidence As Nullable(Of Double) = Nothing, Optional offset As Nullable(Of Integer) = Nothing, Optional length As Nullable(Of Integer) = Nothing) As AnswerSpan" />
<MemberSignature Language="F#" Value="static member AnswerSpan : string * Nullable<double> * Nullable<int> * Nullable<int> -> Azure.AI.Language.QuestionAnswering.AnswerSpan" Usage="Azure.AI.Language.QuestionAnswering.QuestionAnsweringModelFactory.AnswerSpan (text, confidence, offset, length)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.QuestionAnswering</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.Language.QuestionAnswering.AnswerSpan</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
<Parameter Name="confidence" Type="System.Nullable<System.Double>" />
<Parameter Name="offset" Type="System.Nullable<System.Int32>" />
<Parameter Name="length" Type="System.Nullable<System.Int32>" />
</Parameters>
<Docs>
<param name="text"> Predicted text of answer span. </param>
<param name="confidence"> Predicted score of answer span, value ranges from 0 to 1. </param>
<param name="offset"> The answer span offset from the start of answer. </param>
<param name="length"> The length of the answer span. </param>
<summary> Initializes a new instance of AnswerSpan. </summary>
<returns> A new <see cref="T:Azure.AI.Language.QuestionAnswering.AnswerSpan" /> instance for mocking. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AnswersResult">
<MemberSignature Language="C#" Value="public static Azure.AI.Language.QuestionAnswering.AnswersResult AnswersResult (System.Collections.Generic.IEnumerable<Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswer> answers = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.AI.Language.QuestionAnswering.AnswersResult AnswersResult(class System.Collections.Generic.IEnumerable`1<class Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswer> answers) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.QuestionAnswering.QuestionAnsweringModelFactory.AnswersResult(System.Collections.Generic.IEnumerable{Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswer})" />
<MemberSignature Language="VB.NET" Value="Public Shared Function AnswersResult (Optional answers As IEnumerable(Of KnowledgeBaseAnswer) = Nothing) As AnswersResult" />
<MemberSignature Language="F#" Value="static member AnswersResult : seq<Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswer> -> Azure.AI.Language.QuestionAnswering.AnswersResult" Usage="Azure.AI.Language.QuestionAnswering.QuestionAnsweringModelFactory.AnswersResult answers" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.QuestionAnswering</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.Language.QuestionAnswering.AnswersResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="answers" Type="System.Collections.Generic.IEnumerable<Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswer>" />
</Parameters>
<Docs>
<param name="answers"> Represents Answer Result list. </param>
<summary> Initializes a new instance of AnswersResult. </summary>
<returns> A new <see cref="T:Azure.AI.Language.QuestionAnswering.AnswersResult" /> instance for mocking. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="KnowledgeBaseAnswer">
<MemberSignature Language="C#" Value="public static Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswer KnowledgeBaseAnswer (System.Collections.Generic.IEnumerable<string> questions = default, string answer = default, double? confidence = default, int? qnaId = default, string source = default, System.Collections.Generic.IReadOnlyDictionary<string,string> metadata = default, Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerDialog dialog = default, Azure.AI.Language.QuestionAnswering.AnswerSpan shortAnswer = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswer KnowledgeBaseAnswer(class System.Collections.Generic.IEnumerable`1<string> questions, string answer, valuetype System.Nullable`1<float64> confidence, valuetype System.Nullable`1<int32> qnaId, string source, class System.Collections.Generic.IReadOnlyDictionary`2<string, string> metadata, class Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerDialog dialog, class Azure.AI.Language.QuestionAnswering.AnswerSpan shortAnswer) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.QuestionAnswering.QuestionAnsweringModelFactory.KnowledgeBaseAnswer(System.Collections.Generic.IEnumerable{System.String},System.String,System.Nullable{System.Double},System.Nullable{System.Int32},System.String,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerDialog,Azure.AI.Language.QuestionAnswering.AnswerSpan)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function KnowledgeBaseAnswer (Optional questions As IEnumerable(Of String) = Nothing, Optional answer As String = Nothing, Optional confidence As Nullable(Of Double) = Nothing, Optional qnaId As Nullable(Of Integer) = Nothing, Optional source As String = Nothing, Optional metadata As IReadOnlyDictionary(Of String, String) = Nothing, Optional dialog As KnowledgeBaseAnswerDialog = Nothing, Optional shortAnswer As AnswerSpan = Nothing) As KnowledgeBaseAnswer" />
<MemberSignature Language="F#" Value="static member KnowledgeBaseAnswer : seq<string> * string * Nullable<double> * Nullable<int> * string * System.Collections.Generic.IReadOnlyDictionary<string, string> * Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerDialog * Azure.AI.Language.QuestionAnswering.AnswerSpan -> Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswer" Usage="Azure.AI.Language.QuestionAnswering.QuestionAnsweringModelFactory.KnowledgeBaseAnswer (questions, answer, confidence, qnaId, source, metadata, dialog, shortAnswer)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.QuestionAnswering</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswer</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="questions" Type="System.Collections.Generic.IEnumerable<System.String>" />
<Parameter Name="answer" Type="System.String" />
<Parameter Name="confidence" Type="System.Nullable<System.Double>" />
<Parameter Name="qnaId" Type="System.Nullable<System.Int32>" />
<Parameter Name="source" Type="System.String" />
<Parameter Name="metadata" Type="System.Collections.Generic.IReadOnlyDictionary<System.String,System.String>" />
<Parameter Name="dialog" Type="Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerDialog" />
<Parameter Name="shortAnswer" Type="Azure.AI.Language.QuestionAnswering.AnswerSpan" />
</Parameters>
<Docs>
<param name="questions"> List of questions associated with the answer. </param>
<param name="answer"> Answer text. </param>
<param name="confidence"> Answer confidence score, value ranges from 0 to 1. </param>
<param name="qnaId"> ID of the QnA result. </param>
<param name="source"> Source of QnA result. </param>
<param name="metadata"> Metadata associated with the answer, useful to categorize or filter question answers. </param>
<param name="dialog"> Dialog associated with Answer. </param>
<param name="shortAnswer"> Answer span object of QnA with respect to user's question. </param>
<summary> Initializes a new instance of KnowledgeBaseAnswer. </summary>
<returns> A new <see cref="T:Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswer" /> instance for mocking. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="KnowledgeBaseAnswerDialog">
<MemberSignature Language="C#" Value="public static Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerDialog KnowledgeBaseAnswerDialog (bool? isContextOnly = default, System.Collections.Generic.IEnumerable<Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerPrompt> prompts = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerDialog KnowledgeBaseAnswerDialog(valuetype System.Nullable`1<bool> isContextOnly, class System.Collections.Generic.IEnumerable`1<class Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerPrompt> prompts) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.QuestionAnswering.QuestionAnsweringModelFactory.KnowledgeBaseAnswerDialog(System.Nullable{System.Boolean},System.Collections.Generic.IEnumerable{Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerPrompt})" />
<MemberSignature Language="VB.NET" Value="Public Shared Function KnowledgeBaseAnswerDialog (Optional isContextOnly As Nullable(Of Boolean) = Nothing, Optional prompts As IEnumerable(Of KnowledgeBaseAnswerPrompt) = Nothing) As KnowledgeBaseAnswerDialog" />
<MemberSignature Language="F#" Value="static member KnowledgeBaseAnswerDialog : Nullable<bool> * seq<Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerPrompt> -> Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerDialog" Usage="Azure.AI.Language.QuestionAnswering.QuestionAnsweringModelFactory.KnowledgeBaseAnswerDialog (isContextOnly, prompts)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.QuestionAnswering</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerDialog</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="isContextOnly" Type="System.Nullable<System.Boolean>" />
<Parameter Name="prompts" Type="System.Collections.Generic.IEnumerable<Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerPrompt>" />
</Parameters>
<Docs>
<param name="isContextOnly"> To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as search result for queries without context; otherwise, if false, ignores context and includes this QnA in search result. </param>
<param name="prompts"> List of prompts associated with the answer. </param>
<summary> Initializes a new instance of KnowledgeBaseAnswerDialog. </summary>
<returns> A new <see cref="T:Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerDialog" /> instance for mocking. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="KnowledgeBaseAnswerPrompt">
<MemberSignature Language="C#" Value="public static Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerPrompt KnowledgeBaseAnswerPrompt (int? displayOrder = default, int? qnaId = default, string displayText = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerPrompt KnowledgeBaseAnswerPrompt(valuetype System.Nullable`1<int32> displayOrder, valuetype System.Nullable`1<int32> qnaId, string displayText) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.QuestionAnswering.QuestionAnsweringModelFactory.KnowledgeBaseAnswerPrompt(System.Nullable{System.Int32},System.Nullable{System.Int32},System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function KnowledgeBaseAnswerPrompt (Optional displayOrder As Nullable(Of Integer) = Nothing, Optional qnaId As Nullable(Of Integer) = Nothing, Optional displayText As String = Nothing) As KnowledgeBaseAnswerPrompt" />
<MemberSignature Language="F#" Value="static member KnowledgeBaseAnswerPrompt : Nullable<int> * Nullable<int> * string -> Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerPrompt" Usage="Azure.AI.Language.QuestionAnswering.QuestionAnsweringModelFactory.KnowledgeBaseAnswerPrompt (displayOrder, qnaId, displayText)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.QuestionAnswering</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerPrompt</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="displayOrder" Type="System.Nullable<System.Int32>" />
<Parameter Name="qnaId" Type="System.Nullable<System.Int32>" />
<Parameter Name="displayText" Type="System.String" />
</Parameters>
<Docs>
<param name="displayOrder"> Index of the prompt - used in ordering of the prompts. </param>
<param name="qnaId"> QnA ID corresponding to the prompt. </param>
<param name="displayText"> Text displayed to represent a follow up question prompt. </param>
<summary> Initializes a new instance of KnowledgeBaseAnswerPrompt. </summary>
<returns> A new <see cref="T:Azure.AI.Language.QuestionAnswering.KnowledgeBaseAnswerPrompt" /> instance for mocking. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TextAnswer">
<MemberSignature Language="C#" Value="public static Azure.AI.Language.QuestionAnswering.TextAnswer TextAnswer (string answer = default, double? confidence = default, string id = default, Azure.AI.Language.QuestionAnswering.AnswerSpan shortAnswer = default, int? offset = default, int? length = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.AI.Language.QuestionAnswering.TextAnswer TextAnswer(string answer, valuetype System.Nullable`1<float64> confidence, string id, class Azure.AI.Language.QuestionAnswering.AnswerSpan shortAnswer, valuetype System.Nullable`1<int32> offset, valuetype System.Nullable`1<int32> length) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.QuestionAnswering.QuestionAnsweringModelFactory.TextAnswer(System.String,System.Nullable{System.Double},System.String,Azure.AI.Language.QuestionAnswering.AnswerSpan,System.Nullable{System.Int32},System.Nullable{System.Int32})" />
<MemberSignature Language="VB.NET" Value="Public Shared Function TextAnswer (Optional answer As String = Nothing, Optional confidence As Nullable(Of Double) = Nothing, Optional id As String = Nothing, Optional shortAnswer As AnswerSpan = Nothing, Optional offset As Nullable(Of Integer) = Nothing, Optional length As Nullable(Of Integer) = Nothing) As TextAnswer" />
<MemberSignature Language="F#" Value="static member TextAnswer : string * Nullable<double> * string * Azure.AI.Language.QuestionAnswering.AnswerSpan * Nullable<int> * Nullable<int> -> Azure.AI.Language.QuestionAnswering.TextAnswer" Usage="Azure.AI.Language.QuestionAnswering.QuestionAnsweringModelFactory.TextAnswer (answer, confidence, id, shortAnswer, offset, length)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.QuestionAnswering</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.Language.QuestionAnswering.TextAnswer</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="answer" Type="System.String" />
<Parameter Name="confidence" Type="System.Nullable<System.Double>" />
<Parameter Name="id" Type="System.String" />
<Parameter Name="shortAnswer" Type="Azure.AI.Language.QuestionAnswering.AnswerSpan" />
<Parameter Name="offset" Type="System.Nullable<System.Int32>" />
<Parameter Name="length" Type="System.Nullable<System.Int32>" />
</Parameters>
<Docs>
<param name="answer"> Answer. </param>
<param name="confidence"> answer confidence score, value ranges from 0 to 1. </param>
<param name="id"> record ID. </param>
<param name="shortAnswer"> Answer span object with respect to user's question. </param>
<param name="offset"> The sentence offset from the start of the document. </param>
<param name="length"> The length of the sentence. </param>
<summary> Initializes a new instance of TextAnswer. </summary>
<returns> A new <see cref="T:Azure.AI.Language.QuestionAnswering.TextAnswer" /> instance for mocking. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>