-
Notifications
You must be signed in to change notification settings - Fork 256
/
MessageTextFileCitationAnnotation.xml
225 lines (225 loc) · 20.7 KB
/
MessageTextFileCitationAnnotation.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
<Type Name="MessageTextFileCitationAnnotation" FullName="Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation">
<TypeSignature Language="C#" Value="public class MessageTextFileCitationAnnotation : Azure.AI.OpenAI.Assistants.MessageTextAnnotation, System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MessageTextFileCitationAnnotation extends Azure.AI.OpenAI.Assistants.MessageTextAnnotation implements class System.ClientModel.Primitives.IJsonModel`1<class Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>, class System.ClientModel.Primitives.IPersistableModel`1<class Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>" />
<TypeSignature Language="DocId" Value="T:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation" />
<TypeSignature Language="VB.NET" Value="Public Class MessageTextFileCitationAnnotation
Inherits MessageTextAnnotation
Implements IJsonModel(Of MessageTextFileCitationAnnotation), IPersistableModel(Of MessageTextFileCitationAnnotation)" />
<TypeSignature Language="F#" Value="type MessageTextFileCitationAnnotation = class
 inherit MessageTextAnnotation
 interface IJsonModel<MessageTextFileCitationAnnotation>
 interface IPersistableModel<MessageTextFileCitationAnnotation>" />
