-
Notifications
You must be signed in to change notification settings - Fork 255
/
SearchClient.xml
1873 lines (1873 loc) · 131 KB
/
SearchClient.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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<Type Name="SearchClient" FullName="Azure.Search.Documents.SearchClient">
<TypeSignature Language="C#" Value="public class SearchClient" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SearchClient extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Search.Documents.SearchClient" />
<TypeSignature Language="VB.NET" Value="Public Class SearchClient" />
<TypeSignature Language="F#" Value="type SearchClient = class" />
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.2.0.0</AssemblyVersion>
<AssemblyVersion>11.2.1.0</AssemblyVersion>
<AssemblyVersion>11.3.0.0</AssemblyVersion>
<AssemblyVersion>11.4.0.0</AssemblyVersion>
<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>
Azure Cognitive Search client that can be used to query an index and
upload, merge, or delete documents.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected SearchClient ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.SearchClient.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the SearchClient class for
mocking.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SearchClient (Uri endpoint, string indexName, Azure.AzureKeyCredential credential);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, string indexName, class Azure.AzureKeyCredential credential) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.SearchClient.#ctor(System.Uri,System.String,Azure.AzureKeyCredential)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, indexName As String, credential As AzureKeyCredential)" />
<MemberSignature Language="F#" Value="new Azure.Search.Documents.SearchClient : Uri * string * Azure.AzureKeyCredential -> Azure.Search.Documents.SearchClient" Usage="new Azure.Search.Documents.SearchClient (endpoint, indexName, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="indexName" Type="System.String" />
<Parameter Name="credential" Type="Azure.AzureKeyCredential" />
</Parameters>
<Docs>
<param name="endpoint">
Required. The URI endpoint of the Search Service. This is likely
to be similar to "https://{search_service}.search.windows.net".
The URI must use HTTPS.
</param>
<param name="indexName">
Required. The name of the Search Index.
</param>
<param name="credential">
Required. The API key credential used to authenticate requests
against the search service. You need to use an admin key to
modify the documents in a Search Index. See
<see href="https://docs.microsoft.com/azure/search/search-security-api-keys">Create and manage api-keys for an Azure Cognitive Search service</see>
for more information about API keys in Azure Cognitive Search.
</param>
<summary>
Initializes a new instance of the SearchClient class for
querying an index and uploading, merging, or deleting documents.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
Thrown when the <paramref name="endpoint" />,
<paramref name="indexName" />, or <paramref name="credential" /> is
null.
</exception>
<exception cref="T:System.ArgumentException">
Thrown when the <paramref name="endpoint" /> is not using HTTPS or
the <paramref name="indexName" /> is empty.
</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SearchClient (Uri endpoint, string indexName, Azure.Core.TokenCredential tokenCredential);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, string indexName, class Azure.Core.TokenCredential tokenCredential) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.SearchClient.#ctor(System.Uri,System.String,Azure.Core.TokenCredential)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, indexName As String, tokenCredential As TokenCredential)" />
<MemberSignature Language="F#" Value="new Azure.Search.Documents.SearchClient : Uri * string * Azure.Core.TokenCredential -> Azure.Search.Documents.SearchClient" Usage="new Azure.Search.Documents.SearchClient (endpoint, indexName, tokenCredential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="indexName" Type="System.String" />
<Parameter Name="tokenCredential" Type="Azure.Core.TokenCredential" />
</Parameters>
<Docs>
<param name="endpoint">
Required. The URI endpoint of the Search Service. This is likely
to be similar to "https://{search_service}.search.windows.net".
The URI must use HTTPS.
</param>
<param name="indexName">
Required. The name of the Search Index.
</param>
<param name="tokenCredential">
Required. The token credential used to authenticate requests against the Search service.
See <see href="https://docs.microsoft.com/azure/search/search-security-rbac">Use role-based authorization in Azure Cognitive Search</see> for
more information about role-based authorization in Azure Cognitive Search.
</param>
<summary>
Initializes a new instance of the SearchClient class for
querying an index and uploading, merging, or deleting documents.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
Thrown when the <paramref name="endpoint" />,
<paramref name="indexName" />, or <paramref name="tokenCredential" /> is
null.
</exception>
<exception cref="T:System.ArgumentException">
Thrown when the <paramref name="endpoint" /> is not using HTTPS or
the <paramref name="indexName" /> is empty.
</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SearchClient (Uri endpoint, string indexName, Azure.AzureKeyCredential credential, Azure.Search.Documents.SearchClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, string indexName, class Azure.AzureKeyCredential credential, class Azure.Search.Documents.SearchClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.SearchClient.#ctor(System.Uri,System.String,Azure.AzureKeyCredential,Azure.Search.Documents.SearchClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, indexName As String, credential As AzureKeyCredential, options As SearchClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.Search.Documents.SearchClient : Uri * string * Azure.AzureKeyCredential * Azure.Search.Documents.SearchClientOptions -> Azure.Search.Documents.SearchClient" Usage="new Azure.Search.Documents.SearchClient (endpoint, indexName, credential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="indexName" Type="System.String" />
<Parameter Name="credential" Type="Azure.AzureKeyCredential" />
<Parameter Name="options" Type="Azure.Search.Documents.SearchClientOptions" />
</Parameters>
<Docs>
<param name="endpoint">
Required. The URI endpoint of the Search Service. This is likely
to be similar to "https://{search_service}.search.windows.net".
The URI must use HTTPS.
</param>
<param name="indexName">
Required. The name of the Search Index.
</param>
<param name="credential">
Required. The API key credential used to authenticate requests
against the search service. You need to use an admin key to
modify the documents in a Search Index. See
<see href="https://docs.microsoft.com/azure/search/search-security-api-keys">Create and manage api-keys for an Azure Cognitive Search service</see>
for more information about API keys in Azure Cognitive Search.
</param>
<param name="options">
Client configuration options for connecting to Azure Cognitive
Search.
</param>
<summary>
Initializes a new instance of the SearchClient class for
querying an index and uploading, merging, or deleting documents.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
Thrown when the <paramref name="endpoint" />,
<paramref name="indexName" />, or <paramref name="credential" /> is
null.
</exception>
<exception cref="T:System.ArgumentException">
Thrown when the <paramref name="endpoint" /> is not using HTTPS or
the <paramref name="indexName" /> is empty.
</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SearchClient (Uri endpoint, string indexName, Azure.Core.TokenCredential tokenCredential, Azure.Search.Documents.SearchClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, string indexName, class Azure.Core.TokenCredential tokenCredential, class Azure.Search.Documents.SearchClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.SearchClient.#ctor(System.Uri,System.String,Azure.Core.TokenCredential,Azure.Search.Documents.SearchClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, indexName As String, tokenCredential As TokenCredential, options As SearchClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.Search.Documents.SearchClient : Uri * string * Azure.Core.TokenCredential * Azure.Search.Documents.SearchClientOptions -> Azure.Search.Documents.SearchClient" Usage="new Azure.Search.Documents.SearchClient (endpoint, indexName, tokenCredential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="indexName" Type="System.String" />
<Parameter Name="tokenCredential" Type="Azure.Core.TokenCredential" />
<Parameter Name="options" Type="Azure.Search.Documents.SearchClientOptions" />
</Parameters>
<Docs>
<param name="endpoint">
Required. The URI endpoint of the Search Service. This is likely
to be similar to "https://{search_service}.search.windows.net".
The URI must use HTTPS.
</param>
<param name="indexName">
Required. The name of the Search Index.
</param>
<param name="tokenCredential">
Required. The token credential used to authenticate requests against the Search service.
See <see href="https://docs.microsoft.com/azure/search/search-security-rbac">Use role-based authorization in Azure Cognitive Search</see> for
more information about role-based authorization in Azure Cognitive Search.
</param>
<param name="options">
Client configuration options for connecting to Azure Cognitive
Search.
</param>
<summary>
Initializes a new instance of the SearchClient class for
querying an index and uploading, merging, or deleting documents.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
Thrown when the <paramref name="endpoint" />,
<paramref name="indexName" />, or <paramref name="tokenCredential" /> is
null.
</exception>
<exception cref="T:System.ArgumentException">
Thrown when the <paramref name="endpoint" /> is not using HTTPS or
the <paramref name="indexName" /> is empty.
</exception>
</Docs>
</Member>
<Member MemberName="Autocomplete">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Search.Documents.Models.AutocompleteResults> Autocomplete (string searchText, string suggesterName, Azure.Search.Documents.AutocompleteOptions options = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Search.Documents.Models.AutocompleteResults> Autocomplete(string searchText, string suggesterName, class Azure.Search.Documents.AutocompleteOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.SearchClient.Autocomplete(System.String,System.String,Azure.Search.Documents.AutocompleteOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function Autocomplete (searchText As String, suggesterName As String, Optional options As AutocompleteOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AutocompleteResults)" />
<MemberSignature Language="F#" Value="abstract member Autocomplete : string * string * Azure.Search.Documents.AutocompleteOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Models.AutocompleteResults>
override this.Autocomplete : string * string * Azure.Search.Documents.AutocompleteOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Models.AutocompleteResults>" Usage="searchClient.Autocomplete (searchText, suggesterName, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Search.Documents.Models.AutocompleteResults></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="searchText" Type="System.String" />
<Parameter Name="suggesterName" Type="System.String" />
<Parameter Name="options" Type="Azure.Search.Documents.AutocompleteOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="searchText">
The search text on which to base autocomplete results.
</param>
<param name="suggesterName">
The name of the suggester as specified in the suggesters collection
that's part of the index definition.
</param>
<param name="options">
Options that allow specifying autocomplete behaviors, like fuzzy
matching.
</param>
<param name="cancellationToken">
Optional <see cref="T:System.Threading.CancellationToken" /> to propagate notifications
that the operation should be canceled.
</param>
<summary>
Suggests query terms based on input text and matching documents in
the search index.
<see href="https://docs.microsoft.com/rest/api/searchservice/autocomplete">Autocomplete</see></summary>
<returns>The result of Autocomplete query.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException">
Thrown when a failure is returned by the Search Service.
</exception>
</Docs>
</Member>
<Member MemberName="AutocompleteAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.AutocompleteResults>> AutocompleteAsync (string searchText, string suggesterName, Azure.Search.Documents.AutocompleteOptions options = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Search.Documents.Models.AutocompleteResults>> AutocompleteAsync(string searchText, string suggesterName, class Azure.Search.Documents.AutocompleteOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.SearchClient.AutocompleteAsync(System.String,System.String,Azure.Search.Documents.AutocompleteOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AutocompleteAsync (searchText As String, suggesterName As String, Optional options As AutocompleteOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AutocompleteResults))" />
<MemberSignature Language="F#" Value="abstract member AutocompleteAsync : string * string * Azure.Search.Documents.AutocompleteOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.AutocompleteResults>>
override this.AutocompleteAsync : string * string * Azure.Search.Documents.AutocompleteOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.AutocompleteResults>>" Usage="searchClient.AutocompleteAsync (searchText, suggesterName, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.AutocompleteResults>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="searchText" Type="System.String" />
<Parameter Name="suggesterName" Type="System.String" />
<Parameter Name="options" Type="Azure.Search.Documents.AutocompleteOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="searchText">
The search text on which to base autocomplete results.
</param>
<param name="suggesterName">
The name of the suggester as specified in the suggesters collection
that's part of the index definition.
</param>
<param name="options">
Options that allow specifying autocomplete behaviors, like fuzzy
matching.
</param>
<param name="cancellationToken">
Optional <see cref="T:System.Threading.CancellationToken" /> to propagate notifications
that the operation should be canceled.
</param>
<summary>
Suggests query terms based on input text and matching documents in
the search index.
<see href="https://docs.microsoft.com/rest/api/searchservice/autocomplete">Autocomplete</see></summary>
<returns>The result of Autocomplete query.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException">
Thrown when a failure is returned by the Search Service.
</exception>
</Docs>
</Member>
<Member MemberName="DeleteDocuments">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult> DeleteDocuments (string keyName, System.Collections.Generic.IEnumerable<string> keyValues, Azure.Search.Documents.IndexDocumentsOptions options = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Search.Documents.Models.IndexDocumentsResult> DeleteDocuments(string keyName, class System.Collections.Generic.IEnumerable`1<string> keyValues, class Azure.Search.Documents.IndexDocumentsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.SearchClient.DeleteDocuments(System.String,System.Collections.Generic.IEnumerable{System.String},Azure.Search.Documents.IndexDocumentsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteDocuments (keyName As String, keyValues As IEnumerable(Of String), Optional options As IndexDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IndexDocumentsResult)" />
<MemberSignature Language="F#" Value="abstract member DeleteDocuments : string * seq<string> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>
override this.DeleteDocuments : string * seq<string> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>" Usage="searchClient.DeleteDocuments (keyName, keyValues, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="keyName" Type="System.String" />
<Parameter Name="keyValues" Type="System.Collections.Generic.IEnumerable<System.String>" />
<Parameter Name="options" Type="Azure.Search.Documents.IndexDocumentsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="keyName">
The name of the key field that uniquely identifies documents in
the index.
</param>
<param name="keyValues">
The keys of the documents to delete.
</param>
<param name="options">
Options that allow specifying document indexing behavior.
</param>
<param name="cancellationToken">
Optional <see cref="T:System.Threading.CancellationToken" /> to propagate notifications
that the operation should be canceled.
</param>
<summary>
Delete documents from the index as a batch given only their keys.
</summary>
<returns>
Response containing the status of operations for all actions in the
batch of actions.
</returns>
<remarks>
<para>
By default, an exception will only be thrown if the entire request
fails. Individual failures are described in the
<see cref="P:Azure.Search.Documents.Models.IndexDocumentsResult.Results" /> collection. You can set
<see cref="P:Azure.Search.Documents.IndexDocumentsOptions.ThrowOnAnyError" /> if you want
exceptions thrown on partial failure.
</para>
</remarks>
<exception cref="T:Azure.RequestFailedException">
Thrown when a failure is returned by the Search Service.
</exception>
</Docs>
</Member>
<Member MemberName="DeleteDocuments<T>">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult> DeleteDocuments<T> (System.Collections.Generic.IEnumerable<T> documents, Azure.Search.Documents.IndexDocumentsOptions options = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Search.Documents.Models.IndexDocumentsResult> DeleteDocuments<T>(class System.Collections.Generic.IEnumerable`1<!!T> documents, class Azure.Search.Documents.IndexDocumentsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.SearchClient.DeleteDocuments``1(System.Collections.Generic.IEnumerable{``0},Azure.Search.Documents.IndexDocumentsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteDocuments(Of T) (documents As IEnumerable(Of T), Optional options As IndexDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IndexDocumentsResult)" />
<MemberSignature Language="F#" Value="abstract member DeleteDocuments : seq<'T> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>
override this.DeleteDocuments : seq<'T> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>" Usage="searchClient.DeleteDocuments (documents, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<T>" />
<Parameter Name="options" Type="Azure.Search.Documents.IndexDocumentsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="T">
The .NET type that maps to the index schema. Instances of this type
can be retrieved as documents from the index.
</typeparam>
<param name="documents">The documents to delete.</param>
<param name="options">
Options that allow specifying document indexing behavior.
</param>
<param name="cancellationToken">
Optional <see cref="T:System.Threading.CancellationToken" /> to propagate notifications
that the operation should be canceled.
</param>
<summary>
Delete documents from the index as a batch.
</summary>
<returns>
Response containing the status of operations for all actions in the
batch of actions.
</returns>
<remarks>
<para>
The generic overloads of the DeleteDocuments and DeleteDocumentsAsync
methods support mapping of search field types to .NET types via the
type parameter T. See
<see cref="M:Azure.Search.Documents.SearchClient.GetDocumentAsync``1(System.String,Azure.Search.Documents.GetDocumentOptions,System.Threading.CancellationToken)" />
for more details on the type mapping.
</para>
<para>
By default, an exception will only be thrown if the entire request
fails. Individual failures are described in the
<see cref="P:Azure.Search.Documents.Models.IndexDocumentsResult.Results" /> collection. You can set
<see cref="P:Azure.Search.Documents.IndexDocumentsOptions.ThrowOnAnyError" /> if you want
exceptions thrown on partial failure.
</para>
</remarks>
<exception cref="T:Azure.RequestFailedException">
Thrown when a failure is returned by the Search Service.
</exception>
</Docs>
</Member>
<Member MemberName="DeleteDocumentsAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>> DeleteDocumentsAsync (string keyName, System.Collections.Generic.IEnumerable<string> keyValues, Azure.Search.Documents.IndexDocumentsOptions options = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Search.Documents.Models.IndexDocumentsResult>> DeleteDocumentsAsync(string keyName, class System.Collections.Generic.IEnumerable`1<string> keyValues, class Azure.Search.Documents.IndexDocumentsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.SearchClient.DeleteDocumentsAsync(System.String,System.Collections.Generic.IEnumerable{System.String},Azure.Search.Documents.IndexDocumentsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteDocumentsAsync (keyName As String, keyValues As IEnumerable(Of String), Optional options As IndexDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IndexDocumentsResult))" />
<MemberSignature Language="F#" Value="abstract member DeleteDocumentsAsync : string * seq<string> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>>
override this.DeleteDocumentsAsync : string * seq<string> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>>" Usage="searchClient.DeleteDocumentsAsync (keyName, keyValues, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="keyName" Type="System.String" />
<Parameter Name="keyValues" Type="System.Collections.Generic.IEnumerable<System.String>" />
<Parameter Name="options" Type="Azure.Search.Documents.IndexDocumentsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="keyName">
The name of the key field that uniquely identifies documents in
the index.
</param>
<param name="keyValues">
The keys of the documents to delete.
</param>
<param name="options">
Options that allow specifying document indexing behavior.
</param>
<param name="cancellationToken">
Optional <see cref="T:System.Threading.CancellationToken" /> to propagate notifications
that the operation should be canceled.
</param>
<summary>
Delete documents from the index as a batch given only their keys.
</summary>
<returns>
Response containing the status of operations for all actions in the
batch of actions.
</returns>
<remarks>
<para>
By default, an exception will only be thrown if the entire request
fails. Individual failures are described in the
<see cref="P:Azure.Search.Documents.Models.IndexDocumentsResult.Results" /> collection. You can set
<see cref="P:Azure.Search.Documents.IndexDocumentsOptions.ThrowOnAnyError" /> if you want
exceptions thrown on partial failure.
</para>
</remarks>
<exception cref="T:Azure.RequestFailedException">
Thrown when a failure is returned by the Search Service.
</exception>
</Docs>
</Member>
<Member MemberName="DeleteDocumentsAsync<T>">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>> DeleteDocumentsAsync<T> (System.Collections.Generic.IEnumerable<T> documents, Azure.Search.Documents.IndexDocumentsOptions options = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Search.Documents.Models.IndexDocumentsResult>> DeleteDocumentsAsync<T>(class System.Collections.Generic.IEnumerable`1<!!T> documents, class Azure.Search.Documents.IndexDocumentsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.SearchClient.DeleteDocumentsAsync``1(System.Collections.Generic.IEnumerable{``0},Azure.Search.Documents.IndexDocumentsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteDocumentsAsync(Of T) (documents As IEnumerable(Of T), Optional options As IndexDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IndexDocumentsResult))" />
<MemberSignature Language="F#" Value="abstract member DeleteDocumentsAsync : seq<'T> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>>
override this.DeleteDocumentsAsync : seq<'T> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>>" Usage="searchClient.DeleteDocumentsAsync (documents, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<T>" />
<Parameter Name="options" Type="Azure.Search.Documents.IndexDocumentsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="T">
The .NET type that maps to the index schema. Instances of this type
can be retrieved as documents from the index.
</typeparam>
<param name="documents">The documents to delete.</param>
<param name="options">
Options that allow specifying document indexing behavior.
</param>
<param name="cancellationToken">
Optional <see cref="T:System.Threading.CancellationToken" /> to propagate notifications
that the operation should be canceled.
</param>
<summary>
Delete documents from the index as a batch.
</summary>
<returns>
Response containing the status of operations for all actions in the
batch of actions.
</returns>
<remarks>
<para>
The generic overloads of the DeleteDocuments and DeleteDocumentsAsync
methods support mapping of search field types to .NET types via the
type parameter T. See
<see cref="M:Azure.Search.Documents.SearchClient.GetDocumentAsync``1(System.String,Azure.Search.Documents.GetDocumentOptions,System.Threading.CancellationToken)" />
for more details on the type mapping.
</para>
<para>
By default, an exception will only be thrown if the entire request
fails. Individual failures are described in the
<see cref="P:Azure.Search.Documents.Models.IndexDocumentsResult.Results" /> collection. You can set
<see cref="P:Azure.Search.Documents.IndexDocumentsOptions.ThrowOnAnyError" /> if you want
exceptions thrown on partial failure.
</para>
</remarks>
<exception cref="T:Azure.RequestFailedException">
Thrown when a failure is returned by the Search Service.
</exception>
</Docs>
</Member>
<Member MemberName="Endpoint">
<MemberSignature Language="C#" Value="public virtual Uri Endpoint { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri Endpoint" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.SearchClient.Endpoint" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Endpoint As Uri" />
<MemberSignature Language="F#" Value="member this.Endpoint : Uri" Usage="Azure.Search.Documents.SearchClient.Endpoint" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the URI endpoint of the Search Service. This is likely
to be similar to "https://{search_service}.search.windows.net".
</summary>
<value>To be added.</value>
<remarks>
This is not the URI of the Search Index. You could construct that
URI with "{Endpoint}/indexes/{IndexName}" if needed.
</remarks>
</Docs>
</Member>
<Member MemberName="GetDocument<T>">
<MemberSignature Language="C#" Value="public virtual Azure.Response<T> GetDocument<T> (string key, Azure.Search.Documents.GetDocumentOptions options = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<!!T> GetDocument<T>(string key, class Azure.Search.Documents.GetDocumentOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.SearchClient.GetDocument``1(System.String,Azure.Search.Documents.GetDocumentOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDocument(Of T) (key As String, Optional options As GetDocumentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of T)" />
<MemberSignature Language="F#" Value="abstract member GetDocument : string * Azure.Search.Documents.GetDocumentOptions * System.Threading.CancellationToken -> Azure.Response<'T>
override this.GetDocument : string * Azure.Search.Documents.GetDocumentOptions * System.Threading.CancellationToken -> Azure.Response<'T>" Usage="searchClient.GetDocument (key, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="key" Type="System.String" />
<Parameter Name="options" Type="Azure.Search.Documents.GetDocumentOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="T">
The .NET type that maps to the index schema. Instances of this type
can be retrieved as documents from the index.
</typeparam>
<param name="key">
Required. An string value that uniquely identifies each document
in the index. The key is sometimes referred to as a document ID.
See
<see href="https://docs.microsoft.com/rest/api/searchservice/naming-rules">Naming rules</see>
for the rules for constructing valid document keys.
</param>
<param name="options">
Options to customize the operation's behavior.
</param>
<param name="cancellationToken">
Optional <see cref="T:System.Threading.CancellationToken" /> to propagate notifications
that the operation should be canceled.
</param>
<summary>
Retrieves a document from Azure Cognitive Search. This is useful
when a user clicks on a specific search result, and you want to
look up specific details about that document. You can only get one
document at a time. Use Search to get multiple documents in a
single request.
<see href="https://docs.microsoft.com/rest/api/searchservice/lookup-document">Lookup Document</see></summary>
<returns>
The document corresponding to the <paramref name="key" />.
</returns>
<remarks>
The generic overloads of the <see cref="M:Azure.Search.Documents.SearchClient.GetDocument``1(System.String,Azure.Search.Documents.GetDocumentOptions,System.Threading.CancellationToken)" /> and
<see cref="M:Azure.Search.Documents.SearchClient.GetDocumentAsync``1(System.String,Azure.Search.Documents.GetDocumentOptions,System.Threading.CancellationToken)" /> methods support mapping of Azure
Search field types to .NET types via the type parameter
<typeparamref name="T" />. Note that all search field types except
collections are nullable, so we recommend using nullable types for
the properties of <typeparamref name="T" />. See
<see cref="M:Azure.Search.Documents.SearchClient.GetDocumentAsync``1(System.String,Azure.Search.Documents.GetDocumentOptions,System.Threading.CancellationToken)" />
for more information.
</remarks>
<exception cref="T:Azure.RequestFailedException">
Thrown when a failure is returned by the Search Service.
</exception>
</Docs>
</Member>
<Member MemberName="GetDocumentAsync<T>">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<T>> GetDocumentAsync<T> (string key, Azure.Search.Documents.GetDocumentOptions options = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<!!T>> GetDocumentAsync<T>(string key, class Azure.Search.Documents.GetDocumentOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.SearchClient.GetDocumentAsync``1(System.String,Azure.Search.Documents.GetDocumentOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDocumentAsync(Of T) (key As String, Optional options As GetDocumentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of T))" />
<MemberSignature Language="F#" Value="abstract member GetDocumentAsync : string * Azure.Search.Documents.GetDocumentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<'T>>
override this.GetDocumentAsync : string * Azure.Search.Documents.GetDocumentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<'T>>" Usage="searchClient.GetDocumentAsync (key, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<T>></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="key" Type="System.String" />
<Parameter Name="options" Type="Azure.Search.Documents.GetDocumentOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="T">
The .NET type that maps to the index schema. Instances of this type
can be retrieved as documents from the index.
</typeparam>
<param name="key">
Required. An string value that uniquely identifies each document
in the index. The key is sometimes referred to as a document ID.
See
<see href="https://docs.microsoft.com/rest/api/searchservice/naming-rules">Naming rules</see>
for the rules for constructing valid document keys.
</param>
<param name="options">
Options to customize the operation's behavior.
</param>
<param name="cancellationToken">
Optional <see cref="T:System.Threading.CancellationToken" /> to propagate notifications
that the operation should be canceled.
</param>
<summary>
Retrieves a document from Azure Cognitive Search. This is useful
when a user clicks on a specific search result, and you want to
look up specific details about that document. You can only get one
document at a time. Use Search to get multiple documents in a
single request.
<see href="https://docs.microsoft.com/rest/api/searchservice/lookup-document">Lookup Document</see></summary>
<returns>
The document corresponding to the <paramref name="key" />.
</returns>
<remarks>
The <see cref="M:Azure.Search.Documents.SearchClient.GetDocument``1(System.String,Azure.Search.Documents.GetDocumentOptions,System.Threading.CancellationToken)" /> and <see cref="M:Azure.Search.Documents.SearchClient.GetDocumentAsync``1(System.String,Azure.Search.Documents.GetDocumentOptions,System.Threading.CancellationToken)" />
methods support mapping of Azure Search field types to .NET types
via the type parameter <typeparamref name="T" />. Note that all
search field types except collections are nullable, so we recommend
using nullable types for the properties of <typeparamref name="T" />.
The type mapping is as follows:
<list type="table"><listheader><term>Search field type</term><description>.NET type</description></listheader><item><term>Edm.String</term><description><see cref="T:System.String" /> (string in C# and F#)</description></item><item><term>Edm.Boolean</term><description><see cref="T:System.Nullable`1" /> (bool? in C#,\
Nullable<bool> in F#)</description></item><item><term>Edm.Double</term><description><see cref="T:System.Nullable`1" /> (double? in C#,
Nullable<float> in F#)</description></item><item><term>Edm.Int32</term><description><see cref="T:System.Nullable`1" /> (int? in C#,
Nullable<int> in F#)</description></item><item><term>Edm.Int64</term><description><see cref="T:System.Nullable`1" /> (long? in C#,
Nullable<int64> in F#)</description></item><item><term>Edm.DateTimeOffset</term><description><see cref="T:System.Nullable`1" /> (DateTimeOffset? in
C#, Nullable<DateTimeOffset> in F#) or
System.Nullable<System.DateTime> (DateTime? in C#,
Nullable<DateTime> in F#). Both types work, although we
recommend using DateTimeOffset. When retrieving documents,
DateTime values will always be in UTC. When indexing documents,
DateTime values are interpreted as follows:
<list type="table"><item><term>UTC DateTime</term><description>Sent as-is to the index.</description></item><item><term>Local DateTime</term><description>Converted to UTC before being sent to the index.
</description></item><item><term>DateTime with unspecified time zone</term><description>Assumed to be UTC and sent as-is to the index.
</description></item></list></description></item><item><term>Edm.GeographyPoint</term><description> Azure.Core.GeoJson.GeoPoint
</description></item><item><term>Edm.ComplexType</term><description>
Any type that can be deserialized from the JSON objects in the
complex field. This can be a value type or a reference type, but
we recommend using a reference type since complex fields are
nullable in Azure Cognitive Search.
</description></item><item><term>Collection(Edm.String)</term><description><see cref="T:System.Collections.Generic.IEnumerable`1" /> (seq<string>
in F#)</description></item><item><term>Collection(Edm.Boolean)</term><description><see cref="T:System.Collections.Generic.IEnumerable`1" /> (seq<bool> in
F#)</description></item><item><term>Collection(Edm.Double)</term><description><see cref="T:System.Collections.Generic.IEnumerable`1" /> (seq<float> in
F#)</description></item><item><term>Collection(Edm.Int32)</term><description><see cref="T:System.Collections.Generic.IEnumerable`1" /> (seq<int> in
F#)</description></item><item><term>Collection(Edm.Int64)</term><description><see cref="T:System.Collections.Generic.IEnumerable`1" /> (seq<int64> in
F#)</description></item><item><term>Collection(Edm.DateTimeOffset)</term><description><see cref="T:System.Collections.Generic.IEnumerable`1" /> or
<see cref="T:System.Collections.Generic.IEnumerable`1" /> (seq<DateTimeOffset> or
seq<DateTime> in F#). Both types work, although we recommend
using <see cref="T:System.Collections.Generic.IEnumerable`1" />. See the notes
above on Edm.DateTimeOffset for details.
</description></item><item><term>Collection(Edm.GeographyPoint)</term><description>sequence of Azure.Core.GeoJson.GeoPoint
(seq<GeoPoint> in F#)</description></item><item><term>Collection(Edm.ComplexType)</term><description><see cref="T:System.Collections.Generic.IEnumerable`1" /> (seq<T> in F#) where T is any
type that can be deserialized from the JSON objects in the complex
collection field. This can be a value type or a reference type.
</description></item></list>
You can also use the dynamic <see cref="T:Azure.Search.Documents.Models.SearchDocument" /> as your
<typeparamref name="T" /> and we will attempt to map JSON types in
the response payload to .NET types. This mapping does not
have the benefit of precise type information from the index, so the
mapping is not always correct. In particular, be aware of the
following cases:
<list type="bullet"><item><description>
Any numeric value without a decimal point will be deserialized to
a <see cref="T:System.Int32" /> (int in C#, int32 in F#) if it can be
converted or a <see cref="T:System.Int64" /> (long in C#, int64 in F#)
otherwise.
</description></item><item><description>
Special double-precision floating point values such as NaN and
Infinity will be deserialized as type <see cref="T:System.String" /> rather
than <see cref="T:System.Double" />, even if they are in arrays with regular
floating point values.
</description></item><item><description>
Any Edm.DateTimeOffset field will be deserialized as a
<see cref="T:System.DateTimeOffset" />, not <see cref="T:System.DateTime" />.
</description></item><item><description>
Any empty JSON array will be deserialized as an array of
<see cref="T:System.Object" /> (object[] in C#, obj[] in F#).
</description></item><item><description>
Complex fields will be recursively deserialized into instances of
type <see cref="T:Azure.Search.Documents.Models.SearchDocument" />. Similarly, complex collection
fields will be deserialized into arrays of such instances.
</description></item></list></remarks>
<exception cref="T:Azure.RequestFailedException">
Thrown when a failure is returned by the Search Service.
</exception>
</Docs>
</Member>
<Member MemberName="GetDocumentCount">
<MemberSignature Language="C#" Value="public virtual Azure.Response<long> GetDocumentCount (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<int64> GetDocumentCount(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.SearchClient.GetDocumentCount(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDocumentCount (Optional cancellationToken As CancellationToken = Nothing) As Response(Of Long)" />
<MemberSignature Language="F#" Value="abstract member GetDocumentCount : System.Threading.CancellationToken -> Azure.Response<int64>
override this.GetDocumentCount : System.Threading.CancellationToken -> Azure.Response<int64>" Usage="searchClient.GetDocumentCount cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<System.Int64></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">
Optional <see cref="T:System.Threading.CancellationToken" /> to propagate notifications
that the operation should be canceled.
</param>
<summary>
Retrieves a count of the number of documents in this search index.
</summary>
<returns>The number of documents in the search index.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException">
Thrown when a failure is returned by the Search Service.
</exception>
</Docs>
</Member>
<Member MemberName="GetDocumentCountAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<long>> GetDocumentCountAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<int64>> GetDocumentCountAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.SearchClient.GetDocumentCountAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDocumentCountAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Long))" />
<MemberSignature Language="F#" Value="abstract member GetDocumentCountAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<int64>>
override this.GetDocumentCountAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<int64>>" Usage="searchClient.GetDocumentCountAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<System.Int64>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">
Optional <see cref="T:System.Threading.CancellationToken" /> to propagate notifications
that the operation should be canceled.
</param>
<summary>
Retrieves a count of the number of documents in this search index.
</summary>
<returns>The number of documents in the search index.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException">
Thrown when a failure is returned by the Search Service.
</exception>
</Docs>
</Member>
<Member MemberName="IndexDocuments<T>">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult> IndexDocuments<T> (Azure.Search.Documents.Models.IndexDocumentsBatch<T> batch, Azure.Search.Documents.IndexDocumentsOptions options = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Search.Documents.Models.IndexDocumentsResult> IndexDocuments<T>(class Azure.Search.Documents.Models.IndexDocumentsBatch`1<!!T> batch, class Azure.Search.Documents.IndexDocumentsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.SearchClient.IndexDocuments``1(Azure.Search.Documents.Models.IndexDocumentsBatch{``0},Azure.Search.Documents.IndexDocumentsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function IndexDocuments(Of T) (batch As IndexDocumentsBatch(Of T), Optional options As IndexDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IndexDocumentsResult)" />
<MemberSignature Language="F#" Value="abstract member IndexDocuments : Azure.Search.Documents.Models.IndexDocumentsBatch<'T> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>
override this.IndexDocuments : Azure.Search.Documents.Models.IndexDocumentsBatch<'T> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>" Usage="searchClient.IndexDocuments (batch, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="batch" Type="Azure.Search.Documents.Models.IndexDocumentsBatch<T>" />
<Parameter Name="options" Type="Azure.Search.Documents.IndexDocumentsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="T">
The .NET type that maps to the index schema. Instances of this type
can be retrieved as documents from the index.
</typeparam>
<param name="batch">
The batch of document index actions.
</param>
<param name="options">
Options that allow specifying document indexing behavior.
</param>
<param name="cancellationToken">
Optional <see cref="T:System.Threading.CancellationToken" /> to propagate notifications
that the operation should be canceled.
</param>
<summary>
Sends a batch of upload, merge, and/or delete actions to the search
index.
<see href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, Update or Delete Documents</see></summary>
<returns>
Response containing the status of operations for all actions in the
batch of actions.
</returns>
<remarks>
<para>
The generic overloads of the IndexDocuments and IndexDocumentsAsync
methods support mapping of search field types to .NET types via the
type parameter T. See
<see cref="M:Azure.Search.Documents.SearchClient.GetDocumentAsync``1(System.String,Azure.Search.Documents.GetDocumentOptions,System.Threading.CancellationToken)" />
for more details on the type mapping.
</para>
<para>
By default, an exception will only be thrown if the entire request
fails. Individual failures are described in the
<see cref="P:Azure.Search.Documents.Models.IndexDocumentsResult.Results" /> collection. You can set
<see cref="P:Azure.Search.Documents.IndexDocumentsOptions.ThrowOnAnyError" /> if you want
individual <see cref="T:Azure.RequestFailedException" />s wrapped into an
<see cref="T:System.AggregateException" /> that's thrown on partial failure.
</para>
</remarks>
<exception cref="T:Azure.RequestFailedException">
Thrown when a failure is returned by the Search Service.
</exception>
</Docs>
</Member>
<Member MemberName="IndexDocumentsAsync<T>">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>> IndexDocumentsAsync<T> (Azure.Search.Documents.Models.IndexDocumentsBatch<T> batch, Azure.Search.Documents.IndexDocumentsOptions options = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Search.Documents.Models.IndexDocumentsResult>> IndexDocumentsAsync<T>(class Azure.Search.Documents.Models.IndexDocumentsBatch`1<!!T> batch, class Azure.Search.Documents.IndexDocumentsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.SearchClient.IndexDocumentsAsync``1(Azure.Search.Documents.Models.IndexDocumentsBatch{``0},Azure.Search.Documents.IndexDocumentsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function IndexDocumentsAsync(Of T) (batch As IndexDocumentsBatch(Of T), Optional options As IndexDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IndexDocumentsResult))" />
<MemberSignature Language="F#" Value="abstract member IndexDocumentsAsync : Azure.Search.Documents.Models.IndexDocumentsBatch<'T> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>>
override this.IndexDocumentsAsync : Azure.Search.Documents.Models.IndexDocumentsBatch<'T> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>>" Usage="searchClient.IndexDocumentsAsync (batch, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="batch" Type="Azure.Search.Documents.Models.IndexDocumentsBatch<T>" />
<Parameter Name="options" Type="Azure.Search.Documents.IndexDocumentsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="T">
The .NET type that maps to the index schema. Instances of this type
can be retrieved as documents from the index.
</typeparam>
<param name="batch">
The batch of document index actions.
</param>
<param name="options">
Options that allow specifying document indexing behavior.
</param>
<param name="cancellationToken">
Optional <see cref="T:System.Threading.CancellationToken" /> to propagate notifications
that the operation should be canceled.
</param>
<summary>
Sends a batch of upload, merge, and/or delete actions to the search
index.
<see href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, Update or Delete Documents</see></summary>
<returns>
Response containing the status of operations for all actions in the
batch of actions.
</returns>
<remarks>
<para>
The generic overloads of the IndexDocuments and IndexDocumentsAsync
methods support mapping of search field types to .NET types via the
type parameter T. See
<see cref="M:Azure.Search.Documents.SearchClient.GetDocumentAsync``1(System.String,Azure.Search.Documents.GetDocumentOptions,System.Threading.CancellationToken)" />
for more details on the type mapping.
</para>
<para>
By default, an exception will only be thrown if the entire request
fails. Individual failures are described in the
<see cref="P:Azure.Search.Documents.Models.IndexDocumentsResult.Results" /> collection. You can set
<see cref="P:Azure.Search.Documents.IndexDocumentsOptions.ThrowOnAnyError" /> if you want