@azure/search-documents 12.1.0-beta.1 → 12.1.0

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 (62) hide show
  1. package/README.md +30 -19
  2. package/dist/index.js +652 -1967
  3. package/dist/index.js.map +1 -1
  4. package/dist-esm/src/errorModels.js.map +1 -1
  5. package/dist-esm/src/generated/data/models/index.js +8 -190
  6. package/dist-esm/src/generated/data/models/index.js.map +1 -1
  7. package/dist-esm/src/generated/data/models/mappers.js +48 -194
  8. package/dist-esm/src/generated/data/models/mappers.js.map +1 -1
  9. package/dist-esm/src/generated/data/models/parameters.js +43 -85
  10. package/dist-esm/src/generated/data/models/parameters.js.map +1 -1
  11. package/dist-esm/src/generated/data/operations/documents.js +5 -9
  12. package/dist-esm/src/generated/data/operations/documents.js.map +1 -1
  13. package/dist-esm/src/generated/data/searchClient.js +1 -1
  14. package/dist-esm/src/generated/data/searchClient.js.map +1 -1
  15. package/dist-esm/src/generated/service/models/index.js +123 -129
  16. package/dist-esm/src/generated/service/models/index.js.map +1 -1
  17. package/dist-esm/src/generated/service/models/mappers.js +132 -547
  18. package/dist-esm/src/generated/service/models/mappers.js.map +1 -1
  19. package/dist-esm/src/generated/service/models/parameters.js +1 -51
  20. package/dist-esm/src/generated/service/models/parameters.js.map +1 -1
  21. package/dist-esm/src/generated/service/operations/dataSources.js +1 -4
  22. package/dist-esm/src/generated/service/operations/dataSources.js.map +1 -1
  23. package/dist-esm/src/generated/service/operations/index.js +0 -1
  24. package/dist-esm/src/generated/service/operations/index.js.map +1 -1
  25. package/dist-esm/src/generated/service/operations/indexers.js +1 -29
  26. package/dist-esm/src/generated/service/operations/indexers.js.map +1 -1
  27. package/dist-esm/src/generated/service/operations/skillsets.js +1 -30
  28. package/dist-esm/src/generated/service/operations/skillsets.js.map +1 -1
  29. package/dist-esm/src/generated/service/operationsInterfaces/index.js +0 -1
  30. package/dist-esm/src/generated/service/operationsInterfaces/index.js.map +1 -1
  31. package/dist-esm/src/generated/service/operationsInterfaces/indexers.js.map +1 -1
  32. package/dist-esm/src/generated/service/operationsInterfaces/skillsets.js.map +1 -1
  33. package/dist-esm/src/generated/service/searchServiceClient.js +2 -3
  34. package/dist-esm/src/generated/service/searchServiceClient.js.map +1 -1
  35. package/dist-esm/src/index.js +3 -3
  36. package/dist-esm/src/index.js.map +1 -1
  37. package/dist-esm/src/indexModels.js.map +1 -1
  38. package/dist-esm/src/searchClient.js +2 -12
  39. package/dist-esm/src/searchClient.js.map +1 -1
  40. package/dist-esm/src/searchIndexClient.js +3 -152
  41. package/dist-esm/src/searchIndexClient.js.map +1 -1
  42. package/dist-esm/src/searchIndexerClient.js +0 -47
  43. package/dist-esm/src/searchIndexerClient.js.map +1 -1
  44. package/dist-esm/src/searchIndexingBufferedSender.js +2 -1
  45. package/dist-esm/src/searchIndexingBufferedSender.js.map +1 -1
  46. package/dist-esm/src/serialization.js +34 -70
  47. package/dist-esm/src/serialization.js.map +1 -1
  48. package/dist-esm/src/serviceModels.js.map +1 -1
  49. package/dist-esm/src/serviceUtils.js +42 -116
  50. package/dist-esm/src/serviceUtils.js.map +1 -1
  51. package/dist-esm/src/walk.js +79 -0
  52. package/dist-esm/src/walk.js.map +1 -0
  53. package/package.json +13 -11
  54. package/types/search-documents.d.ts +6375 -7432
  55. package/dist-esm/src/constants.js +0 -5
  56. package/dist-esm/src/constants.js.map +0 -1
  57. package/dist-esm/src/generated/service/operations/aliases.js +0 -160
  58. package/dist-esm/src/generated/service/operations/aliases.js.map +0 -1
  59. package/dist-esm/src/generated/service/operationsInterfaces/aliases.js +0 -9
  60. package/dist-esm/src/generated/service/operationsInterfaces/aliases.js.map +0 -1
  61. package/dist-esm/src/generatedStringLiteralUnions.js +0 -4
  62. package/dist-esm/src/generatedStringLiteralUnions.js.map +0 -1
