@azure/search-documents 11.3.0-beta.3 → 11.3.0-beta.4

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 (59) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/dist/index.js +1423 -373
  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 +62 -1
  7. package/dist-esm/src/generated/data/models/index.js.map +1 -1
  8. package/dist-esm/src/generated/data/models/mappers.js.map +1 -1
  9. package/dist-esm/src/generated/data/models/parameters.js +12 -13
  10. package/dist-esm/src/generated/data/models/parameters.js.map +1 -1
  11. package/dist-esm/src/generated/data/operations/documents.js +15 -49
  12. package/dist-esm/src/generated/data/operations/documents.js.map +1 -1
  13. package/dist-esm/src/generated/data/searchClientContext.js +13 -10
  14. package/dist-esm/src/generated/data/searchClientContext.js.map +1 -1
  15. package/dist-esm/src/generated/service/models/index.js +902 -1
  16. package/dist-esm/src/generated/service/models/index.js.map +1 -1
  17. package/dist-esm/src/generated/service/models/mappers.js +169 -2
  18. package/dist-esm/src/generated/service/models/mappers.js.map +1 -1
  19. package/dist-esm/src/generated/service/models/parameters.js +21 -3
  20. package/dist-esm/src/generated/service/models/parameters.js.map +1 -1
  21. package/dist-esm/src/generated/service/operations/dataSources.js +12 -29
  22. package/dist-esm/src/generated/service/operations/dataSources.js.map +1 -1
  23. package/dist-esm/src/generated/service/operations/indexers.js +40 -44
  24. package/dist-esm/src/generated/service/operations/indexers.js.map +1 -1
  25. package/dist-esm/src/generated/service/operations/indexes.js +10 -39
  26. package/dist-esm/src/generated/service/operations/indexes.js.map +1 -1
  27. package/dist-esm/src/generated/service/operations/skillsets.js +38 -29
  28. package/dist-esm/src/generated/service/operations/skillsets.js.map +1 -1
  29. package/dist-esm/src/generated/service/operations/synonymMaps.js +8 -28
  30. package/dist-esm/src/generated/service/operations/synonymMaps.js.map +1 -1
  31. package/dist-esm/src/generated/service/operationsInterfaces/dataSources.js.map +1 -1
  32. package/dist-esm/src/generated/service/operationsInterfaces/indexers.js.map +1 -1
  33. package/dist-esm/src/generated/service/operationsInterfaces/indexes.js.map +1 -1
  34. package/dist-esm/src/generated/service/operationsInterfaces/skillsets.js.map +1 -1
  35. package/dist-esm/src/generated/service/operationsInterfaces/synonymMaps.js.map +1 -1
  36. package/dist-esm/src/generated/service/searchServiceClient.js +3 -6
  37. package/dist-esm/src/generated/service/searchServiceClient.js.map +1 -1
  38. package/dist-esm/src/generated/service/searchServiceClientContext.js +13 -10
  39. package/dist-esm/src/generated/service/searchServiceClientContext.js.map +1 -1
  40. package/dist-esm/src/index.js +2 -0
  41. package/dist-esm/src/index.js.map +1 -1
  42. package/dist-esm/src/indexModels.js.map +1 -1
  43. package/dist-esm/src/odataMetadataPolicy.js +6 -14
  44. package/dist-esm/src/odataMetadataPolicy.js.map +1 -1
  45. package/dist-esm/src/searchApiKeyCredentialPolicy.js +7 -20
  46. package/dist-esm/src/searchApiKeyCredentialPolicy.js.map +1 -1
  47. package/dist-esm/src/searchClient.js +27 -22
  48. package/dist-esm/src/searchClient.js.map +1 -1
  49. package/dist-esm/src/searchIndexClient.js +34 -29
  50. package/dist-esm/src/searchIndexClient.js.map +1 -1
  51. package/dist-esm/src/searchIndexerClient.js +79 -33
  52. package/dist-esm/src/searchIndexerClient.js.map +1 -1
  53. package/dist-esm/src/searchIndexingBufferedSender.js +1 -1
  54. package/dist-esm/src/searchIndexingBufferedSender.js.map +1 -1
  55. package/dist-esm/src/serviceModels.js.map +1 -1
  56. package/dist-esm/src/serviceUtils.js +8 -11
  57. package/dist-esm/src/serviceUtils.js.map +1 -1
  58. package/package.json +7 -5
  59. package/types/search-documents.d.ts +210 -42
