@azure/search-documents 12.1.0 → 12.2.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. package/README.md +1 -1
  2. package/dist/index.js +2710 -454
  3. package/dist/index.js.map +1 -1
  4. package/dist-esm/src/base64.browser.js +1 -1
  5. package/dist-esm/src/base64.browser.js.map +1 -1
  6. package/dist-esm/src/base64.js +1 -1
  7. package/dist-esm/src/base64.js.map +1 -1
  8. package/dist-esm/src/errorModels.js +1 -1
  9. package/dist-esm/src/errorModels.js.map +1 -1
  10. package/dist-esm/src/generated/data/models/index.js +220 -6
  11. package/dist-esm/src/generated/data/models/index.js.map +1 -1
  12. package/dist-esm/src/generated/data/models/mappers.js +481 -0
  13. package/dist-esm/src/generated/data/models/mappers.js.map +1 -1
  14. package/dist-esm/src/generated/data/models/parameters.js +51 -0
  15. package/dist-esm/src/generated/data/models/parameters.js.map +1 -1
  16. package/dist-esm/src/generated/data/operations/documents.js +5 -0
  17. package/dist-esm/src/generated/data/operations/documents.js.map +1 -1
  18. package/dist-esm/src/generated/data/searchClient.js +1 -1
  19. package/dist-esm/src/generated/data/searchClient.js.map +1 -1
  20. package/dist-esm/src/generated/service/models/index.js +210 -84
  21. package/dist-esm/src/generated/service/models/index.js.map +1 -1
  22. package/dist-esm/src/generated/service/models/mappers.js +815 -77
  23. package/dist-esm/src/generated/service/models/mappers.js.map +1 -1
  24. package/dist-esm/src/generated/service/models/parameters.js +51 -1
  25. package/dist-esm/src/generated/service/models/parameters.js.map +1 -1
  26. package/dist-esm/src/generated/service/operations/aliases.js +160 -0
  27. package/dist-esm/src/generated/service/operations/aliases.js.map +1 -0
  28. package/dist-esm/src/generated/service/operations/dataSources.js +4 -1
  29. package/dist-esm/src/generated/service/operations/dataSources.js.map +1 -1
  30. package/dist-esm/src/generated/service/operations/index.js +1 -0
  31. package/dist-esm/src/generated/service/operations/index.js.map +1 -1
  32. package/dist-esm/src/generated/service/operations/indexers.js +29 -1
  33. package/dist-esm/src/generated/service/operations/indexers.js.map +1 -1
  34. package/dist-esm/src/generated/service/operations/skillsets.js +30 -1
  35. package/dist-esm/src/generated/service/operations/skillsets.js.map +1 -1
  36. package/dist-esm/src/generated/service/operationsInterfaces/aliases.js +9 -0
  37. package/dist-esm/src/generated/service/operationsInterfaces/aliases.js.map +1 -0
  38. package/dist-esm/src/generated/service/operationsInterfaces/index.js +1 -0
  39. package/dist-esm/src/generated/service/operationsInterfaces/index.js.map +1 -1
  40. package/dist-esm/src/generated/service/operationsInterfaces/indexers.js.map +1 -1
  41. package/dist-esm/src/generated/service/operationsInterfaces/skillsets.js.map +1 -1
  42. package/dist-esm/src/generated/service/searchServiceClient.js +3 -2
  43. package/dist-esm/src/generated/service/searchServiceClient.js.map +1 -1
  44. package/dist-esm/src/geographyPoint.js +1 -1
  45. package/dist-esm/src/geographyPoint.js.map +1 -1
  46. package/dist-esm/src/index.js +4 -4
  47. package/dist-esm/src/index.js.map +1 -1
  48. package/dist-esm/src/indexDocumentsBatch.js +1 -1
  49. package/dist-esm/src/indexDocumentsBatch.js.map +1 -1
  50. package/dist-esm/src/indexModels.js +1 -1
  51. package/dist-esm/src/indexModels.js.map +1 -1
  52. package/dist-esm/src/logger.js +1 -1
  53. package/dist-esm/src/logger.js.map +1 -1
  54. package/dist-esm/src/odata.js +1 -1
  55. package/dist-esm/src/odata.js.map +1 -1
  56. package/dist-esm/src/odataMetadataPolicy.js +1 -1
  57. package/dist-esm/src/odataMetadataPolicy.js.map +1 -1
  58. package/dist-esm/src/searchApiKeyCredentialPolicy.js +1 -1
  59. package/dist-esm/src/searchApiKeyCredentialPolicy.js.map +1 -1
  60. package/dist-esm/src/searchAudience.js +1 -1
  61. package/dist-esm/src/searchAudience.js.map +1 -1
  62. package/dist-esm/src/searchClient.js +52 -8
  63. package/dist-esm/src/searchClient.js.map +1 -1
  64. package/dist-esm/src/searchIndexClient.js +158 -6
  65. package/dist-esm/src/searchIndexClient.js.map +1 -1
  66. package/dist-esm/src/searchIndexerClient.js +53 -2
  67. package/dist-esm/src/searchIndexerClient.js.map +1 -1
  68. package/dist-esm/src/searchIndexingBufferedSender.js +1 -1
  69. package/dist-esm/src/searchIndexingBufferedSender.js.map +1 -1
  70. package/dist-esm/src/serialization.js +1 -1
  71. package/dist-esm/src/serialization.js.map +1 -1
  72. package/dist-esm/src/serviceModels.js +1 -1
  73. package/dist-esm/src/serviceModels.js.map +1 -1
  74. package/dist-esm/src/serviceUtils.js +112 -26
  75. package/dist-esm/src/serviceUtils.js.map +1 -1
  76. package/dist-esm/src/synonymMapHelper.browser.js +1 -1
  77. package/dist-esm/src/synonymMapHelper.browser.js.map +1 -1
  78. package/dist-esm/src/synonymMapHelper.js +1 -1
  79. package/dist-esm/src/synonymMapHelper.js.map +1 -1
  80. package/dist-esm/src/tracing.js +1 -1
  81. package/dist-esm/src/tracing.js.map +1 -1
  82. package/dist-esm/src/walk.js +1 -1
  83. package/dist-esm/src/walk.js.map +1 -1
  84. package/package.json +13 -16
  85. package/types/search-documents.d.ts +1774 -108
