@azure/search-documents 11.3.1 → 12.0.0-alpha.20230320.1

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 (96) hide show
  1. package/README.md +19 -41
  2. package/dist/index.js +3887 -997
  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/index.js +1 -1
  7. package/dist-esm/src/generated/data/index.js.map +1 -1
  8. package/dist-esm/src/generated/data/models/index.js +202 -1
  9. package/dist-esm/src/generated/data/models/index.js.map +1 -1
  10. package/dist-esm/src/generated/data/models/mappers.js +138 -1
  11. package/dist-esm/src/generated/data/models/mappers.js.map +1 -1
  12. package/dist-esm/src/generated/data/models/parameters.js +72 -22
  13. package/dist-esm/src/generated/data/models/parameters.js.map +1 -1
  14. package/dist-esm/src/generated/data/operations/documents.js +32 -76
  15. package/dist-esm/src/generated/data/operations/documents.js.map +1 -1
  16. package/dist-esm/src/generated/data/operationsInterfaces/documents.js +9 -0
  17. package/dist-esm/src/generated/data/operationsInterfaces/documents.js.map +1 -0
  18. package/dist-esm/src/generated/data/operationsInterfaces/index.js +9 -0
  19. package/dist-esm/src/generated/data/operationsInterfaces/index.js.map +1 -0
  20. package/dist-esm/src/generated/data/searchClient.js +33 -5
  21. package/dist-esm/src/generated/data/searchClient.js.map +1 -1
  22. package/dist-esm/src/generated/data/searchClientContext.js +13 -11
  23. package/dist-esm/src/generated/data/searchClientContext.js.map +1 -1
  24. package/dist-esm/src/generated/service/index.js +1 -1
  25. package/dist-esm/src/generated/service/index.js.map +1 -1
  26. package/dist-esm/src/generated/service/models/index.js +1284 -1
  27. package/dist-esm/src/generated/service/models/index.js.map +1 -1
  28. package/dist-esm/src/generated/service/models/mappers.js +741 -16
  29. package/dist-esm/src/generated/service/models/mappers.js.map +1 -1
  30. package/dist-esm/src/generated/service/models/parameters.js +51 -10
  31. package/dist-esm/src/generated/service/models/parameters.js.map +1 -1
  32. package/dist-esm/src/generated/service/operations/aliases.js +160 -0
  33. package/dist-esm/src/generated/service/operations/aliases.js.map +1 -0
  34. package/dist-esm/src/generated/service/operations/dataSources.js +16 -39
  35. package/dist-esm/src/generated/service/operations/dataSources.js.map +1 -1
  36. package/dist-esm/src/generated/service/operations/index.js +1 -0
  37. package/dist-esm/src/generated/service/operations/index.js.map +1 -1
  38. package/dist-esm/src/generated/service/operations/indexers.js +47 -57
  39. package/dist-esm/src/generated/service/operations/indexers.js.map +1 -1
  40. package/dist-esm/src/generated/service/operations/indexes.js +16 -55
  41. package/dist-esm/src/generated/service/operations/indexes.js.map +1 -1
  42. package/dist-esm/src/generated/service/operations/skillsets.js +42 -39
  43. package/dist-esm/src/generated/service/operations/skillsets.js.map +1 -1
  44. package/dist-esm/src/generated/service/operations/synonymMaps.js +12 -38
  45. package/dist-esm/src/generated/service/operations/synonymMaps.js.map +1 -1
  46. package/dist-esm/src/generated/service/operationsInterfaces/aliases.js +9 -0
  47. package/dist-esm/src/generated/service/operationsInterfaces/aliases.js.map +1 -0
  48. package/dist-esm/src/generated/service/operationsInterfaces/dataSources.js +9 -0
  49. package/dist-esm/src/generated/service/operationsInterfaces/dataSources.js.map +1 -0
  50. package/dist-esm/src/generated/service/operationsInterfaces/index.js +14 -0
  51. package/dist-esm/src/generated/service/operationsInterfaces/index.js.map +1 -0
  52. package/dist-esm/src/generated/service/operationsInterfaces/indexers.js +9 -0
  53. package/dist-esm/src/generated/service/operationsInterfaces/indexers.js.map +1 -0
  54. package/dist-esm/src/generated/service/operationsInterfaces/indexes.js +9 -0
  55. package/dist-esm/src/generated/service/operationsInterfaces/indexes.js.map +1 -0
  56. package/dist-esm/src/generated/service/operationsInterfaces/skillsets.js +9 -0
  57. package/dist-esm/src/generated/service/operationsInterfaces/skillsets.js.map +1 -0
  58. package/dist-esm/src/generated/service/operationsInterfaces/synonymMaps.js +9 -0
  59. package/dist-esm/src/generated/service/operationsInterfaces/synonymMaps.js.map +1 -0
  60. package/dist-esm/src/generated/service/searchServiceClient.js +38 -16
  61. package/dist-esm/src/generated/service/searchServiceClient.js.map +1 -1
  62. package/dist-esm/src/generated/service/searchServiceClientContext.js +13 -11
  63. package/dist-esm/src/generated/service/searchServiceClientContext.js.map +1 -1
  64. package/dist-esm/src/geographyPoint.js +1 -1
  65. package/dist-esm/src/geographyPoint.js.map +1 -1
  66. package/dist-esm/src/index.js +4 -2
  67. package/dist-esm/src/index.js.map +1 -1
  68. package/dist-esm/src/indexDocumentsBatch.js +1 -1
  69. package/dist-esm/src/indexDocumentsBatch.js.map +1 -1
  70. package/dist-esm/src/indexModels.js +0 -1
  71. package/dist-esm/src/indexModels.js.map +1 -1
  72. package/dist-esm/src/odataMetadataPolicy.js +7 -15
  73. package/dist-esm/src/odataMetadataPolicy.js.map +1 -1
  74. package/dist-esm/src/searchApiKeyCredentialPolicy.js +8 -21
  75. package/dist-esm/src/searchApiKeyCredentialPolicy.js.map +1 -1
  76. package/dist-esm/src/searchAudience.js.map +1 -1
  77. package/dist-esm/src/searchClient.js +200 -70
  78. package/dist-esm/src/searchClient.js.map +1 -1
  79. package/dist-esm/src/searchIndexClient.js +240 -74
  80. package/dist-esm/src/searchIndexClient.js.map +1 -1
  81. package/dist-esm/src/searchIndexerClient.js +143 -86
  82. package/dist-esm/src/searchIndexerClient.js.map +1 -1
  83. package/dist-esm/src/searchIndexingBufferedSender.js +16 -17
  84. package/dist-esm/src/searchIndexingBufferedSender.js.map +1 -1
  85. package/dist-esm/src/serialization.js +5 -5
  86. package/dist-esm/src/serialization.js.map +1 -1
  87. package/dist-esm/src/serviceModels.js.map +1 -1
  88. package/dist-esm/src/serviceUtils.js +68 -31
  89. package/dist-esm/src/serviceUtils.js.map +1 -1
  90. package/dist-esm/src/synonymMapHelper.js +6 -2
  91. package/dist-esm/src/synonymMapHelper.js.map +1 -1
  92. package/dist-esm/src/tracing.js +6 -5
  93. package/dist-esm/src/tracing.js.map +1 -1
  94. package/package.json +48 -49
  95. package/types/search-documents.d.ts +1935 -235
  96. package/CHANGELOG.md +0 -233
@@ -1,12 +1,20 @@
1
1
  /// <reference lib="esnext.asynciterable" />
2
+
2
3
  import { AzureKeyCredential } from '@azure/core-auth';
4
+ import { ExtendedCommonClientOptions } from '@azure/core-http-compat';
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
 
11
+ /**
12
+ * An iterator for listing the aliases that exist in the Search service. Will make requests
13
+ * as needed during iteration. Use .byPage() to make one request to the server
14
+ * per iteration.
15
+ */
16
+ export declare type AliasIterator = PagedAsyncIterableIterator<SearchIndexAlias, SearchIndexAlias[], {}>;
17
+
10
18
  /** Information about a token returned by an analyzer. */