@@ -5,12 +5,12 @@
5
5
  * Code generated by Microsoft (R) AutoRest Code Generator.
6
6
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
7
7
  */
8
- /** Known values of {@link ApiVersion20240301Preview} that the service accepts. */
9
- export var KnownApiVersion20240301Preview;
10
- (function (KnownApiVersion20240301Preview) {
11
- /** Api Version '2024-03-01-Preview' */
12
- KnownApiVersion20240301Preview["TwoThousandTwentyFour0301Preview"] = "2024-03-01-Preview";
13
- })(KnownApiVersion20240301Preview || (KnownApiVersion20240301Preview = {}));
8
+ /** Known values of {@link ApiVersion20240701} that the service accepts. */
9
+ export var KnownApiVersion20240701;
10
+ (function (KnownApiVersion20240701) {
11
+ /** Api Version '2024-07-01' */
12
+ KnownApiVersion20240701["TwoThousandTwentyFour0701"] = "2024-07-01";
13
+ })(KnownApiVersion20240701 || (KnownApiVersion20240701 = {}));
14
14
  /** Known values of {@link SearchIndexerDataSourceType} that the service accepts. */
15
15
  export var KnownSearchIndexerDataSourceType;
16
16
  (function (KnownSearchIndexerDataSourceType) {
@@ -79,20 +79,6 @@ export var KnownIndexerExecutionEnvironment;
79
79
  /** Indicates that the indexer should run with the environment provisioned specifically for the search service. This should only be specified as the execution environment if the indexer needs to access resources securely over shared private link resources. */
80
80
  KnownIndexerExecutionEnvironment["Private"] = "private";
81
81
  })(KnownIndexerExecutionEnvironment || (KnownIndexerExecutionEnvironment = {}));
82
- /** Known values of {@link IndexerExecutionStatusDetail} that the service accepts. */
83
- export var KnownIndexerExecutionStatusDetail;
84
- (function (KnownIndexerExecutionStatusDetail) {
85
- /** Indicates that the reset that occurred was for a call to ResetDocs. */
86
- KnownIndexerExecutionStatusDetail["ResetDocs"] = "resetDocs";
87
- })(KnownIndexerExecutionStatusDetail || (KnownIndexerExecutionStatusDetail = {}));
88
- /** Known values of {@link IndexingMode} that the service accepts. */
89
- export var KnownIndexingMode;
90
- (function (KnownIndexingMode) {
91
- /** The indexer is indexing all documents in the datasource. */
92
- KnownIndexingMode["IndexingAllDocs"] = "indexingAllDocs";
93
- /** The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status. */
94
- KnownIndexingMode["IndexingResetDocs"] = "indexingResetDocs";
95
- })(KnownIndexingMode || (KnownIndexingMode = {}));
96
82
  /** Known values of {@link IndexProjectionMode} that the service accepts. */
97
83
  export var KnownIndexProjectionMode;
98
84
  (function (KnownIndexProjectionMode) {
@@ -128,6 +114,8 @@ export var KnownSearchFieldDataType;
128
114
  KnownSearchFieldDataType["Int16"] = "Edm.Int16";
129
115
  /** Indicates that a field contains a 8-bit signed integer. This is only valid when used with Collection(Edm.SByte). */
130
116
  KnownSearchFieldDataType["SByte"] = "Edm.SByte";
117
+ /** Indicates that a field contains a 8-bit unsigned integer. This is only valid when used with Collection(Edm.Byte). */
118
+ KnownSearchFieldDataType["Byte"] = "Edm.Byte";
131
119
  })(KnownSearchFieldDataType || (KnownSearchFieldDataType = {}));
