-
Notifications
You must be signed in to change notification settings - Fork 260
/
QueryCaptionResult.xml
83 lines (83 loc) · 4.57 KB
/
QueryCaptionResult.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
<Type Name="QueryCaptionResult" FullName="Azure.Search.Documents.Models.QueryCaptionResult">
<TypeSignature Language="C#" Value="public class QueryCaptionResult" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit QueryCaptionResult extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Search.Documents.Models.QueryCaptionResult" />
<TypeSignature Language="VB.NET" Value="Public Class QueryCaptionResult" />
<TypeSignature Language="F#" Value="type QueryCaptionResult = class" />
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.0.0</AssemblyVersion>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type `semantic`. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AdditionalProperties">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyDictionary<string,object> AdditionalProperties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyDictionary`2<string, object> AdditionalProperties" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Models.QueryCaptionResult.AdditionalProperties" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AdditionalProperties As IReadOnlyDictionary(Of String, Object)" />
<MemberSignature Language="F#" Value="member this.AdditionalProperties : System.Collections.Generic.IReadOnlyDictionary<string, obj>" Usage="Azure.Search.Documents.Models.QueryCaptionResult.AdditionalProperties" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyDictionary<System.String,System.Object></ReturnType>
</ReturnValue>
<Docs>
<summary> Additional Properties. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Highlights">
<MemberSignature Language="C#" Value="public string Highlights { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Highlights" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Models.QueryCaptionResult.Highlights" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Highlights As String" />
<MemberSignature Language="F#" Value="member this.Highlights : string" Usage="Azure.Search.Documents.Models.QueryCaptionResult.Highlights" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> Same text passage as in the Text property with highlighted phrases most relevant to the query. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Text">
<MemberSignature Language="C#" Value="public string Text { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Text" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Models.QueryCaptionResult.Text" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Text As String" />
<MemberSignature Language="F#" Value="member this.Text : string" Usage="Azure.Search.Documents.Models.QueryCaptionResult.Text" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> A representative text passage extracted from the document most relevant to the search query. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>