@@ -188,6 +188,20 @@ export const SearchDocumentsResult = {
188
188
  name: "String",
189
189
  },
190
190
  },
191
+ semanticQueryRewritesResultType: {
192
+ serializedName: "@search\\.semanticQueryRewritesResultType",
193
+ readOnly: true,
194
+ type: {
195
+ name: "String",
196
+ },
197
+ },
198
+ debugInfo: {
199
+ serializedName: "@search\\.debug",
200
+ type: {
201
+ name: "Composite",
202
+ className: "DebugInfo",
203
+ },
204
+ },
191
205
  },
192
206
  },
193
207
  };
@@ -204,6 +218,21 @@ export const FacetResult = {
204
218
  name: "Number",
205
219
  },
206
220
  },
221
+ facets: {
222
+ serializedName: "@search\\.facets",
223
+ readOnly: true,
224
+ type: {
225
+ name: "Dictionary",
226
+ value: {
227
+ type: {
228
+ name: "Sequence",
229
+ element: {
230
+ type: { name: "Composite", className: "FacetResult" },
231
+ },
232
+ },
233
+ },
234
+ },
235
+ },
207
236
  },
208
237
  },
209
238
  };
@@ -343,6 +372,12 @@ export const SearchRequest = {
343
372
  name: "String",
344
373
  },
345
374
  },
375
+ debug: {
376
+ serializedName: "debug",
377
+ type: {
378
+ name: "String",
379
+ },
380
+ },
346
381
  searchText: {
347
382
  serializedName: "search",
348
383
  type: {
@@ -362,6 +397,18 @@ export const SearchRequest = {
362
397
  allowedValues: ["any", "all"],
363
398
  },
364
399
  },
400
+ queryLanguage: {
401
+ serializedName: "queryLanguage",
402
+ type: {
403
+ name: "String",
404
+ },
405
+ },
406
+ speller: {
407
+ serializedName: "speller",
408
+ type: {
409
+ name: "String",
410
+ },
411
+ },
365
412
  select: {
366
413
  serializedName: "select",
367
414
  type: {
@@ -420,6 +467,18 @@ export const SearchRequest = {
420
467
  name: "String",
421
468
  },
422
469
  },
470
+ queryRewrites: {
471
+ serializedName: "queryRewrites",
472
+ type: {
473
+ name: "String",
474
+ },
475
+ },
476
+ semanticFields: {
477
+ serializedName: "semanticFields",
478
+ type: {
479
+ name: "String",
480
+ },
481
+ },
423
482
  vectorQueries: {
424
483
  serializedName: "vectorQueries",
425
484
  type: {
@@ -438,6 +497,13 @@ export const SearchRequest = {
438
497
  name: "String",
439
498
  },
440
499
  },
500
+ hybridSearch: {
501
+ serializedName: "hybridSearch",
502
+ type: {
503
+ name: "Composite",
504
+ className: "HybridSearch",
505
+ },
506
+ },
441
507
  },
442
508
  },
443
509
  };
