@azure/search-documents 11.3.0-alpha.20210930.1 → 11.3.0-alpha.20211109.3

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/CHANGELOG.md +37 -0
  2. package/dist/index.js +1690 -376
  3. package/dist/index.js.map +1 -1
  4. package/dist-esm/src/constants.js +1 -1
  5. package/dist-esm/src/constants.js.map +1 -1
  6. package/dist-esm/src/generated/data/models/index.js +202 -1
  7. package/dist-esm/src/generated/data/models/index.js.map +1 -1
  8. package/dist-esm/src/generated/data/models/mappers.js +6 -0
  9. package/dist-esm/src/generated/data/models/mappers.js.map +1 -1
  10. package/dist-esm/src/generated/data/models/parameters.js +21 -13
  11. package/dist-esm/src/generated/data/models/parameters.js.map +1 -1
  12. package/dist-esm/src/generated/data/operations/documents.js +16 -49
  13. package/dist-esm/src/generated/data/operations/documents.js.map +1 -1
  14. package/dist-esm/src/generated/data/searchClientContext.js +13 -10
  15. package/dist-esm/src/generated/data/searchClientContext.js.map +1 -1
  16. package/dist-esm/src/generated/service/models/index.js +902 -1
  17. package/dist-esm/src/generated/service/models/index.js.map +1 -1
  18. package/dist-esm/src/generated/service/models/mappers.js +271 -2
  19. package/dist-esm/src/generated/service/models/mappers.js.map +1 -1
  20. package/dist-esm/src/generated/service/models/parameters.js +21 -3
  21. package/dist-esm/src/generated/service/models/parameters.js.map +1 -1
  22. package/dist-esm/src/generated/service/operations/dataSources.js +12 -29
  23. package/dist-esm/src/generated/service/operations/dataSources.js.map +1 -1
  24. package/dist-esm/src/generated/service/operations/indexers.js +40 -44
  25. package/dist-esm/src/generated/service/operations/indexers.js.map +1 -1
  26. package/dist-esm/src/generated/service/operations/indexes.js +10 -39
  27. package/dist-esm/src/generated/service/operations/indexes.js.map +1 -1
  28. package/dist-esm/src/generated/service/operations/skillsets.js +38 -29
  29. package/dist-esm/src/generated/service/operations/skillsets.js.map +1 -1
  30. package/dist-esm/src/generated/service/operations/synonymMaps.js +8 -28
  31. package/dist-esm/src/generated/service/operations/synonymMaps.js.map +1 -1
  32. package/dist-esm/src/generated/service/operationsInterfaces/dataSources.js.map +1 -1
  33. package/dist-esm/src/generated/service/operationsInterfaces/indexers.js.map +1 -1
  34. package/dist-esm/src/generated/service/operationsInterfaces/indexes.js.map +1 -1
  35. package/dist-esm/src/generated/service/operationsInterfaces/skillsets.js.map +1 -1
  36. package/dist-esm/src/generated/service/operationsInterfaces/synonymMaps.js.map +1 -1
  37. package/dist-esm/src/generated/service/searchServiceClient.js +3 -6
  38. package/dist-esm/src/generated/service/searchServiceClient.js.map +1 -1
  39. package/dist-esm/src/generated/service/searchServiceClientContext.js +13 -10
  40. package/dist-esm/src/generated/service/searchServiceClientContext.js.map +1 -1
  41. package/dist-esm/src/index.js +2 -0
  42. package/dist-esm/src/index.js.map +1 -1
  43. package/dist-esm/src/indexModels.js.map +1 -1
  44. package/dist-esm/src/odataMetadataPolicy.js +6 -14
  45. package/dist-esm/src/odataMetadataPolicy.js.map +1 -1
  46. package/dist-esm/src/searchApiKeyCredentialPolicy.js +7 -20
  47. package/dist-esm/src/searchApiKeyCredentialPolicy.js.map +1 -1
  48. package/dist-esm/src/searchClient.js +27 -22
  49. package/dist-esm/src/searchClient.js.map +1 -1
  50. package/dist-esm/src/searchIndexClient.js +34 -29
  51. package/dist-esm/src/searchIndexClient.js.map +1 -1
  52. package/dist-esm/src/searchIndexerClient.js +79 -33
  53. package/dist-esm/src/searchIndexerClient.js.map +1 -1
  54. package/dist-esm/src/searchIndexingBufferedSender.js +1 -1
  55. package/dist-esm/src/searchIndexingBufferedSender.js.map +1 -1
  56. package/dist-esm/src/serialization.js +1 -1
  57. package/dist-esm/src/serialization.js.map +1 -1
  58. package/dist-esm/src/serviceModels.js.map +1 -1
  59. package/dist-esm/src/serviceUtils.js +12 -13
  60. package/dist-esm/src/serviceUtils.js.map +1 -1
  61. package/package.json +3 -2
  62. package/types/search-documents.d.ts +462 -45
@@ -1,11 +1,11 @@
1
1
  /// <reference lib="esnext.asynciterable" />
2
2
 
3
3
  import { AzureKeyCredential } from '@azure/core-auth';
4
+ import { CommonClientOptions } from '@azure/core-client';
4
5
  import { KeyCredential } from '@azure/core-auth';
5
- import { OperationOptions } from '@azure/core-http';
6
+ import { OperationOptions } from '@azure/core-client';
6
7
  import { PagedAsyncIterableIterator } from '@azure/core-paging';
7
- import { PipelineOptions } from '@azure/core-http';
8
- import { RestError } from '@azure/core-http';
8
+ import { RestError } from '@azure/core-rest-pipeline';
9
9
  import { TokenCredential } from '@azure/core-auth';
10
10
 
11
11
  /** Information about a token returned by an analyzer. */
@@ -538,7 +538,7 @@ export declare interface CreateorUpdateDataSourceConnectionOptions extends Opera
538
538
  /**
539
539
  * Ignores cache reset requirements.
540
540
  */
541
- ignoreResetRequirements?: boolean;
541
+ skipIndexerResetRequirementForCache?: boolean;
542
542
  }
543
543
 
544
544
  /**
@@ -550,7 +550,7 @@ export declare interface CreateorUpdateIndexerOptions extends OperationOptions {
550
550
  */