@@ -1,10 +1,11 @@
1
1
  /// <reference lib="esnext.asynciterable" />
2
+
2
3
  import { AzureKeyCredential } from '@azure/core-auth';
4
+ import { CommonClientOptions } from '@azure/core-client';
3
5
  import { KeyCredential } from '@azure/core-auth';
4
- import { OperationOptions } from '@azure/core-http';
6
+ import { OperationOptions } from '@azure/core-client';
5
7
  import { PagedAsyncIterableIterator } from '@azure/core-paging';
6
- import { PipelineOptions } from '@azure/core-http';
7
- import { RestError } from '@azure/core-http';
8
+ import { RestError } from '@azure/core-rest-pipeline';
8
9
  import { TokenCredential } from '@azure/core-auth';
9
10
 
10
11
  /** Information about a token returned by an analyzer. */
@@ -219,6 +220,7 @@ export declare interface AzureActiveDirectoryApplicationCredentials {
219
220
  /** The authentication key of the specified AAD application. */
220
221
  applicationSecret?: string;
221
222
  }
223
+
222
224
  export { AzureKeyCredential }
223
225
 
224
226
  /** Base type for character filters. */
@@ -536,7 +538,7 @@ export declare interface CreateorUpdateDataSourceConnectionOptions extends Opera
536
538
  /**
537
539
  * Ignores cache reset requirements.
538
540
  */
539
- ignoreResetRequirements?: boolean;
541
+ skipIndexerResetRequirementForCache?: boolean;
540
542
  }
541
543
 
542
544
  /**
@@ -548,7 +550,7 @@ export declare interface CreateorUpdateIndexerOptions extends OperationOptions {
548
550
  */
549
551
  onlyIfUnchanged?: boolean;
550
552
  /** Ignores cache reset requirements. */
551
- ignoreResetRequirements?: boolean;
553
+ skipIndexerResetRequirementForCache?: boolean;
552
554
  /** Disables cache reprocessing change detection. */
553
555
  disableCacheReprocessingChangeDetection?: boolean;
554
556
  }
@@ -581,7 +583,7 @@ export declare interface CreateOrUpdateSkillsetOptions extends OperationOptions
581
583
  /**
582
584
  * Ignores cache reset requirements.
583
585
  */
584
- ignoreResetRequirements?: boolean;
586
+ skipIndexerResetRequirementForCache?: boolean;
585
587
  /**
586
588
  * Disables cache reprocessing change detection.
587
589
  */
@@ -865,7 +867,7 @@ export declare type DocumentExtractionSkill = BaseSearchIndexerSkill & {
865
867
  dataToExtract?: string;
866
868
  /** A dictionary of configurations for the skill. */
867
869
  configuration?: {
868
- [propertyName: string]: any;
870
+ [propertyName: string]: Record<string, unknown>;
869
871
  };
870
872
  };
871
873
 
@@ -1036,7 +1038,7 @@ export declare interface FieldMappingFunction {
1036
1038
  name: string;
1037
1039
  /** A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. */
1038
1040
  parameters?: {
1039
- [propertyName: string]: any;
1041
+ [propertyName: string]: Record<string, unknown>;
1040
1042
  };
1041
1043
  }
1042
1044
 
@@ -1263,6 +1265,45 @@ export declare interface IndexDocumentsResult {
1263
1265
  readonly results: IndexingResult[];
1264
1266
  }
1265
1267
 