@@ -488,6 +554,59 @@ export const VectorQuery = {
488
554
  name: "Number",
489
555
  },
490
556
  },
557
+ threshold: {
558
+ serializedName: "threshold",
559
+ type: {
560
+ name: "Composite",
561
+ className: "VectorThreshold",
562
+ },
563
+ },
564
+ filterOverride: {
565
+ serializedName: "filterOverride",
566
+ type: {
567
+ name: "String",
568
+ },
569
+ },
570
+ },
571
+ },
572
+ };
573
+ export const VectorThreshold = {
574
+ type: {
575
+ name: "Composite",
576
+ className: "VectorThreshold",
577
+ uberParent: "VectorThreshold",
578
+ polymorphicDiscriminator: {
579
+ serializedName: "kind",
580
+ clientName: "kind",
581
+ },
582
+ modelProperties: {
583
+ kind: {
584
+ serializedName: "kind",
585
+ required: true,
586
+ type: {
587
+ name: "String",
588
+ },
589
+ },
590
+ },
591
+ },
592
+ };
593
+ export const HybridSearch = {
594
+ type: {
595
+ name: "Composite",
596
+ className: "HybridSearch",
597
+ modelProperties: {
598
+ maxTextRecallSize: {
599
+ serializedName: "maxTextRecallSize",
600
+ type: {
601
+ name: "Number",
602
+ },
603
+ },
604
+ countAndFacetMode: {
605
+ serializedName: "countAndFacetMode",
606
+ type: {
607
+ name: "String",
608
+ },
609
+ },
491
610
  },
492
611
  },
493
612
  };
@@ -537,6 +656,13 @@ export const SearchResult = {
537
656
  },
538
657
  },
539
658
  },
659
+ documentDebugInfo: {
660
+ serializedName: "@search\\.documentDebugInfo",
661
+ type: {
662
+ name: "Composite",
663
+ className: "DocumentDebugInfo",
664
+ },
665
+ },
540
666
  },
541
667
  },
542
668
  };
@@ -564,6 +690,289 @@ export const QueryCaptionResult = {
564
690
  },
565
691
  },
566
692
  };
