@azure/search-documents 11.3.0-beta.2 → 11.3.0-beta.6

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 (70) hide show
  1. package/CHANGELOG.md +55 -0
  2. package/dist/index.js +2323 -801
  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 +904 -1
  17. package/dist-esm/src/generated/service/models/index.js.map +1 -1
  18. package/dist-esm/src/generated/service/models/mappers.js +335 -13
  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/geographyPoint.js +1 -1
  42. package/dist-esm/src/geographyPoint.js.map +1 -1
  43. package/dist-esm/src/index.js +4 -2
  44. package/dist-esm/src/index.js.map +1 -1
  45. package/dist-esm/src/indexDocumentsBatch.js +1 -1
  46. package/dist-esm/src/indexDocumentsBatch.js.map +1 -1
  47. package/dist-esm/src/indexModels.js.map +1 -1
  48. package/dist-esm/src/odataMetadataPolicy.js +7 -15
  49. package/dist-esm/src/odataMetadataPolicy.js.map +1 -1
  50. package/dist-esm/src/searchApiKeyCredentialPolicy.js +8 -21
  51. package/dist-esm/src/searchApiKeyCredentialPolicy.js.map +1 -1
  52. package/dist-esm/src/searchClient.js +73 -50
  53. package/dist-esm/src/searchClient.js.map +1 -1
  54. package/dist-esm/src/searchIndexClient.js +70 -53
  55. package/dist-esm/src/searchIndexClient.js.map +1 -1
  56. package/dist-esm/src/searchIndexerClient.js +119 -61
  57. package/dist-esm/src/searchIndexerClient.js.map +1 -1
  58. package/dist-esm/src/searchIndexingBufferedSender.js +11 -11
  59. package/dist-esm/src/searchIndexingBufferedSender.js.map +1 -1
  60. package/dist-esm/src/serialization.js +6 -6
  61. package/dist-esm/src/serialization.js.map +1 -1
  62. package/dist-esm/src/serviceModels.js.map +1 -1
  63. package/dist-esm/src/serviceUtils.js +33 -29
  64. package/dist-esm/src/serviceUtils.js.map +1 -1
  65. package/dist-esm/src/synonymMapHelper.js +1 -1
  66. package/dist-esm/src/synonymMapHelper.js.map +1 -1
  67. package/dist-esm/src/tracing.js +1 -1
  68. package/dist-esm/src/tracing.js.map +1 -1
  69. package/package.json +17 -28
  70. package/types/search-documents.d.ts +542 -52