132
120
  /** Known values of {@link LexicalAnalyzerName} that the service accepts. */
133
121
  export var KnownLexicalAnalyzerName;
@@ -306,7 +294,7 @@ export var KnownLexicalAnalyzerName;
306
294
  KnownLexicalAnalyzerName["ViMicrosoft"] = "vi.microsoft";
307
295
  /** Standard Lucene analyzer. */
308
296
  KnownLexicalAnalyzerName["StandardLucene"] = "standard.lucene";
309
- /** Standard ASCII Folding Lucene analyzer. See https:\//docs.microsoft.com\/rest\/api\/searchservice\/Custom-analyzers-in-Azure-Search#Analyzers */
297
+ /** Standard ASCII Folding Lucene analyzer. See https:\//learn.microsoft.com\/rest\/api\/searchservice\/Custom-analyzers-in-Azure-Search#Analyzers */
310
298
  KnownLexicalAnalyzerName["StandardAsciiFoldingLucene"] = "standardasciifolding.lucene";
311
299
  /** Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/KeywordAnalyzer.html */
312
300
  KnownLexicalAnalyzerName["Keyword"] = "keyword";
@@ -319,20 +307,12 @@ export var KnownLexicalAnalyzerName;
319
307
  /** An analyzer that uses the whitespace tokenizer. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/WhitespaceAnalyzer.html */
320
308
  KnownLexicalAnalyzerName["Whitespace"] = "whitespace";
321
309
  })(KnownLexicalAnalyzerName || (KnownLexicalAnalyzerName = {}));
322
- /** Known values of {@link LexicalNormalizerName} that the service accepts. */
323
- export var KnownLexicalNormalizerName;
324
- (function (KnownLexicalNormalizerName) {
325
- /** Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/ASCIIFoldingFilter.html */
326
- KnownLexicalNormalizerName["AsciiFolding"] = "asciifolding";
327
- /** Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/util\/ElisionFilter.html */
328
- KnownLexicalNormalizerName["Elision"] = "elision";
329
- /** Normalizes token text to lowercase. See https:\//lucene.apache.org\/core\/6_6_1\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/LowerCaseFilter.html */
330
- KnownLexicalNormalizerName["Lowercase"] = "lowercase";
331
- /** Standard normalizer, which consists of lowercase and asciifolding. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/reverse\/ReverseStringFilter.html */
332
- KnownLexicalNormalizerName["Standard"] = "standard";
333
- /** Normalizes token text to uppercase. See https:\//lucene.apache.org\/core\/6_6_1\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/UpperCaseFilter.html */
334
- KnownLexicalNormalizerName["Uppercase"] = "uppercase";
335
- })(KnownLexicalNormalizerName || (KnownLexicalNormalizerName = {}));
310
+ /** Known values of {@link VectorEncodingFormat} that the service accepts. */
311
+ export var KnownVectorEncodingFormat;
312
+ (function (KnownVectorEncodingFormat) {
313
+ /** Encoding format representing bits packed into a wider data type. */
314
+ KnownVectorEncodingFormat["PackedBit"] = "packedBit";
315
+ })(KnownVectorEncodingFormat || (KnownVectorEncodingFormat = {}));
336
316
  /** Known values of {@link VectorSearchAlgorithmKind} that the service accepts. */
337
317
  export var KnownVectorSearchAlgorithmKind;