693
+ export const DocumentDebugInfo = {
694
+ type: {
695
+ name: "Composite",
696
+ className: "DocumentDebugInfo",
697
+ modelProperties: {
698
+ semantic: {
699
+ serializedName: "semantic",
700
+ type: {
701
+ name: "Composite",
702
+ className: "SemanticDebugInfo",
703
+ },
704
+ },
705
+ vectors: {
706
+ serializedName: "vectors",
707
+ type: {
708
+ name: "Composite",
709
+ className: "VectorsDebugInfo",
710
+ },
711
+ },
712
+ },
713
+ },
714
+ };
715
+ export const SemanticDebugInfo = {
716
+ type: {
717
+ name: "Composite",
718
+ className: "SemanticDebugInfo",
719
+ modelProperties: {
720
+ titleField: {
721
+ serializedName: "titleField",
722
+ type: {
723
+ name: "Composite",
724
+ className: "QueryResultDocumentSemanticField",
725
+ },
726
+ },
727
+ contentFields: {
728
+ serializedName: "contentFields",
729
+ readOnly: true,
730
+ type: {
731
+ name: "Sequence",
732
+ element: {
733
+ type: {
734
+ name: "Composite",
735
+ className: "QueryResultDocumentSemanticField",
736
+ },
737
+ },
738
+ },
739
+ },
740
+ keywordFields: {
741
+ serializedName: "keywordFields",
742
+ readOnly: true,
743
+ type: {
744
+ name: "Sequence",
745
+ element: {
746
+ type: {
747
+ name: "Composite",
748
+ className: "QueryResultDocumentSemanticField",
749
+ },
750
+ },
751
+ },
752
+ },
753
+ rerankerInput: {
754
+ serializedName: "rerankerInput",
755
+ type: {
756
+ name: "Composite",
757
+ className: "QueryResultDocumentRerankerInput",
758
+ },
759
+ },
760
+ },
761
+ },
762
+ };
763
+ export const QueryResultDocumentSemanticField = {
764
+ type: {
765
+ name: "Composite",
766
+ className: "QueryResultDocumentSemanticField",
767
+ modelProperties: {
768
+ name: {
769
+ serializedName: "name",
770
+ readOnly: true,
771
+ type: {
772
+ name: "String",
773
+ },
774
+ },
775
+ state: {
776
+ serializedName: "state",
777
+ readOnly: true,
778
+ type: {
779
+ name: "String",
780
+ },
781
+ },
782
+ },
783
+ },
784
+ };
785
+ export const QueryResultDocumentRerankerInput = {
786
+ type: {
787
+ name: "Composite",
788
+ className: "QueryResultDocumentRerankerInput",
789
+ modelProperties: {
790
+ title: {
791
+ serializedName: "title",
792
+ readOnly: true,
793
+ type: {
794
+ name: "String",
795
+ },
796
+ },
797
+ content: {
798
+ serializedName: "content",
799
+ readOnly: true,
800
+ type: {
801
+ name: "String",
802
+ },
803
+ },
804
+ keywords: {
805
+ serializedName: "keywords",
806
+ readOnly: true,
807
+ type: {
808
+ name: "String",
809
+ },
810
+ },
811
+ },
812
+ },
813
+ };
814
+ export const VectorsDebugInfo = {
815
+ type: {
816
+ name: "Composite",
817
+ className: "VectorsDebugInfo",
818
+ modelProperties: {
819
+ subscores: {
820
+ serializedName: "subscores",
821
+ type: {
822
+ name: "Composite",
823
+ className: "QueryResultDocumentSubscores",
824
+ },
825
+ },
826
+ },
827
+ },
828
+ };
829
+ export const QueryResultDocumentSubscores = {
830
+ type: {
831
+ name: "Composite",
832
+ className: "QueryResultDocumentSubscores",
833
+ modelProperties: {
834
+ text: {
835
+ serializedName: "text",
836
+ type: {
837
+ name: "Composite",
838
+ className: "TextResult",
839
+ },
840
+ },
841
+ vectors: {
842
+ serializedName: "vectors",
843
+ readOnly: true,
844
+ type: {
845
+ name: "Sequence",
846
+ element: {
847
+ type: {
848
+ name: "Dictionary",
849
+ value: {
850
+ type: {
851
+ name: "Composite",
852
+ className: "SingleVectorFieldResult",
853
+ },
854
+ },
855
+ },
856
+ },
857
+ },
858
+ },
859
+ documentBoost: {
860
+ serializedName: "documentBoost",
861
+ readOnly: true,
862
+ type: {
863
+ name: "Number",
864
+ },
865
+ },
866
+ },
867
+ },
868
+ };
869
+ export const TextResult = {
870
+ type: {
871
+ name: "Composite",
872
+ className: "TextResult",
873
+ modelProperties: {
874
+ searchScore: {
875
+ serializedName: "searchScore",
876
+ readOnly: true,
877
+ type: {
878
+ name: "Number",
879
+ },
880
+ },
881
+ },
882
+ },
883
+ };
884
+ export const SingleVectorFieldResult = {
885
+ type: {
886
+ name: "Composite",
887
+ className: "SingleVectorFieldResult",
888
+ modelProperties: {
889
+ searchScore: {
890
+ serializedName: "searchScore",
891
+ readOnly: true,
892
+ type: {
893
+ name: "Number",
894
+ },
895
+ },
896
+ vectorSimilarity: {
897
+ serializedName: "vectorSimilarity",
898
+ readOnly: true,
899
+ type: {
900
+ name: "Number",
901
+ },
902
+ },
903
+ },
904
+ },
905
+ };
906
+ export const DebugInfo = {
907
+ type: {
908
+ name: "Composite",
909
+ className: "DebugInfo",
910
+ modelProperties: {
911
+ queryRewrites: {
912
+ serializedName: "queryRewrites",
913
+ type: {
914
+ name: "Composite",
915
+ className: "QueryRewritesDebugInfo",
916
+ },
917
+ },
918
+ },
919
+ },
920
+ };
921
+ export const QueryRewritesDebugInfo = {
922
+ type: {
923
+ name: "Composite",
924
+ className: "QueryRewritesDebugInfo",
925
+ modelProperties: {
926
+ text: {
927
+ serializedName: "text",
928
+ type: {
929
+ name: "Composite",
930
+ className: "QueryRewritesValuesDebugInfo",
931
+ },
932
+ },
933
+ vectors: {
934
+ serializedName: "vectors",
935
+ readOnly: true,
936
+ type: {
937
+ name: "Sequence",
938
+ element: {
939
+ type: {
940
+ name: "Composite",
941
+ className: "QueryRewritesValuesDebugInfo",
942
+ },
943
+ },
944
+ },
945
+ },
946
+ },
947
+ },
948
+ };
949
+ export const QueryRewritesValuesDebugInfo = {
950
+ type: {
951
+ name: "Composite",
952
+ className: "QueryRewritesValuesDebugInfo",
953
+ modelProperties: {
954
+ inputQuery: {
955
+ serializedName: "inputQuery",
956
+ readOnly: true,
957
+ type: {
958
+ name: "String",
959
+ },
960
+ },
961
+ rewrites: {
962
+ serializedName: "rewrites",
963
+ readOnly: true,
964
+ type: {
965
+ name: "Sequence",
966
+ element: {
967
+ type: {
968
+ name: "String",
969
+ },
970
+ },
971
+ },
972
+ },
973
+ },
974
+ },
975
+ };
567
976
  export const SuggestDocumentsResult = {
568
977
  type: {
569
978
  name: "Composite",
@@ -943,12 +1352,84 @@ export const VectorizableTextQuery = {
943
1352
  type: {
944
1353
  name: "String",
945
1354
  },
1355
+ }, queryRewrites: {
1356
+ serializedName: "queryRewrites",
1357
+ type: {
1358
+ name: "String",
1359
+ },
1360
+ } }),
1361
+ },
1362
+ };
1363
+ export const VectorizableImageUrlQuery = {
1364
+ serializedName: "imageUrl",
1365
+ type: {
1366
+ name: "Composite",
1367
+ className: "VectorizableImageUrlQuery",
1368
+ uberParent: "VectorQuery",
1369
+ polymorphicDiscriminator: VectorQuery.type.polymorphicDiscriminator,
1370
+ modelProperties: Object.assign(Object.assign({}, VectorQuery.type.modelProperties), { url: {
1371
+ serializedName: "url",
1372
+ type: {
1373
+ name: "String",
1374
+ },
1375
+ } }),
1376
+ },
1377
+ };
1378
+ export const VectorizableImageBinaryQuery = {
1379
+ serializedName: "imageBinary",
1380
+ type: {
1381
+ name: "Composite",
1382
+ className: "VectorizableImageBinaryQuery",
1383
+ uberParent: "VectorQuery",
1384
+ polymorphicDiscriminator: VectorQuery.type.polymorphicDiscriminator,
1385
+ modelProperties: Object.assign(Object.assign({}, VectorQuery.type.modelProperties), { base64Image: {
1386
+ serializedName: "base64Image",
1387
+ type: {
1388
+ name: "String",
1389
+ },
1390
+ } }),
1391
+ },
1392
+ };
1393
+ export const VectorSimilarityThreshold = {
1394
+ serializedName: "vectorSimilarity",
1395
+ type: {
1396
+ name: "Composite",
1397
+ className: "VectorSimilarityThreshold",
1398
+ uberParent: "VectorThreshold",
1399
+ polymorphicDiscriminator: VectorThreshold.type.polymorphicDiscriminator,
1400
+ modelProperties: Object.assign(Object.assign({}, VectorThreshold.type.modelProperties), { value: {
1401
+ serializedName: "value",
1402
+ required: true,
1403
+ type: {
1404
+ name: "Number",
1405
+ },
1406
+ } }),
1407
+ },
1408
+ };
1409
+ export const SearchScoreThreshold = {
1410
+ serializedName: "searchScore",
1411
+ type: {
1412
+ name: "Composite",
1413
+ className: "SearchScoreThreshold",
1414
+ uberParent: "VectorThreshold",
1415
+ polymorphicDiscriminator: VectorThreshold.type.polymorphicDiscriminator,
1416
+ modelProperties: Object.assign(Object.assign({}, VectorThreshold.type.modelProperties), { value: {
1417
+ serializedName: "value",
1418
+ required: true,
1419
+ type: {
1420
+ name: "Number",
1421
+ },
946
1422
  } }),
947
1423
  },
948
1424
  };
949
1425
  export let discriminators = {
950
1426
  VectorQuery: VectorQuery,
1427
+ VectorThreshold: VectorThreshold,
951
1428
  "VectorQuery.vector": VectorizedQuery,
952
1429
  "VectorQuery.text": VectorizableTextQuery,
1430
+ "VectorQuery.imageUrl": VectorizableImageUrlQuery,
1431
+ "VectorQuery.imageBinary": VectorizableImageBinaryQuery,
1432
+ "VectorThreshold.vectorSimilarity": VectorSimilarityThreshold,
1433
+ "VectorThreshold.searchScore": SearchScoreThreshold,
953
1434
  };
954
1435
  //# sourceMappingURL=mappers.js.map