11
19
  export declare interface AnalyzedTokenInfo {
12
20
  /**
@@ -53,6 +61,10 @@ export declare interface AnalyzeRequest {
53
61
  * NOTE: Either analyzerName or tokenizerName is required in an AnalyzeRequest.
54
62
  */
55
63
  tokenizerName?: string;
64
+ /**
65
+ * The name of the normalizer to use to normalize the given text.
66
+ */
67
+ normalizerName?: LexicalNormalizerName;
56
68
  /**
57
69
  * An optional list of token filters to use when breaking the given text. This parameter can only
58
70
  * be set when using the tokenizer parameter.
@@ -76,6 +88,42 @@ export declare interface AnalyzeResult {
76
88
  */
77
89
  export declare type AnalyzeTextOptions = OperationOptions & AnalyzeRequest;
78
90
 
91
+ /** An answer is a text passage extracted from the contents of the most relevant documents that matched the query. Answers are extracted from the top search results. Answer candidates are scored and the top answers are selected. */
92
+ export declare interface AnswerResult {
93
+ /** Describes unknown properties. The value of an unknown property can be of "any" type. */
94
+ [property: string]: any;
95
+ /**
96
+ * The score value represents how relevant the answer is to the query relative to other answers returned for the query.
97
+ * NOTE: This property will not be serialized. It can only be populated by the server.
98
+ */
99
+ readonly score: number;
100
+ /**
101
+ * The key of the document the answer was extracted from.
102
+ * NOTE: This property will not be serialized. It can only be populated by the server.
103
+ */
104
+ readonly key: string;
105
+ /**
106
+ * The text passage extracted from the document contents as the answer.
107
+ * NOTE: This property will not be serialized. It can only be populated by the server.
108
+ */
109
+ readonly text: string;
110
+ /**
111
+ * Same text passage as in the Text property with highlighted text phrases most relevant to the query.
112
+ * NOTE: This property will not be serialized. It can only be populated by the server.
113
+ */
114
+ readonly highlights?: string;
115
+ }
116
+
117
+ /**
118
+ * Defines values for Answers. \
119
+ * {@link KnownAnswers} can be used interchangeably with Answers,
120
+ * this enum contains the known values that the service supports.
121
+ * ### Known values supported by the service
122
+ * **none**: Do not return answers for the query. \
123
+ * **extractive**: Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language.
124
+ */
125
+ export declare type Answers = string;
126
+
79
127
  /** 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. This token filter is implemented using Apache Lucene. */
80
128
  export declare type AsciiFoldingTokenFilter = BaseTokenFilter & {
81
129
  /** Polymorphic discriminator, which specifies the different types this object can be */
@@ -104,12 +152,12 @@ export declare type AutocompleteMode = "oneTerm" | "twoTerms" | "oneTermWithCont
104
152
  /**
105
153
  * Options for retrieving completion text for a partial searchText.
106
154
  */
107
- export declare type AutocompleteOptions<Fields> = OperationOptions & AutocompleteRequest<Fields>;
155
+ export declare type AutocompleteOptions<Model extends object> = OperationOptions & AutocompleteRequest<Model>;
108
156
 
109
157
  /**
110
158
  * Parameters for fuzzy matching, and other autocomplete query behaviors.
111
159
  */
112
- export declare interface AutocompleteRequest<Fields> {
160
+ export declare interface AutocompleteRequest<Model extends object> {
113
161
  /**
114
162
  * Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles
115
163
  * and 'oneTermWithContext' to use the current context while producing auto-completed terms.
@@ -136,7 +184,7 @@ export declare interface AutocompleteRequest<Fields> {
136
184
  highlightPostTag?: string;
137
185
  /**
138
186
  * A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If
139
- * omitted, hit highlighting is disabled.
187
+ * omitted, hit highlighting is disabled.availability
140
188
  */
141
189
  highlightPreTag?: string;
142
190
  /**
@@ -150,7 +198,7 @@ export declare interface AutocompleteRequest<Fields> {
150
198
  * The comma-separated list of field names to consider when querying for auto-completed terms.
151
199
  * Target fields must be included in the specified suggester.
152
200
  */
153
- searchFields?: Fields[];
201
+ searchFields?: SelectFields<Model>[] | Readonly<SelectFields<Model>[]>;
154
202
  /**
155
203
  * The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The
156
204
  * default is 5.
@@ -179,8 +227,27 @@ export declare interface AzureActiveDirectoryApplicationCredentials {
179
227
  /** The authentication key of the specified AAD application. */
180
228
  applicationSecret?: string;
181
229
  }
230
+
182
231
  export { AzureKeyCredential }
183
232
 
233
+ /** 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. */
234
+ export declare type AzureMachineLearningSkill = BaseSearchIndexerSkill & {
235
+ /** Polymorphic discriminator, which specifies the different types this object can be */
236
+ odatatype: "#Microsoft.Skills.Custom.AmlSkill";
237
+ /** (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. */
238
+ scoringUri?: string;
239
+ /** (Required for key authentication) The key for the AML service. */
240
+ authenticationKey?: string;
241
+ /** (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}. */
242
+ resourceId?: string;
243
+ /** (Optional) When specified, indicates the timeout for the http client making the API call. */
244
+ timeout?: string;
245
+ /** (Optional for token authentication). The region the AML service is deployed in. */
246
+ region?: string;
247
+ /** (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. */
248
+ degreeOfParallelism?: number;
249
+ };
250
+
184
251
  /** Base type for character filters. */
185
252
  export declare interface BaseCharFilter {
186
253
  /** Polymorphic discriminator, which specifies the different types this object can be */
@@ -217,6 +284,14 @@ export declare interface BaseLexicalAnalyzer {
217
284
  name: string;
218
285
  }
219
286
 
287
+ /** Base type for normalizers. */
288
+ export declare interface BaseLexicalNormalizer {
289
+ /** Polymorphic discriminator, which specifies the different types this object can be */
290
+ odatatype: "#Microsoft.Azure.Search.CustomNormalizer";
291
+ /** The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'. */
292
+ name: string;
293
+ }
294
+
220
295
  /** Base type for tokenizers. */
221
296
  export declare interface BaseLexicalTokenizer {
222
297
  /** Polymorphic discriminator, which specifies the different types this object can be */
@@ -237,10 +312,16 @@ export declare interface BaseScoringFunction {
237
312
  interpolation?: ScoringFunctionInterpolation;
238
313
  }
239
314
 
315
+ /** Abstract base type for data identities. */
316
+ export declare interface BaseSearchIndexerDataIdentity {
317
+ /** Polymorphic discriminator, which specifies the different types this object can be */
318
+ odatatype: "#Microsoft.Azure.Search.DataNoneIdentity" | "#Microsoft.Azure.Search.DataUserAssignedIdentity";
319
+ }
320
+
240
321
  /** Base type for skills. */
241
322
  export declare interface BaseSearchIndexerSkill {
242
323
  /** Polymorphic discriminator, which specifies the different types this object can be */
243
- 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.SplitSkill" | "#Microsoft.Skills.Text.CustomEntityLookupSkill" | "#Microsoft.Skills.Text.TranslationSkill" | "#Microsoft.Skills.Util.DocumentExtractionSkill" | "#Microsoft.Skills.Custom.WebApiSkill";
324
+ 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";
244
325
  /** 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 '#'. */
245
326
  name?: string;
246
327
  /** The description of the skill which describes the inputs, outputs, and usage of the skill. */
@@ -265,7 +346,7 @@ export declare interface BaseTokenFilter {
265
346
  * Defines values for BlobIndexerDataToExtract. \
266
347
  * {@link KnownBlobIndexerDataToExtract} can be used interchangeably with BlobIndexerDataToExtract,
267
348
  * this enum contains the known values that the service supports.
268
- * ### Know values supported by the service
349
+ * ### Known values supported by the service
269
350
  * **storageMetadata**: Indexes just the standard blob properties and user-specified metadata. \
270
351
  * **allMetadata**: 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). \
271
352
  * **contentAndMetadata**: Extracts all metadata and textual content from each blob.
@@ -276,7 +357,7 @@ export declare type BlobIndexerDataToExtract = string;
276
357
  * Defines values for BlobIndexerImageAction. \
277
358
  * {@link KnownBlobIndexerImageAction} can be used interchangeably with BlobIndexerImageAction,
278
359
  * this enum contains the known values that the service supports.
279
- * ### Know values supported by the service
360
+ * ### Known values supported by the service
280
361
  * **none**: Ignores embedded images or image files in the data set. This is the default. \
281
362
  * **generateNormalizedImages**: 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. \
282
363
  * **generateNormalizedImagePerPage**: Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field, but treats PDF files differently in that each page will be rendered as an image and normalized accordingly, instead of extracting embedded images. Non-PDF file types will be treated the same as if "generateNormalizedImages" was set.
@@ -287,7 +368,7 @@ export declare type BlobIndexerImageAction = string;
287
368
  * Defines values for BlobIndexerParsingMode. \
288
369
  * {@link KnownBlobIndexerParsingMode} can be used interchangeably with BlobIndexerParsingMode,
289
370
  * this enum contains the known values that the service supports.
290
- * ### Know values supported by the service
371
+ * ### Known values supported by the service
291
372
  * **default**: Set to default for normal file processing. \
292
373
  * **text**: Set to text to improve indexing performance on plain text files in blob storage. \
293
374
  * **delimitedText**: Set to delimitedText when blobs are plain CSV files. \
@@ -301,7 +382,7 @@ export declare type BlobIndexerParsingMode = string;
301
382
  * Defines values for BlobIndexerPDFTextRotationAlgorithm. \
302
383
  * {@link KnownBlobIndexerPDFTextRotationAlgorithm} can be used interchangeably with BlobIndexerPDFTextRotationAlgorithm,
303
384
  * this enum contains the known values that the service supports.
304
- * ### Know values supported by the service
385
+ * ### Known values supported by the service
305
386
  * **none**: Leverages normal text extraction. This is the default. \
306
387
  * **detectAngles**: 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.
307
388
  */
@@ -312,11 +393,37 @@ export declare type BM25Similarity = Similarity & {
312
393
  /** Polymorphic discriminator, which specifies the different types this object can be */
313
394
  odatatype: "#Microsoft.Azure.Search.BM25Similarity";
314
395
  /** This property controls the scaling function between the term frequency of each matching terms and the final relevance score of a document-query pair. By default, a value of 1.2 is used. A value of 0.0 means the score does not scale with an increase in term frequency. */
315
- k1?: number | null;
396
+ k1?: number;
316
397
  /** This property controls how the length of a document affects the relevance score. By default, a value of 0.75 is used. A value of 0.0 means no length normalization is applied, while a value of 1.0 means the score is fully normalized by the length of the document. */
317
- b?: number | null;
398
+ b?: number;
318
399
  };
319
400
 
401
+ /** Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'.. */
402
+ export declare interface CaptionResult {
403
+ /** Describes unknown properties. The value of an unknown property can be of "any" type. */
404
+ [property: string]: any;
405
+ /**
406
+ * A representative text passage extracted from the document most relevant to the search query.
407
+ * NOTE: This property will not be serialized. It can only be populated by the server.
408
+ */
409
+ readonly text?: string;
410
+ /**
411
+ * Same text passage as in the Text property with highlighted phrases most relevant to the query.
412
+ * NOTE: This property will not be serialized. It can only be populated by the server.
413
+ */
414
+ readonly highlights?: string;
415
+ }
416
+
417
+ /**
418
+ * Defines values for Captions. \
419
+ * {@link KnownCaptions} can be used interchangeably with Captions,
420
+ * this enum contains the known values that the service supports.
421
+ * ### Known values supported by the service
422
+ * **none**: Do not return captions for the query. \
423
+ * **extractive**: Extracts captions from the matching documents that contain passages relevant to the search query.
424
+ */
425
+ export declare type Captions = string;
426
+
320
427
  /**
321
428
  * Contains the possible cases for CharFilter.
322
429
  */
@@ -326,8 +433,8 @@ export declare type CharFilter = MappingCharFilter | PatternReplaceCharFilter;
326
433
  * Defines values for CharFilterName. \
327
434
  * {@link KnownCharFilterName} can be used interchangeably with CharFilterName,
328
435
  * this enum contains the known values that the service supports.
329
- * ### Know values supported by the service
330
- * **html_strip**: 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
436
+ * ### Known values supported by the service
437
+ * **html_strip**: 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
331
438
  */
332
439
  export declare type CharFilterName = string;
333
440
 
@@ -422,7 +529,7 @@ export declare interface CorsOptions {
422
529
  /** The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended). */
423
530
  allowedOrigins: string[];
424
531
  /** The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes. */
425
- maxAgeInSeconds?: number | null;
532
+ maxAgeInSeconds?: number;
426
533
  }
427
534
 
428
535
  /**
@@ -430,6 +537,11 @@ export declare interface CorsOptions {
430
537
  */
431
538
  export declare type CountDocumentsOptions = OperationOptions;
432
539
 
540
+ /**
541
+ * Options for create alias operation.
542
+ */
543
+ export declare type CreateAliasOptions = OperationOptions;
544
+
433
545
  /**
434
546
  * Options for create datasource operation.
435
547
  */
@@ -445,14 +557,28 @@ export declare type CreateIndexerOptions = OperationOptions;
445
557
  */
446
558
  export declare type CreateIndexOptions = OperationOptions;
447
559
 
560
+ /**
561
+ * Options for create or update alias operation.
562
+ */
563
+ export declare interface CreateOrUpdateAliasOptions extends OperationOptions {
564
+ /**
565
+ * If set to true, Resource will be deleted only if the etag matches.
566
+ */
567
+ onlyIfUnchanged?: boolean;
568
+ }
569
+
448
570
  /**
449
571
  * Options for create/update datasource operation.
450
572
  */
451
573
  export declare interface CreateorUpdateDataSourceConnectionOptions extends OperationOptions {
452
574
  /**
453
- * If set to true, Resource will be deleted only if the etag matches.
575
+ * If set to true, Resource will be updated only if the etag matches.
454
576
  */
455
577
  onlyIfUnchanged?: boolean;
578
+ /**
579
+ * Ignores cache reset requirements.
580
+ */
581
+ skipIndexerResetRequirementForCache?: boolean;
456
582
  }
457
583
 
458
584
  /**
@@ -460,9 +586,13 @@ export declare interface CreateorUpdateDataSourceConnectionOptions extends Opera
460
586
  */
461
587
  export declare interface CreateorUpdateIndexerOptions extends OperationOptions {
462
588
  /**
463
- * If set to true, Resource will be deleted only if the etag matches.
589
+ * If set to true, Resource will be updated only if the etag matches.
464
590
  */
465
591
  onlyIfUnchanged?: boolean;
592
+ /** Ignores cache reset requirements. */
593
+ skipIndexerResetRequirementForCache?: boolean;
594
+ /** Disables cache reprocessing change detection. */
595
+ disableCacheReprocessingChangeDetection?: boolean;
466
596
  }
467
597
 
468
598
  /**
@@ -487,9 +617,17 @@ export declare interface CreateOrUpdateIndexOptions extends OperationOptions {
487
617
  */
488
618
  export declare interface CreateOrUpdateSkillsetOptions extends OperationOptions {
489
619
  /**
490
- * If set to true, Resource will be deleted only if the etag matches.
620
+ * If set to true, Resource will be updated only if the etag matches.
491
621
  */
492
622
  onlyIfUnchanged?: boolean;
623
+ /**
624
+ * Ignores cache reset requirements.
625
+ */
626
+ skipIndexerResetRequirementForCache?: boolean;
627
+ /**
628
+ * Disables cache reprocessing change detection.
629
+ */
630
+ disableCacheReprocessingChangeDetection?: boolean;
493
631
  }
494
632
 
495
633
  /**
@@ -497,7 +635,7 @@ export declare interface CreateOrUpdateSkillsetOptions extends OperationOptions
497
635
  */
498
636
  export declare interface CreateOrUpdateSynonymMapOptions extends OperationOptions {
499
637
  /**
500
- * If set to true, Resource will be deleted only if the etag matches.
638
+ * If set to true, Resource will be updated only if the etag matches.
501
639
  */
502
640
  onlyIfUnchanged?: boolean;
503
641
  }
@@ -561,27 +699,27 @@ export declare interface CustomEntity {
561
699
  /** The top-level entity descriptor. Matches in the skill output will be grouped by this name, and it should represent the "normalized" form of the text being found. */
562
700
  name: string;
563
701
  /** This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output. */
564
- description?: string | null;
702
+ description?: string;
565
703
  /** This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output. */
566
- type?: string | null;
704
+ type?: string;
567
705
  /** This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output. */
568
- subtype?: string | null;
706
+ subtype?: string;
569
707
  /** This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output. */
570
- id?: string | null;
708
+ id?: string;
571
709
  /** Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to character casing. Sample case insensitive matches of "Microsoft" could be: microsoft, microSoft, MICROSOFT. */
572
- caseSensitive?: boolean | null;
710
+ caseSensitive?: boolean;
573
711
  /** Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent. */
574
- accentSensitive?: boolean | null;
712
+ accentSensitive?: boolean;
575
713
  /** Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent characters that would still constitute a match with the entity name. The smallest possible fuzziness for any given match is returned. For instance, if the edit distance is set to 3, "Windows10" would still match "Windows", "Windows10" and "Windows 7". When case sensitivity is set to false, case differences do NOT count towards fuzziness tolerance, but otherwise do. */
576
- fuzzyEditDistance?: number | null;
714
+ fuzzyEditDistance?: number;
577
715
  /** Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values. */
578
- defaultCaseSensitive?: boolean | null;
716
+ defaultCaseSensitive?: boolean;
579
717
  /** Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values. */
580
- defaultAccentSensitive?: boolean | null;
718
+ defaultAccentSensitive?: boolean;
581
719
  /** Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values. */
582
- defaultFuzzyEditDistance?: number | null;
720
+ defaultFuzzyEditDistance?: number;
583
721
  /** An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name. */
584
- aliases?: CustomEntityAlias[] | null;
722
+ aliases?: CustomEntityAlias[];
585
723
  }
586
724
 
587
725
  /** A complex object that can be used to specify alternative spellings or synonyms to the root entity name. */
@@ -589,11 +727,11 @@ export declare interface CustomEntityAlias {
589
727
  /** The text of the alias. */
590
728
  text: string;
591
729
  /** Determine if the alias is case sensitive. */
592
- caseSensitive?: boolean | null;
730
+ caseSensitive?: boolean;
593
731
  /** Determine if the alias is accent sensitive. */
594
- accentSensitive?: boolean | null;
732
+ accentSensitive?: boolean;
595
733
  /** Determine the fuzzy edit distance of the alias. */
596
- fuzzyEditDistance?: number | null;
734
+ fuzzyEditDistance?: number;
597
735
  }
598
736
 
599
737
  /** A skill looks for text from a custom, user-defined list of words and phrases. */
@@ -601,24 +739,24 @@ export declare type CustomEntityLookupSkill = BaseSearchIndexerSkill & {
601
739
  /** Polymorphic discriminator, which specifies the different types this object can be */
602
740
  odatatype: "#Microsoft.Skills.Text.CustomEntityLookupSkill";
603
741
  /** A value indicating which language code to use. Default is en. */
604
- defaultLanguageCode?: CustomEntityLookupSkillLanguage | null;
742
+ defaultLanguageCode?: CustomEntityLookupSkillLanguage;
605
743
  /** Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run. Any updates to this file during an indexer run will not take effect until subsequent runs. This config must be accessible over HTTPS. */
606
- entitiesDefinitionUri?: string | null;
744
+ entitiesDefinitionUri?: string;
607
745
  /** The inline CustomEntity definition. */
608
- inlineEntitiesDefinition?: CustomEntity[] | null;
746
+ inlineEntitiesDefinition?: CustomEntity[];
609
747
  /** A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value. */
610
- globalDefaultCaseSensitive?: boolean | null;
748
+ globalDefaultCaseSensitive?: boolean;
611
749
  /** A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value. */
612
- globalDefaultAccentSensitive?: boolean | null;
750
+ globalDefaultAccentSensitive?: boolean;
613
751
  /** A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value. */
614
- globalDefaultFuzzyEditDistance?: number | null;
752
+ globalDefaultFuzzyEditDistance?: number;
615
753
  };
616
754
 
617
755
  /**
618
756
  * Defines values for CustomEntityLookupSkillLanguage. \
619
757
  * {@link KnownCustomEntityLookupSkillLanguage} can be used interchangeably with CustomEntityLookupSkillLanguage,
620
758
  * this enum contains the known values that the service supports.
621
- * ### Know values supported by the service
759
+ * ### Known values supported by the service
622
760
  * **da**: Danish \
623
761
  * **de**: German \
624
762
  * **en**: English \
@@ -631,6 +769,16 @@ export declare type CustomEntityLookupSkill = BaseSearchIndexerSkill & {
631
769
  */
632
770
  export declare type CustomEntityLookupSkillLanguage = string;
633
771
 
772
+ /** Allows you to configure normalization for filterable, sortable, and facetable fields, which by default operate with strict matching. This is a user-defined configuration consisting of at least one or more filters, which modify the token that is stored. */
773
+ export declare type CustomNormalizer = BaseLexicalNormalizer & {
774
+ /** Polymorphic discriminator, which specifies the different types this object can be */
775
+ odatatype: "#Microsoft.Azure.Search.CustomNormalizer";
776
+ /** A list of token filters used to filter out or modify the input token. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed. */
777
+ tokenFilters?: TokenFilterName[];
778
+ /** A list of character filters used to prepare input text before it is processed. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed. */
779
+ charFilters?: CharFilterName[];
780
+ };
781
+
634
782
  /**
635
783
  * Contains the possible cases for DataChangeDetectionPolicy.
636
784
  */
@@ -662,6 +810,16 @@ export declare type DefaultCognitiveServicesAccount = BaseCognitiveServicesAccou
662
810
  odatatype: "#Microsoft.Azure.Search.DefaultCognitiveServices";
663
811
  };
664
812
 
813
+ /**
814
+ * Options for delete alias operation.
815
+ */
816
+ export declare interface DeleteAliasOptions extends OperationOptions {
817
+ /**
818
+ * If set to true, Resource will be deleted only if the etag matches.
819
+ */
820
+ onlyIfUnchanged?: boolean;
821
+ }
822
+
665
823
  /**
666
824
  * Options for delete datasource operation.
667
825
  */
@@ -754,13 +912,13 @@ export declare type DocumentExtractionSkill = BaseSearchIndexerSkill & {
754
912
  /** Polymorphic discriminator, which specifies the different types this object can be */
755
913
  odatatype: "#Microsoft.Skills.Util.DocumentExtractionSkill";
756
914
  /** The parsingMode for the skill. Will be set to 'default' if not defined. */
757
- parsingMode?: string | null;
915
+ parsingMode?: string;
758
916
  /** The type of data to be extracted for the skill. Will be set to 'contentAndMetadata' if not defined. */
759
- dataToExtract?: string | null;
917
+ dataToExtract?: string;
760
918
  /** A dictionary of configurations for the skill. */
761
919
  configuration?: {
762
- [propertyName: string]: any;
763
- } | null;
920
+ [propertyName: string]: Record<string, unknown>;
921
+ };
764
922
  };
765
923
 
766
924
  /**
@@ -821,7 +979,7 @@ export declare type ElisionTokenFilter = BaseTokenFilter & {
821
979
  * Defines values for EntityCategory. \
822
980
  * {@link KnownEntityCategory} can be used interchangeably with EntityCategory,
823
981
  * this enum contains the known values that the service supports.
824
- * ### Know values supported by the service
982
+ * ### Known values supported by the service
825
983
  * **location**: Entities describing a physical location. \
826
984
  * **organization**: Entities describing an organization. \
827
985
  * **person**: Entities describing a person. \
@@ -832,6 +990,18 @@ export declare type ElisionTokenFilter = BaseTokenFilter & {
832
990
  */
833
991
  export declare type EntityCategory = string;
834
992
 
993
+ /** Using the Text Analytics API, extracts linked entities from text. */
994
+ export declare type EntityLinkingSkill = BaseSearchIndexerSkill & {
995
+ /** Polymorphic discriminator, which specifies the different types this object can be */
996
+ odatatype: "#Microsoft.Skills.Text.V3.EntityLinkingSkill";
997
+ /** A value indicating which language code to use. Default is en. */
998
+ defaultLanguageCode?: string;
999
+ /** A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included. */
1000
+ minimumPrecision?: number;
1001
+ /** The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary. */
1002
+ modelVersion?: string;
1003
+ };
1004
+
835
1005
  /** Text analytics entity recognition. */
836
1006
  export declare type EntityRecognitionSkill = BaseSearchIndexerSkill & {
837
1007
  /** Polymorphic discriminator, which specifies the different types this object can be */
@@ -841,16 +1011,16 @@ export declare type EntityRecognitionSkill = BaseSearchIndexerSkill & {
841
1011
  /** A value indicating which language code to use. Default is en. */
842
1012
  defaultLanguageCode?: EntityRecognitionSkillLanguage;
843
1013
  /** Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced. */
844
- includeTypelessEntities?: boolean | null;
1014
+ includeTypelessEntities?: boolean;
845
1015
  /** A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included. */
846
- minimumPrecision?: number | null;
1016
+ minimumPrecision?: number;
847
1017
  };
848
1018
 
849
1019
  /**
850
1020
  * Defines values for EntityRecognitionSkillLanguage. \
851
1021
  * {@link KnownEntityRecognitionSkillLanguage} can be used interchangeably with EntityRecognitionSkillLanguage,
852
1022
  * this enum contains the known values that the service supports.
853
- * ### Know values supported by the service
1023
+ * ### Known values supported by the service
854
1024
  * **ar**: Arabic \
855
1025
  * **cs**: Czech \
856
1026
  * **zh-Hans**: Chinese-Simplified \
@@ -877,6 +1047,26 @@ export declare type EntityRecognitionSkill = BaseSearchIndexerSkill & {
877
1047
  */
878
1048
  export declare type EntityRecognitionSkillLanguage = string;
879
1049
 
1050
+ /** Using the Text Analytics API, extracts entities of different types from text. */
1051
+ export declare type EntityRecognitionSkillV3 = BaseSearchIndexerSkill & {
1052
+ /** Polymorphic discriminator, which specifies the different types this object can be */
1053
+ odatatype: "#Microsoft.Skills.Text.V3.EntityRecognitionSkill";
1054
+ /** A list of entity categories that should be extracted. */
1055
+ categories?: string[];
1056
+ /** A value indicating which language code to use. Default is en. */
1057
+ defaultLanguageCode?: string;
1058
+ /** A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included. */
1059
+ minimumPrecision?: number;
1060
+ /** The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary. */
1061
+ modelVersion?: string;
1062
+ };
1063
+
1064
+ export declare type ExcludedODataTypes = Date | GeographyPoint;
1065
+
1066
+ export declare type ExtractDocumentKey<Model> = {
1067
+ [K in keyof Model as Model[K] extends string | undefined ? K : never]: Model[K];
1068
+ };
1069
+
880
1070
  /** A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval. */
881
1071
  export declare interface FacetResult {
882
1072
  /** Describes unknown properties. The value of an unknown property can be of "any" type. */
@@ -895,7 +1085,7 @@ export declare interface FieldMapping {
895
1085
  /** The name of the target field in the index. Same as the source field name by default. */
896
1086
  targetFieldName?: string;
897
1087
  /** A function to apply to each source field value before indexing. */
898
- mappingFunction?: FieldMappingFunction | null;
1088
+ mappingFunction?: FieldMappingFunction;
899
1089
  }
900
1090
 
901
1091
  /** Represents a function that transforms a value from a data source before indexing. */
@@ -904,7 +1094,7 @@ export declare interface FieldMappingFunction {
904
1094
  name: string;
905
1095
  /** A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. */
906
1096
  parameters?: {
907
- [propertyName: string]: any;
1097
+ [propertyName: string]: Record<string, unknown>;
908
1098
  };
909
1099
  }
910
1100
 
@@ -949,6 +1139,11 @@ export declare class GeographyPoint {
949
1139
  toJSON(): Record<string, unknown>;
950
1140
  }
951
1141
 
1142
+ /**
1143
+ * Options for get alias operation.
1144
+ */
1145
+ export declare type GetAliasOptions = OperationOptions;
1146
+
952
1147
  /**
953
1148
  * Options for get datasource operation.
954
1149
  */
@@ -957,12 +1152,12 @@ export declare type GetDataSourceConnectionOptions = OperationOptions;
957
1152
  /**
958
1153
  * Options for retrieving a single document.
959
1154
  */
960
- export declare interface GetDocumentOptions<Fields> extends OperationOptions {
1155
+ export declare interface GetDocumentOptions<Model extends object, Fields extends SelectFields<Model> = SelectFields<Model>> extends OperationOptions {
961
1156
  /**
962
1157
  * List of field names to retrieve for the document; Any field not retrieved will be missing from
963
1158
  * the returned document.
964
1159
  */
965
- selectedFields?: Fields[];
1160
+ selectedFields?: [string] extends [Fields] ? string[] : Fields[] | Readonly<Fields[]>;
966
1161
  }
967
1162
 
968
1163
  /**
@@ -1024,12 +1219,59 @@ export declare type ImageAnalysisSkill = BaseSearchIndexerSkill & {
1024
1219
  * Defines values for ImageAnalysisSkillLanguage. \
1025
1220
  * {@link KnownImageAnalysisSkillLanguage} can be used interchangeably with ImageAnalysisSkillLanguage,
1026
1221
  * this enum contains the known values that the service supports.
1027
- * ### Know values supported by the service
1222
+ * ### Known values supported by the service
1223
+ * **ar**: Arabic \
1224
+ * **az**: Azerbaijani \
1225
+ * **bg**: Bulgarian \
1226
+ * **bs**: Bosnian Latin \
1227
+ * **ca**: Catalan \
1228
+ * **cs**: Czech \
1229
+ * **cy**: Welsh \
1230
+ * **da**: Danish \
1231
+ * **de**: German \
1232
+ * **el**: Greek \
1028
1233
  * **en**: English \
1029
1234
  * **es**: Spanish \
1235
+ * **et**: Estonian \
1236
+ * **eu**: Basque \
1237
+ * **fi**: Finnish \
1238
+ * **fr**: French \
1239
+ * **ga**: Irish \
1240
+ * **gl**: Galician \
1241
+ * **he**: Hebrew \
1242
+ * **hi**: Hindi \
1243
+ * **hr**: Croatian \
1244
+ * **hu**: Hungarian \
1245
+ * **id**: Indonesian \
1246
+ * **it**: Italian \
1030
1247
  * **ja**: Japanese \
1031
- * **pt**: Portuguese \
1032
- * **zh**: Chinese
1248
+ * **kk**: Kazakh \
1249
+ * **ko**: Korean \
1250
+ * **lt**: Lithuanian \
1251
+ * **lv**: Latvian \
1252
+ * **mk**: Macedonian \
1253
+ * **ms**: Malay Malaysia \
1254
+ * **nb**: Norwegian (Bokmal) \
1255
+ * **nl**: Dutch \
1256
+ * **pl**: Polish \
1257
+ * **prs**: Dari \
1258
+ * **pt-BR**: Portuguese-Brazil \
1259
+ * **pt**: Portuguese-Portugal \
1260
+ * **pt-PT**: Portuguese-Portugal \
1261
+ * **ro**: Romanian \
1262
+ * **ru**: Russian \
1263
+ * **sk**: Slovak \
1264
+ * **sl**: Slovenian \
1265
+ * **sr-Cyrl**: Serbian - Cyrillic RS \
1266
+ * **sr-Latn**: Serbian - Latin RS \
1267
+ * **sv**: Swedish \
1268
+ * **th**: Thai \
1269
+ * **tr**: Turkish \
1270
+ * **uk**: Ukrainian \
1271
+ * **vi**: Vietnamese \
1272
+ * **zh**: Chinese Simplified \
1273
+ * **zh-Hans**: Chinese Simplified \
1274
+ * **zh-Hant**: Chinese Traditional
1033
1275
  */
1034
1276
  export declare type ImageAnalysisSkillLanguage = string;
1035
1277
 
@@ -1037,7 +1279,7 @@ export declare type ImageAnalysisSkillLanguage = string;
1037
1279
  * Defines values for ImageDetail. \
1038
1280
  * {@link KnownImageDetail} can be used interchangeably with ImageDetail,
1039
1281
  * this enum contains the known values that the service supports.
1040
- * ### Know values supported by the service
1282
+ * ### Known values supported by the service
1041
1283
  * **celebrities**: Details recognized as celebrities. \
1042
1284
  * **landmarks**: Details recognized as landmarks.
1043
1285
  */
@@ -1100,7 +1342,7 @@ export declare class IndexDocumentsBatch<T> {
1100
1342
  /**
1101
1343
  * Index Documents Client
1102
1344
  */
1103
- export declare interface IndexDocumentsClient<T> {
1345
+ export declare interface IndexDocumentsClient<T extends object> {
1104
1346
  /**
1105
1347
  * Perform a set of index modifications (upload, merge, mergeOrUpload, delete)
1106
1348
  * for the given set of documents.
@@ -1135,7 +1377,7 @@ export declare interface IndexDocumentsResult {
1135
1377
  * Defines values for IndexerExecutionEnvironment. \
1136
1378
  * {@link KnownIndexerExecutionEnvironment} can be used interchangeably with IndexerExecutionEnvironment,
1137
1379
  * this enum contains the known values that the service supports.
1138
- * ### Know values supported by the service
1380
+ * ### Known values supported by the service
1139
1381
  * **standard**: Indicates that Azure Cognitive Search can determine where the indexer should execute. This is the default environment when nothing is specified and is the recommended value. \
1140
1382
  * **private**: Indicates that the indexer should run with the environment provisioned specifically for the search service. This should only be specified as the execution environment if the indexer needs to access resources securely over shared private link resources.
1141
1383
  */
@@ -1148,6 +1390,16 @@ export declare interface IndexerExecutionResult {
1148
1390
  * NOTE: This property will not be serialized. It can only be populated by the server.
1149
1391
  */
1150
1392
  readonly status: IndexerExecutionStatus;
1393
+ /**
1394
+ * The outcome of this indexer execution.
1395
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1396
+ */
1397
+ readonly statusDetail?: IndexerExecutionStatusDetail;
1398
+ /**
1399
+ * All of the state that defines and dictates the indexer's current execution.
1400
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1401
+ */
1402
+ readonly currentState?: IndexerState;
1151
1403
  /**
1152
1404
  * The error message indicating the top-level error, if any.
1153
1405
  * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -1162,7 +1414,7 @@ export declare interface IndexerExecutionResult {
1162
1414
  * The end time of this indexer execution, if the execution has already completed.
1163
1415
  * NOTE: This property will not be serialized. It can only be populated by the server.
1164
1416
  */
1165
- readonly endTime?: Date | null;
1417
+ readonly endTime?: Date;
1166
1418
  /**
1167
1419
  * The item-level indexing errors.
1168
1420
  * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -1198,17 +1450,75 @@ export declare interface IndexerExecutionResult {
1198
1450
  /** Defines values for IndexerExecutionStatus. */
1199
1451
  export declare type IndexerExecutionStatus = "transientFailure" | "success" | "inProgress" | "reset";
1200
1452
 
1453
+ /**
1454
+ * Defines values for IndexerExecutionStatusDetail. \
1455
+ * {@link KnownIndexerExecutionStatusDetail} can be used interchangeably with IndexerExecutionStatusDetail,
1456
+ * this enum contains the known values that the service supports.
1457
+ * ### Known values supported by the service
1458
+ * **resetDocs**: Indicates that the reset that occurred was for a call to ResetDocs.
1459
+ */
1460
+ export declare type IndexerExecutionStatusDetail = string;
1461
+
1462
+ /** Represents all of the state that defines and dictates the indexer's current execution. */
1463
+ export declare interface IndexerState {
1464
+ /**
1465
+ * The mode the indexer is running in.
1466
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1467
+ */
1468
+ readonly mode?: IndexingMode;
1469
+ /**
1470
+ * Change tracking state used when indexing starts on all documents in the datasource.
1471
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1472
+ */
1473
+ readonly allDocumentsInitialChangeTrackingState?: string;
1474
+ /**
1475
+ * Change tracking state value when indexing finishes on all documents in the datasource.
1476
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1477
+ */
1478
+ readonly allDocumentsFinalChangeTrackingState?: string;
1479
+ /**
1480
+ * Change tracking state used when indexing starts on select, reset documents in the datasource.
1481
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1482
+ */
1483
+ readonly resetDocumentsInitialChangeTrackingState?: string;
1484
+ /**
1485
+ * Change tracking state value when indexing finishes on select, reset documents in the datasource.
1486
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1487
+ */
1488
+ readonly resetDocumentsFinalChangeTrackingState?: string;
1489
+ /**
1490
+ * 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.
1491
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1492
+ */
1493
+ readonly resetDocumentKeys?: string[];
1494
+ /**
1495
+ * 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.
1496
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1497
+ */
1498
+ readonly resetDatasourceDocumentIds?: string[];
1499
+ }
1500
+
1201
1501
  /** Defines values for IndexerStatus. */
1202
1502
  export declare type IndexerStatus = "unknown" | "error" | "running";
1203
1503
 
1504
+ /**
1505
+ * Defines values for IndexingMode. \
1506
+ * {@link KnownIndexingMode} can be used interchangeably with IndexingMode,
1507
+ * this enum contains the known values that the service supports.
1508
+ * ### Known values supported by the service
1509
+ * **indexingAllDocs**: The indexer is indexing all documents in the datasource. \
1510
+ * **indexingResetDocs**: The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status.
1511
+ */
1512
+ export declare type IndexingMode = string;
1513
+
1204
1514
  /** Represents parameters for indexer execution. */
1205
1515
  export declare interface IndexingParameters {
1206
1516
  /** 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. */
1207
- batchSize?: number | null;
1517
+ batchSize?: number;
1208
1518
  /** The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. */
1209
- maxFailedItems?: number | null;
1519
+ maxFailedItems?: number;
1210
1520
  /** The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0. */
1211
- maxFailedItemsPerBatch?: number | null;
1521
+ maxFailedItemsPerBatch?: number;
1212
1522
  /** A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. */
1213
1523
  configuration?: IndexingParametersConfiguration;
1214
1524
  }
@@ -1326,16 +1636,16 @@ export declare type KeyPhraseExtractionSkill = BaseSearchIndexerSkill & {
1326
1636
  /** A value indicating which language code to use. Default is en. */
1327
1637
  defaultLanguageCode?: KeyPhraseExtractionSkillLanguage;
1328
1638
  /** A number indicating how many key phrases to return. If absent, all identified key phrases will be returned. */
1329
- maxKeyPhraseCount?: number | null;
1639
+ maxKeyPhraseCount?: number;
1330
1640
  /** The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary. */
1331
- modelVersion?: string | null;
1641
+ modelVersion?: string;
1332
1642
  };
1333
1643
 
1334
1644
  /**
1335
1645
  * Defines values for KeyPhraseExtractionSkillLanguage. \
1336
1646
  * {@link KnownKeyPhraseExtractionSkillLanguage} can be used interchangeably with KeyPhraseExtractionSkillLanguage,
1337
1647
  * this enum contains the known values that the service supports.
1338
- * ### Know values supported by the service
1648
+ * ### Known values supported by the service
1339
1649
  * **da**: Danish \
1340
1650
  * **nl**: Dutch \
1341
1651
  * **en**: English \
@@ -1765,8 +2075,16 @@ export declare enum KnownAnalyzerNames {
1765
2075
  Whitespace = "whitespace"
1766
2076
  }
1767
2077
 
2078
+ /** Known values of {@link Answers} that the service accepts. */
2079
+ export declare enum KnownAnswers {
2080
+ /** Do not return answers for the query. */
2081
+ None = "none",
2082
+ /** Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. */
2083
+ Extractive = "extractive"
2084
+ }
2085
+
1768
2086
  /** Known values of {@link BlobIndexerDataToExtract} that the service accepts. */
1769
- export declare const enum KnownBlobIndexerDataToExtract {
2087
+ export declare enum KnownBlobIndexerDataToExtract {
1770
2088
  /** Indexes just the standard blob properties and user-specified metadata. */
1771
2089
  StorageMetadata = "storageMetadata",
1772
2090
  /** 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). */
@@ -1776,7 +2094,7 @@ export declare const enum KnownBlobIndexerDataToExtract {
1776
2094
  }
1777
2095
 
1778
2096
  /** Known values of {@link BlobIndexerImageAction} that the service accepts. */
1779
- export declare const enum KnownBlobIndexerImageAction {
2097
+ export declare enum KnownBlobIndexerImageAction {
1780
2098
  /** Ignores embedded images or image files in the data set. This is the default. */
1781
2099
  None = "none",
1782
2100
  /** 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. */
@@ -1786,7 +2104,7 @@ export declare const enum KnownBlobIndexerImageAction {
1786
2104
  }
1787
2105
 
1788
2106
  /** Known values of {@link BlobIndexerParsingMode} that the service accepts. */
1789
- export declare const enum KnownBlobIndexerParsingMode {
2107
+ export declare enum KnownBlobIndexerParsingMode {
1790
2108
  /** Set to default for normal file processing. */
1791
2109
  Default = "default",
1792
2110
  /** Set to text to improve indexing performance on plain text files in blob storage. */
@@ -1802,7 +2120,7 @@ export declare const enum KnownBlobIndexerParsingMode {
1802
2120
  }
1803
2121
 
1804
2122
  /** Known values of {@link BlobIndexerPDFTextRotationAlgorithm} that the service accepts. */
1805
- export declare const enum KnownBlobIndexerPDFTextRotationAlgorithm {
2123
+ export declare enum KnownBlobIndexerPDFTextRotationAlgorithm {
1806
2124
  /** Leverages normal text extraction. This is the default. */
1807
2125
  None = "none",
1808
2126
  /** 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. */
@@ -1810,7 +2128,7 @@ export declare const enum KnownBlobIndexerPDFTextRotationAlgorithm {
1810
2128
  }
1811
2129
 
1812
2130
  /** Known values of {@link CharFilterName} that the service accepts. */
1813
- export declare const enum KnownCharFilterName {
2131
+ export declare enum KnownCharFilterName {
1814
2132
  /** 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 */
1815
2133
  HtmlStrip = "html_strip"
1816
2134
  }
@@ -1828,7 +2146,7 @@ export declare enum KnownCharFilterNames {
1828
2146
  }
1829
2147
 
1830
2148
  /** Known values of {@link CustomEntityLookupSkillLanguage} that the service accepts. */
1831
- export declare const enum KnownCustomEntityLookupSkillLanguage {
2149
+ export declare enum KnownCustomEntityLookupSkillLanguage {
1832
2150
  /** Danish */
1833
2151
  Da = "da",
1834
2152
  /** German */
@@ -1850,7 +2168,7 @@ export declare const enum KnownCustomEntityLookupSkillLanguage {
1850
2168
  }
1851
2169
 
1852
2170
  /** Known values of {@link EntityCategory} that the service accepts. */
1853
- export declare const enum KnownEntityCategory {
2171
+ export declare enum KnownEntityCategory {
1854
2172
  /** Entities describing a physical location. */
1855
2173
  Location = "location",
1856
2174
  /** Entities describing an organization. */
@@ -1868,7 +2186,7 @@ export declare const enum KnownEntityCategory {
1868
2186
  }
1869
2187
 
1870
2188
  /** Known values of {@link EntityRecognitionSkillLanguage} that the service accepts. */
1871
- export declare const enum KnownEntityRecognitionSkillLanguage {
2189
+ export declare enum KnownEntityRecognitionSkillLanguage {
1872
2190
  /** Arabic */
1873
2191
  Ar = "ar",
1874
2192
  /** Czech */
@@ -1918,29 +2236,137 @@ export declare const enum KnownEntityRecognitionSkillLanguage {
1918
2236
  }
1919
2237
 
1920
2238
  /** Known values of {@link ImageAnalysisSkillLanguage} that the service accepts. */
1921
- export declare const enum KnownImageAnalysisSkillLanguage {
2239
+ export declare enum KnownImageAnalysisSkillLanguage {
2240
+ /** Arabic */
2241
+ Ar = "ar",
2242
+ /** Azerbaijani */
2243
+ Az = "az",
2244
+ /** Bulgarian */
2245
+ Bg = "bg",
2246
+ /** Bosnian Latin */
2247
+ Bs = "bs",
2248
+ /** Catalan */
2249
+ Ca = "ca",
2250
+ /** Czech */
2251
+ Cs = "cs",
2252
+ /** Welsh */
2253
+ Cy = "cy",
2254
+ /** Danish */
2255
+ Da = "da",
2256
+ /** German */
2257
+ De = "de",
2258
+ /** Greek */
2259
+ El = "el",
1922
2260
  /** English */
1923
2261
  En = "en",
1924
2262
  /** Spanish */
1925
2263
  Es = "es",
2264
+ /** Estonian */
2265
+ Et = "et",
2266
+ /** Basque */
2267
+ Eu = "eu",
2268
+ /** Finnish */
2269
+ Fi = "fi",
2270
+ /** French */
2271
+ Fr = "fr",
2272
+ /** Irish */
2273
+ Ga = "ga",
2274
+ /** Galician */
2275
+ Gl = "gl",
2276
+ /** Hebrew */
2277
+ He = "he",
2278
+ /** Hindi */
2279
+ Hi = "hi",
2280
+ /** Croatian */
2281
+ Hr = "hr",
2282
+ /** Hungarian */
2283
+ Hu = "hu",
2284
+ /** Indonesian */
2285
+ Id = "id",
2286
+ /** Italian */
2287
+ It = "it",
1926
2288
  /** Japanese */
1927
2289
  Ja = "ja",
1928
- /** Portuguese */
2290
+ /** Kazakh */
2291
+ Kk = "kk",
2292
+ /** Korean */
2293
+ Ko = "ko",
2294
+ /** Lithuanian */
2295
+ Lt = "lt",
2296
+ /** Latvian */
2297
+ Lv = "lv",
2298
+ /** Macedonian */
2299
+ Mk = "mk",
2300
+ /** Malay Malaysia */
2301
+ Ms = "ms",
2302
+ /** Norwegian (Bokmal) */
2303
+ Nb = "nb",
2304
+ /** Dutch */
2305
+ Nl = "nl",
2306
+ /** Polish */
2307
+ Pl = "pl",
2308
+ /** Dari */
2309
+ Prs = "prs",
2310
+ /** Portuguese-Brazil */
2311
+ PtBR = "pt-BR",
2312
+ /** Portuguese-Portugal */
1929
2313
  Pt = "pt",
1930
- /** Chinese */
1931
- Zh = "zh"
2314
+ /** Portuguese-Portugal */
2315
+ PtPT = "pt-PT",
2316
+ /** Romanian */
2317
+ Ro = "ro",
2318
+ /** Russian */
2319
+ Ru = "ru",
2320
+ /** Slovak */
2321
+ Sk = "sk",
2322
+ /** Slovenian */
2323
+ Sl = "sl",
2324
+ /** Serbian - Cyrillic RS */
2325
+ SrCyrl = "sr-Cyrl",
2326
+ /** Serbian - Latin RS */
2327
+ SrLatn = "sr-Latn",
2328
+ /** Swedish */
2329
+ Sv = "sv",
2330
+ /** Thai */
2331
+ Th = "th",
2332
+ /** Turkish */
2333
+ Tr = "tr",
2334
+ /** Ukrainian */
2335
+ Uk = "uk",
2336
+ /** Vietnamese */
2337
+ Vi = "vi",
2338
+ /** Chinese Simplified */
2339
+ Zh = "zh",
2340
+ /** Chinese Simplified */
2341
+ ZhHans = "zh-Hans",
2342
+ /** Chinese Traditional */
2343
+ ZhHant = "zh-Hant"
1932
2344
  }
1933
2345
 
1934
2346
  /** Known values of {@link ImageDetail} that the service accepts. */
1935
- export declare const enum KnownImageDetail {
2347
+ export declare enum KnownImageDetail {
1936
2348
  /** Details recognized as celebrities. */
1937
2349
  Celebrities = "celebrities",
1938
2350
  /** Details recognized as landmarks. */
1939
2351
  Landmarks = "landmarks"
1940
2352
  }
1941
2353
 
2354
+ /** Known values of {@link IndexerExecutionStatusDetail} that the service accepts. */
2355
+ export declare enum KnownIndexerExecutionStatusDetail {
2356
+ /** Indicates that the reset that occurred was for a call to ResetDocs. */
2357
+ ResetDocs = "resetDocs"
2358
+ }
2359
+
2360
+ /** Known values of {@link IndexingMode} that the service accepts. */
2361
+ export declare enum KnownIndexingMode {
2362
+ /** The indexer is indexing all documents in the datasource. */
2363
+ IndexingAllDocs = "indexingAllDocs",
2364
+ /** The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status. */
2365
+ IndexingResetDocs = "indexingResetDocs"
2366
+ }
2367
+
1942
2368
  /** Known values of {@link KeyPhraseExtractionSkillLanguage} that the service accepts. */
1943
- export declare const enum KnownKeyPhraseExtractionSkillLanguage {
2369
+ export declare enum KnownKeyPhraseExtractionSkillLanguage {
1944
2370
  /** Danish */
1945
2371
  Da = "da",
1946
2372
  /** Dutch */
@@ -1976,7 +2402,7 @@ export declare const enum KnownKeyPhraseExtractionSkillLanguage {
1976
2402
  }
1977
2403
 
1978
2404
  /** Known values of {@link LexicalAnalyzerName} that the service accepts. */
1979
- export declare const enum KnownLexicalAnalyzerName {
2405
+ export declare enum KnownLexicalAnalyzerName {
1980
2406
  /** Microsoft analyzer for Arabic. */
1981
2407
  ArMicrosoft = "ar.microsoft",
1982
2408
  /** Lucene analyzer for Arabic. */
@@ -2165,64 +2591,558 @@ export declare const enum KnownLexicalAnalyzerName {
2165
2591
  Whitespace = "whitespace"
2166
2592
  }
2167
2593
 
2594
+ /** Known values of {@link LexicalNormalizerName} that the service accepts. */
2595
+ export declare enum KnownLexicalNormalizerName {
2596
+ /** 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 */
2597
+ AsciiFolding = "asciifolding",
2598
+ /** 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 */
2599
+ Elision = "elision",
2600
+ /** Normalizes token text to lowercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html */
2601
+ Lowercase = "lowercase",
2602
+ /** Standard normalizer, which consists of lowercase and asciifolding. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html */
2603
+ Standard = "standard",
2604
+ /** Normalizes token text to uppercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html */
2605
+ Uppercase = "uppercase"
2606
+ }
2607
+
2608
+ /** Known values of {@link LineEnding} that the service accepts. */
2609
+ export declare enum KnownLineEnding {
2610
+ /** Lines are separated by a single space character. */
2611
+ Space = "space",
2612
+ /** Lines are separated by a carriage return ('\r') character. */
2613
+ CarriageReturn = "carriageReturn",
2614
+ /** Lines are separated by a single line feed ('\n') character. */
2615
+ LineFeed = "lineFeed",
2616
+ /** Lines are separated by a carriage return and a line feed ('\r\n') character. */
2617
+ CarriageReturnLineFeed = "carriageReturnLineFeed"
2618
+ }
2619
+
2168
2620
  /** Known values of {@link OcrSkillLanguage} that the service accepts. */
2169
- export declare const enum KnownOcrSkillLanguage {
2170
- /** Chinese-Simplified */
2621
+ export declare enum KnownOcrSkillLanguage {
2622
+ /** Afrikaans */
2623
+ Af = "af",
2624
+ /** Albanian */
2625
+ Sq = "sq",
2626
+ /** Angika (Devanagiri) */
2627
+ Anp = "anp",
2628
+ /** Arabic */
2629
+ Ar = "ar",
2630
+ /** Asturian */
2631
+ Ast = "ast",
2632
+ /** Awadhi-Hindi (Devanagiri) */
2633
+ Awa = "awa",
2634
+ /** Azerbaijani (Latin) */
2635
+ Az = "az",
2636
+ /** Bagheli */
2637
+ Bfy = "bfy",
2638
+ /** Basque */
2639
+ Eu = "eu",
2640
+ /** Belarusian (Cyrillic and Latin) */
2641
+ Be = "be",
2642
+ /** Belarusian (Cyrillic) */
2643
+ BeCyrl = "be-cyrl",
2644
+ /** Belarusian (Latin) */
2645
+ BeLatn = "be-latn",
2646
+ /** Bhojpuri-Hindi (Devanagiri) */
2647
+ Bho = "bho",
2648
+ /** Bislama */
2649
+ Bi = "bi",
2650
+ /** Bodo (Devanagiri) */
2651
+ Brx = "brx",
2652
+ /** Bosnian Latin */
2653
+ Bs = "bs",
2654
+ /** Brajbha */
2655
+ Bra = "bra",
2656
+ /** Breton */
2657
+ Br = "br",
2658
+ /** Bulgarian */
2659
+ Bg = "bg",
2660
+ /** Bundeli */
2661
+ Bns = "bns",
2662
+ /** Buryat (Cyrillic) */
2663
+ Bua = "bua",
2664
+ /** Catalan */
2665
+ Ca = "ca",
2666
+ /** Cebuano */
2667
+ Ceb = "ceb",
2668
+ /** Chamling */
2669
+ Rab = "rab",
2670
+ /** Chamorro */
2671
+ Ch = "ch",
2672
+ /** Chhattisgarhi (Devanagiri) */
2673
+ Hne = "hne",
2674
+ /** Chinese Simplified */
2171
2675
  ZhHans = "zh-Hans",
2172
- /** Chinese-Traditional */
2676
+ /** Chinese Traditional */
2173
2677
  ZhHant = "zh-Hant",
2678
+ /** Cornish */
2679
+ Kw = "kw",
2680
+ /** Corsican */
2681
+ Co = "co",
2682
+ /** Crimean Tatar (Latin) */
2683
+ Crh = "crh",
2684
+ /** Croatian */
2685
+ Hr = "hr",
2174
2686
  /** Czech */
2175
2687
  Cs = "cs",
2176
2688
  /** Danish */
2177
2689
  Da = "da",
2690
+ /** Dari */
2691
+ Prs = "prs",
2692
+ /** Dhimal (Devanagiri) */
2693
+ Dhi = "dhi",
2694
+ /** Dogri (Devanagiri) */
2695
+ Doi = "doi",
2178
2696
  /** Dutch */
2179
2697
  Nl = "nl",
2180
2698
  /** English */
2181
2699
  En = "en",
2700
+ /** Erzya (Cyrillic) */
2701
+ Myv = "myv",
2702
+ /** Estonian */
2703
+ Et = "et",
2704
+ /** Faroese */
2705
+ Fo = "fo",
2706
+ /** Fijian */
2707
+ Fj = "fj",
2708
+ /** Filipino */
2709
+ Fil = "fil",
2182
2710
  /** Finnish */
2183
2711
  Fi = "fi",
2184
2712
  /** French */
2185
2713
  Fr = "fr",
2714
+ /** Frulian */
2715
+ Fur = "fur",
2716
+ /** Gagauz (Latin) */
2717
+ Gag = "gag",
2718
+ /** Galician */
2719
+ Gl = "gl",
2186
2720
  /** German */
2187
2721
  De = "de",
2722
+ /** Gilbertese */
2723
+ Gil = "gil",
2724
+ /** Gondi (Devanagiri) */
2725
+ Gon = "gon",
2188
2726
  /** Greek */
2189
2727
  El = "el",
2728
+ /** Greenlandic */
2729
+ Kl = "kl",
2730
+ /** Gurung (Devanagiri) */
2731
+ Gvr = "gvr",
2732
+ /** Haitian Creole */
2733
+ Ht = "ht",
2734
+ /** Halbi (Devanagiri) */
2735
+ Hlb = "hlb",
2736
+ /** Hani */
2737
+ Hni = "hni",
2738
+ /** Haryanvi */
2739
+ Bgc = "bgc",
2740
+ /** Hawaiian */
2741
+ Haw = "haw",
2742
+ /** Hindi */
2743
+ Hi = "hi",
2744
+ /** Hmong Daw (Latin) */
2745
+ Mww = "mww",
2746
+ /** Ho (Devanagiri) */
2747
+ Hoc = "hoc",
2190
2748
  /** Hungarian */
2191
2749
  Hu = "hu",
2750
+ /** Icelandic */
2751
+ Is = "is",
2752
+ /** Inari Sami */
2753
+ Smn = "smn",
2754
+ /** Indonesian */
2755
+ Id = "id",
2756
+ /** Interlingua */
2757
+ Ia = "ia",
2758
+ /** Inuktitut (Latin) */
2759
+ Iu = "iu",
2760
+ /** Irish */
2761
+ Ga = "ga",
2192
2762
  /** Italian */
2193
2763
  It = "it",
2194
2764
  /** Japanese */
2195
2765
  Ja = "ja",
2766
+ /** Jaunsari (Devanagiri) */
2767
+ Jns = "Jns",
2768
+ /** Javanese */
2769
+ Jv = "jv",
2770
+ /** Kabuverdianu */
2771
+ Kea = "kea",
2772
+ /** Kachin (Latin) */
2773
+ Kac = "kac",
2774
+ /** Kangri (Devanagiri) */
2775
+ Xnr = "xnr",
2776
+ /** Karachay-Balkar */
2777
+ Krc = "krc",
2778
+ /** Kara-Kalpak (Cyrillic) */
2779
+ KaaCyrl = "kaa-cyrl",
2780
+ /** Kara-Kalpak (Latin) */
2781
+ Kaa = "kaa",
2782
+ /** Kashubian */
2783
+ Csb = "csb",
2784
+ /** Kazakh (Cyrillic) */
2785
+ KkCyrl = "kk-cyrl",
2786
+ /** Kazakh (Latin) */
2787
+ KkLatn = "kk-latn",
2788
+ /** Khaling */
2789
+ Klr = "klr",
2790
+ /** Khasi */
2791
+ Kha = "kha",
2792
+ /** K'iche' */
2793
+ Quc = "quc",
2196
2794
  /** Korean */
2197
2795
  Ko = "ko",
2198
- /** Norwegian (Bokmaal) */
2796
+ /** Korku */
2797
+ Kfq = "kfq",
2798
+ /** Koryak */
2799
+ Kpy = "kpy",
2800
+ /** Kosraean */
2801
+ Kos = "kos",
2802
+ /** Kumyk (Cyrillic) */
2803
+ Kum = "kum",
2804
+ /** Kurdish (Arabic) */
2805
+ KuArab = "ku-arab",
2806
+ /** Kurdish (Latin) */
2807
+ KuLatn = "ku-latn",
2808
+ /** Kurukh (Devanagiri) */
2809
+ Kru = "kru",
2810
+ /** Kyrgyz (Cyrillic) */
2811
+ Ky = "ky",
2812
+ /** Lakota */
2813
+ Lkt = "lkt",
2814
+ /** Latin */
2815
+ La = "la",
2816
+ /** Lithuanian */
2817
+ Lt = "lt",
2818
+ /** Lower Sorbian */
2819
+ Dsb = "dsb",
2820
+ /** Lule Sami */
2821
+ Smj = "smj",
2822
+ /** Luxembourgish */
2823
+ Lb = "lb",
2824
+ /** Mahasu Pahari (Devanagiri) */
2825
+ Bfz = "bfz",
2826
+ /** Malay (Latin) */
2827
+ Ms = "ms",
2828
+ /** Maltese */
2829
+ Mt = "mt",
2830
+ /** Malto (Devanagiri) */
2831
+ Kmj = "kmj",
2832
+ /** Manx */
2833
+ Gv = "gv",
2834
+ /** Maori */
2835
+ Mi = "mi",
2836
+ /** Marathi */
2837
+ Mr = "mr",
2838
+ /** Mongolian (Cyrillic) */
2839
+ Mn = "mn",
2840
+ /** Montenegrin (Cyrillic) */
2841
+ CnrCyrl = "cnr-cyrl",
2842
+ /** Montenegrin (Latin) */
2843
+ CnrLatn = "cnr-latn",
2844
+ /** Neapolitan */
2845
+ Nap = "nap",
2846
+ /** Nepali */
2847
+ Ne = "ne",
2848
+ /** Niuean */
2849
+ Niu = "niu",
2850
+ /** Nogay */
2851
+ Nog = "nog",
2852
+ /** Northern Sami (Latin) */
2853
+ Sme = "sme",
2854
+ /** Norwegian */
2199
2855
  Nb = "nb",
2856
+ /** Norwegian */
2857
+ No = "no",
2858
+ /** Occitan */
2859
+ Oc = "oc",
2860
+ /** Ossetic */
2861
+ Os = "os",
2862
+ /** Pashto */
2863
+ Ps = "ps",
2864
+ /** Persian */
2865
+ Fa = "fa",
2200
2866
  /** Polish */
2201
2867
  Pl = "pl",
2202
2868
  /** Portuguese */
2203
2869
  Pt = "pt",
2870
+ /** Punjabi (Arabic) */
2871
+ Pa = "pa",
2872
+ /** Ripuarian */
2873
+ Ksh = "ksh",
2874
+ /** Romanian */
2875
+ Ro = "ro",
2876
+ /** Romansh */
2877
+ Rm = "rm",
2204
2878
  /** Russian */
2205
2879
  Ru = "ru",
2880
+ /** Sadri (Devanagiri) */
2881
+ Sck = "sck",
2882
+ /** Samoan (Latin) */
2883
+ Sm = "sm",
2884
+ /** Sanskrit (Devanagiri) */
2885
+ Sa = "sa",
2886
+ /** Santali (Devanagiri) */
2887
+ Sat = "sat",
2888
+ /** Scots */
2889
+ Sco = "sco",
2890
+ /** Scottish Gaelic */
2891
+ Gd = "gd",
2892
+ /** Serbian (Latin) */
2893
+ Sr = "sr",
2894
+ /** Serbian (Cyrillic) */
2895
+ SrCyrl = "sr-Cyrl",
2896
+ /** Serbian (Latin) */
2897
+ SrLatn = "sr-Latn",
2898
+ /** Sherpa (Devanagiri) */
2899
+ Xsr = "xsr",
2900
+ /** Sirmauri (Devanagiri) */
2901
+ Srx = "srx",
2902
+ /** Skolt Sami */
2903
+ Sms = "sms",
2904
+ /** Slovak */
2905
+ Sk = "sk",
2906
+ /** Slovenian */
2907
+ Sl = "sl",
2908
+ /** Somali (Arabic) */
2909
+ So = "so",
2910
+ /** Southern Sami */
2911
+ Sma = "sma",
2206
2912
  /** Spanish */
2207
2913
  Es = "es",
2914
+ /** Swahili (Latin) */
2915
+ Sw = "sw",
2208
2916
  /** Swedish */
2209
2917
  Sv = "sv",
2918
+ /** Tajik (Cyrillic) */
2919
+ Tg = "tg",
2920
+ /** Tatar (Latin) */
2921
+ Tt = "tt",
2922
+ /** Tetum */
2923
+ Tet = "tet",
2924
+ /** Thangmi */
2925
+ Thf = "thf",
2926
+ /** Tongan */
2927
+ To = "to",
2210
2928
  /** Turkish */
2211
2929
  Tr = "tr",
2212
- /** Arabic */
2213
- Ar = "ar",
2214
- /** Romanian */
2215
- Ro = "ro",
2216
- /** Serbian (Cyrillic, Serbia) */
2217
- SrCyrl = "sr-Cyrl",
2218
- /** Serbian (Latin, Serbia) */
2219
- SrLatn = "sr-Latn",
2220
- /** Slovak */
2221
- Sk = "sk"
2930
+ /** Turkmen (Latin) */
2931
+ Tk = "tk",
2932
+ /** Tuvan */
2933
+ Tyv = "tyv",
2934
+ /** Upper Sorbian */
2935
+ Hsb = "hsb",
2936
+ /** Urdu */
2937
+ Ur = "ur",
2938
+ /** Uyghur (Arabic) */
2939
+ Ug = "ug",
2940
+ /** Uzbek (Arabic) */
2941
+ UzArab = "uz-arab",
2942
+ /** Uzbek (Cyrillic) */
2943
+ UzCyrl = "uz-cyrl",
2944
+ /** Uzbek (Latin) */
2945
+ Uz = "uz",
2946
+ /** Volapük */
2947
+ Vo = "vo",
2948
+ /** Walser */
2949
+ Wae = "wae",
2950
+ /** Welsh */
2951
+ Cy = "cy",
2952
+ /** Western Frisian */
2953
+ Fy = "fy",
2954
+ /** Yucatec Maya */
2955
+ Yua = "yua",
2956
+ /** Zhuang */
2957
+ Za = "za",
2958
+ /** Zulu */
2959
+ Zu = "zu",
2960
+ /** Unknown (All) */
2961
+ Unk = "unk"
2962
+ }
2963
+
2964
+ /** Known values of {@link PIIDetectionSkillMaskingMode} that the service accepts. */
2965
+ export declare enum KnownPIIDetectionSkillMaskingMode {
2966
+ /** No masking occurs and the maskedText output will not be returned. */
2967
+ None = "none",
2968
+ /** 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. */
2969
+ Replace = "replace"
2970
+ }
2971
+
2972
+ /** Known values of {@link QueryAnswerType} that the service accepts. */
2973
+ export declare enum KnownQueryAnswerType {
2974
+ /** Do not return answers for the query. */
2975
+ None = "none",
2976
+ /** Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. */
2977
+ Extractive = "extractive"
2978
+ }
2979
+
2980
+ /** Known values of {@link QueryCaptionType} that the service accepts. */
2981
+ export declare enum KnownQueryCaptionType {
2982
+ /** Do not return captions for the query. */
2983
+ None = "none",
2984
+ /** Extracts captions from the matching documents that contain passages relevant to the search query. */
2985
+ Extractive = "extractive"
2986
+ }
2987
+
2988
+ /** Known values of {@link QueryLanguage} that the service accepts. */
2989
+ export declare enum KnownQueryLanguage {
2990
+ /** Query language not specified. */
2991
+ None = "none",
2992
+ /** Query language value for English (United States). */
2993
+ EnUs = "en-us",
2994
+ /** Query language value for English (Great Britain). */
2995
+ EnGb = "en-gb",
2996
+ /** Query language value for English (India). */
2997
+ EnIn = "en-in",
2998
+ /** Query language value for English (Canada). */
2999
+ EnCa = "en-ca",
3000
+ /** Query language value for English (Australia). */
3001
+ EnAu = "en-au",
3002
+ /** Query language value for French (France). */
3003
+ FrFr = "fr-fr",
3004
+ /** Query language value for French (Canada). */
3005
+ FrCa = "fr-ca",
3006
+ /** Query language value for German (Germany). */
3007
+ DeDe = "de-de",
3008
+ /** Query language value for Spanish (Spain). */
3009
+ EsEs = "es-es",
3010
+ /** Query language value for Spanish (Mexico). */
3011
+ EsMx = "es-mx",
3012
+ /** Query language value for Chinese (China). */
3013
+ ZhCn = "zh-cn",
3014
+ /** Query language value for Chinese (Taiwan). */
3015
+ ZhTw = "zh-tw",
3016
+ /** Query language value for Portuguese (Brazil). */
3017
+ PtBr = "pt-br",
3018
+ /** Query language value for Portuguese (Portugal). */
3019
+ PtPt = "pt-pt",
3020
+ /** Query language value for Italian (Italy). */
3021
+ ItIt = "it-it",
3022
+ /** Query language value for Japanese (Japan). */
3023
+ JaJp = "ja-jp",
3024
+ /** Query language value for Korean (Korea). */
3025
+ KoKr = "ko-kr",
3026
+ /** Query language value for Russian (Russia). */
3027
+ RuRu = "ru-ru",
3028
+ /** Query language value for Czech (Czech Republic). */
3029
+ CsCz = "cs-cz",
3030
+ /** Query language value for Dutch (Belgium). */
3031
+ NlBe = "nl-be",
3032
+ /** Query language value for Dutch (Netherlands). */
3033
+ NlNl = "nl-nl",
3034
+ /** Query language value for Hungarian (Hungary). */
3035
+ HuHu = "hu-hu",
3036
+ /** Query language value for Polish (Poland). */
3037
+ PlPl = "pl-pl",
3038
+ /** Query language value for Swedish (Sweden). */
3039
+ SvSe = "sv-se",
3040
+ /** Query language value for Turkish (Turkey). */
3041
+ TrTr = "tr-tr",
3042
+ /** Query language value for Hindi (India). */
3043
+ HiIn = "hi-in",
3044
+ /** Query language value for Arabic (Saudi Arabia). */
3045
+ ArSa = "ar-sa",
3046
+ /** Query language value for Arabic (Egypt). */
3047
+ ArEg = "ar-eg",
3048
+ /** Query language value for Arabic (Morocco). */
3049
+ ArMa = "ar-ma",
3050
+ /** Query language value for Arabic (Kuwait). */
3051
+ ArKw = "ar-kw",
3052
+ /** Query language value for Arabic (Jordan). */
3053
+ ArJo = "ar-jo",
3054
+ /** Query language value for Danish (Denmark). */
3055
+ DaDk = "da-dk",
3056
+ /** Query language value for Norwegian (Norway). */
3057
+ NoNo = "no-no",
3058
+ /** Query language value for Bulgarian (Bulgaria). */
3059
+ BgBg = "bg-bg",
3060
+ /** Query language value for Croatian (Croatia). */
3061
+ HrHr = "hr-hr",
3062
+ /** Query language value for Croatian (Bosnia and Herzegovina). */
3063
+ HrBa = "hr-ba",
3064
+ /** Query language value for Malay (Malaysia). */
3065
+ MsMy = "ms-my",
3066
+ /** Query language value for Malay (Brunei Darussalam). */
3067
+ MsBn = "ms-bn",
3068
+ /** Query language value for Slovenian (Slovenia). */
3069
+ SlSl = "sl-sl",
3070
+ /** Query language value for Tamil (India). */
3071
+ TaIn = "ta-in",
3072
+ /** Query language value for Vietnamese (Viet Nam). */
3073
+ ViVn = "vi-vn",
3074
+ /** Query language value for Greek (Greece). */
3075
+ ElGr = "el-gr",
3076
+ /** Query language value for Romanian (Romania). */
3077
+ RoRo = "ro-ro",
3078
+ /** Query language value for Icelandic (Iceland). */
3079
+ IsIs = "is-is",
3080
+ /** Query language value for Indonesian (Indonesia). */
3081
+ IdId = "id-id",
3082
+ /** Query language value for Thai (Thailand). */
3083
+ ThTh = "th-th",
3084
+ /** Query language value for Lithuanian (Lithuania). */
3085
+ LtLt = "lt-lt",
3086
+ /** Query language value for Ukrainian (Ukraine). */
3087
+ UkUa = "uk-ua",
3088
+ /** Query language value for Latvian (Latvia). */
3089
+ LvLv = "lv-lv",
3090
+ /** Query language value for Estonian (Estonia). */
3091
+ EtEe = "et-ee",
3092
+ /** Query language value for Catalan (Spain). */
3093
+ CaEs = "ca-es",
3094
+ /** Query language value for Finnish (Finland). */
3095
+ FiFi = "fi-fi",
3096
+ /** Query language value for Serbian (Bosnia and Herzegovina). */
3097
+ SrBa = "sr-ba",
3098
+ /** Query language value for Serbian (Montenegro). */
3099
+ SrMe = "sr-me",
3100
+ /** Query language value for Serbian (Serbia). */
3101
+ SrRs = "sr-rs",
3102
+ /** Query language value for Slovak (Slovakia). */
3103
+ SkSk = "sk-sk",
3104
+ /** Query language value for Norwegian (Norway). */
3105
+ NbNo = "nb-no",
3106
+ /** Query language value for Armenian (Armenia). */
3107
+ HyAm = "hy-am",
3108
+ /** Query language value for Bengali (India). */
3109
+ BnIn = "bn-in",
3110
+ /** Query language value for Basque (Spain). */
3111
+ EuEs = "eu-es",
3112
+ /** Query language value for Galician (Spain). */
3113
+ GlEs = "gl-es",
3114
+ /** Query language value for Gujarati (India). */
3115
+ GuIn = "gu-in",
3116
+ /** Query language value for Hebrew (Israel). */
3117
+ HeIl = "he-il",
3118
+ /** Query language value for Irish (Ireland). */
3119
+ GaIe = "ga-ie",
3120
+ /** Query language value for Kannada (India). */
3121
+ KnIn = "kn-in",
3122
+ /** Query language value for Malayalam (India). */
3123
+ MlIn = "ml-in",
3124
+ /** Query language value for Marathi (India). */
3125
+ MrIn = "mr-in",
3126
+ /** Query language value for Persian (U.A.E.). */
3127
+ FaAe = "fa-ae",
3128
+ /** Query language value for Punjabi (India). */
3129
+ PaIn = "pa-in",
3130
+ /** Query language value for Telugu (India). */
3131
+ TeIn = "te-in",
3132
+ /** Query language value for Urdu (Pakistan). */
3133
+ UrPk = "ur-pk"
3134
+ }
3135
+
3136
+ /** Known values of {@link QuerySpellerType} that the service accepts. */
3137
+ export declare enum KnownQuerySpellerType {
3138
+ /** Speller not enabled. */
3139
+ None = "none",
3140
+ /** Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. */
3141
+ Lexicon = "lexicon"
2222
3142
  }
2223
3143
 
2224
3144
  /** Known values of {@link RegexFlags} that the service accepts. */
2225
- export declare const enum KnownRegexFlags {
3145
+ export declare enum KnownRegexFlags {
2226
3146
  /** Enables canonical equivalence. */
2227
3147
  CanonEq = "CANON_EQ",
2228
3148
  /** Enables case-insensitive matching. */
@@ -2260,7 +3180,7 @@ export declare enum KnownSearchAudience {
2260
3180
  }
2261
3181
 
2262
3182
  /** Known values of {@link SearchIndexerDataSourceType} that the service accepts. */
2263
- export declare const enum KnownSearchIndexerDataSourceType {
3183
+ export declare enum KnownSearchIndexerDataSourceType {
2264
3184
  /** Indicates an Azure SQL datasource. */
2265
3185
  AzureSql = "azuresql",
2266
3186
  /** Indicates a CosmosDB datasource. */
@@ -2276,7 +3196,7 @@ export declare const enum KnownSearchIndexerDataSourceType {
2276
3196
  }
2277
3197
 
2278
3198
  /** Known values of {@link SentimentSkillLanguage} that the service accepts. */
2279
- export declare const enum KnownSentimentSkillLanguage {
3199
+ export declare enum KnownSentimentSkillLanguage {
2280
3200
  /** Danish */
2281
3201
  Da = "da",
2282
3202
  /** Dutch */
@@ -2309,8 +3229,16 @@ export declare const enum KnownSentimentSkillLanguage {
2309
3229
  Tr = "tr"
2310
3230
  }
2311
3231
 
3232
+ /** Known values of {@link Speller} that the service accepts. */
3233
+ export declare enum KnownSpeller {
3234
+ /** Speller not enabled. */
3235
+ None = "none",
3236
+ /** Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. */
3237
+ Lexicon = "lexicon"
3238
+ }
3239
+
2312
3240
  /** Known values of {@link SplitSkillLanguage} that the service accepts. */
2313
- export declare const enum KnownSplitSkillLanguage {
3241
+ export declare enum KnownSplitSkillLanguage {
2314
3242
  /** Danish */
2315
3243
  Da = "da",
2316
3244
  /** German */
@@ -2332,7 +3260,7 @@ export declare const enum KnownSplitSkillLanguage {
2332
3260
  }
2333
3261
 
2334
3262
  /** Known values of {@link TextSplitMode} that the service accepts. */
2335
- export declare const enum KnownTextSplitMode {
3263
+ export declare enum KnownTextSplitMode {
2336
3264
  /** Split the text into individual pages. */
2337
3265
  Pages = "pages",
2338
3266
  /** Split the text into individual sentences. */
@@ -2340,7 +3268,7 @@ export declare const enum KnownTextSplitMode {
2340
3268
  }
2341
3269
 
2342
3270
  /** Known values of {@link TextTranslationSkillLanguage} that the service accepts. */
2343
- export declare const enum KnownTextTranslationSkillLanguage {
3271
+ export declare enum KnownTextTranslationSkillLanguage {
2344
3272
  /** Afrikaans */
2345
3273
  Af = "af",
2346
3274
  /** Arabic */
@@ -2405,6 +3333,10 @@ export declare const enum KnownTextTranslationSkillLanguage {
2405
3333
  Sw = "sw",
2406
3334
  /** Klingon */
2407
3335
  Tlh = "tlh",
3336
+ /** Klingon (Latin script) */
3337
+ TlhLatn = "tlh-Latn",
3338
+ /** Klingon (Klingon script) */
3339
+ TlhPiqd = "tlh-Piqd",
2408
3340
  /** Korean */
2409
3341
  Ko = "ko",
2410
3342
  /** Latvian */
@@ -2425,6 +3357,10 @@ export declare const enum KnownTextTranslationSkillLanguage {
2425
3357
  Pl = "pl",
2426
3358
  /** Portuguese */
2427
3359
  Pt = "pt",
3360
+ /** Portuguese (Brazil) */
3361
+ PtBr = "pt-br",
3362
+ /** Portuguese (Portugal) */
3363
+ PtPT = "pt-PT",
2428
3364
  /** Queretaro Otomi */
2429
3365
  Otq = "otq",
2430
3366
  /** Romanian */
@@ -2466,11 +3402,21 @@ export declare const enum KnownTextTranslationSkillLanguage {
2466
3402
  /** Welsh */
2467
3403
  Cy = "cy",
2468
3404
  /** Yucatec Maya */
2469
- Yua = "yua"
3405
+ Yua = "yua",
3406
+ /** Irish */
3407
+ Ga = "ga",
3408
+ /** Kannada */
3409
+ Kn = "kn",
3410
+ /** Maori */
3411
+ Mi = "mi",
3412
+ /** Malayalam */
3413
+ Ml = "ml",
3414
+ /** Punjabi */
3415
+ Pa = "pa"
2470
3416
  }
2471
3417
 
2472
3418
  /** Known values of {@link TokenFilterName} that the service accepts. */
2473
- export declare const enum KnownTokenFilterName {
3419
+ export declare enum KnownTokenFilterName {
2474
3420
  /** 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 */
2475
3421
  ArabicNormalization = "arabic_normalization",
2476
3422
  /** 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 */
@@ -2503,7 +3449,7 @@ export declare const enum KnownTokenFilterName {
2503
3449
  Length = "length",
2504
3450
  /** Limits the number of tokens while indexing. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html */
2505
3451
  Limit = "limit",
2506
- /** Normalizes token text to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.htm */
3452
+ /** Normalizes token text to lower case. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html */
2507
3453
  Lowercase = "lowercase",
2508
3454
  /** Generates n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html */
2509
3455
  NGram = "nGram_v2",
@@ -2535,7 +3481,7 @@ export declare const enum KnownTokenFilterName {
2535
3481
  Truncate = "truncate",
2536
3482
  /** Filters out tokens with same text as the previous token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html */
2537
3483
  Unique = "unique",
2538
- /** Normalizes token text to upper case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html */
3484
+ /** Normalizes token text to upper case. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html */
2539
3485
  Uppercase = "uppercase",
2540
3486
  /** Splits words into subwords and performs optional transformations on subword groups. */
2541
3487
  WordDelimiter = "word_delimiter"
@@ -2796,7 +3742,7 @@ export declare enum KnownTokenizerNames {
2796
3742
  }
2797
3743
 
2798
3744
  /** Known values of {@link VisualFeature} that the service accepts. */
2799
- export declare const enum KnownVisualFeature {
3745
+ export declare enum KnownVisualFeature {
2800
3746
  /** Visual features recognized as adult persons. */
2801
3747
  Adult = "adult",
2802
3748
  /** Visual features recognized as commercial brands. */
@@ -2818,9 +3764,9 @@ export declare type LanguageDetectionSkill = BaseSearchIndexerSkill & {
2818
3764
  /** Polymorphic discriminator, which specifies the different types this object can be */
2819
3765
  odatatype: "#Microsoft.Skills.Text.LanguageDetectionSkill";
2820
3766
  /** A country code to use as a hint to the language detection model if it cannot disambiguate the language. */
2821
- defaultCountryHint?: string | null;
3767
+ defaultCountryHint?: string;
2822
3768
  /** The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary. */
2823
- modelVersion?: string | null;
3769
+ modelVersion?: string;
2824
3770
  };
2825
3771
 
2826
3772
  /** Removes words that are too long or too short. This token filter is implemented using Apache Lucene. */
@@ -2842,7 +3788,7 @@ export declare type LexicalAnalyzer = CustomAnalyzer | PatternAnalyzer | LuceneS
2842
3788
  * Defines values for LexicalAnalyzerName. \
2843
3789
  * {@link KnownLexicalAnalyzerName} can be used interchangeably with LexicalAnalyzerName,
2844
3790
  * this enum contains the known values that the service supports.
2845
- * ### Know values supported by the service
3791
+ * ### Known values supported by the service
2846
3792
  * **ar.microsoft**: Microsoft analyzer for Arabic. \
2847
3793
  * **ar.lucene**: Lucene analyzer for Arabic. \
2848
3794
  * **hy.lucene**: Lucene analyzer for Armenian. \
@@ -2930,15 +3876,33 @@ export declare type LexicalAnalyzer = CustomAnalyzer | PatternAnalyzer | LuceneS
2930
3876
  * **ur.microsoft**: Microsoft analyzer for Urdu. \
2931
3877
  * **vi.microsoft**: Microsoft analyzer for Vietnamese. \
2932
3878
  * **standard.lucene**: Standard Lucene analyzer. \
2933
- * **standardasciifolding.lucene**: Standard ASCII Folding Lucene analyzer. See https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers \
2934
- * **keyword**: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html \
2935
- * **pattern**: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html \
2936
- * **simple**: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html \
2937
- * **stop**: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html \
2938
- * **whitespace**: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html
3879
+ * **standardasciifolding.lucene**: Standard ASCII Folding Lucene analyzer. See https:\/\/docs.microsoft.com\/rest\/api\/searchservice\/Custom-analyzers-in-Azure-Search#Analyzers \
3880
+ * **keyword**: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/KeywordAnalyzer.html \
3881
+ * **pattern**: Flexibly separates text into terms via a regular expression pattern. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/PatternAnalyzer.html \
3882
+ * **simple**: Divides text at non-letters and converts them to lower case. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/SimpleAnalyzer.html \
3883
+ * **stop**: Divides text at non-letters; Applies the lowercase and stopword token filters. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/StopAnalyzer.html \
3884
+ * **whitespace**: An analyzer that uses the whitespace tokenizer. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/WhitespaceAnalyzer.html
2939
3885
  */
2940
3886
  export declare type LexicalAnalyzerName = string;
2941
3887
 
3888
+ /**
3889
+ * Contains the possible cases for LexicalNormalizer.
3890
+ */
3891
+ export declare type LexicalNormalizer = CustomNormalizer;
3892
+
3893
+ /**
3894
+ * Defines values for LexicalNormalizerName. \
3895
+ * {@link KnownLexicalNormalizerName} can be used interchangeably with LexicalNormalizerName,
3896
+ * this enum contains the known values that the service supports.
3897
+ * ### Known values supported by the service
3898
+ * **asciifolding**: 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 \
3899
+ * **elision**: 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 \
3900
+ * **lowercase**: Normalizes token text to lowercase. See https:\/\/lucene.apache.org\/core\/6_6_1\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/LowerCaseFilter.html \
3901
+ * **standard**: Standard normalizer, which consists of lowercase and asciifolding. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/reverse\/ReverseStringFilter.html \
3902
+ * **uppercase**: Normalizes token text to uppercase. See https:\/\/lucene.apache.org\/core\/6_6_1\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/UpperCaseFilter.html
3903
+ */
3904
+ export declare type LexicalNormalizerName = string;
3905
+
2942
3906
  /**
2943
3907
  * Contains the possible cases for Tokenizer.
2944
3908
  */
@@ -2954,6 +3918,23 @@ export declare type LimitTokenFilter = BaseTokenFilter & {
2954
3918
  consumeAllTokens?: boolean;
2955
3919
  };
2956
3920
 
3921
+ /**
3922
+ * Defines values for LineEnding. \
3923
+ * {@link KnownLineEnding} can be used interchangeably with LineEnding,
3924
+ * this enum contains the known values that the service supports.
3925
+ * ### Known values supported by the service
3926
+ * **space**: Lines are separated by a single space character. \
3927
+ * **carriageReturn**: Lines are separated by a carriage return ('\r') character. \
3928
+ * **lineFeed**: Lines are separated by a single line feed ('\n') character. \
3929
+ * **carriageReturnLineFeed**: Lines are separated by a carriage return and a line feed ('\r\n') character.
3930
+ */
3931
+ export declare type LineEnding = string;
3932
+
3933
+ /**
3934
+ * Options for list aliases operation.
3935
+ */
3936
+ export declare type ListAliasesOptions = OperationOptions;
3937
+
2957
3938
  /**
2958
3939
  * Options for a list data sources operation.
2959
3940
  */
@@ -3098,6 +4079,8 @@ export declare type MicrosoftStemmingTokenizerLanguage = "arabic" | "bangla" | "
3098
4079
  /** Defines values for MicrosoftTokenizerLanguage. */
3099
4080
  export declare type MicrosoftTokenizerLanguage = "bangla" | "bulgarian" | "catalan" | "chineseSimplified" | "chineseTraditional" | "croatian" | "czech" | "danish" | "dutch" | "english" | "french" | "german" | "greek" | "gujarati" | "hindi" | "icelandic" | "indonesian" | "italian" | "japanese" | "kannada" | "korean" | "malay" | "malayalam" | "marathi" | "norwegianBokmaal" | "polish" | "portuguese" | "portugueseBrazilian" | "punjabi" | "romanian" | "russian" | "serbianCyrillic" | "serbianLatin" | "slovenian" | "spanish" | "swedish" | "tamil" | "telugu" | "thai" | "ukrainian" | "urdu" | "vietnamese";
3100
4081
 
4082
+ export declare type NarrowedModel<Model extends object, Fields extends SelectFields<Model> = SelectFields<Model>> = SelectFields<Model> extends Fields ? Model : SearchPick<Model, Fields>;
4083
+
3101
4084
  /**
3102
4085
  * Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.
3103
4086
  */
@@ -3143,39 +4126,185 @@ export declare type OcrSkill = BaseSearchIndexerSkill & {
3143
4126
  defaultLanguageCode?: OcrSkillLanguage;
3144
4127
  /** A value indicating to turn orientation detection on or not. Default is false. */
3145
4128
  shouldDetectOrientation?: boolean;
4129
+ /** Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is "space". */
4130
+ lineEnding?: LineEnding;
3146
4131
  };
3147
4132
 
3148
4133
  /**
3149
4134
  * Defines values for OcrSkillLanguage. \
3150
4135
  * {@link KnownOcrSkillLanguage} can be used interchangeably with OcrSkillLanguage,
3151
4136
  * this enum contains the known values that the service supports.
3152
- * ### Know values supported by the service
3153
- * **zh-Hans**: Chinese-Simplified \
3154
- * **zh-Hant**: Chinese-Traditional \
4137
+ * ### Known values supported by the service
4138
+ * **af**: Afrikaans \
4139
+ * **sq**: Albanian \
4140
+ * **anp**: Angika (Devanagiri) \
4141
+ * **ar**: Arabic \
4142
+ * **ast**: Asturian \
4143
+ * **awa**: Awadhi-Hindi (Devanagiri) \
4144
+ * **az**: Azerbaijani (Latin) \
4145
+ * **bfy**: Bagheli \
4146
+ * **eu**: Basque \
4147
+ * **be**: Belarusian (Cyrillic and Latin) \
4148
+ * **be-cyrl**: Belarusian (Cyrillic) \
4149
+ * **be-latn**: Belarusian (Latin) \
4150
+ * **bho**: Bhojpuri-Hindi (Devanagiri) \
4151
+ * **bi**: Bislama \
4152
+ * **brx**: Bodo (Devanagiri) \
4153
+ * **bs**: Bosnian Latin \
4154
+ * **bra**: Brajbha \
4155
+ * **br**: Breton \
4156
+ * **bg**: Bulgarian \
4157
+ * **bns**: Bundeli \
4158
+ * **bua**: Buryat (Cyrillic) \
4159
+ * **ca**: Catalan \
4160
+ * **ceb**: Cebuano \
4161
+ * **rab**: Chamling \
4162
+ * **ch**: Chamorro \
4163
+ * **hne**: Chhattisgarhi (Devanagiri) \
4164
+ * **zh-Hans**: Chinese Simplified \
4165
+ * **zh-Hant**: Chinese Traditional \
4166
+ * **kw**: Cornish \
4167
+ * **co**: Corsican \
4168
+ * **crh**: Crimean Tatar (Latin) \
4169
+ * **hr**: Croatian \
3155
4170
  * **cs**: Czech \
3156
4171
  * **da**: Danish \
4172
+ * **prs**: Dari \
4173
+ * **dhi**: Dhimal (Devanagiri) \
4174
+ * **doi**: Dogri (Devanagiri) \
3157
4175
  * **nl**: Dutch \
3158
4176
  * **en**: English \
4177
+ * **myv**: Erzya (Cyrillic) \
4178
+ * **et**: Estonian \
4179
+ * **fo**: Faroese \
4180
+ * **fj**: Fijian \
4181
+ * **fil**: Filipino \
3159
4182
  * **fi**: Finnish \
3160
4183
  * **fr**: French \
4184
+ * **fur**: Frulian \
4185
+ * **gag**: Gagauz (Latin) \
4186
+ * **gl**: Galician \
3161
4187
  * **de**: German \
4188
+ * **gil**: Gilbertese \
4189
+ * **gon**: Gondi (Devanagiri) \
3162
4190
  * **el**: Greek \
4191
+ * **kl**: Greenlandic \
4192
+ * **gvr**: Gurung (Devanagiri) \
4193
+ * **ht**: Haitian Creole \
4194
+ * **hlb**: Halbi (Devanagiri) \
4195
+ * **hni**: Hani \
4196
+ * **bgc**: Haryanvi \
4197
+ * **haw**: Hawaiian \
4198
+ * **hi**: Hindi \
4199
+ * **mww**: Hmong Daw (Latin) \
4200
+ * **hoc**: Ho (Devanagiri) \
3163
4201
  * **hu**: Hungarian \
4202
+ * **is**: Icelandic \
4203
+ * **smn**: Inari Sami \
4204
+ * **id**: Indonesian \
4205
+ * **ia**: Interlingua \
4206
+ * **iu**: Inuktitut (Latin) \
4207
+ * **ga**: Irish \
3164
4208
  * **it**: Italian \
3165
4209
  * **ja**: Japanese \
4210
+ * **Jns**: Jaunsari (Devanagiri) \
4211
+ * **jv**: Javanese \
4212
+ * **kea**: Kabuverdianu \
4213
+ * **kac**: Kachin (Latin) \
4214
+ * **xnr**: Kangri (Devanagiri) \
4215
+ * **krc**: Karachay-Balkar \
4216
+ * **kaa-cyrl**: Kara-Kalpak (Cyrillic) \
4217
+ * **kaa**: Kara-Kalpak (Latin) \
4218
+ * **csb**: Kashubian \
4219
+ * **kk-cyrl**: Kazakh (Cyrillic) \
4220
+ * **kk-latn**: Kazakh (Latin) \
4221
+ * **klr**: Khaling \
4222
+ * **kha**: Khasi \
4223
+ * **quc**: K'iche' \
3166
4224
  * **ko**: Korean \
3167
- * **nb**: Norwegian (Bokmaal) \
4225
+ * **kfq**: Korku \
4226
+ * **kpy**: Koryak \
4227
+ * **kos**: Kosraean \
4228
+ * **kum**: Kumyk (Cyrillic) \
4229
+ * **ku-arab**: Kurdish (Arabic) \
4230
+ * **ku-latn**: Kurdish (Latin) \
4231
+ * **kru**: Kurukh (Devanagiri) \
4232
+ * **ky**: Kyrgyz (Cyrillic) \
4233
+ * **lkt**: Lakota \
4234
+ * **la**: Latin \
4235
+ * **lt**: Lithuanian \
4236
+ * **dsb**: Lower Sorbian \
4237
+ * **smj**: Lule Sami \
4238
+ * **lb**: Luxembourgish \
4239
+ * **bfz**: Mahasu Pahari (Devanagiri) \
4240
+ * **ms**: Malay (Latin) \
4241
+ * **mt**: Maltese \
4242
+ * **kmj**: Malto (Devanagiri) \
4243
+ * **gv**: Manx \
4244
+ * **mi**: Maori \
4245
+ * **mr**: Marathi \
4246
+ * **mn**: Mongolian (Cyrillic) \
4247
+ * **cnr-cyrl**: Montenegrin (Cyrillic) \
4248
+ * **cnr-latn**: Montenegrin (Latin) \
4249
+ * **nap**: Neapolitan \
4250
+ * **ne**: Nepali \
4251
+ * **niu**: Niuean \
4252
+ * **nog**: Nogay \
4253
+ * **sme**: Northern Sami (Latin) \
4254
+ * **nb**: Norwegian \
4255
+ * **no**: Norwegian \
4256
+ * **oc**: Occitan \
4257
+ * **os**: Ossetic \
4258
+ * **ps**: Pashto \
4259
+ * **fa**: Persian \
3168
4260
  * **pl**: Polish \
3169
4261
  * **pt**: Portuguese \
4262
+ * **pa**: Punjabi (Arabic) \
4263
+ * **ksh**: Ripuarian \
4264
+ * **ro**: Romanian \
4265
+ * **rm**: Romansh \
3170
4266
  * **ru**: Russian \
4267
+ * **sck**: Sadri (Devanagiri) \
4268
+ * **sm**: Samoan (Latin) \
4269
+ * **sa**: Sanskrit (Devanagiri) \
4270
+ * **sat**: Santali (Devanagiri) \
4271
+ * **sco**: Scots \
4272
+ * **gd**: Scottish Gaelic \
4273
+ * **sr**: Serbian (Latin) \
4274
+ * **sr-Cyrl**: Serbian (Cyrillic) \
4275
+ * **sr-Latn**: Serbian (Latin) \
4276
+ * **xsr**: Sherpa (Devanagiri) \
4277
+ * **srx**: Sirmauri (Devanagiri) \
4278
+ * **sms**: Skolt Sami \
4279
+ * **sk**: Slovak \
4280
+ * **sl**: Slovenian \
4281
+ * **so**: Somali (Arabic) \
4282
+ * **sma**: Southern Sami \
3171
4283
  * **es**: Spanish \
4284
+ * **sw**: Swahili (Latin) \
3172
4285
  * **sv**: Swedish \
4286
+ * **tg**: Tajik (Cyrillic) \
4287
+ * **tt**: Tatar (Latin) \
4288
+ * **tet**: Tetum \
4289
+ * **thf**: Thangmi \
4290
+ * **to**: Tongan \
3173
4291
  * **tr**: Turkish \
3174
- * **ar**: Arabic \
3175
- * **ro**: Romanian \
3176
- * **sr-Cyrl**: Serbian (Cyrillic, Serbia) \
3177
- * **sr-Latn**: Serbian (Latin, Serbia) \
3178
- * **sk**: Slovak
4292
+ * **tk**: Turkmen (Latin) \
4293
+ * **tyv**: Tuvan \
4294
+ * **hsb**: Upper Sorbian \
4295
+ * **ur**: Urdu \
4296
+ * **ug**: Uyghur (Arabic) \
4297
+ * **uz-arab**: Uzbek (Arabic) \
4298
+ * **uz-cyrl**: Uzbek (Cyrillic) \
4299
+ * **uz**: Uzbek (Latin) \
4300
+ * **vo**: Volapük \
4301
+ * **wae**: Walser \
4302
+ * **cy**: Welsh \
4303
+ * **fy**: Western Frisian \
4304
+ * **yua**: Yucatec Maya \
4305
+ * **za**: Zhuang \
4306
+ * **zu**: Zulu \
4307
+ * **unk**: Unknown (All)
3179
4308
  */
3180
4309
  export declare type OcrSkillLanguage = string;
3181
4310
 
@@ -3327,14 +4456,164 @@ export declare type PhoneticTokenFilter = BaseTokenFilter & {
3327
4456
  replaceOriginalTokens?: boolean;
3328
4457
  };
3329
4458
 
4459
+ /** Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it. */
4460
+ export declare type PIIDetectionSkill = BaseSearchIndexerSkill & {
4461
+ /** Polymorphic discriminator, which specifies the different types this object can be */
4462
+ odatatype: "#Microsoft.Skills.Text.PIIDetectionSkill";
4463
+ /** A value indicating which language code to use. Default is en. */
4464
+ defaultLanguageCode?: string;
4465
+ /** A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included. */
4466
+ minimumPrecision?: number;
4467
+ /** A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'. */
4468
+ maskingMode?: PIIDetectionSkillMaskingMode;
4469
+ /** The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'. */
4470
+ maskingCharacter?: string;
4471
+ /** The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary. */
4472
+ modelVersion?: string;
4473
+ /** A list of PII entity categories that should be extracted and masked. */
4474
+ piiCategories?: string[];
4475
+ /** If specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'phi', 'none'. Default is 'none'. */
4476
+ domain?: string;
4477
+ };
4478
+
4479
+ /**
4480
+ * Defines values for PIIDetectionSkillMaskingMode. \
4481
+ * {@link KnownPIIDetectionSkillMaskingMode} can be used interchangeably with PIIDetectionSkillMaskingMode,
4482
+ * this enum contains the known values that the service supports.
4483
+ * ### Known values supported by the service
4484
+ * **none**: No masking occurs and the maskedText output will not be returned. \
4485
+ * **replace**: 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.
4486
+ */
4487
+ export declare type PIIDetectionSkillMaskingMode = string;
4488
+
4489
+ /** Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers. */
4490
+ export declare interface PrioritizedFields {
4491
+ /** 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. */
4492
+ titleField?: SemanticField;
4493
+ /** 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. */
4494
+ prioritizedContentFields?: SemanticField[];
4495
+ /** 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. */
4496
+ prioritizedKeywordsFields?: SemanticField[];
4497
+ }
4498
+
4499
+ /**
4500
+ * Defines values for QueryAnswerType. \
4501
+ * {@link KnownQueryAnswerType} can be used interchangeably with QueryAnswerType,
4502
+ * this enum contains the known values that the service supports.
4503
+ * ### Known values supported by the service
4504
+ * **none**: Do not return answers for the query. \
4505
+ * **extractive**: Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language.
4506
+ */
4507
+ export declare type QueryAnswerType = string;
4508
+
4509
+ /**
4510
+ * Defines values for QueryCaptionType. \
4511
+ * {@link KnownQueryCaptionType} can be used interchangeably with QueryCaptionType,
4512
+ * this enum contains the known values that the service supports.
4513
+ * ### Known values supported by the service
4514
+ * **none**: Do not return captions for the query. \
4515
+ * **extractive**: Extracts captions from the matching documents that contain passages relevant to the search query.
4516
+ */
4517
+ export declare type QueryCaptionType = string;
4518
+
4519
+ /**
4520
+ * Defines values for QueryLanguage. \
4521
+ * {@link KnownQueryLanguage} can be used interchangeably with QueryLanguage,
4522
+ * this enum contains the known values that the service supports.
4523
+ * ### Known values supported by the service
4524
+ * **none**: Query language not specified. \
4525
+ * **en-us**: Query language value for English (United States). \
4526
+ * **en-gb**: Query language value for English (Great Britain). \
4527
+ * **en-in**: Query language value for English (India). \
4528
+ * **en-ca**: Query language value for English (Canada). \
4529
+ * **en-au**: Query language value for English (Australia). \
4530
+ * **fr-fr**: Query language value for French (France). \
4531
+ * **fr-ca**: Query language value for French (Canada). \
4532
+ * **de-de**: Query language value for German (Germany). \
4533
+ * **es-es**: Query language value for Spanish (Spain). \
4534
+ * **es-mx**: Query language value for Spanish (Mexico). \
4535
+ * **zh-cn**: Query language value for Chinese (China). \
4536
+ * **zh-tw**: Query language value for Chinese (Taiwan). \
4537
+ * **pt-br**: Query language value for Portuguese (Brazil). \
4538
+ * **pt-pt**: Query language value for Portuguese (Portugal). \
4539
+ * **it-it**: Query language value for Italian (Italy). \
4540
+ * **ja-jp**: Query language value for Japanese (Japan). \
4541
+ * **ko-kr**: Query language value for Korean (Korea). \
4542
+ * **ru-ru**: Query language value for Russian (Russia). \
4543
+ * **cs-cz**: Query language value for Czech (Czech Republic). \
4544
+ * **nl-be**: Query language value for Dutch (Belgium). \
4545
+ * **nl-nl**: Query language value for Dutch (Netherlands). \
4546
+ * **hu-hu**: Query language value for Hungarian (Hungary). \
4547
+ * **pl-pl**: Query language value for Polish (Poland). \
4548
+ * **sv-se**: Query language value for Swedish (Sweden). \
4549
+ * **tr-tr**: Query language value for Turkish (Turkey). \
4550
+ * **hi-in**: Query language value for Hindi (India). \
4551
+ * **ar-sa**: Query language value for Arabic (Saudi Arabia). \
4552
+ * **ar-eg**: Query language value for Arabic (Egypt). \
4553
+ * **ar-ma**: Query language value for Arabic (Morocco). \
4554
+ * **ar-kw**: Query language value for Arabic (Kuwait). \
4555
+ * **ar-jo**: Query language value for Arabic (Jordan). \
4556
+ * **da-dk**: Query language value for Danish (Denmark). \
4557
+ * **no-no**: Query language value for Norwegian (Norway). \
4558
+ * **bg-bg**: Query language value for Bulgarian (Bulgaria). \
4559
+ * **hr-hr**: Query language value for Croatian (Croatia). \
4560
+ * **hr-ba**: Query language value for Croatian (Bosnia and Herzegovina). \
4561
+ * **ms-my**: Query language value for Malay (Malaysia). \
4562
+ * **ms-bn**: Query language value for Malay (Brunei Darussalam). \
4563
+ * **sl-sl**: Query language value for Slovenian (Slovenia). \
4564
+ * **ta-in**: Query language value for Tamil (India). \
4565
+ * **vi-vn**: Query language value for Vietnamese (Viet Nam). \
4566
+ * **el-gr**: Query language value for Greek (Greece). \
4567
+ * **ro-ro**: Query language value for Romanian (Romania). \
4568
+ * **is-is**: Query language value for Icelandic (Iceland). \
4569
+ * **id-id**: Query language value for Indonesian (Indonesia). \
4570
+ * **th-th**: Query language value for Thai (Thailand). \
4571
+ * **lt-lt**: Query language value for Lithuanian (Lithuania). \
4572
+ * **uk-ua**: Query language value for Ukrainian (Ukraine). \
4573
+ * **lv-lv**: Query language value for Latvian (Latvia). \
4574
+ * **et-ee**: Query language value for Estonian (Estonia). \
4575
+ * **ca-es**: Query language value for Catalan (Spain). \
4576
+ * **fi-fi**: Query language value for Finnish (Finland). \
4577
+ * **sr-ba**: Query language value for Serbian (Bosnia and Herzegovina). \
4578
+ * **sr-me**: Query language value for Serbian (Montenegro). \
4579
+ * **sr-rs**: Query language value for Serbian (Serbia). \
4580
+ * **sk-sk**: Query language value for Slovak (Slovakia). \
4581
+ * **nb-no**: Query language value for Norwegian (Norway). \
4582
+ * **hy-am**: Query language value for Armenian (Armenia). \
4583
+ * **bn-in**: Query language value for Bengali (India). \
4584
+ * **eu-es**: Query language value for Basque (Spain). \
4585
+ * **gl-es**: Query language value for Galician (Spain). \
4586
+ * **gu-in**: Query language value for Gujarati (India). \
4587
+ * **he-il**: Query language value for Hebrew (Israel). \
4588
+ * **ga-ie**: Query language value for Irish (Ireland). \
4589
+ * **kn-in**: Query language value for Kannada (India). \
4590
+ * **ml-in**: Query language value for Malayalam (India). \
4591
+ * **mr-in**: Query language value for Marathi (India). \
4592
+ * **fa-ae**: Query language value for Persian (U.A.E.). \
4593
+ * **pa-in**: Query language value for Punjabi (India). \
4594
+ * **te-in**: Query language value for Telugu (India). \
4595
+ * **ur-pk**: Query language value for Urdu (Pakistan).
4596
+ */
4597
+ export declare type QueryLanguage = string;
4598
+
4599
+ /**
4600
+ * Defines values for QuerySpellerType. \
4601
+ * {@link KnownQuerySpellerType} can be used interchangeably with QuerySpellerType,
4602
+ * this enum contains the known values that the service supports.
4603
+ * ### Known values supported by the service
4604
+ * **none**: Speller not enabled. \
4605
+ * **lexicon**: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter.
4606
+ */
4607
+ export declare type QuerySpellerType = string;
4608
+
3330
4609
  /** Defines values for QueryType. */
3331
- export declare type QueryType = "simple" | "full";
4610
+ export declare type QueryType = "simple" | "full" | "semantic";
3332
4611
 
3333
4612
  /**
3334
4613
  * Defines values for RegexFlags. \
3335
4614
  * {@link KnownRegexFlags} can be used interchangeably with RegexFlags,
3336
4615
  * this enum contains the known values that the service supports.
3337
- * ### Know values supported by the service
4616
+ * ### Known values supported by the service
3338
4617
  * **CANON_EQ**: Enables canonical equivalence. \
3339
4618
  * **CASE_INSENSITIVE**: Enables case-insensitive matching. \
3340
4619
  * **COMMENTS**: Permits whitespace and comments in the pattern. \
@@ -3346,17 +4625,37 @@ export declare type QueryType = "simple" | "full";
3346
4625
  */
3347
4626
  export declare type RegexFlags = string;
3348
4627
 
4628
+ /**
4629
+ * Options for reset docs operation.
4630
+ */
4631
+ export declare interface ResetDocumentsOptions extends OperationOptions {
4632
+ /** document keys to be reset */
4633
+ documentKeys?: string[];
4634
+ /** datasource document identifiers to be reset */
4635
+ datasourceDocumentIds?: string[];
4636
+ /** 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. */
4637
+ overwrite?: boolean;
4638
+ }
4639
+
3349
4640
  /**
3350
4641
  * Options for reset indexer operation.
3351
4642
  */
3352
4643
  export declare type ResetIndexerOptions = OperationOptions;
3353
4644
 
4645
+ /**
4646
+ * Options for reset skills operation.
4647
+ */
4648
+ export declare interface ResetSkillsOptions extends OperationOptions {
4649
+ /** the names of skills to be reset. */
4650
+ skillNames?: string[];
4651
+ }
4652
+
3354
4653
  /** Represents a resource's usage and quota. */
3355
4654
  export declare interface ResourceCounter {
3356
4655
  /** The resource usage amount. */
3357
4656
  usage: number;
3358
4657
  /** The resource amount quota. */
3359
- quota?: number | null;
4658
+ quota?: number;
3360
4659
  }
3361
4660
 
3362
4661
  /**
@@ -3402,14 +4701,29 @@ export declare interface ScoringProfile {
3402
4701
  /** Defines values for ScoringStatistics. */
3403
4702
  export declare type ScoringStatistics = "local" | "global";
3404
4703
 
4704
+ /** Represents an index alias, which describes a mapping from the alias name to an index. The alias name can be used in place of the index name for supported operations. */
4705
+ export declare interface SearchAlias {
4706
+ /** The name of the alias. */
4707
+ name: string;
4708
+ /** The name of the index this alias maps to. Only one index name may be specified. */
4709
+ indexes: string[];
4710
+ /** The ETag of the alias. */
4711
+ etag?: string;
4712
+ }
4713
+
3405
4714
  /**
3406
4715
  * Class used to perform operations against a search index,
3407
4716
  * including querying documents in the index as well as
3408
4717
  * adding, updating, and removing them.
3409
4718
  */
3410
- export declare class SearchClient<T> implements IndexDocumentsClient<T> {
4719
+ export declare class SearchClient<Model extends object> implements IndexDocumentsClient<Model> {
4720
+ /**
4721
+ * The service version to use when communicating with the service.
4722
+ */
4723
+ readonly serviceVersion: string;
3411
4724
  /**
3412
4725
  * The API version to use when communicating with the service.
4726
+ * @deprecated use {@Link serviceVersion} instead
3413
4727
  */
3414
4728
  readonly apiVersion: string;
3415
4729
  /**
@@ -3431,13 +4745,32 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
3431
4745
  * const client = new SearchClient(
3432
4746
  * "<endpoint>",
3433
4747
  * "<indexName>",
3434
- * new AzureKeyCredential("<Admin Key>");
4748
+ * new AzureKeyCredential("<Admin Key>")
4749
+ * );
4750
+ * ```
4751
+ *
4752
+ * Optionally, the type of the model can be used to enable strong typing and type hints:
4753
+ * ```ts
4754
+ * type Model = {
4755
+ * keyName: string;
4756
+ * field1?: string | null;
4757
+ * field2?: { anotherField?: string | null } | null;
4758
+ * };
4759
+ *
4760
+ * const client = new SearchClient<Model>(
4761
+ * ...
3435
4762
  * );
3436
4763
  * ```
4764
+ *
3437
4765
  * @param endpoint - The endpoint of the search service
3438
4766
  * @param indexName - The name of the index
3439
4767
  * @param credential - Used to authenticate requests to the service.
3440
4768
  * @param options - Used to configure the Search client.
4769
+ *
4770
+ * @typeParam Model - An optional type that represents the documents stored in
4771
+ * the search index. For the best typing experience, all non-key fields should
4772
+ * be marked optional and nullable, and the key property should have the
4773
+ * non-nullable type `string`.
3441
4774
  */
3442
4775
  constructor(endpoint: string, indexName: string, credential: KeyCredential | TokenCredential, options?: SearchClientOptions);
3443
4776
  /**
@@ -3451,8 +4784,35 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
3451
4784
  * @param searchText - The search text on which to base autocomplete results.
3452
4785
  * @param suggesterName - The name of the suggester as specified in the suggesters collection that's part of the index definition.
3453
4786
  * @param options - Options to the autocomplete operation.
4787
+ * @example
4788
+ * ```ts
4789
+ * import {
4790
+ * AzureKeyCredential,
4791
+ * SearchClient,
4792
+ * SelectFields,
4793
+ * } from "@azure/search-documents";
4794
+ *
4795
+ * type Model = {
4796
+ * key: string;
4797
+ * azure?: { sdk: string | null } | null;
4798
+ * };
4799
+ *
4800
+ * const client = new SearchClient<Model>(
4801
+ * "endpoint.azure",
4802
+ * "indexName",
4803
+ * new AzureKeyCredential("key")
4804
+ * );
4805
+ *
4806
+ * const searchFields: SelectFields<Model>[] = ["azure/sdk"];
4807
+ *
4808
+ * const autocompleteResult = await client.autocomplete(
4809
+ * "searchText",
4810
+ * "suggesterName",
4811
+ * { searchFields }
4812
+ * );
4813
+ * ```
3454
4814
  */
3455
- autocomplete<Fields extends keyof T>(searchText: string, suggesterName: string, options?: AutocompleteOptions<Fields>): Promise<AutocompleteResult>;
4815
+ autocomplete(searchText: string, suggesterName: string, options?: AutocompleteOptions<Model>): Promise<AutocompleteResult>;
3456
4816
  private searchDocuments;
3457
4817
  private listSearchResultsPage;
3458
4818
  private listSearchResultsAll;
@@ -3462,22 +4822,76 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
3462
4822
  * the specified arguments.
3463
4823
  * @param searchText - Text to search
3464
4824
  * @param options - Options for the search operation.
4825
+ * @example
4826
+ * ```ts
4827
+ * import {
4828
+ * AzureKeyCredential,
4829
+ * SearchClient,
4830
+ * SelectFields,
4831
+ * } from "@azure/search-documents";
4832
+ *
4833
+ * type Model = {
4834
+ * key: string;
4835
+ * azure?: { sdk: string | null } | null;
4836
+ * };
4837
+ *
4838
+ * const client = new SearchClient<Model>(
4839
+ * "endpoint.azure",
4840
+ * "indexName",
4841
+ * new AzureKeyCredential("key")
4842
+ * );
4843
+ *
4844
+ * const select = ["azure/sdk"] as const;
4845
+ * const searchFields: SelectFields<Model>[] = ["azure/sdk"];
4846
+ *
4847
+ * const searchResult = await client.search("searchText", {
4848
+ * select,
4849
+ * searchFields,
4850
+ * });
4851
+ * ```
3465
4852
  */
3466
- search<Fields extends keyof T>(searchText?: string, options?: SearchOptions<Fields>): Promise<SearchDocumentsResult<Pick<T, Fields>>>;
4853
+ search<Fields extends SelectFields<Model>>(searchText?: string, options?: SearchOptions<Model, Fields>): Promise<SearchDocumentsResult<Model, Fields>>;
3467
4854
  /**
3468
4855
  * Returns a short list of suggestions based on the searchText
3469
4856
  * and specified suggester.
3470
4857
  * @param searchText - The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.
3471
4858
  * @param suggesterName - The name of the suggester as specified in the suggesters collection that's part of the index definition.
3472
4859
  * @param options - Options for the suggest operation
4860
+ * @example
4861
+ * ```ts
4862
+ * import {
4863
+ * AzureKeyCredential,
4864
+ * SearchClient,
4865
+ * SelectFields,
4866
+ * } from "@azure/search-documents";
4867
+ *
4868
+ * type Model = {
4869
+ * key: string;
4870
+ * azure?: { sdk: string | null } | null;
4871
+ * };
4872
+ *
4873
+ * const client = new SearchClient<Model>(
4874
+ * "endpoint.azure",
4875
+ * "indexName",
4876
+ * new AzureKeyCredential("key")
4877
+ * );
4878
+ *
4879
+ * const select = ["azure/sdk"] as const;
4880
+ * const searchFields: SelectFields<Model>[] = ["azure/sdk"];
4881
+ *
4882
+ * const suggestResult = await client.suggest("searchText", "suggesterName", {
4883
+ * select,
4884
+ * searchFields,
4885
+ * });
4886
+ * ```
3473
4887
  */
3474
- suggest<Fields extends keyof T = never>(searchText: string, suggesterName: string, options?: SuggestOptions<Fields>): Promise<SuggestDocumentsResult<Pick<T, Fields>>>;
4888
+ suggest<Fields extends SelectFields<Model> = never>(searchText: string, suggesterName: string, options?: SuggestOptions<Model, Fields>): Promise<SuggestDocumentsResult<Model, Fields>>;
3475
4889
  /**
3476
4890
  * Retrieve a particular document from the index by key.
3477
4891
  * @param key - The primary key value of the document
3478
4892
  * @param options - Additional options
3479
4893
  */
3480
- getDocument<Fields extends keyof T>(key: string, options?: GetDocumentOptions<Fields>): Promise<T>;
4894
+ getDocument<Fields extends SelectFields<Model>>(key: string, options?: GetDocumentOptions<Model, Fields>): Promise<NarrowedModel<Model, Fields>>;
3481
4895
  /**
3482
4896
  * Perform a set of index modifications (upload, merge, mergeOrUpload, delete)
3483
4897
  * for the given set of documents.
@@ -3488,56 +4902,62 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
3488
4902
  * @param batch - An array of actions to perform on the index.
3489
4903
  * @param options - Additional options.
3490
4904
  */
3491
- indexDocuments(batch: IndexDocumentsBatch<T>, options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>;
4905
+ indexDocuments(batch: IndexDocumentsBatch<Model>, options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>;
3492
4906
  /**
3493
4907
  * Upload an array of documents to the index.
3494
4908
  * @param documents - The documents to upload.
3495
4909
  * @param options - Additional options.
3496
4910
  */
3497
- uploadDocuments(documents: T[], options?: UploadDocumentsOptions): Promise<IndexDocumentsResult>;
4911
+ uploadDocuments(documents: Model[], options?: UploadDocumentsOptions): Promise<IndexDocumentsResult>;
3498
4912
  /**
3499
4913
  * Update a set of documents in the index.
3500
4914
  * For more details about how merging works, see https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
3501
4915
  * @param documents - The updated documents.
3502
4916
  * @param options - Additional options.
3503
4917
  */
3504
- mergeDocuments(documents: T[], options?: MergeDocumentsOptions): Promise<IndexDocumentsResult>;
4918
+ mergeDocuments(documents: Model[], options?: MergeDocumentsOptions): Promise<IndexDocumentsResult>;
3505
4919
  /**
3506
4920
  * Update a set of documents in the index or upload them if they don't exist.
3507
4921
  * For more details about how merging works, see https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
3508
4922
  * @param documents - The updated documents.
3509
4923
  * @param options - Additional options.
3510
4924
  */
3511
- mergeOrUploadDocuments(documents: T[], options?: MergeOrUploadDocumentsOptions): Promise<IndexDocumentsResult>;
4925
+ mergeOrUploadDocuments(documents: Model[], options?: MergeOrUploadDocumentsOptions): Promise<IndexDocumentsResult>;
3512
4926
  /**
3513
4927
  * Delete a set of documents.
3514
4928
  * @param documents - Documents to be deleted.
3515
4929
  * @param options - Additional options.
3516
4930
  */
3517
- deleteDocuments(documents: T[], options?: DeleteDocumentsOptions): Promise<IndexDocumentsResult>;
4931
+ deleteDocuments(documents: Model[], options?: DeleteDocumentsOptions): Promise<IndexDocumentsResult>;
3518
4932
  /**
3519
4933
  * Delete a set of documents.
3520
4934
  * @param keyName - The name of their primary key in the index.
3521
4935
  * @param keyValues - The primary key values of documents to delete.
3522
4936
  * @param options - Additional options.
3523
4937
  */
3524
- deleteDocuments(keyName: keyof T, keyValues: string[], options?: DeleteDocumentsOptions): Promise<IndexDocumentsResult>;
4938
+ deleteDocuments(keyName: keyof Model, keyValues: string[], options?: DeleteDocumentsOptions): Promise<IndexDocumentsResult>;
3525
4939
  private encodeContinuationToken;
3526
4940
  private decodeContinuationToken;
3527
4941
  private extractOperationOptions;
3528
4942
  private convertSelect;
3529
4943
  private convertSearchFields;
4944
+ private convertSemanticFields;
3530
4945
  private convertOrderBy;
3531
4946
  }
3532
4947
 
3533
4948
  /**
3534
4949
  * Client options used to configure Cognitive Search API requests.
3535
4950
  */
3536
- export declare interface SearchClientOptions extends PipelineOptions {
4951
+ export declare interface SearchClientOptions extends ExtendedCommonClientOptions {
3537
4952
  /**
3538
4953
  * The API version to use when communicating with the service.
4954
+ * @deprecated use {@link serviceVersion} instead
3539
4955
  */
3540
4956
  apiVersion?: string;
4957
+ /**
4958
+ * The service version to use when communicating with the service.
4959
+ */
4960
+ serviceVersion?: string;
3541
4961
  /**
3542
4962
  * The Audience to use for authentication with Azure Active Directory (AAD). The
3543
4963
  * audience is not considered when using a shared key.
@@ -3549,12 +4969,12 @@ export declare interface SearchClientOptions extends PipelineOptions {
3549
4969
  /**
3550
4970
  * Response containing search page results from an index.
3551
4971
  */
3552
- export declare interface SearchDocumentsPageResult<T> extends SearchDocumentsResultBase {
4972
+ export declare interface SearchDocumentsPageResult<Model extends object, Fields extends SelectFields<Model> = SelectFields<Model>> extends SearchDocumentsResultBase {
3553
4973
  /**
3554
4974
  * The sequence of results returned by the query.
3555
4975
  * **NOTE: This property will not be serialized. It can only be populated by the server.**
3556
4976
  */
3557
- readonly results: SearchResult<T>[];
4977
+ readonly results: SearchResult<Model, Fields>[];
3558
4978
  /**
3559
4979
  * A token used for retrieving the next page of results when the server
3560
4980
  * enforces pagination.
@@ -3565,12 +4985,12 @@ export declare interface SearchDocumentsPageResult<T> extends SearchDocumentsRes
3565
4985
  /**
3566
4986
  * Response containing search results from an index.
3567
4987
  */
3568
- export declare interface SearchDocumentsResult<T> extends SearchDocumentsResultBase {
4988
+ export declare interface SearchDocumentsResult<Model extends object, Fields extends SelectFields<Model> = SelectFields<Model>> extends SearchDocumentsResultBase {
3569
4989
  /**
3570
4990
  * The sequence of results returned by the query.
3571
4991
  * **NOTE: This property will not be serialized. It can only be populated by the server.**
3572
4992
  */
3573
- readonly results: SearchIterator<T>;
4993
+ readonly results: SearchIterator<Model, Fields>;
3574
4994
  }
3575
4995
 
3576
4996
  /**
@@ -3599,6 +5019,12 @@ export declare interface SearchDocumentsResultBase {
3599
5019
  readonly facets?: {
3600
5020
  [propertyName: string]: FacetResult[];
3601
5021
  };
5022
+ /**
5023
+ * The answers query results for the search operation; null if the answers query parameter was
5024
+ * not specified or set to 'none'.
5025
+ * NOTE: This property will not be serialized. It can only be populated by the server.
5026
+ */
5027
+ readonly answers?: AnswerResult[];
3602
5028
  }
3603
5029
 
3604
5030
  /**
@@ -3643,7 +5069,7 @@ export declare interface SearchIndex {
3643
5069
  /**
3644
5070
  * Options to control Cross-Origin Resource Sharing (CORS) for the index.
3645
5071
  */
3646
- corsOptions?: CorsOptions | null;
5072
+ corsOptions?: CorsOptions;
3647
5073
  /**
3648
5074
  * The suggesters for the index.
3649
5075
  */
@@ -3664,6 +5090,10 @@ export declare interface SearchIndex {
3664
5090
  * The character filters for the index.
3665
5091
  */
3666
5092
  charFilters?: CharFilter[];
5093
+ /**
5094
+ * The normalizers for the index.
5095
+ */
5096
+ normalizers?: LexicalNormalizer[];
3667
5097
  /**
3668
5098
  * A description of an encryption key that you create in Azure Key Vault. This key is used to
3669
5099
  * provide an additional level of encryption-at-rest for your data when you want full assurance
@@ -3674,19 +5104,28 @@ export declare interface SearchIndex {
3674
5104
  * keys is not available for free search services, and is only available for paid services
3675
5105
  * created on or after January 1, 2019.
3676
5106
  */
3677
- encryptionKey?: SearchResourceEncryptionKey | null;
5107
+ encryptionKey?: SearchResourceEncryptionKey;
3678
5108
  /**
3679
5109
  * The type of similarity algorithm to be used when scoring and ranking the documents matching a
3680
5110
  * search query. The similarity algorithm can only be defined at index creation time and cannot
3681
5111
  * be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.
3682
5112
  */
3683
5113
  similarity?: SimilarityAlgorithm;
5114
+ /**
5115
+ * Defines parameters for a search index that influence semantic capabilities.
5116
+ */
5117
+ semanticSettings?: SemanticSettings;
3684
5118
  /**
3685
5119
  * The ETag of the index.
3686
5120
  */
3687
5121
  etag?: string;
3688
5122
  }
3689
5123
 
5124
+ /**
5125
+ * Search Alias object.
5126
+ */
5127
+ export declare type SearchIndexAlias = SearchAlias;
5128
+
3690
5129
  /**
3691
5130
  * Class to perform operations to manage
3692
5131
  * (create, update, list/delete)
@@ -3696,6 +5135,11 @@ export declare class SearchIndexClient {
3696
5135
  /**
3697
5136
  * The API version to use when communicating with the service.
3698
5137
  */
5138
+ readonly serviceVersion: string;
5139
+ /**
5140
+ * The API version to use when communicating with the service.
5141
+ * @deprecated use {@Link serviceVersion} instead
5142
+ */
3699
5143
  readonly apiVersion: string;
3700
5144
  /**
3701
5145
  * The endpoint of the search service
@@ -3734,6 +5178,13 @@ export declare class SearchIndexClient {
3734
5178
  * @param options - Options to the list index operation.
3735
5179
  */
3736
5180
  listIndexes(options?: ListIndexesOptions): IndexIterator;
5181
+ private listAliasesPage;
5182
+ private listAliasesAll;
5183
+ /**
5184
+ * Lists all aliases available for a search service.
5185
+ * @param options - The options parameters.
5186
+ */
5187
+ listAliases(options?: ListAliasesOptions): AliasIterator;
3737
5188
  private listIndexesNamesPage;
3738
5189
  private listIndexesNamesAll;
3739
5190
  /**
@@ -3799,6 +5250,31 @@ export declare class SearchIndexClient {
3799
5250
  * @param options - Additional optional arguments.
3800
5251
  */
3801
5252
  deleteSynonymMap(synonymMap: string | SynonymMap, options?: DeleteSynonymMapOptions): Promise<void>;
5253
+ /**
5254
+ * Creates a new search alias or updates an alias if it already exists.
5255
+ * @param alias - The definition of the alias to create or update.
5256
+ * @param options - The options parameters.
5257
+ */
5258
+ createOrUpdateAlias(alias: SearchIndexAlias, options?: CreateOrUpdateAliasOptions): Promise<SearchIndexAlias>;
5259
+ /**
5260
+ * Creates a new search alias.
5261
+ * @param alias - The definition of the alias to create.
5262
+ * @param options - The options parameters.
5263
+ */
5264
+ createAlias(alias: SearchIndexAlias, options?: CreateAliasOptions): Promise<SearchIndexAlias>;
5265
+ /**
5266
+ * Deletes a search alias and its associated mapping to an index. This operation is permanent, with no
5267
+ * recovery option. The mapped index is untouched by this operation.
5268
+ * @param alias - Alias/Name name of the alias to delete.
5269
+ * @param options - The options parameters.
5270
+ */
5271
+ deleteAlias(alias: string | SearchIndexAlias, options?: DeleteAliasOptions): Promise<void>;
5272
+ /**
5273
+ * Retrieves an alias definition.
5274
+ * @param aliasName - The name of the alias to retrieve.
5275
+ * @param options - The options parameters.
5276
+ */
5277
+ getAlias(aliasName: string, options?: GetAliasOptions): Promise<SearchIndexAlias>;
3802
5278
  /**
3803
5279
  * Retrieves statistics about an index, such as the count of documents and the size
3804
5280
  * of index storage.
@@ -3822,18 +5298,27 @@ export declare class SearchIndexClient {
3822
5298
  * Retrieves the SearchClient corresponding to this SearchIndexClient
3823
5299
  * @param indexName - Name of the index
3824
5300
  * @param options - SearchClient Options
5301
+ * @typeParam Model - An optional type that represents the documents stored in
5302
+ * the search index. For the best typing experience, all non-key fields should
5303
+ * be marked optional and nullable, and the key property should have the
5304
+ * non-nullable type `string`.
3825
5305
  */
3826
- getSearchClient<T>(indexName: string, options?: SearchClientOptions): SearchClient<T>;
5306
+ getSearchClient<Model extends object>(indexName: string, options?: SearchClientOptions): SearchClient<Model>;
3827
5307
  }
3828
5308
 
3829
5309
  /**
3830
5310
  * Client options used to configure Cognitive Search API requests.
3831
5311
  */
3832
- export declare interface SearchIndexClientOptions extends PipelineOptions {
5312
+ export declare interface SearchIndexClientOptions extends ExtendedCommonClientOptions {
3833
5313
  /**
3834
5314
  * The API version to use when communicating with the service.
5315
+ * @deprecated use {@Link serviceVersion} instead
3835
5316
  */
3836
5317
  apiVersion?: string;
5318
+ /**
5319
+ * The service version to use when communicating with the service.
5320
+ */
5321
+ serviceVersion?: string;
3837
5322
  /**
3838
5323
  * The Audience to use for authentication with Azure Active Directory (AAD). The
3839
5324
  * audience is not considered when using a shared key.
@@ -3869,11 +5354,11 @@ export declare interface SearchIndexer {
3869
5354
  /**
3870
5355
  * The schedule for this indexer.
3871
5356
  */
3872
- schedule?: IndexingSchedule | null;
5357
+ schedule?: IndexingSchedule;
3873
5358
  /**
3874
5359
  * Parameters for indexer execution.
3875
5360
  */
3876
- parameters?: IndexingParameters | null;
5361
+ parameters?: IndexingParameters;
3877
5362
  /**
3878
5363
  * Defines mappings between fields in the data source and corresponding target fields in the
3879
5364
  * index.
@@ -3886,7 +5371,7 @@ export declare interface SearchIndexer {
3886
5371
  /**
3887
5372
  * A value indicating whether the indexer is disabled. Default is false. Default value: false.
3888
5373
  */
3889
- isDisabled?: boolean | null;
5374
+ isDisabled?: boolean;
3890
5375
  /**
3891
5376
  * The ETag of the indexer.
3892
5377
  */
@@ -3902,7 +5387,19 @@ export declare interface SearchIndexer {
3902
5387
  * customer-managed keys is not available for free search services, and is only available for
3903
5388
  * paid services created on or after January 1, 2019.
3904
5389
  */
3905
- encryptionKey?: SearchResourceEncryptionKey | null;
5390
+ encryptionKey?: SearchResourceEncryptionKey;
5391
+ /**
5392
+ * Adds caching to an enrichment pipeline to allow for incremental modification steps without
5393
+ * having to rebuild the index every time.
5394
+ */
5395
+ cache?: SearchIndexerCache;
5396
+ }
5397
+
5398
+ export declare interface SearchIndexerCache {
5399
+ /** The connection string to the storage account where the cache data will be persisted. */
5400
+ storageConnectionString?: string;
5401
+ /** Specifies whether incremental reprocessing is enabled. */
5402
+ enableReprocessing?: boolean;
3906
5403
  }
3907
5404
 
3908
5405
  /**
@@ -3914,6 +5411,11 @@ export declare class SearchIndexerClient {
3914
5411
  /**
3915
5412
  * The API version to use when communicating with the service.
3916
5413
  */
5414
+ readonly serviceVersion: string;
5415
+ /**
5416
+ * The API version to use when communicating with the service.
5417
+ * @deprecated use {@Link serviceVersion} instead
5418
+ */
3917
5419
  readonly apiVersion: string;
3918
5420
  /**
3919
5421
  * The endpoint of the search service
@@ -4057,16 +5559,34 @@ export declare class SearchIndexerClient {
4057
5559
  * @param options - Additional optional arguments.
4058
5560
  */
4059
5561
  runIndexer(indexerName: string, options?: RunIndexerOptions): Promise<void>;
5562
+ /**
5563
+ * Resets specific documents in the datasource to be selectively re-ingested by the indexer.
5564
+ * @param indexerName - The name of the indexer to reset documents for.
5565
+ * @param options - Additional optional arguments.
5566
+ */
5567
+ resetDocuments(indexerName: string, options?: ResetDocumentsOptions): Promise<void>;
5568
+ /**
5569
+ * Reset an existing skillset in a search service.
5570
+ * @param skillsetName - The name of the skillset to reset.
5571
+ * @param skillNames - The names of skills to reset.
5572
+ * @param options - The options parameters.
5573
+ */
5574
+ resetSkills(skillsetName: string, options?: ResetSkillsOptions): Promise<void>;
4060
5575
  }
4061
5576
 
4062
5577
  /**
4063
5578
  * Client options used to configure Cognitive Search API requests.
4064
5579
  */
4065
- export declare interface SearchIndexerClientOptions extends PipelineOptions {
5580
+ export declare interface SearchIndexerClientOptions extends ExtendedCommonClientOptions {
4066
5581
  /**
4067
5582
  * The API version to use when communicating with the service.
5583
+ * @deprecated use {@Link serviceVersion} instead
4068
5584
  */
4069
5585
  apiVersion?: string;
5586
+ /**
5587
+ * The service version to use when communicating with the service.
5588
+ */
5589
+ serviceVersion?: string;
4070
5590
  /**
4071
5591
  * The Audience to use for authentication with Azure Active Directory (AAD). The
4072
5592
  * audience is not considered when using a shared key.
@@ -4083,6 +5603,17 @@ export declare interface SearchIndexerDataContainer {
4083
5603
  query?: string;
4084
5604
  }
4085
5605
 
5606
+ /**
5607
+ * Contains the possible cases for SearchIndexerDataIdentity.
5608
+ */
5609
+ export declare type SearchIndexerDataIdentity = SearchIndexerDataNoneIdentity | SearchIndexerDataUserAssignedIdentity;
5610
+
5611
+ /** Clears the identity property of a datasource. */
5612
+ export declare type SearchIndexerDataNoneIdentity = BaseSearchIndexerDataIdentity & {
5613
+ /** Polymorphic discriminator, which specifies the different types this object can be */
5614
+ odatatype: "#Microsoft.Azure.Search.DataNoneIdentity";
5615
+ };
5616
+
4086
5617
  /**
4087
5618
  * Represents a datasource definition, which can be used to configure an indexer.
4088
5619
  */
@@ -4108,14 +5639,20 @@ export declare interface SearchIndexerDataSourceConnection {
4108
5639
  * The data container for the datasource.
4109
5640
  */
4110
5641
  container: SearchIndexerDataContainer;
5642
+ /**
5643
+ * An explicit managed identity to use for this datasource. If not specified and the connection
5644
+ * string is a managed identity, the system-assigned managed identity is used. If not specified,
5645
+ * the value remains unchanged. If "none" is specified, the value of this property is cleared.
5646
+ */
5647
+ identity?: SearchIndexerDataIdentity;
4111
5648
  /**
4112
5649
  * The data change detection policy for the datasource.
4113
5650
  */
4114
- dataChangeDetectionPolicy?: DataChangeDetectionPolicy | null;
5651
+ dataChangeDetectionPolicy?: DataChangeDetectionPolicy;
4115
5652
  /**
4116
5653
  * The data deletion detection policy for the datasource.
4117
5654
  */
4118
- dataDeletionDetectionPolicy?: DataDeletionDetectionPolicy | null;
5655
+ dataDeletionDetectionPolicy?: DataDeletionDetectionPolicy;
4119
5656
  /**
4120
5657
  * The ETag of the DataSource.
4121
5658
  */
@@ -4131,14 +5668,14 @@ export declare interface SearchIndexerDataSourceConnection {
4131
5668
  * available for free search services, and is only available for paid services created on or
4132
5669
  * after January 1, 2019.
4133
5670
  */
4134
- encryptionKey?: SearchResourceEncryptionKey | null;
5671
+ encryptionKey?: SearchResourceEncryptionKey;
4135
5672
  }
4136
5673
 
4137
5674
  /**
4138
5675
  * Defines values for SearchIndexerDataSourceType. \
4139
5676
  * {@link KnownSearchIndexerDataSourceType} can be used interchangeably with SearchIndexerDataSourceType,
4140
5677
  * this enum contains the known values that the service supports.
4141
- * ### Know values supported by the service
5678
+ * ### Known values supported by the service
4142
5679
  * **azuresql**: Indicates an Azure SQL datasource. \
4143
5680
  * **cosmosdb**: Indicates a CosmosDB datasource. \
4144
5681
  * **azureblob**: Indicates an Azure Blob datasource. \
@@ -4148,6 +5685,14 @@ export declare interface SearchIndexerDataSourceConnection {
4148
5685
  */
4149
5686
  export declare type SearchIndexerDataSourceType = string;
4150
5687
 
5688
+ /** Specifies the identity for a datasource to use. */
5689
+ export declare type SearchIndexerDataUserAssignedIdentity = BaseSearchIndexerDataIdentity & {
5690
+ /** Polymorphic discriminator, which specifies the different types this object can be */
5691
+ odatatype: "#Microsoft.Azure.Search.DataUserAssignedIdentity";
5692
+ /** The fully qualified Azure resource Id of a user assigned managed identity typically in the form "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" that should have been assigned to the search service. */
5693
+ userAssignedIdentity: string;
5694
+ };
5695
+
4151
5696
  /** Represents an item- or document-level indexing error. */
4152
5697
  export declare interface SearchIndexerError {
4153
5698
  /**
@@ -4253,7 +5798,7 @@ export declare interface SearchIndexerLimits {
4253
5798
  /**
4254
5799
  * Contains the possible cases for Skill.
4255
5800
  */
4256
- export declare type SearchIndexerSkill = ConditionalSkill | KeyPhraseExtractionSkill | OcrSkill | ImageAnalysisSkill | LanguageDetectionSkill | ShaperSkill | MergeSkill | EntityRecognitionSkill | SentimentSkill | SplitSkill | CustomEntityLookupSkill | TextTranslationSkill | DocumentExtractionSkill | WebApiSkill;
5801
+ export declare type SearchIndexerSkill = ConditionalSkill | KeyPhraseExtractionSkill | OcrSkill | ImageAnalysisSkill | LanguageDetectionSkill | ShaperSkill | MergeSkill | EntityRecognitionSkill | SentimentSkill | SplitSkill | PIIDetectionSkill | EntityRecognitionSkillV3 | EntityLinkingSkill | SentimentSkillV3 | CustomEntityLookupSkill | TextTranslationSkill | DocumentExtractionSkill | WebApiSkill | AzureMachineLearningSkill;
4257
5802
 
4258
5803
  /**
4259
5804
  * A list of skills.
@@ -4293,7 +5838,7 @@ export declare interface SearchIndexerSkillset {
4293
5838
  * definition will be unaffected. Encryption with customer-managed keys is not available for free
4294
5839
  * search services, and is only available for paid services created on or after January 1, 2019.
4295
5840
  */
4296
- encryptionKey?: SearchResourceEncryptionKey | null;
5841
+ encryptionKey?: SearchResourceEncryptionKey;
4297
5842
  }
4298
5843
 
4299
5844
  /** Represents the current status and execution history of an indexer. */
@@ -4353,7 +5898,7 @@ export declare interface SearchIndexerWarning {
4353
5898
  * Class used to perform buffered operations against a search index,
4354
5899
  * including adding, updating, and removing them.
4355
5900
  */
4356
- export declare class SearchIndexingBufferedSender<T> {
5901
+ export declare class SearchIndexingBufferedSender<Model extends object> {
4357
5902
  /**
4358
5903
  * Search Client used to call the underlying IndexBatch operations.
4359
5904
  */
@@ -4405,35 +5950,35 @@ export declare class SearchIndexingBufferedSender<T> {
4405
5950
  * @param options - Options to modify auto flush.
4406
5951
  *
4407
5952
  */
4408
- constructor(client: IndexDocumentsClient<T>, documentKeyRetriever: (document: T) => string, options?: SearchIndexingBufferedSenderOptions);
5953
+ constructor(client: IndexDocumentsClient<Model>, documentKeyRetriever: (document: Model) => string, options?: SearchIndexingBufferedSenderOptions);
4409
5954
  /**
4410
5955
  * Uploads the documents/Adds the documents to the upload queue.
4411
5956
  *
4412
5957
  * @param documents - Documents to be uploaded.
4413
5958
  * @param options - Upload options.
4414
5959
  */
4415
- uploadDocuments(documents: T[], options?: SearchIndexingBufferedSenderUploadDocumentsOptions): Promise<void>;
5960
+ uploadDocuments(documents: Model[], options?: SearchIndexingBufferedSenderUploadDocumentsOptions): Promise<void>;
4416
5961
  /**
4417
5962
  * Merges the documents/Adds the documents to the merge queue.
4418
5963
  *
4419
5964
  * @param documents - Documents to be merged.
4420
5965
  * @param options - Upload options.
4421
5966
  */
4422
- mergeDocuments(documents: T[], options?: SearchIndexingBufferedSenderMergeDocumentsOptions): Promise<void>;
5967
+ mergeDocuments(documents: Model[], options?: SearchIndexingBufferedSenderMergeDocumentsOptions): Promise<void>;
4423
5968
  /**
4424
5969
  * Merges/Uploads the documents/Adds the documents to the merge/upload queue.
4425
5970
  *
4426
5971
  * @param documents - Documents to be merged/uploaded.
4427
5972
  * @param options - Upload options.
4428
5973
  */
4429
- mergeOrUploadDocuments(documents: T[], options?: SearchIndexingBufferedSenderMergeOrUploadDocumentsOptions): Promise<void>;
5974
+ mergeOrUploadDocuments(documents: Model[], options?: SearchIndexingBufferedSenderMergeOrUploadDocumentsOptions): Promise<void>;
4430
5975
  /**
4431
5976
  * Deletes the documents/Adds the documents to the delete queue.
4432
5977
  *
4433
5978
  * @param documents - Documents to be deleted.
4434
5979
  * @param options - Upload options.
4435
5980
  */
4436
- deleteDocuments(documents: T[], options?: SearchIndexingBufferedSenderDeleteDocumentsOptions): Promise<void>;
5981
+ deleteDocuments(documents: Model[], options?: SearchIndexingBufferedSenderDeleteDocumentsOptions): Promise<void>;
4437
5982
  /**
4438
5983
  * Flushes the queue manually.
4439
5984
  *
@@ -4452,7 +5997,7 @@ export declare class SearchIndexingBufferedSender<T> {
4452
5997
  */
4453
5998
  on(event: "batchAdded", listener: (e: {
4454
5999
  action: string;
4455
- documents: T[];
6000
+ documents: Model[];
4456
6001
  }) => void): void;
4457
6002
  /**
4458
6003
  * Attach Batch Sent Event
@@ -4460,7 +6005,7 @@ export declare class SearchIndexingBufferedSender<T> {
4460
6005
  * @param event - Event to be emitted
4461
6006
  * @param listener - Event Listener
4462
6007
  */
4463
- on(event: "beforeDocumentSent", listener: (e: IndexDocumentsAction<T>) => void): void;
6008
+ on(event: "beforeDocumentSent", listener: (e: IndexDocumentsAction<Model>) => void): void;
4464
6009
  /**
4465
6010
  * Attach Batch Succeeded Event
4466
6011
  *
@@ -4483,7 +6028,7 @@ export declare class SearchIndexingBufferedSender<T> {
4483
6028
  */
4484
6029
  off(event: "batchAdded", listener: (e: {
4485
6030
  action: string;
4486
- documents: T[];
6031
+ documents: Model[];
4487
6032
  }) => void): void;
4488
6033
  /**
4489
6034
  * Detach Batch Sent Event
@@ -4491,7 +6036,7 @@ export declare class SearchIndexingBufferedSender<T> {
4491
6036
  * @param event - Event to be emitted
4492
6037
  * @param listener - Event Listener
4493
6038
  */
4494
- off(event: "beforeDocumentSent", listener: (e: IndexDocumentsAction<T>) => void): void;
6039
+ off(event: "beforeDocumentSent", listener: (e: IndexDocumentsAction<Model>) => void): void;
4495
6040
  /**
4496
6041
  * Detach Batch Succeeded Event
4497
6042
  *
@@ -4596,7 +6141,7 @@ export declare interface SearchIndexStatistics {
4596
6141
  * as needed during iteration. Use .byPage() to make one request to the server
4597
6142
  * per iteration.
4598
6143
  */
4599
- export declare type SearchIterator<Fields> = PagedAsyncIterableIterator<SearchResult<Fields>, SearchDocumentsPageResult<Fields>, ListSearchResultsPageSettings>;
6144
+ export declare type SearchIterator<Model extends object, Fields extends SelectFields<Model> = SelectFields<Model>> = PagedAsyncIterableIterator<SearchResult<Model, Fields>, SearchDocumentsPageResult<Model, Fields>, ListSearchResultsPageSettings>;
4600
6145
 
4601
6146
  /** Defines values for SearchMode. */
4602
6147
  export declare type SearchMode = "any" | "all";
@@ -4604,7 +6149,21 @@ export declare type SearchMode = "any" | "all";
4604
6149
  /**
4605
6150
  * Options for committing a full search request.
4606
6151
  */
4607
- export declare type SearchOptions<Fields> = OperationOptions & SearchRequestOptions<Fields>;
6152
+ export declare type SearchOptions<Model extends object, Fields extends SelectFields<Model> = SelectFields<Model>> = OperationOptions & SearchRequestOptions<Model, Fields>;
6153
+
6154
+ /**
6155
+ * Deeply pick fields of T using valid Cognitive Search OData $select
6156
+ * paths.
6157
+ */
6158
+ export declare type SearchPick<T extends object, Paths extends SelectFields<T>> = [
6159
+ T
6160
+ ] extends [never] ? object : // We're going to get a union of individual interfaces for each field in T that's selected, so convert that to an intersection.
6161
+ UnionToIntersection<Paths extends `${infer FieldName}/${infer RestPaths}` ? FieldName extends keyof T & string ? NonNullable<T[FieldName]> extends Array<infer Elem> ? Elem extends object ? RestPaths extends SelectFields<Elem> ? {
6162
+ [Key in keyof T as Key & FieldName]: Array<SearchPick<Elem, RestPaths>>;
6163
+ } : never : never : NonNullable<T[FieldName]> extends object ? {
6164
+ [Key in keyof T as Key & FieldName]: RestPaths extends SelectFields<T[Key] & {}> ? SearchPick<T[Key] & {}, RestPaths> | Extract<T[Key], null> : never;
6165
+ } : never : never : // Otherwise, capture the paths that are simple keys of T itself
6166
+ Pick<T, Paths> | Extract<T, null>> & {};
4608
6167
 
4609
6168
  /**
4610
6169
  * Parameters for filtering, sorting, faceting, paging, and other search query behaviors.
@@ -4688,6 +6247,11 @@ export declare interface SearchRequest {
4688
6247
  * the results.
4689
6248
  */
4690
6249
  scoringProfile?: string;
6250
+ /**
6251
+ * The name of a semantic configuration that will be used when processing documents for queries of
6252
+ * type semantic.
6253
+ */
6254
+ semanticConfiguration?: string;
4691
6255
  /**
4692
6256
  * A full-text search query expression; Use "*" or omit this parameter to match all documents.
4693
6257
  */
@@ -4703,6 +6267,19 @@ export declare interface SearchRequest {
4703
6267
  * count the document as a match. Possible values include: 'Any', 'All'
4704
6268
  */
4705
6269
  searchMode?: SearchMode;
6270
+ /**
6271
+ * A value that specifies the language of the search query.
6272
+ */
6273
+ queryLanguage?: QueryLanguage;
6274
+ /**
6275
+ * A value that specified the type of the speller to use to spell-correct individual search
6276
+ * query terms.
6277
+ */
6278
+ speller?: QuerySpellerType;
6279
+ /**
6280
+ * A value that specifies whether answers should be returned as part of the search response.
6281
+ */
6282
+ answers?: QueryAnswerType;
4706
6283
  /**
4707
6284
  * The comma-separated list of fields to retrieve. If unspecified, all fields marked as
4708
6285
  * retrievable in the schema are included.
@@ -4721,12 +6298,20 @@ export declare interface SearchRequest {
4721
6298
  * Search request for the next page of results.
4722
6299
  */
4723
6300
  top?: number;
6301
+ /**
6302
+ * A value that specifies whether captions should be returned as part of the search response.
6303
+ */
6304
+ captions?: QueryCaptionType;
6305
+ /**
6306
+ * The comma-separated list of field names used for semantic search.
6307
+ */
6308
+ semanticFields?: string;
4724
6309
  }
4725
6310
 
4726
6311
  /**
4727
6312
  * Parameters for filtering, sorting, faceting, paging, and other search query behaviors.
4728
6313
  */
4729
- export declare interface SearchRequestOptions<Fields> {
6314
+ export declare interface SearchRequestOptions<Model extends object, Fields extends SelectFields<Model> = SelectFields<Model>> {
4730
6315
  /**
4731
6316
  * A value that specifies whether to fetch the total count of results. Default is false. Setting
4732
6317
  * this value to true may have a performance impact. Note that the count returned is an
@@ -4794,7 +6379,22 @@ export declare interface SearchRequestOptions<Fields> {
4794
6379
  * fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each
4795
6380
  * fielded search expression take precedence over any field names listed in this parameter.
4796
6381
  */
4797
- searchFields?: Fields[];
6382
+ searchFields?: SelectFields<Model>[] | Readonly<SelectFields<Model>[]>;
6383
+ /**
6384
+ * The language of the query.
6385
+ */
6386
+ queryLanguage?: QueryLanguage;
6387
+ /**
6388
+ * Improve search recall by spell-correcting individual search query terms.
6389
+ */
6390
+ speller?: Speller;
6391
+ /**
6392
+ * This parameter is only valid if the query type is 'semantic'. If set, the query returns answers
6393
+ * extracted from key passages in the highest ranked documents. The number of answers returned can
6394
+ * be configured by appending the pipe character '|' followed by the 'count-\<number of answers\>' option
6395
+ * after the answers parameter value, such as 'extractive|count-3'. Default count is 1.
6396
+ */
6397
+ answers?: Answers;
4798
6398
  /**
4799
6399
  * A value that specifies whether any or all of the search terms must be matched in order to
4800
6400
  * count the document as a match. Possible values include: 'any', 'all'
@@ -4818,7 +6418,7 @@ export declare interface SearchRequestOptions<Fields> {
4818
6418
  * The list of fields to retrieve. If unspecified, all fields marked as
4819
6419
  * retrievable in the schema are included.
4820
6420
  */
4821
- select?: Fields[];
6421
+ select?: [string] extends [Fields] ? string[] : Fields[] | Readonly<Fields[]>;
4822
6422
  /**
4823
6423
  * The number of search results to skip. This value cannot be greater than 100,000. If you need
4824
6424
  * to scan documents in sequence, but cannot use skip due to this limitation, consider using
@@ -4832,6 +6432,17 @@ export declare interface SearchRequestOptions<Fields> {
4832
6432
  * Search request for the next page of results.
4833
6433
  */
4834
6434
  top?: number;
6435
+ /**
6436
+ * This parameter is only valid if the query type is 'semantic'. If set, the query returns captions
6437
+ * extracted from key passages in the highest ranked documents. When Captions is set to 'extractive',
6438
+ * highlighting is enabled by default, and can be configured by appending the pipe character '|'
6439
+ * followed by the 'highlight-true'/'highlight-false' option, such as 'extractive|highlight-true'. Defaults to 'None'.
6440
+ */
6441
+ captions?: Captions;
6442
+ /**
6443
+ * The list of field names used for semantic search.
6444
+ */
6445
+ semanticFields?: string[];
4835
6446
  }
4836
6447
 
4837
6448
  /**
@@ -4864,26 +6475,43 @@ export declare interface SearchResourceEncryptionKey {
4864
6475
  * The authentication key of the specified AAD application.
4865
6476
  */
4866
6477
  applicationSecret?: string;
6478
+ /**
6479
+ * An explicit managed identity to use for this encryption key. If not specified and the access
6480
+ * credentials property is null, the system-assigned managed identity is used. On update to the
6481
+ * resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified,
6482
+ * the value of this property is cleared.
6483
+ */
6484
+ identity?: SearchIndexerDataIdentity;
4867
6485
  }
4868
6486
 
4869
6487
  /**
4870
6488
  * Contains a document found by a search query, plus associated metadata.
4871
6489
  */
4872
- export declare type SearchResult<T> = {
6490
+ export declare type SearchResult<Model extends object, Fields extends SelectFields<Model> = SelectFields<Model>> = {
4873
6491
  /**
4874
6492
  * The relevance score of the document compared to other documents returned by the query.
4875
6493
  * **NOTE: This property will not be serialized. It can only be populated by the server.**
4876
6494
  */
4877
6495
  readonly score: number;
6496
+ /**
6497
+ * The relevance score computed by the semantic ranker for the top search results. Search results are sorted by the RerankerScore first and then by the Score. RerankerScore is only returned for queries of type 'semantic'.
6498
+ * NOTE: This property will not be serialized. It can only be populated by the server.
6499
+ */
6500
+ readonly rerankerScore?: number;
4878
6501
  /**
4879
6502
  * Text fragments from the document that indicate the matching search terms, organized by each
4880
6503
  * applicable field; null if hit highlighting was not enabled for the query.
4881
6504
  * **NOTE: This property will not be serialized. It can only be populated by the server.**
4882
6505
  */
4883
6506
  readonly highlights?: {
4884
- [k in keyof T]?: string[];
6507
+ [k in SelectFields<Model>]?: string[];
4885
6508
  };
4886
- document: T;
6509
+ /**
6510
+ * Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'.
6511
+ * NOTE: This property will not be serialized. It can only be populated by the server.
6512
+ */
6513
+ readonly captions?: CaptionResult[];
6514
+ document: NarrowedModel<Model, Fields>;
4887
6515
  };
4888
6516
 
4889
6517
  /**
@@ -4911,6 +6539,34 @@ export declare interface SearchSuggester {
4911
6539
  sourceFields: string[];
4912
6540
  }
4913
6541
 
6542
+ /**
6543
+ * Produces a union of valid Cognitive Search OData $select paths for T
6544
+ * using a post-order traversal of the field tree rooted at T.
6545
+ */
6546
+ export declare type SelectFields<T extends object> = T extends Array<infer Elem> ? Elem extends object ? SelectFields<Elem> : never : {
6547
+ [Key in keyof T]: Key extends string ? NonNullable<T[Key]> extends object ? NonNullable<T[Key]> extends ExcludedODataTypes ? Key : SelectFields<NonNullable<T[Key]>> extends infer NextPaths ? NextPaths extends string ? // Union this key with all the next paths separated with '/'
6548
+ Key | `${Key}/${NextPaths}` : Key : never : Key : never;
6549
+ }[keyof T & string] & string;
6550
+
6551
+ /** Defines a specific configuration to be used in the context of semantic capabilities. */
6552
+ export declare interface SemanticConfiguration {
6553
+ /** The name of the semantic configuration. */
6554
+ name: string;
6555
+ /** 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. */
6556
+ prioritizedFields: PrioritizedFields;
6557
+ }
6558
+
6559
+ /** A field that is used as part of the semantic configuration. */
6560
+ export declare interface SemanticField {
6561
+ name?: string;
6562
+ }
6563
+
6564
+ /** Defines parameters for a search index that influence semantic capabilities. */
6565
+ export declare interface SemanticSettings {
6566
+ /** The semantic configurations for the index. */
6567
+ configurations?: SemanticConfiguration[];
6568
+ }
6569
+
4914
6570
  /** Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1. */
4915
6571
  export declare type SentimentSkill = BaseSearchIndexerSkill & {
4916
6572
  /** Polymorphic discriminator, which specifies the different types this object can be */
@@ -4923,7 +6579,7 @@ export declare type SentimentSkill = BaseSearchIndexerSkill & {
4923
6579
  * Defines values for SentimentSkillLanguage. \
4924
6580
  * {@link KnownSentimentSkillLanguage} can be used interchangeably with SentimentSkillLanguage,
4925
6581
  * this enum contains the known values that the service supports.
4926
- * ### Know values supported by the service
6582
+ * ### Known values supported by the service
4927
6583
  * **da**: Danish \
4928
6584
  * **nl**: Dutch \
4929
6585
  * **en**: English \
@@ -4942,8 +6598,22 @@ export declare type SentimentSkill = BaseSearchIndexerSkill & {
4942
6598
  */
4943
6599
  export declare type SentimentSkillLanguage = string;
4944
6600
 
6601
+ /** Using the Text Analytics API, evaluates unstructured text and for each record, provides sentiment labels (such as "negative", "neutral" and "positive") based on the highest confidence score found by the service at a sentence and document-level. */
6602
+ export declare type SentimentSkillV3 = BaseSearchIndexerSkill & {
6603
+ /** Polymorphic discriminator, which specifies the different types this object can be */
6604
+ odatatype: "#Microsoft.Skills.Text.V3.SentimentSkill";
6605
+ /** A value indicating which language code to use. Default is en. */
6606
+ defaultLanguageCode?: string;
6607
+ /** If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text. Default is false. */
6608
+ includeOpinionMining?: boolean;
6609
+ /** The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary. */
6610
+ modelVersion?: string;
6611
+ };
6612
+
4945
6613
  /** Represents service-level resource counters and quotas. */
4946
6614
  export declare interface ServiceCounters {
6615
+ /** Total number of aliases. */
6616
+ aliasCounter?: ResourceCounter;
4947
6617
  /** Total number of documents across all indexes in the service. */
4948
6618
  documentCounter: ResourceCounter;
4949
6619
  /** Total number of indexes. */
@@ -4963,13 +6633,13 @@ export declare interface ServiceCounters {
4963
6633
  /** Represents various service level limits. */
4964
6634
  export declare interface ServiceLimits {
4965
6635
  /** The maximum allowed fields per index. */
4966
- maxFieldsPerIndex?: number | null;
6636
+ maxFieldsPerIndex?: number;
4967
6637
  /** The maximum depth which you can nest sub-fields in an index, including the top-level complex field. For example, a/b/c has a nesting depth of 3. */
4968
- maxFieldNestingDepthPerIndex?: number | null;
6638
+ maxFieldNestingDepthPerIndex?: number;
4969
6639
  /** The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index. */
4970
- maxComplexCollectionFieldsPerIndex?: number | null;
6640
+ maxComplexCollectionFieldsPerIndex?: number;
4971
6641
  /** The maximum number of objects in complex collections allowed per document. */
4972
- maxComplexObjectsInCollectionsPerDocument?: number | null;
6642
+ maxComplexObjectsInCollectionsPerDocument?: number;
4973
6643
  }
4974
6644
 
4975
6645
  /** A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields). */
@@ -5108,6 +6778,10 @@ export declare interface SimpleField {
5108
6778
  * fields.
5109
6779
  */
5110
6780
  synonymMapNames?: string[];
6781
+ /**
6782
+ * The name of the normalizer used at indexing time for the field.
6783
+ */
6784
+ normalizerName?: LexicalNormalizerName;
5111
6785
  }
5112
6786
 
5113
6787
  /** A filter that stems words using a Snowball-generated stemmer. This token filter is implemented using Apache Lucene. */
@@ -5131,6 +6805,16 @@ export declare type SoftDeleteColumnDeletionDetectionPolicy = BaseDataDeletionDe
5131
6805
  softDeleteMarkerValue?: string;
5132
6806
  };
5133
6807
 
6808
+ /**
6809
+ * Defines values for Speller. \
6810
+ * {@link KnownSpeller} can be used interchangeably with Speller,
6811
+ * this enum contains the known values that the service supports.
6812
+ * ### Known values supported by the service
6813
+ * **none**: Speller not enabled. \
6814
+ * **lexicon**: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter.
6815
+ */
6816
+ export declare type Speller = string;
6817
+
5134
6818
  /** A skill to split a string into chunks of text. */
5135
6819
  export declare type SplitSkill = BaseSearchIndexerSkill & {
5136
6820
  /** Polymorphic discriminator, which specifies the different types this object can be */
@@ -5140,14 +6824,14 @@ export declare type SplitSkill = BaseSearchIndexerSkill & {
5140
6824
  /** A value indicating which split mode to perform. */
5141
6825
  textSplitMode?: TextSplitMode;
5142
6826
  /** The desired maximum page length. Default is 10000. */
5143
- maxPageLength?: number | null;
6827
+ maxPageLength?: number;
5144
6828
  };
5145
6829
 
5146
6830
  /**
5147
6831
  * Defines values for SplitSkillLanguage. \
5148
6832
  * {@link KnownSplitSkillLanguage} can be used interchangeably with SplitSkillLanguage,
5149
6833
  * this enum contains the known values that the service supports.
5150
- * ### Know values supported by the service
6834
+ * ### Known values supported by the service
5151
6835
  * **da**: Danish \
5152
6836
  * **de**: German \
5153
6837
  * **en**: English \
@@ -5213,12 +6897,12 @@ export declare type StopwordsTokenFilter = BaseTokenFilter & {
5213
6897
  /**
5214
6898
  * Response containing suggestion query results from an index.
5215
6899
  */
5216
- export declare interface SuggestDocumentsResult<T> {
6900
+ export declare interface SuggestDocumentsResult<Model extends object, Fields extends SelectFields<Model> = SelectFields<Model>> {
5217
6901
  /**
5218
6902
  * The sequence of results returned by the query.
5219
6903
  * **NOTE: This property will not be serialized. It can only be populated by the server.**
5220
6904
  */
5221
- readonly results: SuggestResult<T>[];
6905
+ readonly results: SuggestResult<Model, Fields>[];
5222
6906
  /**
5223
6907
  * A value indicating the percentage of the index that was included in the query, or null if
5224
6908
  * minimumCoverage was not set in the request.
@@ -5227,15 +6911,19 @@ export declare interface SuggestDocumentsResult<T> {
5227
6911
  readonly coverage?: number;
5228
6912
  }
5229
6913
 
6914
+ export declare type SuggestNarrowedModel<Model extends object, Fields extends SelectFields<Model> = SelectFields<Model>> = [Model] extends [never] ? object : [
6915
+ Fields
6916
+ ] extends [never] ? keyof ExtractDocumentKey<Model> extends never ? Model : ExtractDocumentKey<Model> : Fields extends SelectFields<Model> ? NarrowedModel<Model, Fields> : never;
6917
+
5230
6918
  /**
5231
6919
  * Options for retrieving suggestions based on the searchText.
5232
6920
  */
5233
- export declare type SuggestOptions<Fields> = OperationOptions & SuggestRequest<Fields>;
6921
+ export declare type SuggestOptions<Model extends object, Fields extends SelectFields<Model> = SelectFields<Model>> = OperationOptions & SuggestRequest<Model, Fields>;
5234
6922
 
5235
6923
  /**
5236
6924
  * Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors.
5237
6925
  */
5238
- export declare interface SuggestRequest<Fields> {
6926
+ export declare interface SuggestRequest<Model extends object, Fields extends SelectFields<Model> = SelectFields<Model>> {
5239
6927
  /**
5240
6928
  * An OData expression that filters the documents considered for suggestions.
5241
6929
  */
@@ -5278,13 +6966,14 @@ export declare interface SuggestRequest<Fields> {
5278
6966
  * The comma-separated list of field names to search for the specified search text. Target fields
5279
6967
  * must be included in the specified suggester.
5280
6968
  */
5281
- searchFields?: Fields[];
6969
+ searchFields?: SelectFields<Model>[] | Readonly<SelectFields<Model>[]>;
5282
6970
  /**
5283
6971
  * The list of fields to retrieve. If unspecified, only the key field will be
5284
6972
  * included in the results.
5285
6973
  */
5286
- select?: Fields[];
6974
+ select?: [string] extends [Fields] ? string[] : Fields[] | Readonly<Fields[]>;
5287
6975
  /**
6976
+ /**
5288
6977
  * The number of suggestions to retrieve. This must be a value between 1 and 100. The default is
5289
6978
  * 5.
5290
6979
  */
@@ -5294,13 +6983,13 @@ export declare interface SuggestRequest<Fields> {
5294
6983
  /**
5295
6984
  * A result containing a document found by a suggestion query, plus associated metadata.
5296
6985
  */
5297
- export declare type SuggestResult<T> = {
6986
+ export declare type SuggestResult<Model extends object, Fields extends SelectFields<Model> = SelectFields<Model>> = {
5298
6987
  /**
5299
6988
  * The text of the suggestion result.
5300
6989
  * **NOTE: This property will not be serialized. It can only be populated by the server.**
5301
6990
  */
5302
6991
  readonly text: string;
5303
- document: T;
6992
+ document: SuggestNarrowedModel<Model, Fields>;
5304
6993
  };
5305
6994
 
5306
6995
  /**
@@ -5325,7 +7014,7 @@ export declare interface SynonymMap {
5325
7014
  * keys is not available for free search services, and is only available for paid services
5326
7015
  * created on or after January 1, 2019.
5327
7016
  */
5328
- encryptionKey?: SearchResourceEncryptionKey | null;
7017
+ encryptionKey?: SearchResourceEncryptionKey;
5329
7018
  /**
5330
7019
  * The ETag of the synonym map.
5331
7020
  */
@@ -5362,7 +7051,7 @@ export declare interface TagScoringParameters {
5362
7051
  * Defines values for TextSplitMode. \
5363
7052
  * {@link KnownTextSplitMode} can be used interchangeably with TextSplitMode,
5364
7053
  * this enum contains the known values that the service supports.
5365
- * ### Know values supported by the service
7054
+ * ### Known values supported by the service
5366
7055
  * **pages**: Split the text into individual pages. \
5367
7056
  * **sentences**: Split the text into individual sentences.
5368
7057
  */
@@ -5377,14 +7066,14 @@ export declare type TextTranslationSkill = BaseSearchIndexerSkill & {
5377
7066
  /** The language code to translate documents from for documents that don't specify the from language explicitly. */
5378
7067
  defaultFromLanguageCode?: TextTranslationSkillLanguage;
5379
7068
  /** The language code to translate documents from when neither the fromLanguageCode input nor the defaultFromLanguageCode parameter are provided, and the automatic language detection is unsuccessful. Default is en. */
5380
- suggestedFrom?: TextTranslationSkillLanguage | null;
7069
+ suggestedFrom?: TextTranslationSkillLanguage;
5381
7070
  };
5382
7071
 
5383
7072
  /**
5384
7073
  * Defines values for TextTranslationSkillLanguage. \
5385
7074
  * {@link KnownTextTranslationSkillLanguage} can be used interchangeably with TextTranslationSkillLanguage,
5386
7075
  * this enum contains the known values that the service supports.
5387
- * ### Know values supported by the service
7076
+ * ### Known values supported by the service
5388
7077
  * **af**: Afrikaans \
5389
7078
  * **ar**: Arabic \
5390
7079
  * **bn**: Bangla \
@@ -5417,6 +7106,8 @@ export declare type TextTranslationSkill = BaseSearchIndexerSkill & {
5417
7106
  * **ja**: Japanese \
5418
7107
  * **sw**: Kiswahili \
5419
7108
  * **tlh**: Klingon \
7109
+ * **tlh-Latn**: Klingon (Latin script) \
7110
+ * **tlh-Piqd**: Klingon (Klingon script) \
5420
7111
  * **ko**: Korean \
5421
7112
  * **lv**: Latvian \
5422
7113
  * **lt**: Lithuanian \
@@ -5427,6 +7118,8 @@ export declare type TextTranslationSkill = BaseSearchIndexerSkill & {
5427
7118
  * **fa**: Persian \
5428
7119
  * **pl**: Polish \
5429
7120
  * **pt**: Portuguese \
7121
+ * **pt-br**: Portuguese (Brazil) \
7122
+ * **pt-PT**: Portuguese (Portugal) \
5430
7123
  * **otq**: Queretaro Otomi \
5431
7124
  * **ro**: Romanian \
5432
7125
  * **ru**: Russian \
@@ -5447,7 +7140,12 @@ export declare type TextTranslationSkill = BaseSearchIndexerSkill & {
5447
7140
  * **ur**: Urdu \
5448
7141
  * **vi**: Vietnamese \
5449
7142
  * **cy**: Welsh \
5450
- * **yua**: Yucatec Maya
7143
+ * **yua**: Yucatec Maya \
7144
+ * **ga**: Irish \
7145
+ * **kn**: Kannada \
7146
+ * **mi**: Maori \
7147
+ * **ml**: Malayalam \
7148
+ * **pa**: Punjabi
5451
7149
  */
5452
7150
  export declare type TextTranslationSkillLanguage = string;
5453
7151
 
@@ -5471,40 +7169,40 @@ export declare type TokenFilter = AsciiFoldingTokenFilter | CjkBigramTokenFilter
5471
7169
  * Defines values for TokenFilterName. \
5472
7170
  * {@link KnownTokenFilterName} can be used interchangeably with TokenFilterName,
5473
7171
  * this enum contains the known values that the service supports.
5474
- * ### Know values supported by the service
5475
- * **arabic_normalization**: 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 \
5476
- * **apostrophe**: 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 \
5477
- * **asciifolding**: 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 \
5478
- * **cjk_bigram**: Forms bigrams of CJK terms that are generated from the standard tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html \
5479
- * **cjk_width**: Normalizes CJK width differences. Folds fullwidth ASCII variants into the equivalent basic Latin, and half-width Katakana variants into the equivalent Kana. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKWidthFilter.html \
5480
- * **classic**: Removes English possessives, and dots from acronyms. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicFilter.html \
5481
- * **common_grams**: Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html \
5482
- * **edgeNGram_v2**: Generates n-grams of the given size(s) starting from the front or the back of an input token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html \
5483
- * **elision**: 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 \
5484
- * **german_normalization**: Normalizes German characters according to the heuristics of the German2 snowball algorithm. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/de/GermanNormalizationFilter.html \
5485
- * **hindi_normalization**: Normalizes text in Hindi to remove some differences in spelling variations. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/hi/HindiNormalizationFilter.html \
5486
- * **indic_normalization**: Normalizes the Unicode representation of text in Indian languages. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/in/IndicNormalizationFilter.html \
5487
- * **keyword_repeat**: Emits each incoming token twice, once as keyword and once as non-keyword. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordRepeatFilter.html \
5488
- * **kstem**: A high-performance kstem filter for English. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/en/KStemFilter.html \
5489
- * **length**: Removes words that are too long or too short. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html \
5490
- * **limit**: Limits the number of tokens while indexing. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html \
5491
- * **lowercase**: Normalizes token text to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.htm \
5492
- * **nGram_v2**: Generates n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html \
5493
- * **persian_normalization**: Applies normalization for Persian. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/fa/PersianNormalizationFilter.html \
5494
- * **phonetic**: Create tokens for phonetic matches. See https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html \
5495
- * **porter_stem**: Uses the Porter stemming algorithm to transform the token stream. See http://tartarus.org/~martin/PorterStemmer \
5496
- * **reverse**: Reverses the token string. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html \
5497
- * **scandinavian_normalization**: Normalizes use of the interchangeable Scandinavian characters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianNormalizationFilter.html \
5498
- * **scandinavian_folding**: Folds Scandinavian characters åÅäæÄÆ-&gt;a and öÖøØ-&gt;o. It also discriminates against use of double vowels aa, ae, ao, oe and oo, leaving just the first one. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianFoldingFilter.html \
5499
- * **shingle**: Creates combinations of tokens as a single token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html \
5500
- * **snowball**: A filter that stems words using a Snowball-generated stemmer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html \
5501
- * **sorani_normalization**: Normalizes the Unicode representation of Sorani text. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ckb/SoraniNormalizationFilter.html \
5502
- * **stemmer**: Language specific stemming filter. See https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters \
5503
- * **stopwords**: Removes stop words from a token stream. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html \
5504
- * **trim**: Trims leading and trailing whitespace from tokens. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TrimFilter.html \
5505
- * **truncate**: Truncates the terms to a specific length. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html \
5506
- * **unique**: Filters out tokens with same text as the previous token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html \
5507
- * **uppercase**: Normalizes token text to upper case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html \
7172
+ * ### Known values supported by the service
7173
+ * **arabic_normalization**: 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 \
7174
+ * **apostrophe**: 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 \
7175
+ * **asciifolding**: 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 \
7176
+ * **cjk_bigram**: Forms bigrams of CJK terms that are generated from the standard tokenizer. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/cjk\/CJKBigramFilter.html \
7177
+ * **cjk_width**: Normalizes CJK width differences. Folds fullwidth ASCII variants into the equivalent basic Latin, and half-width Katakana variants into the equivalent Kana. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/cjk\/CJKWidthFilter.html \
7178
+ * **classic**: Removes English possessives, and dots from acronyms. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/standard\/ClassicFilter.html \
7179
+ * **common_grams**: Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/commongrams\/CommonGramsFilter.html \
7180
+ * **edgeNGram_v2**: Generates n-grams of the given size(s) starting from the front or the back of an input token. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/ngram\/EdgeNGramTokenFilter.html \
7181
+ * **elision**: 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 \
7182
+ * **german_normalization**: Normalizes German characters according to the heuristics of the German2 snowball algorithm. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/de\/GermanNormalizationFilter.html \
7183
+ * **hindi_normalization**: Normalizes text in Hindi to remove some differences in spelling variations. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/hi\/HindiNormalizationFilter.html \
7184
+ * **indic_normalization**: Normalizes the Unicode representation of text in Indian languages. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/in\/IndicNormalizationFilter.html \
7185
+ * **keyword_repeat**: Emits each incoming token twice, once as keyword and once as non-keyword. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/KeywordRepeatFilter.html \
7186
+ * **kstem**: A high-performance kstem filter for English. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/en\/KStemFilter.html \
7187
+ * **length**: Removes words that are too long or too short. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/LengthFilter.html \
7188
+ * **limit**: Limits the number of tokens while indexing. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/LimitTokenCountFilter.html \
7189
+ * **lowercase**: Normalizes token text to lower case. See https:\/\/lucene.apache.org\/core\/6_6_1\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/LowerCaseFilter.html \
7190
+ * **nGram_v2**: Generates n-grams of the given size(s). See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/ngram\/NGramTokenFilter.html \
7191
+ * **persian_normalization**: Applies normalization for Persian. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/fa\/PersianNormalizationFilter.html \
7192
+ * **phonetic**: Create tokens for phonetic matches. See https:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-phonetic\/org\/apache\/lucene\/analysis\/phonetic\/package-tree.html \
7193
+ * **porter_stem**: Uses the Porter stemming algorithm to transform the token stream. See http:\/\/tartarus.org\/~martin\/PorterStemmer \
7194
+ * **reverse**: Reverses the token string. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/reverse\/ReverseStringFilter.html \
7195
+ * **scandinavian_normalization**: Normalizes use of the interchangeable Scandinavian characters. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/ScandinavianNormalizationFilter.html \
7196
+ * **scandinavian_folding**: Folds Scandinavian characters åÅäæÄÆ-&gt;a and öÖøØ-&gt;o. It also discriminates against use of double vowels aa, ae, ao, oe and oo, leaving just the first one. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/ScandinavianFoldingFilter.html \
7197
+ * **shingle**: Creates combinations of tokens as a single token. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/shingle\/ShingleFilter.html \
7198
+ * **snowball**: A filter that stems words using a Snowball-generated stemmer. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/snowball\/SnowballFilter.html \
7199
+ * **sorani_normalization**: Normalizes the Unicode representation of Sorani text. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/ckb\/SoraniNormalizationFilter.html \
7200
+ * **stemmer**: Language specific stemming filter. See https:\/\/docs.microsoft.com\/rest\/api\/searchservice\/Custom-analyzers-in-Azure-Search#TokenFilters \
7201
+ * **stopwords**: Removes stop words from a token stream. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/StopFilter.html \
7202
+ * **trim**: Trims leading and trailing whitespace from tokens. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/TrimFilter.html \
7203
+ * **truncate**: Truncates the terms to a specific length. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/TruncateTokenFilter.html \
7204
+ * **unique**: Filters out tokens with same text as the previous token. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/RemoveDuplicatesTokenFilter.html \
7205
+ * **uppercase**: Normalizes token text to upper case. See https:\/\/lucene.apache.org\/core\/6_6_1\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/UpperCaseFilter.html \
5508
7206
  * **word_delimiter**: Splits words into subwords and performs optional transformations on subword groups.
5509
7207
  */
5510
7208
  export declare type TokenFilterName = string;
@@ -5525,6 +7223,8 @@ export declare type UaxUrlEmailTokenizer = BaseLexicalTokenizer & {
5525
7223
  maxTokenLength?: number;
5526
7224
  };
5527
7225
 
7226
+ export declare type UnionToIntersection<U> = (U extends unknown ? (_: U) => unknown : never) extends (_: infer I) => unknown ? I : never;
7227
+
5528
7228
  /** Filters out tokens with same text as the previous token. This token filter is implemented using Apache Lucene. */
5529
7229
  export declare type UniqueTokenFilter = BaseTokenFilter & {
5530
7230
  /** Polymorphic discriminator, which specifies the different types this object can be */
@@ -5542,7 +7242,7 @@ export declare type UploadDocumentsOptions = IndexDocumentsOptions;
5542
7242
  * Defines values for VisualFeature. \
5543
7243
  * {@link KnownVisualFeature} can be used interchangeably with VisualFeature,
5544
7244
  * this enum contains the known values that the service supports.
5545
- * ### Know values supported by the service
7245
+ * ### Known values supported by the service
5546
7246
  * **adult**: Visual features recognized as adult persons. \
5547
7247
  * **brands**: Visual features recognized as commercial brands. \
5548
7248
  * **categories**: Categories. \
@@ -5568,9 +7268,9 @@ export declare type WebApiSkill = BaseSearchIndexerSkill & {
5568
7268
  /** The desired timeout for the request. Default is 30 seconds. */
5569
7269
  timeout?: string;
5570
7270
  /** The desired batch size which indicates number of documents. */
5571
- batchSize?: number | null;
7271
+ batchSize?: number;
5572
7272
  /** If set, the number of parallel calls that can be made to the Web API. */
5573
- degreeOfParallelism?: number | null;
7273
+ degreeOfParallelism?: number;
5574
7274
  };
5575
7275
 
5576
7276
  /** Splits words into subwords and performs optional transformations on subword groups. This token filter is implemented using Apache Lucene. */