1268
+ /** Represents all of the state that defines and dictates the indexer's current execution. */
1269
+ export declare interface IndexerCurrentState {
1270
+ /**
1271
+ * The mode the indexer is running in.
1272
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1273
+ */
1274
+ readonly mode?: IndexingMode;
1275
+ /**
1276
+ * Change tracking state used when indexing starts on all documents in the datasource.
1277
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1278
+ */
1279
+ readonly allDocsInitialChangeTrackingState?: string;
1280
+ /**
1281
+ * Change tracking state value when indexing finishes on all documents in the datasource.
1282
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1283
+ */
1284
+ readonly allDocsFinalChangeTrackingState?: string;
1285
+ /**
1286
+ * Change tracking state used when indexing starts on select, reset documents in the datasource.
1287
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1288
+ */
1289
+ readonly resetDocsInitialChangeTrackingState?: string;
1290
+ /**
1291
+ * Change tracking state value when indexing finishes on select, reset documents in the datasource.
1292
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1293
+ */
1294
+ readonly resetDocsFinalChangeTrackingState?: string;
1295
+ /**
1296
+ * 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.
1297
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1298
+ */
1299
+ readonly resetDocumentKeys?: string[];
1300
+ /**
1301
+ * 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.
1302
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1303
+ */
1304
+ readonly resetDatasourceDocumentIds?: string[];
1305
+ }
1306
+
1266
1307
  /**
1267
1308
  * Defines values for IndexerExecutionEnvironment. \
1268
1309
  * {@link KnownIndexerExecutionEnvironment} can be used interchangeably with IndexerExecutionEnvironment,
@@ -1280,6 +1321,16 @@ export declare interface IndexerExecutionResult {
1280
1321
  * NOTE: This property will not be serialized. It can only be populated by the server.
1281
1322
  */
1282
1323
  readonly status: IndexerExecutionStatus;
1324
+ /**
1325
+ * The outcome of this indexer execution.
1326
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1327
+ */
1328
+ readonly statusDetail?: IndexerExecutionStatusDetail;
1329
+ /**
1330
+ * All of the state that defines and dictates the indexer's current execution.
1331
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1332
+ */
1333
+ readonly currentState?: IndexerCurrentState;
1283
1334
  /**
1284
1335
  * The error message indicating the top-level error, if any.
1285
1336
  * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -1330,9 +1381,28 @@ export declare interface IndexerExecutionResult {
1330
1381
  /** Defines values for IndexerExecutionStatus. */
1331
1382
  export declare type IndexerExecutionStatus = "transientFailure" | "success" | "inProgress" | "reset";
1332
1383
 
1384
+ /**
1385
+ * Defines values for IndexerExecutionStatusDetail. \
1386
+ * {@link KnownIndexerExecutionStatusDetail} can be used interchangeably with IndexerExecutionStatusDetail,
1387
+ * this enum contains the known values that the service supports.
1388
+ * ### Known values supported by the service
1389
+ * **resetDocs**: Indicates that the reset that occurred was for a call to ResetDocs.
1390
+ */
1391
+ export declare type IndexerExecutionStatusDetail = string;
1392
+
1333
1393
  /** Defines values for IndexerStatus. */
1334
1394
  export declare type IndexerStatus = "unknown" | "error" | "running";
1335
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
+
1336
1406
  /** Represents parameters for indexer execution. */