@@ -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. */
@@ -53,6 +54,10 @@ export declare interface AnalyzeRequest {
53
54
  * NOTE: Either analyzerName or tokenizerName is required in an AnalyzeRequest.
54
55
  */
55
56
  tokenizerName?: string;
57
+ /**
58
+ * The name of the normalizer to use to normalize the given text.
59
+ */
60
+ normalizerName?: LexicalNormalizerName;
56
61
  /**
57
62
  * An optional list of token filters to use when breaking the given text. This parameter can only
58
63
  * be set when using the tokenizer parameter.
@@ -81,7 +86,7 @@ export declare interface AnswerResult {
81
86
  /** Describes unknown properties. The value of an unknown property can be of "any" type. */
82
87
  [property: string]: any;
83
88
  /**
84
- * The score value represents how relevant the answer is to the the query relative to other answers returned for the query.
89
+ * The score value represents how relevant the answer is to the query relative to other answers returned for the query.
85
90
  * NOTE: This property will not be serialized. It can only be populated by the server.
86
91
  */
87
92
  readonly score: number;
@@ -215,8 +220,27 @@ export declare interface AzureActiveDirectoryApplicationCredentials {
215
220
  /** The authentication key of the specified AAD application. */
216
221
  applicationSecret?: string;
217
222
  }
223
+
218
224
  export { AzureKeyCredential }
219
225
 
226
+ /** The AML skill allows you to extend AI enrichment with a custom Azure Machine Learning (AML) model. Once an AML model is trained and deployed, an AML skill integrates it into AI enrichment. */
227
+ export declare type AzureMachineLearningSkill = BaseSearchIndexerSkill & {
228
+ /** Polymorphic discriminator, which specifies the different types this object can be */
229
+ odatatype: "#Microsoft.Skills.Custom.AmlSkill";
230
+ /** (Required for no authentication or key authentication) The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed. */
231
+ scoringUri?: string;
232
+ /** (Required for key authentication) The key for the AML service. */
233
+ authenticationKey?: string;
234
+ /** (Required for token authentication). The Azure Resource Manager resource ID of the AML service. It should be in the format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}. */
235
+ resourceId?: string;
236
+ /** (Optional) When specified, indicates the timeout for the http client making the API call. */
237
+ timeout?: string;
238
+ /** (Optional for token authentication). The region the AML service is deployed in. */
239
+ region?: string;
240
+ /** (Optional) When specified, indicates the number of calls the indexer will make in parallel to the endpoint you have provided. You can decrease this value if your endpoint is failing under too high of a request load, or raise it if your endpoint is able to accept more requests and you would like an increase in the performance of the indexer. If not set, a default value of 5 is used. The degreeOfParallelism can be set to a maximum of 10 and a minimum of 1. */
241
+ degreeOfParallelism?: number;
242
+ };
243
+
220
244
  /** Base type for character filters. */
221
245
  export declare interface BaseCharFilter {
222
246
  /** Polymorphic discriminator, which specifies the different types this object can be */
@@ -290,7 +314,7 @@ export declare interface BaseSearchIndexerDataIdentity {
290
314
  /** Base type for skills. */
291
315
  export declare interface BaseSearchIndexerSkill {
292
316
  /** Polymorphic discriminator, which specifies the different types this object can be */
293
- odatatype: "#Microsoft.Skills.Util.ConditionalSkill" | "#Microsoft.Skills.Text.KeyPhraseExtractionSkill" | "#Microsoft.Skills.Vision.OcrSkill" | "#Microsoft.Skills.Vision.ImageAnalysisSkill" | "#Microsoft.Skills.Text.LanguageDetectionSkill" | "#Microsoft.Skills.Util.ShaperSkill" | "#Microsoft.Skills.Text.MergeSkill" | "#Microsoft.Skills.Text.EntityRecognitionSkill" | "#Microsoft.Skills.Text.SentimentSkill" | "#Microsoft.Skills.Text.V3.SentimentSkill" | "#Microsoft.Skills.Text.V3.EntityLinkingSkill" | "#Microsoft.Skills.Text.V3.EntityRecognitionSkill" | "#Microsoft.Skills.Text.PIIDetectionSkill" | "#Microsoft.Skills.Text.SplitSkill" | "#Microsoft.Skills.Text.CustomEntityLookupSkill" | "#Microsoft.Skills.Text.TranslationSkill" | "#Microsoft.Skills.Util.DocumentExtractionSkill" | "#Microsoft.Skills.Custom.WebApiSkill";
317
+ odatatype: "#Microsoft.Skills.Util.ConditionalSkill" | "#Microsoft.Skills.Text.KeyPhraseExtractionSkill" | "#Microsoft.Skills.Vision.OcrSkill" | "#Microsoft.Skills.Vision.ImageAnalysisSkill" | "#Microsoft.Skills.Text.LanguageDetectionSkill" | "#Microsoft.Skills.Util.ShaperSkill" | "#Microsoft.Skills.Text.MergeSkill" | "#Microsoft.Skills.Text.EntityRecognitionSkill" | "#Microsoft.Skills.Text.SentimentSkill" | "#Microsoft.Skills.Text.V3.SentimentSkill" | "#Microsoft.Skills.Text.V3.EntityLinkingSkill" | "#Microsoft.Skills.Text.V3.EntityRecognitionSkill" | "#Microsoft.Skills.Text.PIIDetectionSkill" | "#Microsoft.Skills.Text.SplitSkill" | "#Microsoft.Skills.Text.CustomEntityLookupSkill" | "#Microsoft.Skills.Text.TranslationSkill" | "#Microsoft.Skills.Util.DocumentExtractionSkill" | "#Microsoft.Skills.Custom.WebApiSkill" | "#Microsoft.Skills.Custom.AmlSkill";
294
318
  /** The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. */
295
319
  name?: string;
296
320
  /** The description of the skill which describes the inputs, outputs, and usage of the skill. */
@@ -532,7 +556,7 @@ export declare interface CreateorUpdateDataSourceConnectionOptions extends Opera
532
556
  /**
533
557
  * Ignores cache reset requirements.
534
558
  */
535
- ignoreResetRequirements?: boolean;
559
+ skipIndexerResetRequirementForCache?: boolean;
536
560
  }
537
561
 
538
562
  /**
@@ -544,7 +568,7 @@ export declare interface CreateorUpdateIndexerOptions extends OperationOptions {
544
568
  */
545
569
  onlyIfUnchanged?: boolean;
546
570
  /** Ignores cache reset requirements. */
547
- ignoreResetRequirements?: boolean;
571
+ skipIndexerResetRequirementForCache?: boolean;
548
572
  /** Disables cache reprocessing change detection. */
549
573
  disableCacheReprocessingChangeDetection?: boolean;
550
574
  }
@@ -577,7 +601,7 @@ export declare interface CreateOrUpdateSkillsetOptions extends OperationOptions
577
601
  /**
578
602
  * Ignores cache reset requirements.
579
603
  */
580
- ignoreResetRequirements?: boolean;
604
+ skipIndexerResetRequirementForCache?: boolean;
581
605
  /**
582
606
  * Disables cache reprocessing change detection.
583
607
  */
@@ -861,7 +885,7 @@ export declare type DocumentExtractionSkill = BaseSearchIndexerSkill & {
861
885
  dataToExtract?: string;
862
886
  /** A dictionary of configurations for the skill. */
863
887
  configuration?: {
864
- [propertyName: string]: any;
888
+ [propertyName: string]: Record<string, unknown>;
865
889
  };
866
890
  };
867
891
 
@@ -1032,7 +1056,7 @@ export declare interface FieldMappingFunction {
1032
1056
  name: string;
1033
1057
  /** A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. */
1034
1058
  parameters?: {
1035
- [propertyName: string]: any;
1059
+ [propertyName: string]: Record<string, unknown>;
1036
1060
  };
1037
1061
  }
1038
1062
 
@@ -1276,6 +1300,16 @@ export declare interface IndexerExecutionResult {
1276
1300
  * NOTE: This property will not be serialized. It can only be populated by the server.
1277
1301
  */
1278
1302
  readonly status: IndexerExecutionStatus;
1303
+ /**
1304
+ * The outcome of this indexer execution.
1305
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1306
+ */
1307
+ readonly statusDetail?: IndexerExecutionStatusDetail;
1308
+ /**
1309
+ * All of the state that defines and dictates the indexer's current execution.
1310
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1311
+ */
1312
+ readonly currentState?: IndexerState;
1279
1313
  /**
1280
1314
  * The error message indicating the top-level error, if any.
1281
1315
  * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -1326,9 +1360,67 @@ export declare interface IndexerExecutionResult {
1326
1360
  /** Defines values for IndexerExecutionStatus. */
1327
1361
  export declare type IndexerExecutionStatus = "transientFailure" | "success" | "inProgress" | "reset";
1328
1362
 
1363
+ /**
1364
+ * Defines values for IndexerExecutionStatusDetail. \
1365
+ * {@link KnownIndexerExecutionStatusDetail} can be used interchangeably with IndexerExecutionStatusDetail,
1366
+ * this enum contains the known values that the service supports.
1367
+ * ### Known values supported by the service
1368
+ * **resetDocs**: Indicates that the reset that occurred was for a call to ResetDocs.
1369
+ */
1370
+ export declare type IndexerExecutionStatusDetail = string;
1371
+
1372
+ /** Represents all of the state that defines and dictates the indexer's current execution. */
1373
+ export declare interface IndexerState {
1374
+ /**
1375
+ * The mode the indexer is running in.
1376
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1377
+ */
1378
+ readonly mode?: IndexingMode;
1379
+ /**
1380
+ * Change tracking state used when indexing starts on all documents in the datasource.
1381
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1382
+ */
1383
+ readonly allDocumentsInitialChangeTrackingState?: string;
1384
+ /**
1385
+ * Change tracking state value when indexing finishes on all documents in the datasource.
1386
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1387
+ */
1388
+ readonly allDocumentsFinalChangeTrackingState?: string;
1389
+ /**
1390
+ * Change tracking state used when indexing starts on select, reset documents in the datasource.
1391
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1392
+ */
1393
+ readonly resetDocumentsInitialChangeTrackingState?: string;
1394
+ /**
1395
+ * Change tracking state value when indexing finishes on select, reset documents in the datasource.
1396
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1397
+ */
1398
+ readonly resetDocumentsFinalChangeTrackingState?: string;
1399
+ /**
1400
+ * 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.
1401
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1402
+ */
1403
+ readonly resetDocumentKeys?: string[];
1404
+ /**
1405
+ * 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.
1406
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1407
+ */
1408
+ readonly resetDatasourceDocumentIds?: string[];
1409
+ }
1410
+
1329
1411
  /** Defines values for IndexerStatus. */
1330
1412
  export declare type IndexerStatus = "unknown" | "error" | "running";
1331
1413
 
1414
+ /**
1415
+ * Defines values for IndexingMode. \
1416
+ * {@link KnownIndexingMode} can be used interchangeably with IndexingMode,
1417
+ * this enum contains the known values that the service supports.
1418
+ * ### Known values supported by the service
1419
+ * **indexingAllDocs**: The indexer is indexing all documents in the datasource. \
1420
+ * **indexingResetDocs**: The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status.
1421
+ */
1422
+ export declare type IndexingMode = string;
1423
+
1332
1424
  /** Represents parameters for indexer execution. */
1333
1425
  export declare interface IndexingParameters {
1334
1426
  /** 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. */
@@ -1894,7 +1986,7 @@ export declare enum KnownAnalyzerNames {
1894
1986
  }
1895
1987
 
1896
1988
  /** Known values of {@link Answers} that the service accepts. */
1897
- export declare const enum KnownAnswers {
1989
+ export declare enum KnownAnswers {
1898
1990
  /** Do not return answers for the query. */
1899
1991
  None = "none",
1900
1992
  /** Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. */
@@ -1902,7 +1994,7 @@ export declare const enum KnownAnswers {
1902
1994
  }
1903
1995
 
1904
1996
  /** Known values of {@link BlobIndexerDataToExtract} that the service accepts. */
1905
- export declare const enum KnownBlobIndexerDataToExtract {
1997
+ export declare enum KnownBlobIndexerDataToExtract {
1906
1998
  /** Indexes just the standard blob properties and user-specified metadata. */
1907
1999
  StorageMetadata = "storageMetadata",
1908
2000
  /** 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). */
@@ -1912,7 +2004,7 @@ export declare const enum KnownBlobIndexerDataToExtract {
1912
2004
  }
1913
2005
 
1914
2006
  /** Known values of {@link BlobIndexerImageAction} that the service accepts. */
1915
- export declare const enum KnownBlobIndexerImageAction {
2007
+ export declare enum KnownBlobIndexerImageAction {
1916
2008
  /** Ignores embedded images or image files in the data set. This is the default. */
1917
2009
  None = "none",
1918
2010
  /** 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. */
@@ -1922,7 +2014,7 @@ export declare const enum KnownBlobIndexerImageAction {
1922
2014
  }
1923
2015
 
1924
2016
  /** Known values of {@link BlobIndexerParsingMode} that the service accepts. */
1925
- export declare const enum KnownBlobIndexerParsingMode {
2017
+ export declare enum KnownBlobIndexerParsingMode {
1926
2018
  /** Set to default for normal file processing. */
1927
2019
  Default = "default",
1928
2020
  /** Set to text to improve indexing performance on plain text files in blob storage. */
@@ -1938,7 +2030,7 @@ export declare const enum KnownBlobIndexerParsingMode {
1938
2030
  }
1939
2031
 
1940
2032
  /** Known values of {@link BlobIndexerPDFTextRotationAlgorithm} that the service accepts. */
1941
- export declare const enum KnownBlobIndexerPDFTextRotationAlgorithm {
2033
+ export declare enum KnownBlobIndexerPDFTextRotationAlgorithm {
1942
2034
  /** Leverages normal text extraction. This is the default. */
1943
2035
  None = "none",
1944
2036
  /** 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. */
@@ -1946,7 +2038,7 @@ export declare const enum KnownBlobIndexerPDFTextRotationAlgorithm {
1946
2038
  }
1947
2039
 
1948
2040
  /** Known values of {@link CharFilterName} that the service accepts. */
1949
- export declare const enum KnownCharFilterName {
2041
+ export declare enum KnownCharFilterName {
1950
2042
  /** 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 */
1951
2043
  HtmlStrip = "html_strip"
1952
2044
  }
@@ -1964,7 +2056,7 @@ export declare enum KnownCharFilterNames {
1964
2056
  }
1965
2057
 
1966
2058
  /** Known values of {@link CustomEntityLookupSkillLanguage} that the service accepts. */
1967
- export declare const enum KnownCustomEntityLookupSkillLanguage {
2059
+ export declare enum KnownCustomEntityLookupSkillLanguage {
1968
2060
  /** Danish */
1969
2061
  Da = "da",
1970
2062
  /** German */
@@ -1986,7 +2078,7 @@ export declare const enum KnownCustomEntityLookupSkillLanguage {
1986
2078
  }
1987
2079
 
1988
2080
  /** Known values of {@link EntityCategory} that the service accepts. */
1989
- export declare const enum KnownEntityCategory {
2081
+ export declare enum KnownEntityCategory {
1990
2082
  /** Entities describing a physical location. */
1991
2083
  Location = "location",
1992
2084
  /** Entities describing an organization. */
@@ -2004,7 +2096,7 @@ export declare const enum KnownEntityCategory {
2004
2096
  }
2005
2097
 
2006
2098
  /** Known values of {@link EntityRecognitionSkillLanguage} that the service accepts. */
2007
- export declare const enum KnownEntityRecognitionSkillLanguage {
2099
+ export declare enum KnownEntityRecognitionSkillLanguage {
2008
2100
  /** Arabic */
2009
2101
  Ar = "ar",
2010
2102
  /** Czech */
@@ -2054,7 +2146,7 @@ export declare const enum KnownEntityRecognitionSkillLanguage {
2054
2146
  }
2055
2147
 
2056
2148
  /** Known values of {@link ImageAnalysisSkillLanguage} that the service accepts. */
2057
- export declare const enum KnownImageAnalysisSkillLanguage {
2149
+ export declare enum KnownImageAnalysisSkillLanguage {
2058
2150
  /** English */
2059
2151
  En = "en",
2060
2152
  /** Spanish */
@@ -2068,15 +2160,29 @@ export declare const enum KnownImageAnalysisSkillLanguage {
2068
2160
  }
2069
2161
 
2070
2162
  /** Known values of {@link ImageDetail} that the service accepts. */
2071
- export declare const enum KnownImageDetail {
2163
+ export declare enum KnownImageDetail {
2072
2164
  /** Details recognized as celebrities. */
2073
2165
  Celebrities = "celebrities",
2074
2166
  /** Details recognized as landmarks. */
2075
2167
  Landmarks = "landmarks"
2076
2168
  }
2077
2169
 
2170
+ /** Known values of {@link IndexerExecutionStatusDetail} that the service accepts. */
2171
+ export declare enum KnownIndexerExecutionStatusDetail {
2172
+ /** Indicates that the reset that occurred was for a call to ResetDocs. */
2173
+ ResetDocs = "resetDocs"
2174
+ }
2175
+
2176
+ /** Known values of {@link IndexingMode} that the service accepts. */
2177
+ export declare enum KnownIndexingMode {
2178
+ /** The indexer is indexing all documents in the datasource. */
2179
+ IndexingAllDocs = "indexingAllDocs",
2180
+ /** The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status. */
2181
+ IndexingResetDocs = "indexingResetDocs"
2182
+ }
2183
+
2078
2184
  /** Known values of {@link KeyPhraseExtractionSkillLanguage} that the service accepts. */
2079
- export declare const enum KnownKeyPhraseExtractionSkillLanguage {
2185
+ export declare enum KnownKeyPhraseExtractionSkillLanguage {
2080
2186
  /** Danish */
2081
2187
  Da = "da",
2082
2188
  /** Dutch */
@@ -2112,7 +2218,7 @@ export declare const enum KnownKeyPhraseExtractionSkillLanguage {
2112
2218
  }
2113
2219
 
2114
2220
  /** Known values of {@link LexicalAnalyzerName} that the service accepts. */
2115
- export declare const enum KnownLexicalAnalyzerName {
2221
+ export declare enum KnownLexicalAnalyzerName {
2116
2222
  /** Microsoft analyzer for Arabic. */
2117
2223
  ArMicrosoft = "ar.microsoft",
2118
2224
  /** Lucene analyzer for Arabic. */
@@ -2302,7 +2408,7 @@ export declare const enum KnownLexicalAnalyzerName {
2302
2408
  }
2303
2409
 
2304
2410
  /** Known values of {@link LexicalNormalizerName} that the service accepts. */
2305
- export declare const enum KnownLexicalNormalizerName {
2411
+ export declare enum KnownLexicalNormalizerName {
2306
2412
  /** 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 */
2307
2413
  AsciiFolding = "asciifolding",
2308
2414
  /** 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 */
@@ -2316,7 +2422,7 @@ export declare const enum KnownLexicalNormalizerName {
2316
2422
  }
2317
2423
 
2318
2424
  /** Known values of {@link LineEnding} that the service accepts. */
2319
- export declare const enum KnownLineEnding {
2425
+ export declare enum KnownLineEnding {
2320
2426
  /** Lines are separated by a single space character. */
2321
2427
  Space = "space",
2322
2428
  /** Lines are separated by a carriage return ('\r') character. */
@@ -2328,7 +2434,7 @@ export declare const enum KnownLineEnding {
2328
2434
  }
2329
2435
 
2330
2436
  /** Known values of {@link OcrSkillLanguage} that the service accepts. */
2331
- export declare const enum KnownOcrSkillLanguage {
2437
+ export declare enum KnownOcrSkillLanguage {
2332
2438
  /** Chinese-Simplified */
2333
2439
  ZhHans = "zh-Hans",
2334
2440
  /** Chinese-Traditional */
@@ -2380,27 +2486,193 @@ export declare const enum KnownOcrSkillLanguage {
2380
2486
  /** Serbian (Latin, Serbia) */
2381
2487
  SrLatn = "sr-Latn",
2382
2488
  /** Slovak */
2383
- Sk = "sk"
2489
+ Sk = "sk",
2490
+ /** Unknown. If the language is explicitly set to "unk", the language will be auto-detected. */
2491
+ Unk = "unk"
2384
2492
  }
2385
2493
 
2386
2494
  /** Known values of {@link PIIDetectionSkillMaskingMode} that the service accepts. */
2387
- export declare const enum KnownPIIDetectionSkillMaskingMode {
2495
+ export declare enum KnownPIIDetectionSkillMaskingMode {
2388
2496
  /** No masking occurs and the maskedText output will not be returned. */
2389
2497
  None = "none",
2390
2498
  /** 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. */
2391
2499
  Replace = "replace"
2392
2500
  }
2393
2501
 
2502
+ /** Known values of {@link QueryAnswerType} that the service accepts. */
2503
+ export declare enum KnownQueryAnswerType {
2504
+ /** Do not return answers for the query. */
2505
+ None = "none",
2506
+ /** Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. */
2507
+ Extractive = "extractive"
2508
+ }
2509
+
2510
+ /** Known values of {@link QueryCaptionType} that the service accepts. */
2511
+ export declare enum KnownQueryCaptionType {
2512
+ /** Do not return captions for the query. */
2513
+ None = "none",
2514
+ /** Extracts captions from the matching documents that contain passages relevant to the search query. */
2515
+ Extractive = "extractive"
2516
+ }
2517
+
2394
2518
  /** Known values of {@link QueryLanguage} that the service accepts. */
2395
- export declare const enum KnownQueryLanguage {
2519
+ export declare enum KnownQueryLanguage {
2396
2520
  /** Query language not specified. */
2397
2521
  None = "none",
2398
- /** English */
2399
- EnUs = "en-us"
2522
+ /** Query language value for English (United States). */
2523
+ EnUs = "en-us",
2524
+ /** Query language value for English (Great Britain). */
2525
+ EnGb = "en-gb",
2526
+ /** Query language value for English (India). */
2527
+ EnIn = "en-in",
2528
+ /** Query language value for English (Canada). */
2529
+ EnCa = "en-ca",
2530
+ /** Query language value for English (Australia). */
2531
+ EnAu = "en-au",
2532
+ /** Query language value for French (France). */
2533
+ FrFr = "fr-fr",
2534
+ /** Query language value for French (Canada). */
2535
+ FrCa = "fr-ca",
2536
+ /** Query language value for German (Germany). */
2537
+ DeDe = "de-de",
2538
+ /** Query language value for Spanish (Spain). */
2539
+ EsEs = "es-es",
2540
+ /** Query language value for Spanish (Mexico). */
2541
+ EsMx = "es-mx",
2542
+ /** Query language value for Chinese (China). */
2543
+ ZhCn = "zh-cn",
2544
+ /** Query language value for Chinese (Taiwan). */
2545
+ ZhTw = "zh-tw",
2546
+ /** Query language value for Portuguese (Brazil). */
2547
+ PtBr = "pt-br",
2548
+ /** Query language value for Portuguese (Portugal). */
2549
+ PtPt = "pt-pt",
2550
+ /** Query language value for Italian (Italy). */
2551
+ ItIt = "it-it",
2552
+ /** Query language value for Japanese (Japan). */
2553
+ JaJp = "ja-jp",
2554
+ /** Query language value for Korean (Korea). */
2555
+ KoKr = "ko-kr",
2556
+ /** Query language value for Russian (Russia). */
2557
+ RuRu = "ru-ru",
2558
+ /** Query language value for Czech (Czech Republic). */
2559
+ CsCz = "cs-cz",
2560
+ /** Query language value for Dutch (Belgium). */
2561
+ NlBe = "nl-be",
2562
+ /** Query language value for Dutch (Netherlands). */
2563
+ NlNl = "nl-nl",
2564
+ /** Query language value for Hungarian (Hungary). */
2565
+ HuHu = "hu-hu",
2566
+ /** Query language value for Polish (Poland). */
2567
+ PlPl = "pl-pl",
2568
+ /** Query language value for Swedish (Sweden). */
2569
+ SvSe = "sv-se",
2570
+ /** Query language value for Turkish (Turkey). */
2571
+ TrTr = "tr-tr",
2572
+ /** Query language value for Hindi (India). */
2573
+ HiIn = "hi-in",
2574
+ /** Query language value for Arabic (Saudi Arabia). */
2575
+ ArSa = "ar-sa",
2576
+ /** Query language value for Arabic (Egypt). */
2577
+ ArEg = "ar-eg",
2578
+ /** Query language value for Arabic (Morocco). */
2579
+ ArMa = "ar-ma",
2580
+ /** Query language value for Arabic (Kuwait). */
2581
+ ArKw = "ar-kw",
2582
+ /** Query language value for Arabic (Jordan). */
2583
+ ArJo = "ar-jo",
2584
+ /** Query language value for Danish (Denmark). */
2585
+ DaDk = "da-dk",
2586
+ /** Query language value for Norwegian (Norway). */
2587
+ NoNo = "no-no",
2588
+ /** Query language value for Bulgarian (Bulgaria). */
2589
+ BgBg = "bg-bg",
2590
+ /** Query language value for Croatian (Croatia). */
2591
+ HrHr = "hr-hr",
2592
+ /** Query language value for Croatian (Bosnia and Herzegovina). */
2593
+ HrBa = "hr-ba",
2594
+ /** Query language value for Malay (Malaysia). */
2595
+ MsMy = "ms-my",
2596
+ /** Query language value for Malay (Brunei Darussalam). */
2597
+ MsBn = "ms-bn",
2598
+ /** Query language value for Slovenian (Slovenia). */
2599
+ SlSl = "sl-sl",
2600
+ /** Query language value for Tamil (India). */
2601
+ TaIn = "ta-in",
2602
+ /** Query language value for Vietnamese (Viet Nam). */
2603
+ ViVn = "vi-vn",
2604
+ /** Query language value for Greek (Greece). */
2605
+ ElGr = "el-gr",
2606
+ /** Query language value for Romanian (Romania). */
2607
+ RoRo = "ro-ro",
2608
+ /** Query language value for Icelandic (Iceland). */
2609
+ IsIs = "is-is",
2610
+ /** Query language value for Indonesian (Indonesia). */
2611
+ IdId = "id-id",
2612
+ /** Query language value for Thai (Thailand). */
2613
+ ThTh = "th-th",
2614
+ /** Query language value for Lithuanian (Lithuania). */
2615
+ LtLt = "lt-lt",
2616
+ /** Query language value for Ukrainian (Ukraine). */
2617
+ UkUa = "uk-ua",
2618
+ /** Query language value for Latvian (Latvia). */
2619
+ LvLv = "lv-lv",
2620
+ /** Query language value for Estonian (Estonia). */
2621
+ EtEe = "et-ee",
2622
+ /** Query language value for Catalan (Spain). */
2623
+ CaEs = "ca-es",
2624
+ /** Query language value for Finnish (Finland). */
2625
+ FiFi = "fi-fi",
2626
+ /** Query language value for Serbian (Bosnia and Herzegovina). */
2627
+ SrBa = "sr-ba",
2628
+ /** Query language value for Serbian (Montenegro). */
2629
+ SrMe = "sr-me",
2630
+ /** Query language value for Serbian (Serbia). */
2631
+ SrRs = "sr-rs",
2632
+ /** Query language value for Slovak (Slovakia). */
2633
+ SkSk = "sk-sk",
2634
+ /** Query language value for Norwegian (Norway). */
2635
+ NbNo = "nb-no",
2636
+ /** Query language value for Armenian (Armenia). */
2637
+ HyAm = "hy-am",
2638
+ /** Query language value for Bengali (India). */
2639
+ BnIn = "bn-in",
2640
+ /** Query language value for Basque (Spain). */
2641
+ EuEs = "eu-es",
2642
+ /** Query language value for Galician (Spain). */
2643
+ GlEs = "gl-es",
2644
+ /** Query language value for Gujarati (India). */
2645
+ GuIn = "gu-in",
2646
+ /** Query language value for Hebrew (Israel). */
2647
+ HeIl = "he-il",
2648
+ /** Query language value for Irish (Ireland). */
2649
+ GaIe = "ga-ie",
2650
+ /** Query language value for Kannada (India). */
2651
+ KnIn = "kn-in",
2652
+ /** Query language value for Malayalam (India). */
2653
+ MlIn = "ml-in",
2654
+ /** Query language value for Marathi (India). */
2655
+ MrIn = "mr-in",
2656
+ /** Query language value for Persian (U.A.E.). */
2657
+ FaAe = "fa-ae",
2658
+ /** Query language value for Punjabi (India). */
2659
+ PaIn = "pa-in",
2660
+ /** Query language value for Telugu (India). */
2661
+ TeIn = "te-in",
2662
+ /** Query language value for Urdu (Pakistan). */
2663
+ UrPk = "ur-pk"
2664
+ }
2665
+
2666
+ /** Known values of {@link QuerySpellerType} that the service accepts. */
2667
+ export declare enum KnownQuerySpellerType {
2668
+ /** Speller not enabled. */
2669
+ None = "none",
2670
+ /** Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. */
2671
+ Lexicon = "lexicon"
2400
2672
  }
2401
2673
 
2402
2674
  /** Known values of {@link RegexFlags} that the service accepts. */
2403
- export declare const enum KnownRegexFlags {
2675
+ export declare enum KnownRegexFlags {
2404
2676
  /** Enables canonical equivalence. */
2405
2677
  CanonEq = "CANON_EQ",
2406
2678
  /** Enables case-insensitive matching. */
@@ -2420,7 +2692,7 @@ export declare const enum KnownRegexFlags {
2420
2692
  }
2421
2693
 
2422
2694
  /** Known values of {@link SearchIndexerDataSourceType} that the service accepts. */
2423
- export declare const enum KnownSearchIndexerDataSourceType {
2695
+ export declare enum KnownSearchIndexerDataSourceType {
2424
2696
  /** Indicates an Azure SQL datasource. */
2425
2697
  AzureSql = "azuresql",
2426
2698
  /** Indicates a CosmosDB datasource. */
@@ -2436,7 +2708,7 @@ export declare const enum KnownSearchIndexerDataSourceType {
2436
2708
  }
2437
2709
 
2438
2710
  /** Known values of {@link SentimentSkillLanguage} that the service accepts. */
2439
- export declare const enum KnownSentimentSkillLanguage {
2711
+ export declare enum KnownSentimentSkillLanguage {
2440
2712
  /** Danish */
2441
2713
  Da = "da",
2442
2714
  /** Dutch */
@@ -2470,7 +2742,7 @@ export declare const enum KnownSentimentSkillLanguage {
2470
2742
  }
2471
2743
 
2472
2744
  /** Known values of {@link Speller} that the service accepts. */
2473
- export declare const enum KnownSpeller {
2745
+ export declare enum KnownSpeller {
2474
2746
  /** Speller not enabled. */
2475
2747
  None = "none",
2476
2748
  /** Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. */
@@ -2478,7 +2750,7 @@ export declare const enum KnownSpeller {
2478
2750
  }
2479
2751
 
2480
2752
  /** Known values of {@link SplitSkillLanguage} that the service accepts. */
2481
- export declare const enum KnownSplitSkillLanguage {
2753
+ export declare enum KnownSplitSkillLanguage {
2482
2754
  /** Danish */
2483
2755
  Da = "da",
2484
2756
  /** German */
@@ -2500,7 +2772,7 @@ export declare const enum KnownSplitSkillLanguage {
2500
2772
  }
2501
2773
 
2502
2774
  /** Known values of {@link TextSplitMode} that the service accepts. */
2503
- export declare const enum KnownTextSplitMode {
2775
+ export declare enum KnownTextSplitMode {
2504
2776
  /** Split the text into individual pages. */
2505
2777
  Pages = "pages",
2506
2778
  /** Split the text into individual sentences. */
@@ -2508,7 +2780,7 @@ export declare const enum KnownTextSplitMode {
2508
2780
  }
2509
2781
 
2510
2782
  /** Known values of {@link TextTranslationSkillLanguage} that the service accepts. */
2511
- export declare const enum KnownTextTranslationSkillLanguage {
2783
+ export declare enum KnownTextTranslationSkillLanguage {
2512
2784
  /** Afrikaans */
2513
2785
  Af = "af",
2514
2786
  /** Arabic */
@@ -2656,7 +2928,7 @@ export declare const enum KnownTextTranslationSkillLanguage {
2656
2928
  }
2657
2929
 
2658
2930
  /** Known values of {@link TokenFilterName} that the service accepts. */
2659
- export declare const enum KnownTokenFilterName {
2931
+ export declare enum KnownTokenFilterName {
2660
2932
  /** 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 */
2661
2933
  ArabicNormalization = "arabic_normalization",
2662
2934
  /** 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 */
@@ -2982,7 +3254,7 @@ export declare enum KnownTokenizerNames {
2982
3254
  }
2983
3255
 
2984
3256
  /** Known values of {@link VisualFeature} that the service accepts. */
2985
- export declare const enum KnownVisualFeature {
3257
+ export declare enum KnownVisualFeature {
2986
3258
  /** Visual features recognized as adult persons. */
2987
3259
  Adult = "adult",
2988
3260
  /** Visual features recognized as commercial brands. */
@@ -3393,7 +3665,8 @@ export declare type OcrSkill = BaseSearchIndexerSkill & {
3393
3665
  * **ro**: Romanian \
3394
3666
  * **sr-Cyrl**: Serbian (Cyrillic, Serbia) \
3395
3667
  * **sr-Latn**: Serbian (Latin, Serbia) \
3396
- * **sk**: Slovak
3668
+ * **sk**: Slovak \
3669
+ * **unk**: Unknown. If the language is explicitly set to "unk", the language will be auto-detected.
3397
3670
  */
3398
3671
  export declare type OcrSkillLanguage = string;
3399
3672
 
@@ -3575,16 +3848,126 @@ export declare type PIIDetectionSkill = BaseSearchIndexerSkill & {
3575
3848
  */
3576
3849
  export declare type PIIDetectionSkillMaskingMode = string;
3577
3850
 
3851
+ /** Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers. */
3852
+ export declare interface PrioritizedFields {
3853
+ /** 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. */
3854
+ titleField?: SemanticField;
3855
+ /** 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. */
3856
+ prioritizedContentFields?: SemanticField[];
3857
+ /** 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. */
3858
+ prioritizedKeywordsFields?: SemanticField[];
3859
+ }
3860
+
3861
+ /**
3862
+ * Defines values for QueryAnswerType. \
3863
+ * {@link KnownQueryAnswerType} can be used interchangeably with QueryAnswerType,
3864
+ * this enum contains the known values that the service supports.
3865
+ * ### Known values supported by the service
3866
+ * **none**: Do not return answers for the query. \
3867
+ * **extractive**: Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language.
3868
+ */
3869
+ export declare type QueryAnswerType = string;
3870
+
3871
+ /**
3872
+ * Defines values for QueryCaptionType. \
3873
+ * {@link KnownQueryCaptionType} can be used interchangeably with QueryCaptionType,
3874
+ * this enum contains the known values that the service supports.
3875
+ * ### Known values supported by the service
3876
+ * **none**: Do not return captions for the query. \
3877
+ * **extractive**: Extracts captions from the matching documents that contain passages relevant to the search query.
3878
+ */
3879
+ export declare type QueryCaptionType = string;
3880
+
3578
3881
  /**
3579
3882
  * Defines values for QueryLanguage. \
3580
3883
  * {@link KnownQueryLanguage} can be used interchangeably with QueryLanguage,
3581
3884
  * this enum contains the known values that the service supports.
3582
3885
  * ### Known values supported by the service
3583
3886
  * **none**: Query language not specified. \
3584
- * **en-us**: English
3887
+ * **en-us**: Query language value for English (United States). \
3888
+ * **en-gb**: Query language value for English (Great Britain). \
3889
+ * **en-in**: Query language value for English (India). \
3890
+ * **en-ca**: Query language value for English (Canada). \
3891
+ * **en-au**: Query language value for English (Australia). \
3892
+ * **fr-fr**: Query language value for French (France). \
3893
+ * **fr-ca**: Query language value for French (Canada). \
3894
+ * **de-de**: Query language value for German (Germany). \
3895
+ * **es-es**: Query language value for Spanish (Spain). \
3896
+ * **es-mx**: Query language value for Spanish (Mexico). \
3897
+ * **zh-cn**: Query language value for Chinese (China). \
3898
+ * **zh-tw**: Query language value for Chinese (Taiwan). \
3899
+ * **pt-br**: Query language value for Portuguese (Brazil). \
3900
+ * **pt-pt**: Query language value for Portuguese (Portugal). \
3901
+ * **it-it**: Query language value for Italian (Italy). \
3902
+ * **ja-jp**: Query language value for Japanese (Japan). \
3903
+ * **ko-kr**: Query language value for Korean (Korea). \
3904
+ * **ru-ru**: Query language value for Russian (Russia). \
3905
+ * **cs-cz**: Query language value for Czech (Czech Republic). \
3906
+ * **nl-be**: Query language value for Dutch (Belgium). \
3907
+ * **nl-nl**: Query language value for Dutch (Netherlands). \
3908
+ * **hu-hu**: Query language value for Hungarian (Hungary). \
3909
+ * **pl-pl**: Query language value for Polish (Poland). \
3910
+ * **sv-se**: Query language value for Swedish (Sweden). \
3911
+ * **tr-tr**: Query language value for Turkish (Turkey). \
3912
+ * **hi-in**: Query language value for Hindi (India). \
3913
+ * **ar-sa**: Query language value for Arabic (Saudi Arabia). \
3914
+ * **ar-eg**: Query language value for Arabic (Egypt). \
3915
+ * **ar-ma**: Query language value for Arabic (Morocco). \
3916
+ * **ar-kw**: Query language value for Arabic (Kuwait). \
3917
+ * **ar-jo**: Query language value for Arabic (Jordan). \
3918
+ * **da-dk**: Query language value for Danish (Denmark). \
3919
+ * **no-no**: Query language value for Norwegian (Norway). \
3920
+ * **bg-bg**: Query language value for Bulgarian (Bulgaria). \
3921
+ * **hr-hr**: Query language value for Croatian (Croatia). \
3922
+ * **hr-ba**: Query language value for Croatian (Bosnia and Herzegovina). \
3923
+ * **ms-my**: Query language value for Malay (Malaysia). \
3924
+ * **ms-bn**: Query language value for Malay (Brunei Darussalam). \
3925
+ * **sl-sl**: Query language value for Slovenian (Slovenia). \
3926
+ * **ta-in**: Query language value for Tamil (India). \
3927
+ * **vi-vn**: Query language value for Vietnamese (Viet Nam). \
3928
+ * **el-gr**: Query language value for Greek (Greece). \
3929
+ * **ro-ro**: Query language value for Romanian (Romania). \
3930
+ * **is-is**: Query language value for Icelandic (Iceland). \
3931
+ * **id-id**: Query language value for Indonesian (Indonesia). \
3932
+ * **th-th**: Query language value for Thai (Thailand). \
3933
+ * **lt-lt**: Query language value for Lithuanian (Lithuania). \
3934
+ * **uk-ua**: Query language value for Ukrainian (Ukraine). \
3935
+ * **lv-lv**: Query language value for Latvian (Latvia). \
3936
+ * **et-ee**: Query language value for Estonian (Estonia). \
3937
+ * **ca-es**: Query language value for Catalan (Spain). \
3938
+ * **fi-fi**: Query language value for Finnish (Finland). \
3939
+ * **sr-ba**: Query language value for Serbian (Bosnia and Herzegovina). \
3940
+ * **sr-me**: Query language value for Serbian (Montenegro). \
3941
+ * **sr-rs**: Query language value for Serbian (Serbia). \
3942
+ * **sk-sk**: Query language value for Slovak (Slovakia). \
3943
+ * **nb-no**: Query language value for Norwegian (Norway). \
3944
+ * **hy-am**: Query language value for Armenian (Armenia). \
3945
+ * **bn-in**: Query language value for Bengali (India). \
3946
+ * **eu-es**: Query language value for Basque (Spain). \
3947
+ * **gl-es**: Query language value for Galician (Spain). \
3948
+ * **gu-in**: Query language value for Gujarati (India). \
3949
+ * **he-il**: Query language value for Hebrew (Israel). \
3950
+ * **ga-ie**: Query language value for Irish (Ireland). \
3951
+ * **kn-in**: Query language value for Kannada (India). \
3952
+ * **ml-in**: Query language value for Malayalam (India). \
3953
+ * **mr-in**: Query language value for Marathi (India). \
3954
+ * **fa-ae**: Query language value for Persian (U.A.E.). \
3955
+ * **pa-in**: Query language value for Punjabi (India). \
3956
+ * **te-in**: Query language value for Telugu (India). \
3957
+ * **ur-pk**: Query language value for Urdu (Pakistan).
3585
3958
  */
3586
3959
  export declare type QueryLanguage = string;
3587
3960
 
3961
+ /**
3962
+ * Defines values for QuerySpellerType. \
3963
+ * {@link KnownQuerySpellerType} can be used interchangeably with QuerySpellerType,
3964
+ * this enum contains the known values that the service supports.
3965
+ * ### Known values supported by the service
3966
+ * **none**: Speller not enabled. \
3967
+ * **lexicon**: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter.
3968
+ */
3969
+ export declare type QuerySpellerType = string;
3970
+
3588
3971
  /** Defines values for QueryType. */
3589
3972
  export declare type QueryType = "simple" | "full" | "semantic";
3590
3973
 
@@ -3604,11 +3987,31 @@ export declare type QueryType = "simple" | "full" | "semantic";
3604
3987
  */
3605
3988
  export declare type RegexFlags = string;
3606
3989
 
3990
+ /**
3991
+ * Options for reset docs operation.
3992
+ */
3993
+ export declare interface ResetDocumentsOptions extends OperationOptions {
3994
+ /** document keys to be reset */
3995
+ documentKeys?: string[];
3996
+ /** datasource document identifiers to be reset */
3997
+ datasourceDocumentIds?: string[];
3998
+ /** 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. */
3999
+ overwrite?: boolean;
4000
+ }
4001
+
3607
4002
  /**
3608
4003
  * Options for reset indexer operation.
3609
4004
  */
3610
4005
  export declare type ResetIndexerOptions = OperationOptions;
3611
4006
 
4007
+ /**
4008
+ * Options for reset skills operation.
4009
+ */
4010
+ export declare interface ResetSkillsOptions extends OperationOptions {
4011
+ /** the names of skills to be reset. */
4012
+ skillNames?: string[];
4013
+ }
4014
+
3612
4015
  /** Represents a resource's usage and quota. */
3613
4016
  export declare interface ResourceCounter {
3614
4017
  /** The resource usage amount. */
@@ -3666,8 +4069,13 @@ export declare type ScoringStatistics = "local" | "global";
3666
4069
  * adding, updating, and removing them.
3667
4070
  */
3668
4071
  export declare class SearchClient<T> implements IndexDocumentsClient<T> {
4072
+ /**
4073
+ * The service version to use when communicating with the service.
4074
+ */
4075
+ readonly serviceVersion: string;
3669
4076
  /**
3670
4077
  * The API version to use when communicating with the service.
4078
+ * @deprecated use {@Link serviceVersion} instead
3671
4079
  */
3672
4080
  readonly apiVersion: string;
3673
4081
  /**
@@ -3735,7 +4143,7 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
3735
4143
  * @param key - The primary key value of the document
3736
4144
  * @param options - Additional options
3737
4145
  */
3738
- getDocument<Fields extends keyof T>(key: string, options?: GetDocumentOptions<Fields>): Promise<T>;
4146
+ getDocument<Fields extends Extract<keyof T, string>>(key: string, options?: GetDocumentOptions<Fields>): Promise<T>;
3739
4147
  /**
3740
4148
  * Perform a set of index modifications (upload, merge, mergeOrUpload, delete)
3741
4149
  * for the given set of documents.
@@ -3785,17 +4193,23 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
3785
4193
  private extractOperationOptions;
3786
4194
  private convertSelect;
3787
4195
  private convertSearchFields;
4196
+ private convertSemanticFields;
3788
4197
  private convertOrderBy;
3789
4198
  }
3790
4199
 
3791
4200
  /**
3792
4201
  * Client options used to configure Cognitive Search API requests.
3793
4202
  */
3794
- export declare interface SearchClientOptions extends PipelineOptions {
4203
+ export declare interface SearchClientOptions extends CommonClientOptions {
3795
4204
  /**
3796
4205
  * The API version to use when communicating with the service.
4206
+ * @deprecated use {@Link serviceVersion} instead
3797
4207
  */
3798
4208
  apiVersion?: string;
4209
+ /**
4210
+ * The service version to use when communicating with the service.
4211
+ */
4212
+ serviceVersion?: string;
3799
4213
  }
3800
4214
 
3801
4215
  /**
@@ -3943,6 +4357,10 @@ export declare interface SearchIndex {
3943
4357
  * be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.
3944
4358
  */
3945
4359
  similarity?: SimilarityAlgorithm;
4360
+ /**
4361
+ * Defines parameters for a search index that influence semantic capabilities.
4362
+ */
4363
+ semanticSettings?: SemanticSettings;
3946
4364
  /**
3947
4365
  * The ETag of the index.
3948
4366
  */
@@ -3958,6 +4376,11 @@ export declare class SearchIndexClient {
3958
4376
  /**
3959
4377
  * The API version to use when communicating with the service.
3960
4378
  */
4379
+ readonly serviceVersion: string;
4380
+ /**
4381
+ * The API version to use when communicating with the service.
4382
+ * @deprecated use {@Link serviceVersion} instead
4383
+ */
3961
4384
  readonly apiVersion: string;
3962
4385
  /**
3963
4386
  * The endpoint of the search service
@@ -4091,11 +4514,16 @@ export declare class SearchIndexClient {
4091
4514
  /**
4092
4515
  * Client options used to configure Cognitive Search API requests.
4093
4516
  */
4094
- export declare interface SearchIndexClientOptions extends PipelineOptions {
4517
+ export declare interface SearchIndexClientOptions extends CommonClientOptions {
4095
4518
  /**
4096
4519
  * The API version to use when communicating with the service.
4520
+ * @deprecated use {@Link serviceVersion} instead
4097
4521
  */
4098
4522
  apiVersion?: string;
4523
+ /**
4524
+ * The service version to use when communicating with the service.
4525
+ */
4526
+ serviceVersion?: string;
4099
4527
  }
4100
4528
 
4101
4529
  /**
@@ -4182,6 +4610,11 @@ export declare class SearchIndexerClient {
4182
4610
  /**
4183
4611
  * The API version to use when communicating with the service.
4184
4612
  */
4613
+ readonly serviceVersion: string;
4614
+ /**
4615
+ * The API version to use when communicating with the service.
4616
+ * @deprecated use {@Link serviceVersion} instead
4617
+ */
4185
4618
  readonly apiVersion: string;
4186
4619
  /**
4187
4620
  * The endpoint of the search service
@@ -4325,16 +4758,34 @@ export declare class SearchIndexerClient {
4325
4758
  * @param options - Additional optional arguments.
4326
4759
  */
4327
4760
  runIndexer(indexerName: string, options?: RunIndexerOptions): Promise<void>;
4761
+ /**
4762
+ * Resets specific documents in the datasource to be selectively re-ingested by the indexer.
4763
+ * @param indexerName - The name of the indexer to reset documents for.
4764
+ * @param options - Additional optional arguments.
4765
+ */
4766
+ resetDocuments(indexerName: string, options?: ResetDocumentsOptions): Promise<void>;
4767
+ /**
4768
+ * Reset an existing skillset in a search service.
4769
+ * @param skillsetName - The name of the skillset to reset.
4770
+ * @param skillNames - The names of skills to reset.
4771
+ * @param options - The options parameters.
4772
+ */
4773
+ resetSkills(skillsetName: string, options?: ResetSkillsOptions): Promise<void>;
4328
4774
  }
4329
4775
 
4330
4776
  /**
4331
4777
  * Client options used to configure Cognitive Search API requests.
4332
4778
  */
4333
- export declare interface SearchIndexerClientOptions extends PipelineOptions {
4779
+ export declare interface SearchIndexerClientOptions extends CommonClientOptions {
4334
4780
  /**
4335
4781
  * The API version to use when communicating with the service.
4782
+ * @deprecated use {@Link serviceVersion} instead
4336
4783
  */
4337
4784
  apiVersion?: string;
4785
+ /**
4786
+ * The service version to use when communicating with the service.
4787
+ */
4788
+ serviceVersion?: string;
4338
4789
  }
4339
4790
 
4340
4791
  /** Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed. */
@@ -4540,7 +4991,7 @@ export declare interface SearchIndexerLimits {
4540
4991
  /**
4541
4992
  * Contains the possible cases for Skill.
4542
4993
  */
4543
- export declare type SearchIndexerSkill = ConditionalSkill | KeyPhraseExtractionSkill | OcrSkill | ImageAnalysisSkill | LanguageDetectionSkill | ShaperSkill | MergeSkill | EntityRecognitionSkill | SentimentSkill | SplitSkill | PIIDetectionSkill | EntityRecognitionSkillV3 | EntityLinkingSkill | SentimentSkillV3 | CustomEntityLookupSkill | TextTranslationSkill | DocumentExtractionSkill | WebApiSkill;
4994
+ export declare type SearchIndexerSkill = ConditionalSkill | KeyPhraseExtractionSkill | OcrSkill | ImageAnalysisSkill | LanguageDetectionSkill | ShaperSkill | MergeSkill | EntityRecognitionSkill | SentimentSkill | SplitSkill | PIIDetectionSkill | EntityRecognitionSkillV3 | EntityLinkingSkill | SentimentSkillV3 | CustomEntityLookupSkill | TextTranslationSkill | DocumentExtractionSkill | WebApiSkill | AzureMachineLearningSkill;
4544
4995
 
4545
4996
  /**
4546
4997
  * A list of skills.
@@ -4975,6 +5426,11 @@ export declare interface SearchRequest {
4975
5426
  * the results.
4976
5427
  */
4977
5428
  scoringProfile?: string;
5429
+ /**
5430
+ * The name of a semantic configuration that will be used when processing documents for queries of
5431
+ * type semantic.
5432
+ */
5433
+ semanticConfiguration?: string;
4978
5434
  /**
4979
5435
  * A full-text search query expression; Use "*" or omit this parameter to match all documents.
4980
5436
  */
@@ -4998,11 +5454,11 @@ export declare interface SearchRequest {
4998
5454
  * A value that specified the type of the speller to use to spell-correct individual search
4999
5455
  * query terms.
5000
5456
  */
5001
- speller?: Speller;
5457
+ speller?: QuerySpellerType;
5002
5458
  /**
5003
5459
  * A value that specifies whether answers should be returned as part of the search response.
5004
5460
  */
5005
- answers?: Answers;
5461
+ answers?: QueryAnswerType;
5006
5462
  /**
5007
5463
  * The comma-separated list of fields to retrieve. If unspecified, all fields marked as
5008
5464
  * retrievable in the schema are included.
@@ -5021,9 +5477,13 @@ export declare interface SearchRequest {
5021
5477
  * Search request for the next page of results.
5022
5478
  */
5023
5479
  top?: number;
5024
- /** A value that specifies whether captions should be returned as part of the search response. */
5025
- captions?: Captions;
5026
- /** The comma-separated list of field names used for semantic search. */
5480
+ /**
5481
+ * A value that specifies whether captions should be returned as part of the search response.
5482
+ */
5483
+ captions?: QueryCaptionType;
5484
+ /**
5485
+ * The comma-separated list of field names used for semantic search.
5486
+ */
5027
5487
  semanticFields?: string;
5028
5488
  }
5029
5489
 
@@ -5151,6 +5611,17 @@ export declare interface SearchRequestOptions<Fields> {
5151
5611
  * Search request for the next page of results.
5152
5612
  */
5153
5613
  top?: number;
5614
+ /**
5615
+ * This parameter is only valid if the query type is 'semantic'. If set, the query returns captions
5616
+ * extracted from key passages in the highest ranked documents. When Captions is set to 'extractive',
5617
+ * highlighting is enabled by default, and can be configured by appending the pipe character '|'
5618
+ * followed by the 'highlight-true'/'highlight-false' option, such as 'extractive|highlight-true'. Defaults to 'None'.
5619
+ */
5620
+ captions?: Captions;
5621
+ /**
5622
+ * The list of field names used for semantic search.
5623
+ */
5624
+ semanticFields?: string[];
5154
5625
  }
5155
5626
 
5156
5627
  /**
@@ -5247,6 +5718,25 @@ export declare interface SearchSuggester {
5247
5718
  sourceFields: string[];
5248
5719
  }
5249
5720
 
5721
+ /** Defines a specific configuration to be used in the context of semantic capabilities. */
5722
+ export declare interface SemanticConfiguration {
5723
+ /** The name of the semantic configuration. */
5724
+ name: string;
5725
+ /** 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. */
5726
+ prioritizedFields: PrioritizedFields;
5727
+ }
5728
+
5729
+ /** A field that is used as part of the semantic configuration. */
5730
+ export declare interface SemanticField {
5731
+ name?: string;
5732
+ }
5733
+
5734
+ /** Defines parameters for a search index that influence semantic capabilities. */
5735
+ export declare interface SemanticSettings {
5736
+ /** The semantic configurations for the index. */
5737
+ configurations?: SemanticConfiguration[];
5738
+ }
5739
+
5250
5740
  /** Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1. */
5251
5741
  export declare type SentimentSkill = BaseSearchIndexerSkill & {
5252
5742
  /** Polymorphic discriminator, which specifies the different types this object can be */