<AssemblyInfo>
<AssemblyName>Azure.AI.OpenAI.Assistants</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.AI.OpenAI.Assistants.MessageTextAnnotation</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation></InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation></InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.ClientModel.Primitives.IPersistableModel<T></InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary> A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="FileId">
<MemberSignature Language="C#" Value="public string FileId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string FileId" />
<MemberSignature Language="DocId" Value="P:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.FileId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property FileId As String" />
<MemberSignature Language="F#" Value="member this.FileId : string" Usage="Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.FileId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.OpenAI.Assistants</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> The ID of the file associated with this citation. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Quote">
<MemberSignature Language="C#" Value="public string Quote { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Quote" />
<MemberSignature Language="DocId" Value="P:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.Quote" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Quote As String" />
<MemberSignature Language="F#" Value="member this.Quote : string" Usage="Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.Quote" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.OpenAI.Assistants</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> The specific quote cited in the associated file. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Create">
<MemberSignature Language="C#" Value="Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation IJsonModel<MessageTextFileCitationAnnotation>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Create(valuetype System.Text.Json.Utf8JsonReader& reader, class System.ClientModel.Primitives.ModelReaderWriterOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.System#ClientModel#Primitives#IJsonModel<Azure#AI#OpenAI#Assistants#MessageTextFileCitationAnnotation>#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)" />
<MemberSignature Language="VB.NET" Value="Function Create (ByRef reader As Utf8JsonReader, options As ModelReaderWriterOptions) As MessageTextFileCitationAnnotation Implements IJsonModel(Of MessageTextFileCitationAnnotation).Create" />
<MemberSignature Language="F#" Value="abstract member System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Create : Utf8JsonReader * System.ClientModel.Primitives.ModelReaderWriterOptions -> Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation
override this.System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Create : Utf8JsonReader * System.ClientModel.Primitives.ModelReaderWriterOptions -> Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation" Usage="messageTextFileCitationAnnotation.System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Create (reader, options)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.ClientModel.Primitives.IJsonModel`1.Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Azure.AI.OpenAI.Assistants</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reader" Type="System.Text.Json.Utf8JsonReader" RefType="ref" />
<Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" />
</Parameters>
<Docs>
<param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param>
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param>
<summary>
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
</summary>
<returns>A <typeparamref name="T" /> representation of the JSON value.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
</Docs>
</Member>
<Member MemberName="System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Write">
<MemberSignature Language="C#" Value="void IJsonModel<MessageTextFileCitationAnnotation>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance void System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Write(class System.Text.Json.Utf8JsonWriter writer, class System.ClientModel.Primitives.ModelReaderWriterOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.System#ClientModel#Primitives#IJsonModel<Azure#AI#OpenAI#Assistants#MessageTextFileCitationAnnotation>#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)" />
<MemberSignature Language="VB.NET" Value="Sub Write (writer As Utf8JsonWriter, options As ModelReaderWriterOptions) Implements IJsonModel(Of MessageTextFileCitationAnnotation).Write" />
<MemberSignature Language="F#" Value="abstract member System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Write : System.Text.Json.Utf8JsonWriter * System.ClientModel.Primitives.ModelReaderWriterOptions -> unit
override this.System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Write : System.Text.Json.Utf8JsonWriter * System.ClientModel.Primitives.ModelReaderWriterOptions -> unit" Usage="messageTextFileCitationAnnotation.System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Write (writer, options)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.ClientModel.Primitives.IJsonModel`1.Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Azure.AI.OpenAI.Assistants</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Text.Json.Utf8JsonWriter" />
<Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" />
</Parameters>
<Docs>
<param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param>
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param>
<summary>
Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
</Docs>
</Member>
<Member MemberName="System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Create">
<MemberSignature Language="C#" Value="Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation IPersistableModel<MessageTextFileCitationAnnotation>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Create(class System.BinaryData data, class System.ClientModel.Primitives.ModelReaderWriterOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.System#ClientModel#Primitives#IPersistableModel<Azure#AI#OpenAI#Assistants#MessageTextFileCitationAnnotation>#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)" />
<MemberSignature Language="VB.NET" Value="Function Create (data As BinaryData, options As ModelReaderWriterOptions) As MessageTextFileCitationAnnotation Implements IPersistableModel(Of MessageTextFileCitationAnnotation).Create" />
<MemberSignature Language="F#" Value="abstract member System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Create : BinaryData * System.ClientModel.Primitives.ModelReaderWriterOptions -> Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation
override this.System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Create : BinaryData * System.ClientModel.Primitives.ModelReaderWriterOptions -> Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation" Usage="messageTextFileCitationAnnotation.System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Create (data, options)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.ClientModel.Primitives.IPersistableModel`1.Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Azure.AI.OpenAI.Assistants</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.BinaryData" />
<Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" />
</Parameters>
<Docs>
<param name="data">The <see cref="T:System.BinaryData" /> to parse.</param>
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param>
<summary>
Converts the provided <see cref="T:System.BinaryData" /> into a model.
</summary>
<returns>A <typeparamref name="T" /> representation of the data.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
</Docs>
</Member>
<Member MemberName="System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.GetFormatFromOptions">
<MemberSignature Language="C#" Value="string IPersistableModel<MessageTextFileCitationAnnotation>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance string System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.GetFormatFromOptions(class System.ClientModel.Primitives.ModelReaderWriterOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.System#ClientModel#Primitives#IPersistableModel<Azure#AI#OpenAI#Assistants#MessageTextFileCitationAnnotation>#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)" />
<MemberSignature Language="VB.NET" Value="Function GetFormatFromOptions (options As ModelReaderWriterOptions) As String Implements IPersistableModel(Of MessageTextFileCitationAnnotation).GetFormatFromOptions" />
<MemberSignature Language="F#" Value="abstract member System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.GetFormatFromOptions : System.ClientModel.Primitives.ModelReaderWriterOptions -> string
override this.System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.GetFormatFromOptions : System.ClientModel.Primitives.ModelReaderWriterOptions -> string" Usage="messageTextFileCitationAnnotation.System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.GetFormatFromOptions options" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.ClientModel.Primitives.IPersistableModel`1.GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Azure.AI.OpenAI.Assistants</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" />
</Parameters>
<Docs>
<param name="options">To be added.</param>
<summary>
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param></summary>
<returns>The format that the model uses when communicating with the serivce.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Write">
<MemberSignature Language="C#" Value="BinaryData IPersistableModel<MessageTextFileCitationAnnotation>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.BinaryData System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Write(class System.ClientModel.Primitives.ModelReaderWriterOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation.System#ClientModel#Primitives#IPersistableModel<Azure#AI#OpenAI#Assistants#MessageTextFileCitationAnnotation>#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)" />
<MemberSignature Language="VB.NET" Value="Function Write (options As ModelReaderWriterOptions) As BinaryData Implements IPersistableModel(Of MessageTextFileCitationAnnotation).Write" />
<MemberSignature Language="F#" Value="abstract member System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Write : System.ClientModel.Primitives.ModelReaderWriterOptions -> BinaryData
override this.System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Write : System.ClientModel.Primitives.ModelReaderWriterOptions -> BinaryData" Usage="messageTextFileCitationAnnotation.System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.MessageTextFileCitationAnnotation>.Write options" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.ClientModel.Primitives.IPersistableModel`1.Write(System.ClientModel.Primitives.ModelReaderWriterOptions)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Azure.AI.OpenAI.Assistants</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.BinaryData</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" />
</Parameters>
<Docs>
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param>
<summary>
Writes the model into a <see cref="T:System.BinaryData" />.
</summary>
<returns>A binary representation of the written model.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
</Docs>
</Member>
</Members>
</Type>