1337
1407
  export declare interface IndexingParameters {
1338
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. */
@@ -1898,7 +1968,7 @@ export declare enum KnownAnalyzerNames {
1898
1968
  }
1899
1969
 
1900
1970
  /** Known values of {@link Answers} that the service accepts. */
1901
- export declare const enum KnownAnswers {
1971
+ export declare enum KnownAnswers {
1902
1972
  /** Do not return answers for the query. */
1903
1973
  None = "none",
1904
1974
  /** Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. */
@@ -1906,7 +1976,7 @@ export declare const enum KnownAnswers {
1906
1976
  }
1907
1977
 
1908
1978
  /** Known values of {@link BlobIndexerDataToExtract} that the service accepts. */
1909
- export declare const enum KnownBlobIndexerDataToExtract {
1979
+ export declare enum KnownBlobIndexerDataToExtract {
1910
1980
  /** Indexes just the standard blob properties and user-specified metadata. */
1911
1981
  StorageMetadata = "storageMetadata",
1912
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). */
@@ -1916,7 +1986,7 @@ export declare const enum KnownBlobIndexerDataToExtract {
1916
1986
  }
1917
1987
 
1918
1988
  /** Known values of {@link BlobIndexerImageAction} that the service accepts. */
1919
- export declare const enum KnownBlobIndexerImageAction {
1989
+ export declare enum KnownBlobIndexerImageAction {
1920
1990
  /** Ignores embedded images or image files in the data set. This is the default. */
1921
1991
  None = "none",
1922
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. */
@@ -1926,7 +1996,7 @@ export declare const enum KnownBlobIndexerImageAction {
1926
1996
  }
1927
1997
 
1928
1998
  /** Known values of {@link BlobIndexerParsingMode} that the service accepts. */
1929
- export declare const enum KnownBlobIndexerParsingMode {
1999
+ export declare enum KnownBlobIndexerParsingMode {
1930
2000
  /** Set to default for normal file processing. */
1931
2001
  Default = "default",
1932
2002
  /** Set to text to improve indexing performance on plain text files in blob storage. */
@@ -1942,7 +2012,7 @@ export declare const enum KnownBlobIndexerParsingMode {
1942
2012
  }
1943
2013
 
1944
2014
  /** Known values of {@link BlobIndexerPDFTextRotationAlgorithm} that the service accepts. */
1945
- export declare const enum KnownBlobIndexerPDFTextRotationAlgorithm {
2015
+ export declare enum KnownBlobIndexerPDFTextRotationAlgorithm {
1946
2016
  /** Leverages normal text extraction. This is the default. */
1947
2017
  None = "none",
1948
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. */
@@ -1950,7 +2020,7 @@ export declare const enum KnownBlobIndexerPDFTextRotationAlgorithm {
1950
2020
  }
1951
2021
 
1952
2022
  /** Known values of {@link CharFilterName} that the service accepts. */
1953
- export declare const enum KnownCharFilterName {
2023
+ export declare enum KnownCharFilterName {
1954
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 */
1955
2025
  HtmlStrip = "html_strip"
1956
2026
  }
@@ -1968,7 +2038,7 @@ export declare enum KnownCharFilterNames {
1968
2038
  }
1969
2039
 
1970
2040
  /** Known values of {@link CustomEntityLookupSkillLanguage} that the service accepts. */
1971
- export declare const enum KnownCustomEntityLookupSkillLanguage {
2041
+ export declare enum KnownCustomEntityLookupSkillLanguage {
1972
2042
  /** Danish */
1973
2043
  Da = "da",
1974
2044
  /** German */
@@ -1990,7 +2060,7 @@ export declare const enum KnownCustomEntityLookupSkillLanguage {
1990
2060
  }
1991
2061
 
1992
2062
  /** Known values of {@link EntityCategory} that the service accepts. */
1993
- export declare const enum KnownEntityCategory {
2063
+ export declare enum KnownEntityCategory {
1994
2064
  /** Entities describing a physical location. */
1995
2065
  Location = "location",
1996
2066
  /** Entities describing an organization. */
@@ -2008,7 +2078,7 @@ export declare const enum KnownEntityCategory {
2008
2078
  }
2009
2079
 
2010
2080
  /** Known values of {@link EntityRecognitionSkillLanguage} that the service accepts. */
2011
- export declare const enum KnownEntityRecognitionSkillLanguage {
2081
+ export declare enum KnownEntityRecognitionSkillLanguage {
2012
2082
  /** Arabic */
2013
2083
  Ar = "ar",
2014
2084
  /** Czech */
@@ -2058,7 +2128,7 @@ export declare const enum KnownEntityRecognitionSkillLanguage {
2058
2128
  }
2059
2129
 
2060
2130
  /** Known values of {@link ImageAnalysisSkillLanguage} that the service accepts. */
2061
- export declare const enum KnownImageAnalysisSkillLanguage {
2131
+ export declare enum KnownImageAnalysisSkillLanguage {
2062
2132
  /** English */
2063
2133
  En = "en",
2064
2134
  /** Spanish */
@@ -2072,15 +2142,29 @@ export declare const enum KnownImageAnalysisSkillLanguage {
2072
2142
  }
2073
2143
 
2074
2144
  /** Known values of {@link ImageDetail} that the service accepts. */
2075
- export declare const enum KnownImageDetail {
2145
+ export declare enum KnownImageDetail {
2076
2146
  /** Details recognized as celebrities. */
2077
2147
  Celebrities = "celebrities",
2078
2148
  /** Details recognized as landmarks. */
2079
2149
  Landmarks = "landmarks"
2080
2150
  }
2081
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
+
2082
2166
  /** Known values of {@link KeyPhraseExtractionSkillLanguage} that the service accepts. */
2083
- export declare const enum KnownKeyPhraseExtractionSkillLanguage {
2167
+ export declare enum KnownKeyPhraseExtractionSkillLanguage {
2084
2168
  /** Danish */
2085
2169
  Da = "da",
2086
2170
  /** Dutch */
@@ -2116,7 +2200,7 @@ export declare const enum KnownKeyPhraseExtractionSkillLanguage {
2116
2200
  }
2117
2201
 
2118
2202
  /** Known values of {@link LexicalAnalyzerName} that the service accepts. */
2119
- export declare const enum KnownLexicalAnalyzerName {
2203
+ export declare enum KnownLexicalAnalyzerName {
2120
2204
  /** Microsoft analyzer for Arabic. */
2121
2205
  ArMicrosoft = "ar.microsoft",
2122
2206
  /** Lucene analyzer for Arabic. */
@@ -2306,7 +2390,7 @@ export declare const enum KnownLexicalAnalyzerName {
2306
2390
  }
2307
2391
 
2308
2392
  /** Known values of {@link LexicalNormalizerName} that the service accepts. */
2309
- export declare const enum KnownLexicalNormalizerName {
2393
+ export declare enum KnownLexicalNormalizerName {
2310
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 */
2311
2395
  AsciiFolding = "asciifolding",
2312
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 */
@@ -2320,7 +2404,7 @@ export declare const enum KnownLexicalNormalizerName {
2320
2404
  }
2321
2405
 
2322
2406
  /** Known values of {@link LineEnding} that the service accepts. */
2323
- export declare const enum KnownLineEnding {
2407
+ export declare enum KnownLineEnding {
2324
2408
  /** Lines are separated by a single space character. */
2325
2409
  Space = "space",
2326
2410
  /** Lines are separated by a carriage return ('\r') character. */
@@ -2332,7 +2416,7 @@ export declare const enum KnownLineEnding {
2332
2416
  }
2333
2417
 
2334
2418
  /** Known values of {@link OcrSkillLanguage} that the service accepts. */
2335
- export declare const enum KnownOcrSkillLanguage {
2419
+ export declare enum KnownOcrSkillLanguage {
2336
2420
  /** Chinese-Simplified */
2337
2421
  ZhHans = "zh-Hans",
2338
2422
  /** Chinese-Traditional */
@@ -2388,23 +2472,47 @@ export declare const enum KnownOcrSkillLanguage {
2388
2472
  }
2389
2473
 
2390
2474
  /** Known values of {@link PIIDetectionSkillMaskingMode} that the service accepts. */
2391
- export declare const enum KnownPIIDetectionSkillMaskingMode {
2475
+ export declare enum KnownPIIDetectionSkillMaskingMode {
2392
2476
  /** No masking occurs and the maskedText output will not be returned. */
2393
2477
  None = "none",
2394
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. */
2395
2479
  Replace = "replace"
2396
2480
  }
2397
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
+
2398
2498
  /** Known values of {@link QueryLanguage} that the service accepts. */
2399
- export declare const enum KnownQueryLanguage {
2499
+ export declare enum KnownQueryLanguage {
2400
2500
  /** Query language not specified. */
2401
2501
  None = "none",
2402
2502
  /** English */
2403
2503
  EnUs = "en-us"
2404
2504
  }
2405
2505
 
2506
+ /** Known values of {@link QuerySpellerType} that the service accepts. */
2507
+ export declare enum KnownQuerySpellerType {
2508
+ /** Speller not enabled. */
2509
+ None = "none",
2510
+ /** Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. */
2511
+ Lexicon = "lexicon"
2512
+ }
2513
+
2406
2514
  /** Known values of {@link RegexFlags} that the service accepts. */
2407
- export declare const enum KnownRegexFlags {
2515
+ export declare enum KnownRegexFlags {
2408
2516
  /** Enables canonical equivalence. */
2409
2517
  CanonEq = "CANON_EQ",
2410
2518
  /** Enables case-insensitive matching. */
@@ -2424,7 +2532,7 @@ export declare const enum KnownRegexFlags {
2424
2532
  }
2425
2533
 
2426
2534
  /** Known values of {@link SearchIndexerDataSourceType} that the service accepts. */
2427
- export declare const enum KnownSearchIndexerDataSourceType {
2535
+ export declare enum KnownSearchIndexerDataSourceType {
2428
2536
  /** Indicates an Azure SQL datasource. */
2429
2537
  AzureSql = "azuresql",
2430
2538
  /** Indicates a CosmosDB datasource. */
@@ -2440,7 +2548,7 @@ export declare const enum KnownSearchIndexerDataSourceType {
2440
2548
  }
2441
2549
 
2442
2550
  /** Known values of {@link SentimentSkillLanguage} that the service accepts. */
2443
- export declare const enum KnownSentimentSkillLanguage {
2551
+ export declare enum KnownSentimentSkillLanguage {
2444
2552
  /** Danish */
2445
2553
  Da = "da",
2446
2554
  /** Dutch */
@@ -2474,7 +2582,7 @@ export declare const enum KnownSentimentSkillLanguage {
2474
2582
  }
2475
2583
 
2476
2584
  /** Known values of {@link Speller} that the service accepts. */
2477
- export declare const enum KnownSpeller {
2585
+ export declare enum KnownSpeller {
2478
2586
  /** Speller not enabled. */
2479
2587
  None = "none",
2480
2588
  /** Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. */
@@ -2482,7 +2590,7 @@ export declare const enum KnownSpeller {
2482
2590
  }
2483
2591
 
2484
2592
  /** Known values of {@link SplitSkillLanguage} that the service accepts. */
2485
- export declare const enum KnownSplitSkillLanguage {
2593
+ export declare enum KnownSplitSkillLanguage {
2486
2594
  /** Danish */
2487
2595
  Da = "da",
2488
2596
  /** German */
@@ -2504,7 +2612,7 @@ export declare const enum KnownSplitSkillLanguage {
2504
2612
  }
2505
2613
 
2506
2614
  /** Known values of {@link TextSplitMode} that the service accepts. */
2507
- export declare const enum KnownTextSplitMode {
2615
+ export declare enum KnownTextSplitMode {
2508
2616
  /** Split the text into individual pages. */
2509
2617
  Pages = "pages",
2510
2618
  /** Split the text into individual sentences. */
@@ -2512,7 +2620,7 @@ export declare const enum KnownTextSplitMode {
2512
2620
  }
2513
2621
 
2514
2622
  /** Known values of {@link TextTranslationSkillLanguage} that the service accepts. */
2515
- export declare const enum KnownTextTranslationSkillLanguage {
2623
+ export declare enum KnownTextTranslationSkillLanguage {
2516
2624
  /** Afrikaans */
2517
2625
  Af = "af",
2518
2626
  /** Arabic */
@@ -2660,7 +2768,7 @@ export declare const enum KnownTextTranslationSkillLanguage {
2660
2768
  }
2661
2769
 
2662
2770
  /** Known values of {@link TokenFilterName} that the service accepts. */
2663
- export declare const enum KnownTokenFilterName {
2771
+ export declare enum KnownTokenFilterName {
2664
2772
  /** 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 */
2665
2773
  ArabicNormalization = "arabic_normalization",
2666
2774
  /** 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 */
@@ -2986,7 +3094,7 @@ export declare enum KnownTokenizerNames {
2986
3094
  }
2987
3095
 
2988
3096
  /** Known values of {@link VisualFeature} that the service accepts. */
2989
- export declare const enum KnownVisualFeature {
3097
+ export declare enum KnownVisualFeature {
2990
3098
  /** Visual features recognized as adult persons. */
2991
3099
  Adult = "adult",
2992
3100
  /** Visual features recognized as commercial brands. */
@@ -3579,6 +3687,26 @@ export declare type PIIDetectionSkill = BaseSearchIndexerSkill & {
3579
3687
  */
3580
3688
  export declare type PIIDetectionSkillMaskingMode = string;
3581
3689
 
3690
+ /**
3691
+ * Defines values for QueryAnswerType. \
3692
+ * {@link KnownQueryAnswerType} can be used interchangeably with QueryAnswerType,
3693
+ * this enum contains the known values that the service supports.
3694
+ * ### Known values supported by the service
3695
+ * **none**: Do not return answers for the query. \
3696
+ * **extractive**: Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language.
3697
+ */
3698
+ export declare type QueryAnswerType = string;
3699
+
3700
+ /**
3701
+ * Defines values for QueryCaptionType. \
3702
+ * {@link KnownQueryCaptionType} can be used interchangeably with QueryCaptionType,
3703
+ * this enum contains the known values that the service supports.
3704
+ * ### Known values supported by the service
3705
+ * **none**: Do not return captions for the query. \
3706
+ * **extractive**: Extracts captions from the matching documents that contain passages relevant to the search query.
3707
+ */
3708
+ export declare type QueryCaptionType = string;
3709
+
3582
3710
  /**
3583
3711
  * Defines values for QueryLanguage. \
3584
3712
  * {@link KnownQueryLanguage} can be used interchangeably with QueryLanguage,
@@ -3589,6 +3717,16 @@ export declare type PIIDetectionSkillMaskingMode = string;
3589
3717
  */
3590
3718
  export declare type QueryLanguage = string;
3591
3719
 
3720
+ /**
3721
+ * Defines values for QuerySpellerType. \
3722
+ * {@link KnownQuerySpellerType} can be used interchangeably with QuerySpellerType,
3723
+ * this enum contains the known values that the service supports.
3724
+ * ### Known values supported by the service
3725
+ * **none**: Speller not enabled. \
3726
+ * **lexicon**: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter.
3727
+ */
3728
+ export declare type QuerySpellerType = string;
3729
+
3592
3730
  /** Defines values for QueryType. */
3593
3731
  export declare type QueryType = "simple" | "full" | "semantic";
3594
3732
 
@@ -3608,11 +3746,28 @@ export declare type QueryType = "simple" | "full" | "semantic";
3608
3746
  */
3609
3747
  export declare type RegexFlags = string;
3610
3748
 
3749
+ /**
3750
+ * Options for reset docs operation.
3751
+ */
3752
+ export declare interface ResetDocsOptions extends OperationOptions {
3753
+ /** document keys to be reset */
3754
+ documentKeys?: string[];
3755
+ /** datasource document identifiers to be reset */
3756
+ datasourceDocumentIds?: string[];
3757
+ /** 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. */
3758
+ overwrite?: boolean;
3759
+ }
3760
+
3611
3761
  /**
3612
3762
  * Options for reset indexer operation.
3613
3763
  */
3614
3764
  export declare type ResetIndexerOptions = OperationOptions;
3615
3765
 
3766
+ /**
3767
+ * Options for reset skills operation.
3768
+ */
3769
+ export declare type ResetSkillsOptions = OperationOptions;
3770
+
3616
3771
  /** Represents a resource's usage and quota. */
3617
3772
  export declare interface ResourceCounter {
3618
3773
  /** The resource usage amount. */
@@ -3739,7 +3894,7 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
3739
3894
  * @param key - The primary key value of the document
3740
3895
  * @param options - Additional options
3741
3896
  */
3742
- getDocument<Fields extends keyof T>(key: string, options?: GetDocumentOptions<Fields>): Promise<T>;
3897
+ getDocument<Fields extends Extract<keyof T, string>>(key: string, options?: GetDocumentOptions<Fields>): Promise<T>;
3743
3898
  /**
3744
3899
  * Perform a set of index modifications (upload, merge, mergeOrUpload, delete)
3745
3900
  * for the given set of documents.
@@ -3796,7 +3951,7 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
3796
3951
  /**
3797
3952
  * Client options used to configure Cognitive Search API requests.
3798
3953
  */
3799
- export declare interface SearchClientOptions extends PipelineOptions {
3954
+ export declare interface SearchClientOptions extends CommonClientOptions {
3800
3955
  /**
3801
3956
  * The API version to use when communicating with the service.
3802
3957
  */
@@ -4096,7 +4251,7 @@ export declare class SearchIndexClient {
4096
4251
  /**
4097
4252
  * Client options used to configure Cognitive Search API requests.
4098
4253
  */
4099
- export declare interface SearchIndexClientOptions extends PipelineOptions {
4254
+ export declare interface SearchIndexClientOptions extends CommonClientOptions {
4100
4255
  /**
4101
4256
  * The API version to use when communicating with the service.
4102
4257
  */
@@ -4330,12 +4485,25 @@ export declare class SearchIndexerClient {
4330
4485
  * @param options - Additional optional arguments.
4331
4486
  */
4332
4487
  runIndexer(indexerName: string, options?: RunIndexerOptions): Promise<void>;
4488
+ /**
4489
+ * Resets specific documents in the datasource to be selectively re-ingested by the indexer.
4490
+ * @param indexerName - The name of the indexer to reset documents for.
4491
+ * @param options - Additional optional arguments.
4492
+ */
4493
+ resetDocs(indexerName: string, options?: ResetDocsOptions): Promise<void>;
4494
+ /**
4495
+ * Reset an existing skillset in a search service.
4496
+ * @param skillsetName - The name of the skillset to reset.
4497
+ * @param skillNames - The names of skills to reset.
4498
+ * @param options - The options parameters.
4499
+ */
4500
+ resetSkills(skillsetName: string, skillNames: string[], options?: ResetSkillsOptions): Promise<void>;
4333
4501
  }
4334
4502
 
4335
4503
  /**
4336
4504
  * Client options used to configure Cognitive Search API requests.
4337
4505
  */
4338
- export declare interface SearchIndexerClientOptions extends PipelineOptions {
4506
+ export declare interface SearchIndexerClientOptions extends CommonClientOptions {
4339
4507
  /**
4340
4508
  * The API version to use when communicating with the service.
4341
4509
  */
@@ -5003,11 +5171,11 @@ export declare interface SearchRequest {
5003
5171
  * A value that specified the type of the speller to use to spell-correct individual search
5004
5172
  * query terms.
5005
5173
  */
5006
- speller?: Speller;
5174
+ speller?: QuerySpellerType;
5007
5175
  /**
5008
5176
  * A value that specifies whether answers should be returned as part of the search response.
5009
5177
  */
5010
- answers?: Answers;
5178
+ answers?: QueryAnswerType;
5011
5179
  /**
5012
5180
  * The comma-separated list of fields to retrieve. If unspecified, all fields marked as
5013
5181
  * retrievable in the schema are included.
@@ -5029,7 +5197,7 @@ export declare interface SearchRequest {
5029
5197
  /**
5030
5198
  * A value that specifies whether captions should be returned as part of the search response.
5031
5199
  */
5032
- captions?: Captions;
5200
+ captions?: QueryCaptionType;
5033
5201
  /**
5034
5202
  * The comma-separated list of field names used for semantic search.
5035
5203
  */