338
318
  (function (KnownVectorSearchAlgorithmKind) {
@@ -354,101 +334,37 @@ export var KnownVectorSearchCompressionKind;
354
334
  (function (KnownVectorSearchCompressionKind) {
355
335
  /** Scalar Quantization, a type of compression method. In scalar quantization, the original vectors values are compressed to a narrower type by discretizing and representing each component of a vector using a reduced set of quantized values, thereby reducing the overall data size. */
356
336
  KnownVectorSearchCompressionKind["ScalarQuantization"] = "scalarQuantization";
337
+ /** Binary Quantization, a type of compression method. In binary quantization, the original vectors values are compressed to the narrower binary type by discretizing and representing each component of a vector using binary values, thereby reducing the overall data size. */
338
+ KnownVectorSearchCompressionKind["BinaryQuantization"] = "binaryQuantization";
357
339
  })(KnownVectorSearchCompressionKind || (KnownVectorSearchCompressionKind = {}));
358
- /** Known values of {@link TokenFilterName} that the service accepts. */
359
- export var KnownTokenFilterName;
360
- (function (KnownTokenFilterName) {
361
- /** A token filter that applies the Arabic normalizer to normalize the orthography. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/ar\/ArabicNormalizationFilter.html */
362
- KnownTokenFilterName["ArabicNormalization"] = "arabic_normalization";
363
- /** Strips all characters after an apostrophe (including the apostrophe itself). See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/tr\/ApostropheFilter.html */
364
- KnownTokenFilterName["Apostrophe"] = "apostrophe";
365
- /** Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/ASCIIFoldingFilter.html */
366
- KnownTokenFilterName["AsciiFolding"] = "asciifolding";
367
- /** Forms bigrams of CJK terms that are generated from the standard tokenizer. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/cjk\/CJKBigramFilter.html */
368
- KnownTokenFilterName["CjkBigram"] = "cjk_bigram";
369
- /** Normalizes CJK width differences. Folds fullwidth ASCII variants into the equivalent basic Latin, and half-width Katakana variants into the equivalent Kana. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/cjk\/CJKWidthFilter.html */
370
- KnownTokenFilterName["CjkWidth"] = "cjk_width";
371
- /** Removes English possessives, and dots from acronyms. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/standard\/ClassicFilter.html */
372
- KnownTokenFilterName["Classic"] = "classic";
373
- /** Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/commongrams\/CommonGramsFilter.html */
374
- KnownTokenFilterName["CommonGram"] = "common_grams";
375
- /** Generates n-grams of the given size(s) starting from the front or the back of an input token. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/ngram\/EdgeNGramTokenFilter.html */
376
- KnownTokenFilterName["EdgeNGram"] = "edgeNGram_v2";
377
- /** Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/util\/ElisionFilter.html */
378
- KnownTokenFilterName["Elision"] = "elision";
379
- /** Normalizes German characters according to the heuristics of the German2 snowball algorithm. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/de\/GermanNormalizationFilter.html */
380
- KnownTokenFilterName["GermanNormalization"] = "german_normalization";
381
- /** Normalizes text in Hindi to remove some differences in spelling variations. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/hi\/HindiNormalizationFilter.html */
382
- KnownTokenFilterName["HindiNormalization"] = "hindi_normalization";
383
- /** Normalizes the Unicode representation of text in Indian languages. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/in\/IndicNormalizationFilter.html */
384
- KnownTokenFilterName["IndicNormalization"] = "indic_normalization";
385
- /** Emits each incoming token twice, once as keyword and once as non-keyword. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/KeywordRepeatFilter.html */
386
- KnownTokenFilterName["KeywordRepeat"] = "keyword_repeat";
387
- /** A high-performance kstem filter for English. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/en\/KStemFilter.html */
388
- KnownTokenFilterName["KStem"] = "kstem";
389
- /** Removes words that are too long or too short. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/LengthFilter.html */
390
- KnownTokenFilterName["Length"] = "length";
391
- /** Limits the number of tokens while indexing. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/LimitTokenCountFilter.html */
392
- KnownTokenFilterName["Limit"] = "limit";
393
- /** Normalizes token text to lower case. See https:\//lucene.apache.org\/core\/6_6_1\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/LowerCaseFilter.html */
394
- KnownTokenFilterName["Lowercase"] = "lowercase";
395
- /** Generates n-grams of the given size(s). See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/ngram\/NGramTokenFilter.html */
396
- KnownTokenFilterName["NGram"] = "nGram_v2";
397
- /** Applies normalization for Persian. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/fa\/PersianNormalizationFilter.html */
398
- KnownTokenFilterName["PersianNormalization"] = "persian_normalization";
399
- /** Create tokens for phonetic matches. See https:\//lucene.apache.org\/core\/4_10_3\/analyzers-phonetic\/org\/apache\/lucene\/analysis\/phonetic\/package-tree.html */
400
- KnownTokenFilterName["Phonetic"] = "phonetic";
401
- /** Uses the Porter stemming algorithm to transform the token stream. See http:\//tartarus.org\/~martin\/PorterStemmer */
402
- KnownTokenFilterName["PorterStem"] = "porter_stem";
403
- /** Reverses the token string. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/reverse\/ReverseStringFilter.html */
404
- KnownTokenFilterName["Reverse"] = "reverse";
405
- /** Normalizes use of the interchangeable Scandinavian characters. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/ScandinavianNormalizationFilter.html */
406
- KnownTokenFilterName["ScandinavianNormalization"] = "scandinavian_normalization";
407
- /** Folds Scandinavian characters åÅäæÄÆ->a and öÖøØ->o. It also discriminates against use of double vowels aa, ae, ao, oe and oo, leaving just the first one. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/ScandinavianFoldingFilter.html */
408
- KnownTokenFilterName["ScandinavianFoldingNormalization"] = "scandinavian_folding";
409
- /** Creates combinations of tokens as a single token. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/shingle\/ShingleFilter.html */
410
- KnownTokenFilterName["Shingle"] = "shingle";
411
- /** A filter that stems words using a Snowball-generated stemmer. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/snowball\/SnowballFilter.html */
412
- KnownTokenFilterName["Snowball"] = "snowball";
413
- /** Normalizes the Unicode representation of Sorani text. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/ckb\/SoraniNormalizationFilter.html */
414
- KnownTokenFilterName["SoraniNormalization"] = "sorani_normalization";
415
- /** Language specific stemming filter. See https:\//docs.microsoft.com\/rest\/api\/searchservice\/Custom-analyzers-in-Azure-Search#TokenFilters */
416
- KnownTokenFilterName["Stemmer"] = "stemmer";
417
- /** Removes stop words from a token stream. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/StopFilter.html */
418
- KnownTokenFilterName["Stopwords"] = "stopwords";
419
- /** Trims leading and trailing whitespace from tokens. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/TrimFilter.html */
420
- KnownTokenFilterName["Trim"] = "trim";
421
- /** Truncates the terms to a specific length. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/TruncateTokenFilter.html */
422
- KnownTokenFilterName["Truncate"] = "truncate";
423
- /** Filters out tokens with same text as the previous token. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/RemoveDuplicatesTokenFilter.html */
424
- KnownTokenFilterName["Unique"] = "unique";
425
- /** Normalizes token text to upper case. See https:\//lucene.apache.org\/core\/6_6_1\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/UpperCaseFilter.html */
426
- KnownTokenFilterName["Uppercase"] = "uppercase";
427
- /** Splits words into subwords and performs optional transformations on subword groups. */
428
- KnownTokenFilterName["WordDelimiter"] = "word_delimiter";
429
- })(KnownTokenFilterName || (KnownTokenFilterName = {}));
430
- /** Known values of {@link CharFilterName} that the service accepts. */
431
- export var KnownCharFilterName;
432
- (function (KnownCharFilterName) {
433
- /** A character filter that attempts to strip out HTML constructs. See https:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/charfilter\/HTMLStripCharFilter.html */
434
- KnownCharFilterName["HtmlStrip"] = "html_strip";
435
- })(KnownCharFilterName || (KnownCharFilterName = {}));
436
340
  /** Known values of {@link VectorSearchAlgorithmMetric} that the service accepts. */
437
341
  export var KnownVectorSearchAlgorithmMetric;
438
342
  (function (KnownVectorSearchAlgorithmMetric) {
439
- /** Cosine */
343
+ /** Measures the angle between vectors to quantify their similarity, disregarding magnitude. The smaller the angle, the closer the similarity. */
440
344
  KnownVectorSearchAlgorithmMetric["Cosine"] = "cosine";
441
- /** Euclidean */
345
+ /** Computes the straight-line distance between vectors in a multi-dimensional space. The smaller the distance, the closer the similarity. */
442
346
  KnownVectorSearchAlgorithmMetric["Euclidean"] = "euclidean";
443
- /** DotProduct */
347
+ /** Calculates the sum of element-wise products to gauge alignment and magnitude similarity. The larger and more positive, the closer the similarity. */
444
348
  KnownVectorSearchAlgorithmMetric["DotProduct"] = "dotProduct";
349
+ /** Only applicable to bit-packed binary data types. Determines dissimilarity by counting differing positions in binary vectors. The fewer differences, the closer the similarity. */
350
+ KnownVectorSearchAlgorithmMetric["Hamming"] = "hamming";
445
351
  })(KnownVectorSearchAlgorithmMetric || (KnownVectorSearchAlgorithmMetric = {}));
446
- /** Known values of {@link VectorSearchCompressionTargetDataType} that the service accepts. */
447
- export var KnownVectorSearchCompressionTargetDataType;
448
- (function (KnownVectorSearchCompressionTargetDataType) {
352
+ /** Known values of {@link VectorSearchCompressionTarget} that the service accepts. */
353
+ export var KnownVectorSearchCompressionTarget;
354
+ (function (KnownVectorSearchCompressionTarget) {
449
355
  /** Int8 */
450
- KnownVectorSearchCompressionTargetDataType["Int8"] = "int8";
451
- })(KnownVectorSearchCompressionTargetDataType || (KnownVectorSearchCompressionTargetDataType = {}));
356
+ KnownVectorSearchCompressionTarget["Int8"] = "int8";
357
+ })(KnownVectorSearchCompressionTarget || (KnownVectorSearchCompressionTarget = {}));
358
+ /** Known values of {@link AzureOpenAIModelName} that the service accepts. */
359
+ export var KnownAzureOpenAIModelName;
360
+ (function (KnownAzureOpenAIModelName) {
361
+ /** TextEmbeddingAda002 */
362
+ KnownAzureOpenAIModelName["TextEmbeddingAda002"] = "text-embedding-ada-002";
363
+ /** TextEmbedding3Large */
364
+ KnownAzureOpenAIModelName["TextEmbedding3Large"] = "text-embedding-3-large";
365
+ /** TextEmbedding3Small */
366
+ KnownAzureOpenAIModelName["TextEmbedding3Small"] = "text-embedding-3-small";
367
+ })(KnownAzureOpenAIModelName || (KnownAzureOpenAIModelName = {}));
452
368
  /** Known values of {@link KeyPhraseExtractionSkillLanguage} that the service accepts. */
453
369
  export var KnownKeyPhraseExtractionSkillLanguage;
454
370
  (function (KnownKeyPhraseExtractionSkillLanguage) {
@@ -829,18 +745,18 @@ export var KnownOcrSkillLanguage;
829
745
  /** Unknown (All) */
830
746
  KnownOcrSkillLanguage["Unk"] = "unk";
831
747
  })(KnownOcrSkillLanguage || (KnownOcrSkillLanguage = {}));
832
- /** Known values of {@link LineEnding} that the service accepts. */
833
- export var KnownLineEnding;
834
- (function (KnownLineEnding) {
748
+ /** Known values of {@link OcrLineEnding} that the service accepts. */
749
+ export var KnownOcrLineEnding;
750
+ (function (KnownOcrLineEnding) {
835
751
  /** Lines are separated by a single space character. */
836
- KnownLineEnding["Space"] = "space";
752
+ KnownOcrLineEnding["Space"] = "space";
837
753
  /** Lines are separated by a carriage return ('\r') character. */
838
- KnownLineEnding["CarriageReturn"] = "carriageReturn";
754
+ KnownOcrLineEnding["CarriageReturn"] = "carriageReturn";
839
755
  /** Lines are separated by a single line feed ('\n') character. */
840
- KnownLineEnding["LineFeed"] = "lineFeed";
756
+ KnownOcrLineEnding["LineFeed"] = "lineFeed";
841
757
  /** Lines are separated by a carriage return and a line feed ('\r\n') character. */
842
- KnownLineEnding["CarriageReturnLineFeed"] = "carriageReturnLineFeed";
843
- })(KnownLineEnding || (KnownLineEnding = {}));
758
+ KnownOcrLineEnding["CarriageReturnLineFeed"] = "carriageReturnLineFeed";
759
+ })(KnownOcrLineEnding || (KnownOcrLineEnding = {}));
844
760
  /** Known values of {@link ImageAnalysisSkillLanguage} that the service accepts. */
845
761
  export var KnownImageAnalysisSkillLanguage;
846
762
  (function (KnownImageAnalysisSkillLanguage) {
@@ -1363,6 +1279,84 @@ export var KnownLexicalTokenizerName;
1363
1279
  /** Divides text at whitespace. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/WhitespaceTokenizer.html */
1364
1280
  KnownLexicalTokenizerName["Whitespace"] = "whitespace";
1365
1281
  })(KnownLexicalTokenizerName || (KnownLexicalTokenizerName = {}));
1282
+ /** Known values of {@link TokenFilterName} that the service accepts. */
1283
+ export var KnownTokenFilterName;
1284
+ (function (KnownTokenFilterName) {
1285
+ /** A token filter that applies the Arabic normalizer to normalize the orthography. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/ar\/ArabicNormalizationFilter.html */
1286
+ KnownTokenFilterName["ArabicNormalization"] = "arabic_normalization";
1287
+ /** Strips all characters after an apostrophe (including the apostrophe itself). See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/tr\/ApostropheFilter.html */
1288
+ KnownTokenFilterName["Apostrophe"] = "apostrophe";
1289
+ /** Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/ASCIIFoldingFilter.html */
1290
+ KnownTokenFilterName["AsciiFolding"] = "asciifolding";
1291
+ /** Forms bigrams of CJK terms that are generated from the standard tokenizer. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/cjk\/CJKBigramFilter.html */
1292
+ KnownTokenFilterName["CjkBigram"] = "cjk_bigram";
1293
+ /** Normalizes CJK width differences. Folds fullwidth ASCII variants into the equivalent basic Latin, and half-width Katakana variants into the equivalent Kana. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/cjk\/CJKWidthFilter.html */
1294
+ KnownTokenFilterName["CjkWidth"] = "cjk_width";
1295
+ /** Removes English possessives, and dots from acronyms. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/standard\/ClassicFilter.html */
1296
+ KnownTokenFilterName["Classic"] = "classic";
1297
+ /** Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/commongrams\/CommonGramsFilter.html */
1298
+ KnownTokenFilterName["CommonGram"] = "common_grams";
1299
+ /** Generates n-grams of the given size(s) starting from the front or the back of an input token. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/ngram\/EdgeNGramTokenFilter.html */
1300
+ KnownTokenFilterName["EdgeNGram"] = "edgeNGram_v2";
1301
+ /** Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/util\/ElisionFilter.html */
1302
+ KnownTokenFilterName["Elision"] = "elision";
1303
+ /** Normalizes German characters according to the heuristics of the German2 snowball algorithm. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/de\/GermanNormalizationFilter.html */
1304
+ KnownTokenFilterName["GermanNormalization"] = "german_normalization";
1305
+ /** Normalizes text in Hindi to remove some differences in spelling variations. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/hi\/HindiNormalizationFilter.html */
1306
+ KnownTokenFilterName["HindiNormalization"] = "hindi_normalization";
1307
+ /** Normalizes the Unicode representation of text in Indian languages. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/in\/IndicNormalizationFilter.html */
1308
+ KnownTokenFilterName["IndicNormalization"] = "indic_normalization";
1309
+ /** Emits each incoming token twice, once as keyword and once as non-keyword. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/KeywordRepeatFilter.html */
1310
+ KnownTokenFilterName["KeywordRepeat"] = "keyword_repeat";
1311
+ /** A high-performance kstem filter for English. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/en\/KStemFilter.html */
1312
+ KnownTokenFilterName["KStem"] = "kstem";
1313
+ /** Removes words that are too long or too short. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/LengthFilter.html */
1314
+ KnownTokenFilterName["Length"] = "length";
1315
+ /** Limits the number of tokens while indexing. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/LimitTokenCountFilter.html */
1316
+ KnownTokenFilterName["Limit"] = "limit";
1317
+ /** Normalizes token text to lower case. See https:\//lucene.apache.org\/core\/6_6_1\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/LowerCaseFilter.html */
1318
+ KnownTokenFilterName["Lowercase"] = "lowercase";
1319
+ /** Generates n-grams of the given size(s). See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/ngram\/NGramTokenFilter.html */
1320
+ KnownTokenFilterName["NGram"] = "nGram_v2";
1321
+ /** Applies normalization for Persian. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/fa\/PersianNormalizationFilter.html */
1322
+ KnownTokenFilterName["PersianNormalization"] = "persian_normalization";
1323
+ /** Create tokens for phonetic matches. See https:\//lucene.apache.org\/core\/4_10_3\/analyzers-phonetic\/org\/apache\/lucene\/analysis\/phonetic\/package-tree.html */
1324
+ KnownTokenFilterName["Phonetic"] = "phonetic";
1325
+ /** Uses the Porter stemming algorithm to transform the token stream. See http:\//tartarus.org\/~martin\/PorterStemmer */
1326
+ KnownTokenFilterName["PorterStem"] = "porter_stem";
1327
+ /** Reverses the token string. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/reverse\/ReverseStringFilter.html */
1328
+ KnownTokenFilterName["Reverse"] = "reverse";
1329
+ /** Normalizes use of the interchangeable Scandinavian characters. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/ScandinavianNormalizationFilter.html */
1330
+ KnownTokenFilterName["ScandinavianNormalization"] = "scandinavian_normalization";
1331
+ /** Folds Scandinavian characters åÅäæÄÆ->a and öÖøØ->o. It also discriminates against use of double vowels aa, ae, ao, oe and oo, leaving just the first one. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/ScandinavianFoldingFilter.html */
1332
+ KnownTokenFilterName["ScandinavianFoldingNormalization"] = "scandinavian_folding";
1333
+ /** Creates combinations of tokens as a single token. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/shingle\/ShingleFilter.html */
1334
+ KnownTokenFilterName["Shingle"] = "shingle";
1335
+ /** A filter that stems words using a Snowball-generated stemmer. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/snowball\/SnowballFilter.html */
1336
+ KnownTokenFilterName["Snowball"] = "snowball";
1337
+ /** Normalizes the Unicode representation of Sorani text. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/ckb\/SoraniNormalizationFilter.html */
1338
+ KnownTokenFilterName["SoraniNormalization"] = "sorani_normalization";
1339
+ /** Language specific stemming filter. See https:\//learn.microsoft.com\/rest\/api\/searchservice\/Custom-analyzers-in-Azure-Search#TokenFilters */
1340
+ KnownTokenFilterName["Stemmer"] = "stemmer";
1341
+ /** Removes stop words from a token stream. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/StopFilter.html */
1342
+ KnownTokenFilterName["Stopwords"] = "stopwords";
1343
+ /** Trims leading and trailing whitespace from tokens. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/TrimFilter.html */
1344
+ KnownTokenFilterName["Trim"] = "trim";
1345
+ /** Truncates the terms to a specific length. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/TruncateTokenFilter.html */
1346
+ KnownTokenFilterName["Truncate"] = "truncate";
1347
+ /** Filters out tokens with same text as the previous token. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/RemoveDuplicatesTokenFilter.html */
1348
+ KnownTokenFilterName["Unique"] = "unique";
1349
+ /** Normalizes token text to upper case. See https:\//lucene.apache.org\/core\/6_6_1\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/UpperCaseFilter.html */
1350
+ KnownTokenFilterName["Uppercase"] = "uppercase";
1351
+ /** Splits words into subwords and performs optional transformations on subword groups. */
1352
+ KnownTokenFilterName["WordDelimiter"] = "word_delimiter";
1353
+ })(KnownTokenFilterName || (KnownTokenFilterName = {}));
1354
+ /** Known values of {@link CharFilterName} that the service accepts. */
1355
+ export var KnownCharFilterName;
1356
+ (function (KnownCharFilterName) {
1357
+ /** A character filter that attempts to strip out HTML constructs. See https:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/charfilter\/HTMLStripCharFilter.html */
1358
+ KnownCharFilterName["HtmlStrip"] = "html_strip";
1359
+ })(KnownCharFilterName || (KnownCharFilterName = {}));
1366
1360
  /** Known values of {@link RegexFlags} that the service accepts. */
1367
1361
  export var KnownRegexFlags;
1368
1362
  (function (KnownRegexFlags) {