551
551
  onlyIfUnchanged?: boolean;
552
552
  /** Ignores cache reset requirements. */
553
- ignoreResetRequirements?: boolean;
553
+ skipIndexerResetRequirementForCache?: boolean;
554
554
  /** Disables cache reprocessing change detection. */
555
555
  disableCacheReprocessingChangeDetection?: boolean;
556
556
  }
@@ -583,7 +583,7 @@ export declare interface CreateOrUpdateSkillsetOptions extends OperationOptions
583
583
  /**
584
584
  * Ignores cache reset requirements.
585
585
  */
586
- ignoreResetRequirements?: boolean;
586
+ skipIndexerResetRequirementForCache?: boolean;
587
587
  /**
588
588
  * Disables cache reprocessing change detection.
589
589
  */
@@ -867,7 +867,7 @@ export declare type DocumentExtractionSkill = BaseSearchIndexerSkill & {
867
867
  dataToExtract?: string;
868
868
  /** A dictionary of configurations for the skill. */
869
869
  configuration?: {
870
- [propertyName: string]: any;
870
+ [propertyName: string]: Record<string, unknown>;
871
871
  };
872
872
  };
873
873
 
@@ -1038,7 +1038,7 @@ export declare interface FieldMappingFunction {
1038
1038
  name: string;
1039
1039
  /** A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. */
1040
1040
  parameters?: {
1041
- [propertyName: string]: any;
1041
+ [propertyName: string]: Record<string, unknown>;
1042
1042
  };
1043
1043
  }
1044
1044
 
@@ -1282,6 +1282,16 @@ export declare interface IndexerExecutionResult {
1282
1282
  * NOTE: This property will not be serialized. It can only be populated by the server.
1283
1283
  */
1284
1284
  readonly status: IndexerExecutionStatus;
1285
+ /**
1286
+ * The outcome of this indexer execution.
1287
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1288
+ */
1289
+ readonly statusDetail?: IndexerExecutionStatusDetail;
1290
+ /**
1291
+ * All of the state that defines and dictates the indexer's current execution.
1292
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1293
+ */
1294
+ readonly currentState?: IndexerState;
1285
1295
  /**
1286
1296
  * The error message indicating the top-level error, if any.
1287
1297
  * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -1332,9 +1342,67 @@ export declare interface IndexerExecutionResult {
1332
1342
  /** Defines values for IndexerExecutionStatus. */
1333
1343
  export declare type IndexerExecutionStatus = "transientFailure" | "success" | "inProgress" | "reset";
1334
1344
 
1345
+ /**
1346
+ * Defines values for IndexerExecutionStatusDetail. \
1347
+ * {@link KnownIndexerExecutionStatusDetail} can be used interchangeably with IndexerExecutionStatusDetail,
1348
+ * this enum contains the known values that the service supports.
1349
+ * ### Known values supported by the service
1350
+ * **resetDocs**: Indicates that the reset that occurred was for a call to ResetDocs.
1351
+ */
1352
+ export declare type IndexerExecutionStatusDetail = string;
1353
+
1354
+ /** Represents all of the state that defines and dictates the indexer's current execution. */
1355
+ export declare interface IndexerState {
1356
+ /**
1357
+ * The mode the indexer is running in.
1358
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1359
+ */
1360
+ readonly mode?: IndexingMode;
1361
+ /**
1362
+ * Change tracking state used when indexing starts on all documents in the datasource.
1363
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1364
+ */
1365
+ readonly allDocumentsInitialChangeTrackingState?: string;
1366
+ /**
1367
+ * Change tracking state value when indexing finishes on all documents in the datasource.
1368
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1369
+ */
1370
+ readonly allDocumentsFinalChangeTrackingState?: string;
1371
+ /**
1372
+ * Change tracking state used when indexing starts on select, reset documents in the datasource.
1373
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1374
+ */
1375
+ readonly resetDocumentsInitialChangeTrackingState?: string;
1376
+ /**
1377
+ * Change tracking state value when indexing finishes on select, reset documents in the datasource.
1378
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1379
+ */
1380
+ readonly resetDocumentsFinalChangeTrackingState?: string;
1381
+ /**
1382
+ * The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys.
1383
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1384
+ */
1385
+ readonly resetDocumentKeys?: string[];
1386
+ /**
1387
+ * The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids.
1388
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1389
+ */
1390
+ readonly resetDatasourceDocumentIds?: string[];
1391
+ }
1392
+
1335
1393
  /** Defines values for IndexerStatus. */
1336
1394
  export declare type IndexerStatus = "unknown" | "error" | "running";
1337
1395
 
1396
+ /**
1397
+ * Defines values for IndexingMode. \
1398
+ * {@link KnownIndexingMode} can be used interchangeably with IndexingMode,
1399
+ * this enum contains the known values that the service supports.
1400
+ * ### Known values supported by the service
1401
+ * **indexingAllDocs**: The indexer is indexing all documents in the datasource. \
1402
+ * **indexingResetDocs**: The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status.
1403
+ */
1404
+ export declare type IndexingMode = string;
1405
+
1338
1406
  /** Represents parameters for indexer execution. */
1339
1407
  export declare interface IndexingParameters {
1340
1408
  /** The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type. */
@@ -1900,7 +1968,7 @@ export declare enum KnownAnalyzerNames {
1900
1968
  }
1901
1969
 
1902
1970
  /** Known values of {@link Answers} that the service accepts. */
1903
- export declare const enum KnownAnswers {
1971
+ export declare enum KnownAnswers {
1904
1972
  /** Do not return answers for the query. */
1905
1973
  None = "none",
1906
1974
  /** Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. */
@@ -1908,7 +1976,7 @@ export declare const enum KnownAnswers {
1908
1976
  }
1909
1977
 
1910
1978
  /** Known values of {@link BlobIndexerDataToExtract} that the service accepts. */
1911
- export declare const enum KnownBlobIndexerDataToExtract {
1979
+ export declare enum KnownBlobIndexerDataToExtract {
1912
1980
  /** Indexes just the standard blob properties and user-specified metadata. */
1913
1981
  StorageMetadata = "storageMetadata",
1914
1982
  /** Extracts metadata provided by the Azure blob storage subsystem and the content-type specific metadata (for example, metadata unique to just .png files are indexed). */
@@ -1918,7 +1986,7 @@ export declare const enum KnownBlobIndexerDataToExtract {
1918
1986
  }
1919
1987
 
1920
1988
  /** Known values of {@link BlobIndexerImageAction} that the service accepts. */
1921
- export declare const enum KnownBlobIndexerImageAction {
1989
+ export declare enum KnownBlobIndexerImageAction {
1922
1990
  /** Ignores embedded images or image files in the data set. This is the default. */
1923
1991
  None = "none",
1924
1992
  /** Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field. This action requires that "dataToExtract" is set to "contentAndMetadata". A normalized image refers to additional processing resulting in uniform image output, sized and rotated to promote consistent rendering when you include images in visual search results. This information is generated for each image when you use this option. */
@@ -1928,7 +1996,7 @@ export declare const enum KnownBlobIndexerImageAction {
1928
1996
  }
1929
1997
 
1930
1998
  /** Known values of {@link BlobIndexerParsingMode} that the service accepts. */
1931
- export declare const enum KnownBlobIndexerParsingMode {
1999
+ export declare enum KnownBlobIndexerParsingMode {
1932
2000
  /** Set to default for normal file processing. */
1933
2001
  Default = "default",
1934
2002
  /** Set to text to improve indexing performance on plain text files in blob storage. */
@@ -1944,7 +2012,7 @@ export declare const enum KnownBlobIndexerParsingMode {
1944
2012
  }
1945
2013
 
1946
2014
  /** Known values of {@link BlobIndexerPDFTextRotationAlgorithm} that the service accepts. */
1947
- export declare const enum KnownBlobIndexerPDFTextRotationAlgorithm {
2015
+ export declare enum KnownBlobIndexerPDFTextRotationAlgorithm {
1948
2016
  /** Leverages normal text extraction. This is the default. */
1949
2017
  None = "none",
1950
2018
  /** May produce better and more readable text extraction from PDF files that have rotated text within them. Note that there may be a small performance speed impact when this parameter is used. This parameter only applies to PDF files, and only to PDFs with embedded text. If the rotated text appears within an embedded image in the PDF, this parameter does not apply. */
@@ -1952,7 +2020,7 @@ export declare const enum KnownBlobIndexerPDFTextRotationAlgorithm {
1952
2020
  }
1953
2021
 
1954
2022
  /** Known values of {@link CharFilterName} that the service accepts. */
1955
- export declare const enum KnownCharFilterName {
2023
+ export declare enum KnownCharFilterName {
1956
2024
  /** 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 */
1957
2025
  HtmlStrip = "html_strip"
1958
2026
  }
@@ -1970,7 +2038,7 @@ export declare enum KnownCharFilterNames {
1970
2038
  }
1971
2039
 
1972
2040
  /** Known values of {@link CustomEntityLookupSkillLanguage} that the service accepts. */
1973
- export declare const enum KnownCustomEntityLookupSkillLanguage {
2041
+ export declare enum KnownCustomEntityLookupSkillLanguage {
1974
2042
  /** Danish */
1975
2043
  Da = "da",
1976
2044
  /** German */
@@ -1992,7 +2060,7 @@ export declare const enum KnownCustomEntityLookupSkillLanguage {
1992
2060
  }
1993
2061
 
1994
2062
  /** Known values of {@link EntityCategory} that the service accepts. */
1995
- export declare const enum KnownEntityCategory {
2063
+ export declare enum KnownEntityCategory {
1996
2064
  /** Entities describing a physical location. */
1997
2065
  Location = "location",
1998
2066
  /** Entities describing an organization. */
@@ -2010,7 +2078,7 @@ export declare const enum KnownEntityCategory {
2010
2078
  }
2011
2079
 
2012
2080
  /** Known values of {@link EntityRecognitionSkillLanguage} that the service accepts. */
2013
- export declare const enum KnownEntityRecognitionSkillLanguage {
2081
+ export declare enum KnownEntityRecognitionSkillLanguage {
2014
2082
  /** Arabic */
2015
2083
  Ar = "ar",
2016
2084
  /** Czech */
@@ -2060,7 +2128,7 @@ export declare const enum KnownEntityRecognitionSkillLanguage {
2060
2128
  }
2061
2129
 
2062
2130
  /** Known values of {@link ImageAnalysisSkillLanguage} that the service accepts. */
2063
- export declare const enum KnownImageAnalysisSkillLanguage {
2131
+ export declare enum KnownImageAnalysisSkillLanguage {
2064
2132
  /** English */
2065
2133
  En = "en",
2066
2134
  /** Spanish */
@@ -2074,15 +2142,29 @@ export declare const enum KnownImageAnalysisSkillLanguage {
2074
2142
  }
2075
2143
 
2076
2144
  /** Known values of {@link ImageDetail} that the service accepts. */
2077
- export declare const enum KnownImageDetail {
2145
+ export declare enum KnownImageDetail {
2078
2146
  /** Details recognized as celebrities. */
2079
2147
  Celebrities = "celebrities",
2080
2148
  /** Details recognized as landmarks. */
2081
2149
  Landmarks = "landmarks"
2082
2150
  }
2083
2151
 
2152
+ /** Known values of {@link IndexerExecutionStatusDetail} that the service accepts. */
2153
+ export declare enum KnownIndexerExecutionStatusDetail {
2154
+ /** Indicates that the reset that occurred was for a call to ResetDocs. */
2155
+ ResetDocs = "resetDocs"
2156
+ }
2157
+
2158
+ /** Known values of {@link IndexingMode} that the service accepts. */
2159
+ export declare enum KnownIndexingMode {
2160
+ /** The indexer is indexing all documents in the datasource. */
2161
+ IndexingAllDocs = "indexingAllDocs",
2162
+ /** The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status. */
2163
+ IndexingResetDocs = "indexingResetDocs"
2164
+ }
2165
+
2084
2166
  /** Known values of {@link KeyPhraseExtractionSkillLanguage} that the service accepts. */
2085
- export declare const enum KnownKeyPhraseExtractionSkillLanguage {
2167
+ export declare enum KnownKeyPhraseExtractionSkillLanguage {
2086
2168
  /** Danish */
2087
2169
  Da = "da",
2088
2170
  /** Dutch */
@@ -2118,7 +2200,7 @@ export declare const enum KnownKeyPhraseExtractionSkillLanguage {
2118
2200
  }
2119
2201
 
2120
2202
  /** Known values of {@link LexicalAnalyzerName} that the service accepts. */
2121
- export declare const enum KnownLexicalAnalyzerName {
2203
+ export declare enum KnownLexicalAnalyzerName {
2122
2204
  /** Microsoft analyzer for Arabic. */
2123
2205
  ArMicrosoft = "ar.microsoft",
2124
2206
  /** Lucene analyzer for Arabic. */
@@ -2308,7 +2390,7 @@ export declare const enum KnownLexicalAnalyzerName {
2308
2390
  }
2309
2391
 
2310
2392
  /** Known values of {@link LexicalNormalizerName} that the service accepts. */
2311
- export declare const enum KnownLexicalNormalizerName {
2393
+ export declare enum KnownLexicalNormalizerName {
2312
2394
  /** 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 */
2313
2395
  AsciiFolding = "asciifolding",
2314
2396
  /** 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 */
@@ -2322,7 +2404,7 @@ export declare const enum KnownLexicalNormalizerName {
2322
2404
  }
2323
2405
 
2324
2406
  /** Known values of {@link LineEnding} that the service accepts. */
2325
- export declare const enum KnownLineEnding {
2407
+ export declare enum KnownLineEnding {
2326
2408
  /** Lines are separated by a single space character. */
2327
2409
  Space = "space",
2328
2410
  /** Lines are separated by a carriage return ('\r') character. */
@@ -2334,7 +2416,7 @@ export declare const enum KnownLineEnding {
2334
2416
  }
2335
2417
 
2336
2418
  /** Known values of {@link OcrSkillLanguage} that the service accepts. */
2337
- export declare const enum KnownOcrSkillLanguage {
2419
+ export declare enum KnownOcrSkillLanguage {
2338
2420
  /** Chinese-Simplified */
2339
2421
  ZhHans = "zh-Hans",
2340
2422
  /** Chinese-Traditional */
@@ -2390,23 +2472,187 @@ export declare const enum KnownOcrSkillLanguage {
2390
2472
  }
2391
2473
 
2392
2474
  /** Known values of {@link PIIDetectionSkillMaskingMode} that the service accepts. */
2393
- export declare const enum KnownPIIDetectionSkillMaskingMode {
2475
+ export declare enum KnownPIIDetectionSkillMaskingMode {
2394
2476
  /** No masking occurs and the maskedText output will not be returned. */
2395
2477
  None = "none",
2396
2478
  /** Replaces the detected entities with the character given in the maskingCharacter parameter. The character will be repeated to the length of the detected entity so that the offsets will correctly correspond to both the input text as well as the output maskedText. */
2397
2479
  Replace = "replace"
2398
2480
  }
2399
2481
 
2482
+ /** Known values of {@link QueryAnswerType} that the service accepts. */
2483
+ export declare enum KnownQueryAnswerType {
2484
+ /** Do not return answers for the query. */
2485
+ None = "none",
2486
+ /** Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. */
2487
+ Extractive = "extractive"
2488
+ }
2489
+
2490
+ /** Known values of {@link QueryCaptionType} that the service accepts. */
2491
+ export declare enum KnownQueryCaptionType {
2492
+ /** Do not return captions for the query. */
2493
+ None = "none",
2494
+ /** Extracts captions from the matching documents that contain passages relevant to the search query. */
2495
+ Extractive = "extractive"
2496
+ }
2497
+
2400
2498
  /** Known values of {@link QueryLanguage} that the service accepts. */
2401
- export declare const enum KnownQueryLanguage {
2499
+ export declare enum KnownQueryLanguage {
2402
2500
  /** Query language not specified. */
2403
2501
  None = "none",
2404
- /** English */
2405
- EnUs = "en-us"
2502
+ /** Query language value for English (United States). */
2503
+ EnUs = "en-us",
2504
+ /** Query language value for English (Great Britain). */
2505
+ EnGb = "en-gb",
2506
+ /** Query language value for English (India). */
2507
+ EnIn = "en-in",
2508
+ /** Query language value for English (Canada). */
2509
+ EnCa = "en-ca",
2510
+ /** Query language value for English (Australia). */
2511
+ EnAu = "en-au",
2512
+ /** Query language value for French (France). */
2513
+ FrFr = "fr-fr",
2514
+ /** Query language value for French (Canada). */
2515
+ FrCa = "fr-ca",
2516
+ /** Query language value for German (Germany). */
2517
+ DeDe = "de-de",
2518
+ /** Query language value for Spanish (Spain). */
2519
+ EsEs = "es-es",
2520
+ /** Query language value for Spanish (Mexico). */
2521
+ EsMx = "es-mx",
2522
+ /** Query language value for Chinese (China). */
2523
+ ZhCn = "zh-cn",
2524
+ /** Query language value for Chinese (Taiwan). */
2525
+ ZhTw = "zh-tw",
2526
+ /** Query language value for Portuguese (Brazil). */
2527
+ PtBr = "pt-br",
2528
+ /** Query language value for Portuguese (Portugal). */
2529
+ PtPt = "pt-pt",
2530
+ /** Query language value for Italian (Italy). */
2531
+ ItIt = "it-it",
2532
+ /** Query language value for Japanese (Japan). */
2533
+ JaJp = "ja-jp",
2534
+ /** Query language value for Korean (Korea). */
2535
+ KoKr = "ko-kr",
2536
+ /** Query language value for Russian (Russia). */
2537
+ RuRu = "ru-ru",
2538
+ /** Query language value for Czech (Czech Republic). */
2539
+ CsCz = "cs-cz",
2540
+ /** Query language value for Dutch (Belgium). */
2541
+ NlBe = "nl-be",
2542
+ /** Query language value for Dutch (Netherlands). */
2543
+ NlNl = "nl-nl",
2544
+ /** Query language value for Hungarian (Hungary). */
2545
+ HuHu = "hu-hu",
2546
+ /** Query language value for Polish (Poland). */
2547
+ PlPl = "pl-pl",
2548
+ /** Query language value for Swedish (Sweden). */
2549
+ SvSe = "sv-se",
2550
+ /** Query language value for Turkish (Turkey). */
2551
+ TrTr = "tr-tr",
2552
+ /** Query language value for Hindi (India). */
2553
+ HiIn = "hi-in",
2554
+ /** Query language value for Arabic (Saudi Arabia). */
2555
+ ArSa = "ar-sa",
2556
+ /** Query language value for Arabic (Egypt). */
2557
+ ArEg = "ar-eg",
2558
+ /** Query language value for Arabic (Morocco). */
2559
+ ArMa = "ar-ma",
2560
+ /** Query language value for Arabic (Kuwait). */
2561
+ ArKw = "ar-kw",
2562
+ /** Query language value for Arabic (Jordan). */
2563
+ ArJo = "ar-jo",
2564
+ /** Query language value for Danish (Denmark). */
2565
+ DaDk = "da-dk",
2566
+ /** Query language value for Norwegian (Normway). */
2567
+ NoNo = "no-no",
2568
+ /** Query language value for Bulgarian (Bulgary). */
2569
+ BgBg = "bg-bg",
2570
+ /** Query language value for Croatian (Croatia). */
2571
+ HrHr = "hr-hr",
2572
+ /** Query language value for Croatian (Bosnia and Herzegovina). */
2573
+ HrBa = "hr-ba",
2574
+ /** Query language value for Malay (Malaysia). */
2575
+ MsMy = "ms-my",
2576
+ /** Query language value for Malay (Brunei Darussalam). */
2577
+ MsBn = "ms-bn",
2578
+ /** Query language value for Slovenian (Slovenia). */
2579
+ SlSl = "sl-sl",
2580
+ /** Query language value for Tamil (India). */
2581
+ TaIn = "ta-in",
2582
+ /** Query language value for Vietnamese (Viet Nam). */
2583
+ ViVn = "vi-vn",
2584
+ /** Query language value for Greek (Greece). */
2585
+ ElGr = "el-gr",
2586
+ /** Query language value for Romanian (Romania). */
2587
+ RoRo = "ro-ro",
2588
+ /** Query language value for Icelandic (Iceland). */
2589
+ IsIs = "is-is",
2590
+ /** Query language value for Indonesian (Indonesia). */
2591
+ IdId = "id-id",
2592
+ /** Query language value for Thai (Thailand). */
2593
+ ThTh = "th-th",
2594
+ /** Query language value for Lithuanian (Lithuania). */
2595
+ LtLt = "lt-lt",
2596
+ /** Query language value for Ukrainian (Ukraine). */
2597
+ UkUa = "uk-ua",
2598
+ /** Query language value for Latvian (Latvia). */
2599
+ LvLv = "lv-lv",
2600
+ /** Query language value for Estonian (Estonia). */
2601
+ EtEe = "et-ee",
2602
+ /** Query language value for Catalan (Spain). */
2603
+ CaEs = "ca-es",
2604
+ /** Query language value for Finnish (Finland). */
2605
+ FiFi = "fi-fi",
2606
+ /** Query language value for Serbian (Bosnia and Herzegovina). */
2607
+ SrBa = "sr-ba",
2608
+ /** Query language value for Serbian (Montenegro). */
2609
+ SrMe = "sr-me",
2610
+ /** Query language value for Serbian (Serbia). */
2611
+ SrRs = "sr-rs",
2612
+ /** Query language value for Slovak (Slovakia). */
2613
+ SkSk = "sk-sk",
2614
+ /** Query language value for Norwegian (Norway). */
2615
+ NbNo = "nb-no",
2616
+ /** Query language value for Armenian (Armenia). */
2617
+ HyAm = "hy-am",
2618
+ /** Query language value for Bengali (India). */
2619
+ BnIn = "bn-in",
2620
+ /** Query language value for Basque (Spain). */
2621
+ EuEs = "eu-es",
2622
+ /** Query language value for Galician (Spain). */
2623
+ GlEs = "gl-es",
2624
+ /** Query language value for Gujarati (India). */
2625
+ GuIn = "gu-in",
2626
+ /** Query language value for Hebrew (Israel). */
2627
+ HeIl = "he-il",
2628
+ /** Query language value for Irish (Ireland). */
2629
+ GaIe = "ga-ie",
2630
+ /** Query language value for Kannada (India). */
2631
+ KnIn = "kn-in",
2632
+ /** Query language value for Malayalam (India). */
2633
+ MlIn = "ml-in",
2634
+ /** Query language value for Marathi (India). */
2635
+ MrIn = "mr-in",
2636
+ /** Query language value for Persian (U.A.E.). */
2637
+ FaAe = "fa-ae",
2638
+ /** Query language value for Punjabi (India). */
2639
+ PaIn = "pa-in",
2640
+ /** Query language value for Telugu (India). */
2641
+ TeIn = "te-in",
2642
+ /** Query language value for Urdu (Pakistan). */
2643
+ UrPk = "ur-pk"
2644
+ }
2645
+
2646
+ /** Known values of {@link QuerySpellerType} that the service accepts. */
2647
+ export declare enum KnownQuerySpellerType {
2648
+ /** Speller not enabled. */
2649
+ None = "none",
2650
+ /** Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. */
2651
+ Lexicon = "lexicon"
2406
2652
  }
2407
2653
 
2408
2654
  /** Known values of {@link RegexFlags} that the service accepts. */
2409
- export declare const enum KnownRegexFlags {
2655
+ export declare enum KnownRegexFlags {
2410
2656
  /** Enables canonical equivalence. */
2411
2657
  CanonEq = "CANON_EQ",
2412
2658
  /** Enables case-insensitive matching. */
@@ -2426,7 +2672,7 @@ export declare const enum KnownRegexFlags {
2426
2672
  }
2427
2673
 
2428
2674
  /** Known values of {@link SearchIndexerDataSourceType} that the service accepts. */
2429
- export declare const enum KnownSearchIndexerDataSourceType {
2675
+ export declare enum KnownSearchIndexerDataSourceType {
2430
2676
  /** Indicates an Azure SQL datasource. */
2431
2677
  AzureSql = "azuresql",
2432
2678
  /** Indicates a CosmosDB datasource. */
@@ -2442,7 +2688,7 @@ export declare const enum KnownSearchIndexerDataSourceType {
2442
2688
  }
2443
2689
 
2444
2690
  /** Known values of {@link SentimentSkillLanguage} that the service accepts. */
2445
- export declare const enum KnownSentimentSkillLanguage {
2691
+ export declare enum KnownSentimentSkillLanguage {
2446
2692
  /** Danish */
2447
2693
  Da = "da",
2448
2694
  /** Dutch */
@@ -2476,7 +2722,7 @@ export declare const enum KnownSentimentSkillLanguage {
2476
2722
  }
2477
2723
 
2478
2724
  /** Known values of {@link Speller} that the service accepts. */
2479
- export declare const enum KnownSpeller {
2725
+ export declare enum KnownSpeller {
2480
2726
  /** Speller not enabled. */
2481
2727
  None = "none",
2482
2728
  /** Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. */
@@ -2484,7 +2730,7 @@ export declare const enum KnownSpeller {
2484
2730
  }
2485
2731
 
2486
2732
  /** Known values of {@link SplitSkillLanguage} that the service accepts. */
2487
- export declare const enum KnownSplitSkillLanguage {
2733
+ export declare enum KnownSplitSkillLanguage {
2488
2734
  /** Danish */
2489
2735
  Da = "da",
2490
2736
  /** German */
@@ -2506,7 +2752,7 @@ export declare const enum KnownSplitSkillLanguage {
2506
2752
  }
2507
2753
 
2508
2754
  /** Known values of {@link TextSplitMode} that the service accepts. */
2509
- export declare const enum KnownTextSplitMode {
2755
+ export declare enum KnownTextSplitMode {
2510
2756
  /** Split the text into individual pages. */
2511
2757
  Pages = "pages",
2512
2758
  /** Split the text into individual sentences. */
@@ -2514,7 +2760,7 @@ export declare const enum KnownTextSplitMode {
2514
2760
  }
2515
2761
 
2516
2762
  /** Known values of {@link TextTranslationSkillLanguage} that the service accepts. */
2517
- export declare const enum KnownTextTranslationSkillLanguage {
2763
+ export declare enum KnownTextTranslationSkillLanguage {
2518
2764
  /** Afrikaans */
2519
2765
  Af = "af",
2520
2766
  /** Arabic */
@@ -2662,7 +2908,7 @@ export declare const enum KnownTextTranslationSkillLanguage {
2662
2908
  }
2663
2909
 
2664
2910
  /** Known values of {@link TokenFilterName} that the service accepts. */
2665
- export declare const enum KnownTokenFilterName {
2911
+ export declare enum KnownTokenFilterName {
2666
2912
  /** 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 */
2667
2913
  ArabicNormalization = "arabic_normalization",
2668
2914
  /** 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 */
@@ -2988,7 +3234,7 @@ export declare enum KnownTokenizerNames {
2988
3234
  }
2989
3235
 
2990
3236
  /** Known values of {@link VisualFeature} that the service accepts. */
2991
- export declare const enum KnownVisualFeature {
3237
+ export declare enum KnownVisualFeature {
2992
3238
  /** Visual features recognized as adult persons. */
2993
3239
  Adult = "adult",
2994
3240
  /** Visual features recognized as commercial brands. */
@@ -3581,16 +3827,126 @@ export declare type PIIDetectionSkill = BaseSearchIndexerSkill & {
3581
3827
  */
3582
3828
  export declare type PIIDetectionSkillMaskingMode = string;
3583
3829
 
3830
+ /** Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers. */
3831
+ export declare interface PrioritizedFields {
3832
+ /** Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank. */
3833
+ titleField?: SemanticField;
3834
+ /** Defines the content fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. */
3835
+ prioritizedContentFields?: SemanticField[];
3836
+ /** Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. */
3837
+ prioritizedKeywordsFields?: SemanticField[];
3838
+ }
3839
+
3840
+ /**
3841
+ * Defines values for QueryAnswerType. \
3842
+ * {@link KnownQueryAnswerType} can be used interchangeably with QueryAnswerType,
3843
+ * this enum contains the known values that the service supports.
3844
+ * ### Known values supported by the service
3845
+ * **none**: Do not return answers for the query. \
3846
+ * **extractive**: Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language.
3847
+ */
3848
+ export declare type QueryAnswerType = string;
3849
+
3850
+ /**
3851
+ * Defines values for QueryCaptionType. \
3852
+ * {@link KnownQueryCaptionType} can be used interchangeably with QueryCaptionType,
3853
+ * this enum contains the known values that the service supports.
3854
+ * ### Known values supported by the service
3855
+ * **none**: Do not return captions for the query. \
3856
+ * **extractive**: Extracts captions from the matching documents that contain passages relevant to the search query.
3857
+ */
3858
+ export declare type QueryCaptionType = string;
3859
+
3584
3860
  /**
3585
3861
  * Defines values for QueryLanguage. \
3586
3862
  * {@link KnownQueryLanguage} can be used interchangeably with QueryLanguage,
3587
3863
  * this enum contains the known values that the service supports.
3588
3864
  * ### Known values supported by the service
3589
3865
  * **none**: Query language not specified. \
3590
- * **en-us**: English
3866
+ * **en-us**: Query language value for English (United States). \
3867
+ * **en-gb**: Query language value for English (Great Britain). \
3868
+ * **en-in**: Query language value for English (India). \
3869
+ * **en-ca**: Query language value for English (Canada). \
3870
+ * **en-au**: Query language value for English (Australia). \
3871
+ * **fr-fr**: Query language value for French (France). \
3872
+ * **fr-ca**: Query language value for French (Canada). \
3873
+ * **de-de**: Query language value for German (Germany). \
3874
+ * **es-es**: Query language value for Spanish (Spain). \
3875
+ * **es-mx**: Query language value for Spanish (Mexico). \
3876
+ * **zh-cn**: Query language value for Chinese (China). \
3877
+ * **zh-tw**: Query language value for Chinese (Taiwan). \
3878
+ * **pt-br**: Query language value for Portuguese (Brazil). \
3879
+ * **pt-pt**: Query language value for Portuguese (Portugal). \
3880
+ * **it-it**: Query language value for Italian (Italy). \
3881
+ * **ja-jp**: Query language value for Japanese (Japan). \
3882
+ * **ko-kr**: Query language value for Korean (Korea). \
3883
+ * **ru-ru**: Query language value for Russian (Russia). \
3884
+ * **cs-cz**: Query language value for Czech (Czech Republic). \
3885
+ * **nl-be**: Query language value for Dutch (Belgium). \
3886
+ * **nl-nl**: Query language value for Dutch (Netherlands). \
3887
+ * **hu-hu**: Query language value for Hungarian (Hungary). \
3888
+ * **pl-pl**: Query language value for Polish (Poland). \
3889
+ * **sv-se**: Query language value for Swedish (Sweden). \
3890
+ * **tr-tr**: Query language value for Turkish (Turkey). \
3891
+ * **hi-in**: Query language value for Hindi (India). \
3892
+ * **ar-sa**: Query language value for Arabic (Saudi Arabia). \
3893
+ * **ar-eg**: Query language value for Arabic (Egypt). \
3894
+ * **ar-ma**: Query language value for Arabic (Morocco). \
3895
+ * **ar-kw**: Query language value for Arabic (Kuwait). \
3896
+ * **ar-jo**: Query language value for Arabic (Jordan). \
3897
+ * **da-dk**: Query language value for Danish (Denmark). \
3898
+ * **no-no**: Query language value for Norwegian (Normway). \
3899
+ * **bg-bg**: Query language value for Bulgarian (Bulgary). \
3900
+ * **hr-hr**: Query language value for Croatian (Croatia). \
3901
+ * **hr-ba**: Query language value for Croatian (Bosnia and Herzegovina). \
3902
+ * **ms-my**: Query language value for Malay (Malaysia). \
3903
+ * **ms-bn**: Query language value for Malay (Brunei Darussalam). \
3904
+ * **sl-sl**: Query language value for Slovenian (Slovenia). \
3905
+ * **ta-in**: Query language value for Tamil (India). \
3906
+ * **vi-vn**: Query language value for Vietnamese (Viet Nam). \
3907
+ * **el-gr**: Query language value for Greek (Greece). \
3908
+ * **ro-ro**: Query language value for Romanian (Romania). \
3909
+ * **is-is**: Query language value for Icelandic (Iceland). \
3910
+ * **id-id**: Query language value for Indonesian (Indonesia). \
3911
+ * **th-th**: Query language value for Thai (Thailand). \
3912
+ * **lt-lt**: Query language value for Lithuanian (Lithuania). \
3913
+ * **uk-ua**: Query language value for Ukrainian (Ukraine). \
3914
+ * **lv-lv**: Query language value for Latvian (Latvia). \
3915
+ * **et-ee**: Query language value for Estonian (Estonia). \
3916
+ * **ca-es**: Query language value for Catalan (Spain). \
3917
+ * **fi-fi**: Query language value for Finnish (Finland). \
3918
+ * **sr-ba**: Query language value for Serbian (Bosnia and Herzegovina). \
3919
+ * **sr-me**: Query language value for Serbian (Montenegro). \
3920
+ * **sr-rs**: Query language value for Serbian (Serbia). \
3921
+ * **sk-sk**: Query language value for Slovak (Slovakia). \
3922
+ * **nb-no**: Query language value for Norwegian (Norway). \
3923
+ * **hy-am**: Query language value for Armenian (Armenia). \
3924
+ * **bn-in**: Query language value for Bengali (India). \
3925
+ * **eu-es**: Query language value for Basque (Spain). \
3926
+ * **gl-es**: Query language value for Galician (Spain). \
3927
+ * **gu-in**: Query language value for Gujarati (India). \
3928
+ * **he-il**: Query language value for Hebrew (Israel). \
3929
+ * **ga-ie**: Query language value for Irish (Ireland). \
3930
+ * **kn-in**: Query language value for Kannada (India). \
3931
+ * **ml-in**: Query language value for Malayalam (India). \
3932
+ * **mr-in**: Query language value for Marathi (India). \
3933
+ * **fa-ae**: Query language value for Persian (U.A.E.). \
3934
+ * **pa-in**: Query language value for Punjabi (India). \
3935
+ * **te-in**: Query language value for Telugu (India). \
3936
+ * **ur-pk**: Query language value for Urdu (Pakistan).
3591
3937
  */
3592
3938
  export declare type QueryLanguage = string;
3593
3939
 
3940
+ /**
3941
+ * Defines values for QuerySpellerType. \
3942
+ * {@link KnownQuerySpellerType} can be used interchangeably with QuerySpellerType,
3943
+ * this enum contains the known values that the service supports.
3944
+ * ### Known values supported by the service
3945
+ * **none**: Speller not enabled. \
3946
+ * **lexicon**: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter.
3947
+ */
3948
+ export declare type QuerySpellerType = string;
3949
+
3594
3950
  /** Defines values for QueryType. */
3595
3951
  export declare type QueryType = "simple" | "full" | "semantic";
3596
3952
 
@@ -3610,11 +3966,31 @@ export declare type QueryType = "simple" | "full" | "semantic";
3610
3966
  */
3611
3967
  export declare type RegexFlags = string;
3612
3968
 
3969
+ /**
3970
+ * Options for reset docs operation.
3971
+ */
3972
+ export declare interface ResetDocumentsOptions extends OperationOptions {
3973
+ /** document keys to be reset */
3974
+ documentKeys?: string[];
3975
+ /** datasource document identifiers to be reset */
3976
+ datasourceDocumentIds?: string[];
3977
+ /** If false, keys or ids will be appended to existing ones. If true, only the keys or ids in this payload will be queued to be re-ingested. */
3978
+ overwrite?: boolean;
3979
+ }
3980
+
3613
3981
  /**
3614
3982
  * Options for reset indexer operation.
3615
3983
  */
3616
3984
  export declare type ResetIndexerOptions = OperationOptions;
3617
3985
 
3986
+ /**
3987
+ * Options for reset skills operation.
3988
+ */
3989
+ export declare interface ResetSkillsOptions extends OperationOptions {
3990
+ /** the names of skills to be reset. */
3991
+ skillNames?: string[];
3992
+ }
3993
+
3618
3994
  /** Represents a resource's usage and quota. */
3619
3995
  export declare interface ResourceCounter {
3620
3996
  /** The resource usage amount. */
@@ -3741,7 +4117,7 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
3741
4117
  * @param key - The primary key value of the document
3742
4118
  * @param options - Additional options
3743
4119
  */
3744
- getDocument<Fields extends keyof T>(key: string, options?: GetDocumentOptions<Fields>): Promise<T>;
4120
+ getDocument<Fields extends Extract<keyof T, string>>(key: string, options?: GetDocumentOptions<Fields>): Promise<T>;
3745
4121
  /**
3746
4122
  * Perform a set of index modifications (upload, merge, mergeOrUpload, delete)
3747
4123
  * for the given set of documents.
@@ -3798,7 +4174,7 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
3798
4174
  /**
3799
4175
  * Client options used to configure Cognitive Search API requests.
3800
4176
  */
3801
- export declare interface SearchClientOptions extends PipelineOptions {
4177
+ export declare interface SearchClientOptions extends CommonClientOptions {
3802
4178
  /**
3803
4179
  * The API version to use when communicating with the service.
3804
4180
  */
@@ -3950,6 +4326,10 @@ export declare interface SearchIndex {
3950
4326
  * be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.
3951
4327
  */
3952
4328
  similarity?: SimilarityAlgorithm;
4329
+ /**
4330
+ * Defines parameters for a search index that influence semantic capabilities.
4331
+ */
4332
+ semanticSettings?: SemanticSettings;
3953
4333
  /**
3954
4334
  * The ETag of the index.
3955
4335
  */
@@ -4098,7 +4478,7 @@ export declare class SearchIndexClient {
4098
4478
  /**
4099
4479
  * Client options used to configure Cognitive Search API requests.
4100
4480
  */
4101
- export declare interface SearchIndexClientOptions extends PipelineOptions {
4481
+ export declare interface SearchIndexClientOptions extends CommonClientOptions {
4102
4482
  /**
4103
4483
  * The API version to use when communicating with the service.
4104
4484
  */
@@ -4332,12 +4712,25 @@ export declare class SearchIndexerClient {
4332
4712
  * @param options - Additional optional arguments.
4333
4713
  */
4334
4714
  runIndexer(indexerName: string, options?: RunIndexerOptions): Promise<void>;
4715
+ /**
4716
+ * Resets specific documents in the datasource to be selectively re-ingested by the indexer.
4717
+ * @param indexerName - The name of the indexer to reset documents for.
4718
+ * @param options - Additional optional arguments.
4719
+ */
4720
+ resetDocuments(indexerName: string, options?: ResetDocumentsOptions): Promise<void>;
4721
+ /**
4722
+ * Reset an existing skillset in a search service.
4723
+ * @param skillsetName - The name of the skillset to reset.
4724
+ * @param skillNames - The names of skills to reset.
4725
+ * @param options - The options parameters.
4726
+ */
4727
+ resetSkills(skillsetName: string, options?: ResetSkillsOptions): Promise<void>;
4335
4728
  }
4336
4729
 
4337
4730
  /**
4338
4731
  * Client options used to configure Cognitive Search API requests.
4339
4732
  */
4340
- export declare interface SearchIndexerClientOptions extends PipelineOptions {
4733
+ export declare interface SearchIndexerClientOptions extends CommonClientOptions {
4341
4734
  /**
4342
4735
  * The API version to use when communicating with the service.
4343
4736
  */
@@ -4982,6 +5375,11 @@ export declare interface SearchRequest {
4982
5375
  * the results.
4983
5376
  */
4984
5377
  scoringProfile?: string;
5378
+ /**
5379
+ * The name of a semantic configuration that will be used when processing documents for queries of
5380
+ * type semantic.
5381
+ */
5382
+ semanticConfiguration?: string;
4985
5383
  /**
4986
5384
  * A full-text search query expression; Use "*" or omit this parameter to match all documents.
4987
5385
  */
@@ -5005,11 +5403,11 @@ export declare interface SearchRequest {
5005
5403
  * A value that specified the type of the speller to use to spell-correct individual search
5006
5404
  * query terms.
5007
5405
  */
5008
- speller?: Speller;
5406
+ speller?: QuerySpellerType;
5009
5407
  /**
5010
5408
  * A value that specifies whether answers should be returned as part of the search response.
5011
5409
  */
5012
- answers?: Answers;
5410
+ answers?: QueryAnswerType;
5013
5411
  /**
5014
5412
  * The comma-separated list of fields to retrieve. If unspecified, all fields marked as
5015
5413
  * retrievable in the schema are included.
@@ -5031,7 +5429,7 @@ export declare interface SearchRequest {
5031
5429
  /**
5032
5430
  * A value that specifies whether captions should be returned as part of the search response.
5033
5431
  */
5034
- captions?: Captions;
5432
+ captions?: QueryCaptionType;
5035
5433
  /**
5036
5434
  * The comma-separated list of field names used for semantic search.
5037
5435
  */
@@ -5269,6 +5667,25 @@ export declare interface SearchSuggester {
5269
5667
  sourceFields: string[];
5270
5668
  }
5271
5669
 
5670
+ /** Defines a specific configuration to be used in the context of semantic capabilities. */
5671
+ export declare interface SemanticConfiguration {
5672
+ /** The name of the semantic configuration. */
5673
+ name: string;
5674
+ /** Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers. At least one of the three sub properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) need to be set. */
5675
+ prioritizedFields: PrioritizedFields;
5676
+ }
5677
+
5678
+ /** A field that is used as part of the semantic configuration. */
5679
+ export declare interface SemanticField {
5680
+ name?: string;
5681
+ }
5682
+
5683
+ /** Defines parameters for a search index that influence semantic capabilities. */
5684
+ export declare interface SemanticSettings {
5685
+ /** The semantic configurations for the index. */
5686
+ configurations?: SemanticConfiguration[];
5687
+ }
5688
+
5272
5689
  /** Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1. */
5273
5690
  export declare type SentimentSkill = BaseSearchIndexerSkill & {
5274
5691
  /** Polymorphic discriminator, which specifies the different types this object can be */