@azure/search-documents 11.3.0-beta.6 → 11.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +28 -0
- package/README.md +73 -35
- package/dist/index.js +839 -2940
- package/dist/index.js.map +1 -1
- package/dist-esm/src/constants.js +1 -1
- package/dist-esm/src/constants.js.map +1 -1
- package/dist-esm/src/generated/data/index.js +0 -1
- package/dist-esm/src/generated/data/index.js.map +1 -1
- package/dist-esm/src/generated/data/models/index.js +1 -202
- package/dist-esm/src/generated/data/models/index.js.map +1 -1
- package/dist-esm/src/generated/data/models/mappers.js +1 -138
- package/dist-esm/src/generated/data/models/mappers.js.map +1 -1
- package/dist-esm/src/generated/data/models/parameters.js +13 -72
- package/dist-esm/src/generated/data/models/parameters.js.map +1 -1
- package/dist-esm/src/generated/data/operations/documents.js +51 -23
- package/dist-esm/src/generated/data/operations/documents.js.map +1 -1
- package/dist-esm/src/generated/data/searchClient.js +2 -2
- package/dist-esm/src/generated/data/searchClient.js.map +1 -1
- package/dist-esm/src/generated/data/searchClientContext.js +11 -13
- package/dist-esm/src/generated/data/searchClientContext.js.map +1 -1
- package/dist-esm/src/generated/service/index.js +0 -1
- package/dist-esm/src/generated/service/index.js.map +1 -1
- package/dist-esm/src/generated/service/models/index.js +1 -904
- package/dist-esm/src/generated/service/models/index.js.map +1 -1
- package/dist-esm/src/generated/service/models/mappers.js +11 -674
- package/dist-esm/src/generated/service/models/mappers.js.map +1 -1
- package/dist-esm/src/generated/service/models/parameters.js +1 -37
- package/dist-esm/src/generated/service/models/parameters.js.map +1 -1
- package/dist-esm/src/generated/service/operations/dataSources.js +30 -13
- package/dist-esm/src/generated/service/operations/dataSources.js.map +1 -1
- package/dist-esm/src/generated/service/operations/indexers.js +45 -45
- package/dist-esm/src/generated/service/operations/indexers.js.map +1 -1
- package/dist-esm/src/generated/service/operations/indexes.js +40 -11
- package/dist-esm/src/generated/service/operations/indexes.js.map +1 -1
- package/dist-esm/src/generated/service/operations/skillsets.js +30 -43
- package/dist-esm/src/generated/service/operations/skillsets.js.map +1 -1
- package/dist-esm/src/generated/service/operations/synonymMaps.js +29 -9
- package/dist-esm/src/generated/service/operations/synonymMaps.js.map +1 -1
- package/dist-esm/src/generated/service/searchServiceClient.js +12 -9
- package/dist-esm/src/generated/service/searchServiceClient.js.map +1 -1
- package/dist-esm/src/generated/service/searchServiceClientContext.js +11 -13
- package/dist-esm/src/generated/service/searchServiceClientContext.js.map +1 -1
- package/dist-esm/src/geographyPoint.js +1 -1
- package/dist-esm/src/geographyPoint.js.map +1 -1
- package/dist-esm/src/index.js +3 -4
- package/dist-esm/src/index.js.map +1 -1
- package/dist-esm/src/indexDocumentsBatch.js +1 -1
- package/dist-esm/src/indexDocumentsBatch.js.map +1 -1
- package/dist-esm/src/indexModels.js.map +1 -1
- package/dist-esm/src/odataMetadataPolicy.js +15 -7
- package/dist-esm/src/odataMetadataPolicy.js.map +1 -1
- package/dist-esm/src/searchApiKeyCredentialPolicy.js +21 -8
- package/dist-esm/src/searchApiKeyCredentialPolicy.js.map +1 -1
- package/dist-esm/src/searchAudience.js +21 -0
- package/dist-esm/src/searchAudience.js.map +1 -0
- package/dist-esm/src/searchClient.js +56 -77
- package/dist-esm/src/searchClient.js.map +1 -1
- package/dist-esm/src/searchIndexClient.js +57 -70
- package/dist-esm/src/searchIndexClient.js.map +1 -1
- package/dist-esm/src/searchIndexerClient.js +65 -119
- package/dist-esm/src/searchIndexerClient.js.map +1 -1
- package/dist-esm/src/searchIndexingBufferedSender.js +11 -11
- package/dist-esm/src/searchIndexingBufferedSender.js.map +1 -1
- package/dist-esm/src/serialization.js +5 -5
- package/dist-esm/src/serialization.js.map +1 -1
- package/dist-esm/src/serviceModels.js.map +1 -1
- package/dist-esm/src/serviceUtils.js +31 -69
- package/dist-esm/src/serviceUtils.js.map +1 -1
- package/dist-esm/src/synonymMapHelper.js +2 -6
- package/dist-esm/src/synonymMapHelper.js.map +1 -1
- package/dist-esm/src/tracing.js +1 -1
- package/dist-esm/src/tracing.js.map +1 -1
- package/package.json +38 -38
- package/types/search-documents.d.ts +188 -1049
- package/dist-esm/src/generated/data/operationsInterfaces/documents.js +0 -9
- package/dist-esm/src/generated/data/operationsInterfaces/documents.js.map +0 -1
- package/dist-esm/src/generated/data/operationsInterfaces/index.js +0 -9
- package/dist-esm/src/generated/data/operationsInterfaces/index.js.map +0 -1
- package/dist-esm/src/generated/service/operationsInterfaces/dataSources.js +0 -9
- package/dist-esm/src/generated/service/operationsInterfaces/dataSources.js.map +0 -1
- package/dist-esm/src/generated/service/operationsInterfaces/index.js +0 -13
- package/dist-esm/src/generated/service/operationsInterfaces/index.js.map +0 -1
- package/dist-esm/src/generated/service/operationsInterfaces/indexers.js +0 -9
- package/dist-esm/src/generated/service/operationsInterfaces/indexers.js.map +0 -1
- package/dist-esm/src/generated/service/operationsInterfaces/indexes.js +0 -9
- package/dist-esm/src/generated/service/operationsInterfaces/indexes.js.map +0 -1
- package/dist-esm/src/generated/service/operationsInterfaces/skillsets.js +0 -9
- package/dist-esm/src/generated/service/operationsInterfaces/skillsets.js.map +0 -1
- package/dist-esm/src/generated/service/operationsInterfaces/synonymMaps.js +0 -9
- package/dist-esm/src/generated/service/operationsInterfaces/synonymMaps.js.map +0 -1
|
@@ -1,11 +1,10 @@
|
|
|
1
1
|
/// <reference lib="esnext.asynciterable" />
|
|
2
|
-
|
|
3
2
|
import { AzureKeyCredential } from '@azure/core-auth';
|
|
4
|
-
import { CommonClientOptions } from '@azure/core-client';
|
|
5
3
|
import { KeyCredential } from '@azure/core-auth';
|
|
6
|
-
import { OperationOptions } from '@azure/core-
|
|
4
|
+
import { OperationOptions } from '@azure/core-http';
|
|
7
5
|
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
|
8
|
-
import {
|
|
6
|
+
import { PipelineOptions } from '@azure/core-http';
|
|
7
|
+
import { RestError } from '@azure/core-http';
|
|
9
8
|
import { TokenCredential } from '@azure/core-auth';
|
|
10
9
|
|
|
11
10
|
/** Information about a token returned by an analyzer. */
|
|
@@ -54,10 +53,6 @@ export declare interface AnalyzeRequest {
|
|
|
54
53
|
* NOTE: Either analyzerName or tokenizerName is required in an AnalyzeRequest.
|
|
55
54
|
*/
|
|
56
55
|
tokenizerName?: string;
|
|
57
|
-
/**
|
|
58
|
-
* The name of the normalizer to use to normalize the given text.
|
|
59
|
-
*/
|
|
60
|
-
normalizerName?: LexicalNormalizerName;
|
|
61
56
|
/**
|
|
62
57
|
* An optional list of token filters to use when breaking the given text. This parameter can only
|
|
63
58
|
* be set when using the tokenizer parameter.
|
|
@@ -81,42 +76,6 @@ export declare interface AnalyzeResult {
|
|
|
81
76
|
*/
|
|
82
77
|
export declare type AnalyzeTextOptions = OperationOptions & AnalyzeRequest;
|
|
83
78
|
|
|
84
|
-
/** 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. */
|
|
85
|
-
export declare interface AnswerResult {
|
|
86
|
-
/** Describes unknown properties. The value of an unknown property can be of "any" type. */
|
|
87
|
-
[property: string]: any;
|
|
88
|
-
/**
|
|
89
|
-
* The score value represents how relevant the answer is to the query relative to other answers returned for the query.
|
|
90
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
91
|
-
*/
|
|
92
|
-
readonly score: number;
|
|
93
|
-
/**
|
|
94
|
-
* The key of the document the answer was extracted from.
|
|
95
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
96
|
-
*/
|
|
97
|
-
readonly key: string;
|
|
98
|
-
/**
|
|
99
|
-
* The text passage extracted from the document contents as the answer.
|
|
100
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
101
|
-
*/
|
|
102
|
-
readonly text: string;
|
|
103
|
-
/**
|
|
104
|
-
* Same text passage as in the Text property with highlighted text phrases most relevant to the query.
|
|
105
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
106
|
-
*/
|
|
107
|
-
readonly highlights?: string;
|
|
108
|
-
}
|
|
109
|
-
|
|
110
|
-
/**
|
|
111
|
-
* Defines values for Answers. \
|
|
112
|
-
* {@link KnownAnswers} can be used interchangeably with Answers,
|
|
113
|
-
* this enum contains the known values that the service supports.
|
|
114
|
-
* ### Known values supported by the service
|
|
115
|
-
* **none**: Do not return answers for the query. \
|
|
116
|
-
* **extractive**: Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language.
|
|
117
|
-
*/
|
|
118
|
-
export declare type Answers = string;
|
|
119
|
-
|
|
120
79
|
/** 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. */
|
|
121
80
|
export declare type AsciiFoldingTokenFilter = BaseTokenFilter & {
|
|
122
81
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -220,27 +179,8 @@ export declare interface AzureActiveDirectoryApplicationCredentials {
|
|
|
220
179
|
/** The authentication key of the specified AAD application. */
|
|
221
180
|
applicationSecret?: string;
|
|
222
181
|
}
|
|
223
|
-
|
|
224
182
|
export { AzureKeyCredential }
|
|
225
183
|
|
|
226
|
-
/** The AML skill allows you to extend AI enrichment with a custom Azure Machine Learning (AML) model. Once an AML model is trained and deployed, an AML skill integrates it into AI enrichment. */
|
|
227
|
-
export declare type AzureMachineLearningSkill = BaseSearchIndexerSkill & {
|
|
228
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
229
|
-
odatatype: "#Microsoft.Skills.Custom.AmlSkill";
|
|
230
|
-
/** (Required for no authentication or key authentication) The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed. */
|
|
231
|
-
scoringUri?: string;
|
|
232
|
-
/** (Required for key authentication) The key for the AML service. */
|
|
233
|
-
authenticationKey?: string;
|
|
234
|
-
/** (Required for token authentication). The Azure Resource Manager resource ID of the AML service. It should be in the format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}. */
|
|
235
|
-
resourceId?: string;
|
|
236
|
-
/** (Optional) When specified, indicates the timeout for the http client making the API call. */
|
|
237
|
-
timeout?: string;
|
|
238
|
-
/** (Optional for token authentication). The region the AML service is deployed in. */
|
|
239
|
-
region?: string;
|
|
240
|
-
/** (Optional) When specified, indicates the number of calls the indexer will make in parallel to the endpoint you have provided. You can decrease this value if your endpoint is failing under too high of a request load, or raise it if your endpoint is able to accept more requests and you would like an increase in the performance of the indexer. If not set, a default value of 5 is used. The degreeOfParallelism can be set to a maximum of 10 and a minimum of 1. */
|
|
241
|
-
degreeOfParallelism?: number;
|
|
242
|
-
};
|
|
243
|
-
|
|
244
184
|
/** Base type for character filters. */
|
|
245
185
|
export declare interface BaseCharFilter {
|
|
246
186
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -277,14 +217,6 @@ export declare interface BaseLexicalAnalyzer {
|
|
|
277
217
|
name: string;
|
|
278
218
|
}
|
|
279
219
|
|
|
280
|
-
/** Base type for normalizers. */
|
|
281
|
-
export declare interface BaseLexicalNormalizer {
|
|
282
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
283
|
-
odatatype: "#Microsoft.Azure.Search.CustomNormalizer";
|
|
284
|
-
/** 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'. */
|
|
285
|
-
name: string;
|
|
286
|
-
}
|
|
287
|
-
|
|
288
220
|
/** Base type for tokenizers. */
|
|
289
221
|
export declare interface BaseLexicalTokenizer {
|
|
290
222
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -305,16 +237,10 @@ export declare interface BaseScoringFunction {
|
|
|
305
237
|
interpolation?: ScoringFunctionInterpolation;
|
|
306
238
|
}
|
|
307
239
|
|
|
308
|
-
/** Abstract base type for data identities. */
|
|
309
|
-
export declare interface BaseSearchIndexerDataIdentity {
|
|
310
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
311
|
-
odatatype: "#Microsoft.Azure.Search.SearchIndexerDataNoneIdentity" | "#Microsoft.Azure.Search.SearchIndexerDataUserAssignedIdentity";
|
|
312
|
-
}
|
|
313
|
-
|
|
314
240
|
/** Base type for skills. */
|
|
315
241
|
export declare interface BaseSearchIndexerSkill {
|
|
316
242
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
317
|
-
odatatype: "#Microsoft.Skills.Util.ConditionalSkill" | "#Microsoft.Skills.Text.KeyPhraseExtractionSkill" | "#Microsoft.Skills.Vision.OcrSkill" | "#Microsoft.Skills.Vision.ImageAnalysisSkill" | "#Microsoft.Skills.Text.LanguageDetectionSkill" | "#Microsoft.Skills.Util.ShaperSkill" | "#Microsoft.Skills.Text.MergeSkill" | "#Microsoft.Skills.Text.EntityRecognitionSkill" | "#Microsoft.Skills.Text.SentimentSkill" | "#Microsoft.Skills.Text.
|
|
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";
|
|
318
244
|
/** 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 '#'. */
|
|
319
245
|
name?: string;
|
|
320
246
|
/** The description of the skill which describes the inputs, outputs, and usage of the skill. */
|
|
@@ -339,7 +265,7 @@ export declare interface BaseTokenFilter {
|
|
|
339
265
|
* Defines values for BlobIndexerDataToExtract. \
|
|
340
266
|
* {@link KnownBlobIndexerDataToExtract} can be used interchangeably with BlobIndexerDataToExtract,
|
|
341
267
|
* this enum contains the known values that the service supports.
|
|
342
|
-
* ###
|
|
268
|
+
* ### Know values supported by the service
|
|
343
269
|
* **storageMetadata**: Indexes just the standard blob properties and user-specified metadata. \
|
|
344
270
|
* **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). \
|
|
345
271
|
* **contentAndMetadata**: Extracts all metadata and textual content from each blob.
|
|
@@ -350,7 +276,7 @@ export declare type BlobIndexerDataToExtract = string;
|
|
|
350
276
|
* Defines values for BlobIndexerImageAction. \
|
|
351
277
|
* {@link KnownBlobIndexerImageAction} can be used interchangeably with BlobIndexerImageAction,
|
|
352
278
|
* this enum contains the known values that the service supports.
|
|
353
|
-
* ###
|
|
279
|
+
* ### Know values supported by the service
|
|
354
280
|
* **none**: Ignores embedded images or image files in the data set. This is the default. \
|
|
355
281
|
* **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. \
|
|
356
282
|
* **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.
|
|
@@ -361,7 +287,7 @@ export declare type BlobIndexerImageAction = string;
|
|
|
361
287
|
* Defines values for BlobIndexerParsingMode. \
|
|
362
288
|
* {@link KnownBlobIndexerParsingMode} can be used interchangeably with BlobIndexerParsingMode,
|
|
363
289
|
* this enum contains the known values that the service supports.
|
|
364
|
-
* ###
|
|
290
|
+
* ### Know values supported by the service
|
|
365
291
|
* **default**: Set to default for normal file processing. \
|
|
366
292
|
* **text**: Set to text to improve indexing performance on plain text files in blob storage. \
|
|
367
293
|
* **delimitedText**: Set to delimitedText when blobs are plain CSV files. \
|
|
@@ -375,7 +301,7 @@ export declare type BlobIndexerParsingMode = string;
|
|
|
375
301
|
* Defines values for BlobIndexerPDFTextRotationAlgorithm. \
|
|
376
302
|
* {@link KnownBlobIndexerPDFTextRotationAlgorithm} can be used interchangeably with BlobIndexerPDFTextRotationAlgorithm,
|
|
377
303
|
* this enum contains the known values that the service supports.
|
|
378
|
-
* ###
|
|
304
|
+
* ### Know values supported by the service
|
|
379
305
|
* **none**: Leverages normal text extraction. This is the default. \
|
|
380
306
|
* **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.
|
|
381
307
|
*/
|
|
@@ -386,37 +312,11 @@ export declare type BM25Similarity = Similarity & {
|
|
|
386
312
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
387
313
|
odatatype: "#Microsoft.Azure.Search.BM25Similarity";
|
|
388
314
|
/** 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. */
|
|
389
|
-
k1?: number;
|
|
315
|
+
k1?: number | null;
|
|
390
316
|
/** 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. */
|
|
391
|
-
b?: number;
|
|
317
|
+
b?: number | null;
|
|
392
318
|
};
|
|
393
319
|
|
|
394
|
-
/** 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'.. */
|
|
395
|
-
export declare interface CaptionResult {
|
|
396
|
-
/** Describes unknown properties. The value of an unknown property can be of "any" type. */
|
|
397
|
-
[property: string]: any;
|
|
398
|
-
/**
|
|
399
|
-
* A representative text passage extracted from the document most relevant to the search query.
|
|
400
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
401
|
-
*/
|
|
402
|
-
readonly text?: string;
|
|
403
|
-
/**
|
|
404
|
-
* Same text passage as in the Text property with highlighted phrases most relevant to the query.
|
|
405
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
406
|
-
*/
|
|
407
|
-
readonly highlights?: string;
|
|
408
|
-
}
|
|
409
|
-
|
|
410
|
-
/**
|
|
411
|
-
* Defines values for Captions. \
|
|
412
|
-
* {@link KnownCaptions} can be used interchangeably with Captions,
|
|
413
|
-
* this enum contains the known values that the service supports.
|
|
414
|
-
* ### Known values supported by the service
|
|
415
|
-
* **none**: Do not return captions for the query. \
|
|
416
|
-
* **extractive**: Extracts captions from the matching documents that contain passages relevant to the search query.
|
|
417
|
-
*/
|
|
418
|
-
export declare type Captions = string;
|
|
419
|
-
|
|
420
320
|
/**
|
|
421
321
|
* Contains the possible cases for CharFilter.
|
|
422
322
|
*/
|
|
@@ -426,8 +326,8 @@ export declare type CharFilter = MappingCharFilter | PatternReplaceCharFilter;
|
|
|
426
326
|
* Defines values for CharFilterName. \
|
|
427
327
|
* {@link KnownCharFilterName} can be used interchangeably with CharFilterName,
|
|
428
328
|
* this enum contains the known values that the service supports.
|
|
429
|
-
* ###
|
|
430
|
-
* **html_strip**: A character filter that attempts to strip out HTML constructs. See https
|
|
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
|
|
431
331
|
*/
|
|
432
332
|
export declare type CharFilterName = string;
|
|
433
333
|
|
|
@@ -522,7 +422,7 @@ export declare interface CorsOptions {
|
|
|
522
422
|
/** 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). */
|
|
523
423
|
allowedOrigins: string[];
|
|
524
424
|
/** The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes. */
|
|
525
|
-
maxAgeInSeconds?: number;
|
|
425
|
+
maxAgeInSeconds?: number | null;
|
|
526
426
|
}
|
|
527
427
|
|
|
528
428
|
/**
|
|
@@ -553,10 +453,6 @@ export declare interface CreateorUpdateDataSourceConnectionOptions extends Opera
|
|
|
553
453
|
* If set to true, Resource will be deleted only if the etag matches.
|
|
554
454
|
*/
|
|
555
455
|
onlyIfUnchanged?: boolean;
|
|
556
|
-
/**
|
|
557
|
-
* Ignores cache reset requirements.
|
|
558
|
-
*/
|
|
559
|
-
skipIndexerResetRequirementForCache?: boolean;
|
|
560
456
|
}
|
|
561
457
|
|
|
562
458
|
/**
|
|
@@ -567,10 +463,6 @@ export declare interface CreateorUpdateIndexerOptions extends OperationOptions {
|
|
|
567
463
|
* If set to true, Resource will be deleted only if the etag matches.
|
|
568
464
|
*/
|
|
569
465
|
onlyIfUnchanged?: boolean;
|
|
570
|
-
/** Ignores cache reset requirements. */
|
|
571
|
-
skipIndexerResetRequirementForCache?: boolean;
|
|
572
|
-
/** Disables cache reprocessing change detection. */
|
|
573
|
-
disableCacheReprocessingChangeDetection?: boolean;
|
|
574
466
|
}
|
|
575
467
|
|
|
576
468
|
/**
|
|
@@ -598,14 +490,6 @@ export declare interface CreateOrUpdateSkillsetOptions extends OperationOptions
|
|
|
598
490
|
* If set to true, Resource will be deleted only if the etag matches.
|
|
599
491
|
*/
|
|
600
492
|
onlyIfUnchanged?: boolean;
|
|
601
|
-
/**
|
|
602
|
-
* Ignores cache reset requirements.
|
|
603
|
-
*/
|
|
604
|
-
skipIndexerResetRequirementForCache?: boolean;
|
|
605
|
-
/**
|
|
606
|
-
* Disables cache reprocessing change detection.
|
|
607
|
-
*/
|
|
608
|
-
disableCacheReprocessingChangeDetection?: boolean;
|
|
609
493
|
}
|
|
610
494
|
|
|
611
495
|
/**
|
|
@@ -677,27 +561,27 @@ export declare interface CustomEntity {
|
|
|
677
561
|
/** 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. */
|
|
678
562
|
name: string;
|
|
679
563
|
/** 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. */
|
|
680
|
-
description?: string;
|
|
564
|
+
description?: string | null;
|
|
681
565
|
/** 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. */
|
|
682
|
-
type?: string;
|
|
566
|
+
type?: string | null;
|
|
683
567
|
/** 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. */
|
|
684
|
-
subtype?: string;
|
|
568
|
+
subtype?: string | null;
|
|
685
569
|
/** 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. */
|
|
686
|
-
id?: string;
|
|
570
|
+
id?: string | null;
|
|
687
571
|
/** 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. */
|
|
688
|
-
caseSensitive?: boolean;
|
|
572
|
+
caseSensitive?: boolean | null;
|
|
689
573
|
/** Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent. */
|
|
690
|
-
accentSensitive?: boolean;
|
|
574
|
+
accentSensitive?: boolean | null;
|
|
691
575
|
/** 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. */
|
|
692
|
-
fuzzyEditDistance?: number;
|
|
576
|
+
fuzzyEditDistance?: number | null;
|
|
693
577
|
/** Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values. */
|
|
694
|
-
defaultCaseSensitive?: boolean;
|
|
578
|
+
defaultCaseSensitive?: boolean | null;
|
|
695
579
|
/** Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values. */
|
|
696
|
-
defaultAccentSensitive?: boolean;
|
|
580
|
+
defaultAccentSensitive?: boolean | null;
|
|
697
581
|
/** Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values. */
|
|
698
|
-
defaultFuzzyEditDistance?: number;
|
|
582
|
+
defaultFuzzyEditDistance?: number | null;
|
|
699
583
|
/** An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name. */
|
|
700
|
-
aliases?: CustomEntityAlias[];
|
|
584
|
+
aliases?: CustomEntityAlias[] | null;
|
|
701
585
|
}
|
|
702
586
|
|
|
703
587
|
/** A complex object that can be used to specify alternative spellings or synonyms to the root entity name. */
|
|
@@ -705,11 +589,11 @@ export declare interface CustomEntityAlias {
|
|
|
705
589
|
/** The text of the alias. */
|
|
706
590
|
text: string;
|
|
707
591
|
/** Determine if the alias is case sensitive. */
|
|
708
|
-
caseSensitive?: boolean;
|
|
592
|
+
caseSensitive?: boolean | null;
|
|
709
593
|
/** Determine if the alias is accent sensitive. */
|
|
710
|
-
accentSensitive?: boolean;
|
|
594
|
+
accentSensitive?: boolean | null;
|
|
711
595
|
/** Determine the fuzzy edit distance of the alias. */
|
|
712
|
-
fuzzyEditDistance?: number;
|
|
596
|
+
fuzzyEditDistance?: number | null;
|
|
713
597
|
}
|
|
714
598
|
|
|
715
599
|
/** A skill looks for text from a custom, user-defined list of words and phrases. */
|
|
@@ -717,24 +601,24 @@ export declare type CustomEntityLookupSkill = BaseSearchIndexerSkill & {
|
|
|
717
601
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
718
602
|
odatatype: "#Microsoft.Skills.Text.CustomEntityLookupSkill";
|
|
719
603
|
/** A value indicating which language code to use. Default is en. */
|
|
720
|
-
defaultLanguageCode?: CustomEntityLookupSkillLanguage;
|
|
604
|
+
defaultLanguageCode?: CustomEntityLookupSkillLanguage | null;
|
|
721
605
|
/** 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. */
|
|
722
|
-
entitiesDefinitionUri?: string;
|
|
606
|
+
entitiesDefinitionUri?: string | null;
|
|
723
607
|
/** The inline CustomEntity definition. */
|
|
724
|
-
inlineEntitiesDefinition?: CustomEntity[];
|
|
608
|
+
inlineEntitiesDefinition?: CustomEntity[] | null;
|
|
725
609
|
/** A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value. */
|
|
726
|
-
globalDefaultCaseSensitive?: boolean;
|
|
610
|
+
globalDefaultCaseSensitive?: boolean | null;
|
|
727
611
|
/** A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value. */
|
|
728
|
-
globalDefaultAccentSensitive?: boolean;
|
|
612
|
+
globalDefaultAccentSensitive?: boolean | null;
|
|
729
613
|
/** A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value. */
|
|
730
|
-
globalDefaultFuzzyEditDistance?: number;
|
|
614
|
+
globalDefaultFuzzyEditDistance?: number | null;
|
|
731
615
|
};
|
|
732
616
|
|
|
733
617
|
/**
|
|
734
618
|
* Defines values for CustomEntityLookupSkillLanguage. \
|
|
735
619
|
* {@link KnownCustomEntityLookupSkillLanguage} can be used interchangeably with CustomEntityLookupSkillLanguage,
|
|
736
620
|
* this enum contains the known values that the service supports.
|
|
737
|
-
* ###
|
|
621
|
+
* ### Know values supported by the service
|
|
738
622
|
* **da**: Danish \
|
|
739
623
|
* **de**: German \
|
|
740
624
|
* **en**: English \
|
|
@@ -747,16 +631,6 @@ export declare type CustomEntityLookupSkill = BaseSearchIndexerSkill & {
|
|
|
747
631
|
*/
|
|
748
632
|
export declare type CustomEntityLookupSkillLanguage = string;
|
|
749
633
|
|
|
750
|
-
/** 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. */
|
|
751
|
-
export declare type CustomNormalizer = BaseLexicalNormalizer & {
|
|
752
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
753
|
-
odatatype: "#Microsoft.Azure.Search.CustomNormalizer";
|
|
754
|
-
/** 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. */
|
|
755
|
-
tokenFilters?: TokenFilterName[];
|
|
756
|
-
/** 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. */
|
|
757
|
-
charFilters?: CharFilterName[];
|
|
758
|
-
};
|
|
759
|
-
|
|
760
634
|
/**
|
|
761
635
|
* Contains the possible cases for DataChangeDetectionPolicy.
|
|
762
636
|
*/
|
|
@@ -880,13 +754,13 @@ export declare type DocumentExtractionSkill = BaseSearchIndexerSkill & {
|
|
|
880
754
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
881
755
|
odatatype: "#Microsoft.Skills.Util.DocumentExtractionSkill";
|
|
882
756
|
/** The parsingMode for the skill. Will be set to 'default' if not defined. */
|
|
883
|
-
parsingMode?: string;
|
|
757
|
+
parsingMode?: string | null;
|
|
884
758
|
/** The type of data to be extracted for the skill. Will be set to 'contentAndMetadata' if not defined. */
|
|
885
|
-
dataToExtract?: string;
|
|
759
|
+
dataToExtract?: string | null;
|
|
886
760
|
/** A dictionary of configurations for the skill. */
|
|
887
761
|
configuration?: {
|
|
888
|
-
[propertyName: string]:
|
|
889
|
-
};
|
|
762
|
+
[propertyName: string]: any;
|
|
763
|
+
} | null;
|
|
890
764
|
};
|
|
891
765
|
|
|
892
766
|
/**
|
|
@@ -947,7 +821,7 @@ export declare type ElisionTokenFilter = BaseTokenFilter & {
|
|
|
947
821
|
* Defines values for EntityCategory. \
|
|
948
822
|
* {@link KnownEntityCategory} can be used interchangeably with EntityCategory,
|
|
949
823
|
* this enum contains the known values that the service supports.
|
|
950
|
-
* ###
|
|
824
|
+
* ### Know values supported by the service
|
|
951
825
|
* **location**: Entities describing a physical location. \
|
|
952
826
|
* **organization**: Entities describing an organization. \
|
|
953
827
|
* **person**: Entities describing a person. \
|
|
@@ -958,18 +832,6 @@ export declare type ElisionTokenFilter = BaseTokenFilter & {
|
|
|
958
832
|
*/
|
|
959
833
|
export declare type EntityCategory = string;
|
|
960
834
|
|
|
961
|
-
/** Using the Text Analytics API, extracts linked entities from text. */
|
|
962
|
-
export declare type EntityLinkingSkill = BaseSearchIndexerSkill & {
|
|
963
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
964
|
-
odatatype: "#Microsoft.Skills.Text.V3.EntityLinkingSkill";
|
|
965
|
-
/** A value indicating which language code to use. Default is en. */
|
|
966
|
-
defaultLanguageCode?: string;
|
|
967
|
-
/** 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. */
|
|
968
|
-
minimumPrecision?: number;
|
|
969
|
-
/** 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. */
|
|
970
|
-
modelVersion?: string;
|
|
971
|
-
};
|
|
972
|
-
|
|
973
835
|
/** Text analytics entity recognition. */
|
|
974
836
|
export declare type EntityRecognitionSkill = BaseSearchIndexerSkill & {
|
|
975
837
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -979,16 +841,16 @@ export declare type EntityRecognitionSkill = BaseSearchIndexerSkill & {
|
|
|
979
841
|
/** A value indicating which language code to use. Default is en. */
|
|
980
842
|
defaultLanguageCode?: EntityRecognitionSkillLanguage;
|
|
981
843
|
/** 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. */
|
|
982
|
-
includeTypelessEntities?: boolean;
|
|
844
|
+
includeTypelessEntities?: boolean | null;
|
|
983
845
|
/** 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. */
|
|
984
|
-
minimumPrecision?: number;
|
|
846
|
+
minimumPrecision?: number | null;
|
|
985
847
|
};
|
|
986
848
|
|
|
987
849
|
/**
|
|
988
850
|
* Defines values for EntityRecognitionSkillLanguage. \
|
|
989
851
|
* {@link KnownEntityRecognitionSkillLanguage} can be used interchangeably with EntityRecognitionSkillLanguage,
|
|
990
852
|
* this enum contains the known values that the service supports.
|
|
991
|
-
* ###
|
|
853
|
+
* ### Know values supported by the service
|
|
992
854
|
* **ar**: Arabic \
|
|
993
855
|
* **cs**: Czech \
|
|
994
856
|
* **zh-Hans**: Chinese-Simplified \
|
|
@@ -1015,20 +877,6 @@ export declare type EntityRecognitionSkill = BaseSearchIndexerSkill & {
|
|
|
1015
877
|
*/
|
|
1016
878
|
export declare type EntityRecognitionSkillLanguage = string;
|
|
1017
879
|
|
|
1018
|
-
/** Using the Text Analytics API, extracts entities of different types from text. */
|
|
1019
|
-
export declare type EntityRecognitionSkillV3 = BaseSearchIndexerSkill & {
|
|
1020
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1021
|
-
odatatype: "#Microsoft.Skills.Text.V3.EntityRecognitionSkill";
|
|
1022
|
-
/** A list of entity categories that should be extracted. */
|
|
1023
|
-
categories?: string[];
|
|
1024
|
-
/** A value indicating which language code to use. Default is en. */
|
|
1025
|
-
defaultLanguageCode?: string;
|
|
1026
|
-
/** 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. */
|
|
1027
|
-
minimumPrecision?: number;
|
|
1028
|
-
/** 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. */
|
|
1029
|
-
modelVersion?: string;
|
|
1030
|
-
};
|
|
1031
|
-
|
|
1032
880
|
/** 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. */
|
|
1033
881
|
export declare interface FacetResult {
|
|
1034
882
|
/** Describes unknown properties. The value of an unknown property can be of "any" type. */
|
|
@@ -1047,7 +895,7 @@ export declare interface FieldMapping {
|
|
|
1047
895
|
/** The name of the target field in the index. Same as the source field name by default. */
|
|
1048
896
|
targetFieldName?: string;
|
|
1049
897
|
/** A function to apply to each source field value before indexing. */
|
|
1050
|
-
mappingFunction?: FieldMappingFunction;
|
|
898
|
+
mappingFunction?: FieldMappingFunction | null;
|
|
1051
899
|
}
|
|
1052
900
|
|
|
1053
901
|
/** Represents a function that transforms a value from a data source before indexing. */
|
|
@@ -1056,7 +904,7 @@ export declare interface FieldMappingFunction {
|
|
|
1056
904
|
name: string;
|
|
1057
905
|
/** A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. */
|
|
1058
906
|
parameters?: {
|
|
1059
|
-
[propertyName: string]:
|
|
907
|
+
[propertyName: string]: any;
|
|
1060
908
|
};
|
|
1061
909
|
}
|
|
1062
910
|
|
|
@@ -1176,7 +1024,7 @@ export declare type ImageAnalysisSkill = BaseSearchIndexerSkill & {
|
|
|
1176
1024
|
* Defines values for ImageAnalysisSkillLanguage. \
|
|
1177
1025
|
* {@link KnownImageAnalysisSkillLanguage} can be used interchangeably with ImageAnalysisSkillLanguage,
|
|
1178
1026
|
* this enum contains the known values that the service supports.
|
|
1179
|
-
* ###
|
|
1027
|
+
* ### Know values supported by the service
|
|
1180
1028
|
* **en**: English \
|
|
1181
1029
|
* **es**: Spanish \
|
|
1182
1030
|
* **ja**: Japanese \
|
|
@@ -1189,7 +1037,7 @@ export declare type ImageAnalysisSkillLanguage = string;
|
|
|
1189
1037
|
* Defines values for ImageDetail. \
|
|
1190
1038
|
* {@link KnownImageDetail} can be used interchangeably with ImageDetail,
|
|
1191
1039
|
* this enum contains the known values that the service supports.
|
|
1192
|
-
* ###
|
|
1040
|
+
* ### Know values supported by the service
|
|
1193
1041
|
* **celebrities**: Details recognized as celebrities. \
|
|
1194
1042
|
* **landmarks**: Details recognized as landmarks.
|
|
1195
1043
|
*/
|
|
@@ -1287,7 +1135,7 @@ export declare interface IndexDocumentsResult {
|
|
|
1287
1135
|
* Defines values for IndexerExecutionEnvironment. \
|
|
1288
1136
|
* {@link KnownIndexerExecutionEnvironment} can be used interchangeably with IndexerExecutionEnvironment,
|
|
1289
1137
|
* this enum contains the known values that the service supports.
|
|
1290
|
-
* ###
|
|
1138
|
+
* ### Know values supported by the service
|
|
1291
1139
|
* **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. \
|
|
1292
1140
|
* **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.
|
|
1293
1141
|
*/
|
|
@@ -1300,16 +1148,6 @@ export declare interface IndexerExecutionResult {
|
|
|
1300
1148
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1301
1149
|
*/
|
|
1302
1150
|
readonly status: IndexerExecutionStatus;
|
|
1303
|
-
/**
|
|
1304
|
-
* The outcome of this indexer execution.
|
|
1305
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1306
|
-
*/
|
|
1307
|
-
readonly statusDetail?: IndexerExecutionStatusDetail;
|
|
1308
|
-
/**
|
|
1309
|
-
* All of the state that defines and dictates the indexer's current execution.
|
|
1310
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1311
|
-
*/
|
|
1312
|
-
readonly currentState?: IndexerState;
|
|
1313
1151
|
/**
|
|
1314
1152
|
* The error message indicating the top-level error, if any.
|
|
1315
1153
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
@@ -1324,7 +1162,7 @@ export declare interface IndexerExecutionResult {
|
|
|
1324
1162
|
* The end time of this indexer execution, if the execution has already completed.
|
|
1325
1163
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1326
1164
|
*/
|
|
1327
|
-
readonly endTime?: Date;
|
|
1165
|
+
readonly endTime?: Date | null;
|
|
1328
1166
|
/**
|
|
1329
1167
|
* The item-level indexing errors.
|
|
1330
1168
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
@@ -1360,75 +1198,17 @@ export declare interface IndexerExecutionResult {
|
|
|
1360
1198
|
/** Defines values for IndexerExecutionStatus. */
|
|
1361
1199
|
export declare type IndexerExecutionStatus = "transientFailure" | "success" | "inProgress" | "reset";
|
|
1362
1200
|
|
|
1363
|
-
/**
|
|
1364
|
-
* Defines values for IndexerExecutionStatusDetail. \
|
|
1365
|
-
* {@link KnownIndexerExecutionStatusDetail} can be used interchangeably with IndexerExecutionStatusDetail,
|
|
1366
|
-
* this enum contains the known values that the service supports.
|
|
1367
|
-
* ### Known values supported by the service
|
|
1368
|
-
* **resetDocs**: Indicates that the reset that occurred was for a call to ResetDocs.
|
|
1369
|
-
*/
|
|
1370
|
-
export declare type IndexerExecutionStatusDetail = string;
|
|
1371
|
-
|
|
1372
|
-
/** Represents all of the state that defines and dictates the indexer's current execution. */
|
|
1373
|
-
export declare interface IndexerState {
|
|
1374
|
-
/**
|
|
1375
|
-
* The mode the indexer is running in.
|
|
1376
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1377
|
-
*/
|
|
1378
|
-
readonly mode?: IndexingMode;
|
|
1379
|
-
/**
|
|
1380
|
-
* Change tracking state used when indexing starts on all documents in the datasource.
|
|
1381
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1382
|
-
*/
|
|
1383
|
-
readonly allDocumentsInitialChangeTrackingState?: string;
|
|
1384
|
-
/**
|
|
1385
|
-
* Change tracking state value when indexing finishes on all documents in the datasource.
|
|
1386
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1387
|
-
*/
|
|
1388
|
-
readonly allDocumentsFinalChangeTrackingState?: string;
|
|
1389
|
-
/**
|
|
1390
|
-
* Change tracking state used when indexing starts on select, reset documents in the datasource.
|
|
1391
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1392
|
-
*/
|
|
1393
|
-
readonly resetDocumentsInitialChangeTrackingState?: string;
|
|
1394
|
-
/**
|
|
1395
|
-
* Change tracking state value when indexing finishes on select, reset documents in the datasource.
|
|
1396
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1397
|
-
*/
|
|
1398
|
-
readonly resetDocumentsFinalChangeTrackingState?: string;
|
|
1399
|
-
/**
|
|
1400
|
-
* The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys.
|
|
1401
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1402
|
-
*/
|
|
1403
|
-
readonly resetDocumentKeys?: string[];
|
|
1404
|
-
/**
|
|
1405
|
-
* The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids.
|
|
1406
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1407
|
-
*/
|
|
1408
|
-
readonly resetDatasourceDocumentIds?: string[];
|
|
1409
|
-
}
|
|
1410
|
-
|
|
1411
1201
|
/** Defines values for IndexerStatus. */
|
|
1412
1202
|
export declare type IndexerStatus = "unknown" | "error" | "running";
|
|
1413
1203
|
|
|
1414
|
-
/**
|
|
1415
|
-
* Defines values for IndexingMode. \
|
|
1416
|
-
* {@link KnownIndexingMode} can be used interchangeably with IndexingMode,
|
|
1417
|
-
* this enum contains the known values that the service supports.
|
|
1418
|
-
* ### Known values supported by the service
|
|
1419
|
-
* **indexingAllDocs**: The indexer is indexing all documents in the datasource. \
|
|
1420
|
-
* **indexingResetDocs**: The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status.
|
|
1421
|
-
*/
|
|
1422
|
-
export declare type IndexingMode = string;
|
|
1423
|
-
|
|
1424
1204
|
/** Represents parameters for indexer execution. */
|
|
1425
1205
|
export declare interface IndexingParameters {
|
|
1426
1206
|
/** 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. */
|
|
1427
|
-
batchSize?: number;
|
|
1207
|
+
batchSize?: number | null;
|
|
1428
1208
|
/** The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. */
|
|
1429
|
-
maxFailedItems?: number;
|
|
1209
|
+
maxFailedItems?: number | null;
|
|
1430
1210
|
/** 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. */
|
|
1431
|
-
maxFailedItemsPerBatch?: number;
|
|
1211
|
+
maxFailedItemsPerBatch?: number | null;
|
|
1432
1212
|
/** A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. */
|
|
1433
1213
|
configuration?: IndexingParametersConfiguration;
|
|
1434
1214
|
}
|
|
@@ -1546,16 +1326,16 @@ export declare type KeyPhraseExtractionSkill = BaseSearchIndexerSkill & {
|
|
|
1546
1326
|
/** A value indicating which language code to use. Default is en. */
|
|
1547
1327
|
defaultLanguageCode?: KeyPhraseExtractionSkillLanguage;
|
|
1548
1328
|
/** A number indicating how many key phrases to return. If absent, all identified key phrases will be returned. */
|
|
1549
|
-
maxKeyPhraseCount?: number;
|
|
1329
|
+
maxKeyPhraseCount?: number | null;
|
|
1550
1330
|
/** 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. */
|
|
1551
|
-
modelVersion?: string;
|
|
1331
|
+
modelVersion?: string | null;
|
|
1552
1332
|
};
|
|
1553
1333
|
|
|
1554
1334
|
/**
|
|
1555
1335
|
* Defines values for KeyPhraseExtractionSkillLanguage. \
|
|
1556
1336
|
* {@link KnownKeyPhraseExtractionSkillLanguage} can be used interchangeably with KeyPhraseExtractionSkillLanguage,
|
|
1557
1337
|
* this enum contains the known values that the service supports.
|
|
1558
|
-
* ###
|
|
1338
|
+
* ### Know values supported by the service
|
|
1559
1339
|
* **da**: Danish \
|
|
1560
1340
|
* **nl**: Dutch \
|
|
1561
1341
|
* **en**: English \
|
|
@@ -1985,16 +1765,8 @@ export declare enum KnownAnalyzerNames {
|
|
|
1985
1765
|
Whitespace = "whitespace"
|
|
1986
1766
|
}
|
|
1987
1767
|
|
|
1988
|
-
/** Known values of {@link Answers} that the service accepts. */
|
|
1989
|
-
export declare enum KnownAnswers {
|
|
1990
|
-
/** Do not return answers for the query. */
|
|
1991
|
-
None = "none",
|
|
1992
|
-
/** Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. */
|
|
1993
|
-
Extractive = "extractive"
|
|
1994
|
-
}
|
|
1995
|
-
|
|
1996
1768
|
/** Known values of {@link BlobIndexerDataToExtract} that the service accepts. */
|
|
1997
|
-
export declare enum KnownBlobIndexerDataToExtract {
|
|
1769
|
+
export declare const enum KnownBlobIndexerDataToExtract {
|
|
1998
1770
|
/** Indexes just the standard blob properties and user-specified metadata. */
|
|
1999
1771
|
StorageMetadata = "storageMetadata",
|
|
2000
1772
|
/** 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). */
|
|
@@ -2004,7 +1776,7 @@ export declare enum KnownBlobIndexerDataToExtract {
|
|
|
2004
1776
|
}
|
|
2005
1777
|
|
|
2006
1778
|
/** Known values of {@link BlobIndexerImageAction} that the service accepts. */
|
|
2007
|
-
export declare enum KnownBlobIndexerImageAction {
|
|
1779
|
+
export declare const enum KnownBlobIndexerImageAction {
|
|
2008
1780
|
/** Ignores embedded images or image files in the data set. This is the default. */
|
|
2009
1781
|
None = "none",
|
|
2010
1782
|
/** 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. */
|
|
@@ -2014,7 +1786,7 @@ export declare enum KnownBlobIndexerImageAction {
|
|
|
2014
1786
|
}
|
|
2015
1787
|
|
|
2016
1788
|
/** Known values of {@link BlobIndexerParsingMode} that the service accepts. */
|
|
2017
|
-
export declare enum KnownBlobIndexerParsingMode {
|
|
1789
|
+
export declare const enum KnownBlobIndexerParsingMode {
|
|
2018
1790
|
/** Set to default for normal file processing. */
|
|
2019
1791
|
Default = "default",
|
|
2020
1792
|
/** Set to text to improve indexing performance on plain text files in blob storage. */
|
|
@@ -2030,7 +1802,7 @@ export declare enum KnownBlobIndexerParsingMode {
|
|
|
2030
1802
|
}
|
|
2031
1803
|
|
|
2032
1804
|
/** Known values of {@link BlobIndexerPDFTextRotationAlgorithm} that the service accepts. */
|
|
2033
|
-
export declare enum KnownBlobIndexerPDFTextRotationAlgorithm {
|
|
1805
|
+
export declare const enum KnownBlobIndexerPDFTextRotationAlgorithm {
|
|
2034
1806
|
/** Leverages normal text extraction. This is the default. */
|
|
2035
1807
|
None = "none",
|
|
2036
1808
|
/** 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. */
|
|
@@ -2038,7 +1810,7 @@ export declare enum KnownBlobIndexerPDFTextRotationAlgorithm {
|
|
|
2038
1810
|
}
|
|
2039
1811
|
|
|
2040
1812
|
/** Known values of {@link CharFilterName} that the service accepts. */
|
|
2041
|
-
export declare enum KnownCharFilterName {
|
|
1813
|
+
export declare const enum KnownCharFilterName {
|
|
2042
1814
|
/** 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 */
|
|
2043
1815
|
HtmlStrip = "html_strip"
|
|
2044
1816
|
}
|
|
@@ -2056,7 +1828,7 @@ export declare enum KnownCharFilterNames {
|
|
|
2056
1828
|
}
|
|
2057
1829
|
|
|
2058
1830
|
/** Known values of {@link CustomEntityLookupSkillLanguage} that the service accepts. */
|
|
2059
|
-
export declare enum KnownCustomEntityLookupSkillLanguage {
|
|
1831
|
+
export declare const enum KnownCustomEntityLookupSkillLanguage {
|
|
2060
1832
|
/** Danish */
|
|
2061
1833
|
Da = "da",
|
|
2062
1834
|
/** German */
|
|
@@ -2078,7 +1850,7 @@ export declare enum KnownCustomEntityLookupSkillLanguage {
|
|
|
2078
1850
|
}
|
|
2079
1851
|
|
|
2080
1852
|
/** Known values of {@link EntityCategory} that the service accepts. */
|
|
2081
|
-
export declare enum KnownEntityCategory {
|
|
1853
|
+
export declare const enum KnownEntityCategory {
|
|
2082
1854
|
/** Entities describing a physical location. */
|
|
2083
1855
|
Location = "location",
|
|
2084
1856
|
/** Entities describing an organization. */
|
|
@@ -2096,7 +1868,7 @@ export declare enum KnownEntityCategory {
|
|
|
2096
1868
|
}
|
|
2097
1869
|
|
|
2098
1870
|
/** Known values of {@link EntityRecognitionSkillLanguage} that the service accepts. */
|
|
2099
|
-
export declare enum KnownEntityRecognitionSkillLanguage {
|
|
1871
|
+
export declare const enum KnownEntityRecognitionSkillLanguage {
|
|
2100
1872
|
/** Arabic */
|
|
2101
1873
|
Ar = "ar",
|
|
2102
1874
|
/** Czech */
|
|
@@ -2146,7 +1918,7 @@ export declare enum KnownEntityRecognitionSkillLanguage {
|
|
|
2146
1918
|
}
|
|
2147
1919
|
|
|
2148
1920
|
/** Known values of {@link ImageAnalysisSkillLanguage} that the service accepts. */
|
|
2149
|
-
export declare enum KnownImageAnalysisSkillLanguage {
|
|
1921
|
+
export declare const enum KnownImageAnalysisSkillLanguage {
|
|
2150
1922
|
/** English */
|
|
2151
1923
|
En = "en",
|
|
2152
1924
|
/** Spanish */
|
|
@@ -2160,29 +1932,15 @@ export declare enum KnownImageAnalysisSkillLanguage {
|
|
|
2160
1932
|
}
|
|
2161
1933
|
|
|
2162
1934
|
/** Known values of {@link ImageDetail} that the service accepts. */
|
|
2163
|
-
export declare enum KnownImageDetail {
|
|
1935
|
+
export declare const enum KnownImageDetail {
|
|
2164
1936
|
/** Details recognized as celebrities. */
|
|
2165
1937
|
Celebrities = "celebrities",
|
|
2166
1938
|
/** Details recognized as landmarks. */
|
|
2167
1939
|
Landmarks = "landmarks"
|
|
2168
1940
|
}
|
|
2169
1941
|
|
|
2170
|
-
/** Known values of {@link IndexerExecutionStatusDetail} that the service accepts. */
|
|
2171
|
-
export declare enum KnownIndexerExecutionStatusDetail {
|
|
2172
|
-
/** Indicates that the reset that occurred was for a call to ResetDocs. */
|
|
2173
|
-
ResetDocs = "resetDocs"
|
|
2174
|
-
}
|
|
2175
|
-
|
|
2176
|
-
/** Known values of {@link IndexingMode} that the service accepts. */
|
|
2177
|
-
export declare enum KnownIndexingMode {
|
|
2178
|
-
/** The indexer is indexing all documents in the datasource. */
|
|
2179
|
-
IndexingAllDocs = "indexingAllDocs",
|
|
2180
|
-
/** The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status. */
|
|
2181
|
-
IndexingResetDocs = "indexingResetDocs"
|
|
2182
|
-
}
|
|
2183
|
-
|
|
2184
1942
|
/** Known values of {@link KeyPhraseExtractionSkillLanguage} that the service accepts. */
|
|
2185
|
-
export declare enum KnownKeyPhraseExtractionSkillLanguage {
|
|
1943
|
+
export declare const enum KnownKeyPhraseExtractionSkillLanguage {
|
|
2186
1944
|
/** Danish */
|
|
2187
1945
|
Da = "da",
|
|
2188
1946
|
/** Dutch */
|
|
@@ -2218,7 +1976,7 @@ export declare enum KnownKeyPhraseExtractionSkillLanguage {
|
|
|
2218
1976
|
}
|
|
2219
1977
|
|
|
2220
1978
|
/** Known values of {@link LexicalAnalyzerName} that the service accepts. */
|
|
2221
|
-
export declare enum KnownLexicalAnalyzerName {
|
|
1979
|
+
export declare const enum KnownLexicalAnalyzerName {
|
|
2222
1980
|
/** Microsoft analyzer for Arabic. */
|
|
2223
1981
|
ArMicrosoft = "ar.microsoft",
|
|
2224
1982
|
/** Lucene analyzer for Arabic. */
|
|
@@ -2407,34 +2165,8 @@ export declare enum KnownLexicalAnalyzerName {
|
|
|
2407
2165
|
Whitespace = "whitespace"
|
|
2408
2166
|
}
|
|
2409
2167
|
|
|
2410
|
-
/** Known values of {@link LexicalNormalizerName} that the service accepts. */
|
|
2411
|
-
export declare enum KnownLexicalNormalizerName {
|
|
2412
|
-
/** Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html */
|
|
2413
|
-
AsciiFolding = "asciifolding",
|
|
2414
|
-
/** Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html */
|
|
2415
|
-
Elision = "elision",
|
|
2416
|
-
/** Normalizes token text to lowercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html */
|
|
2417
|
-
Lowercase = "lowercase",
|
|
2418
|
-
/** 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 */
|
|
2419
|
-
Standard = "standard",
|
|
2420
|
-
/** Normalizes token text to uppercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html */
|
|
2421
|
-
Uppercase = "uppercase"
|
|
2422
|
-
}
|
|
2423
|
-
|
|
2424
|
-
/** Known values of {@link LineEnding} that the service accepts. */
|
|
2425
|
-
export declare enum KnownLineEnding {
|
|
2426
|
-
/** Lines are separated by a single space character. */
|
|
2427
|
-
Space = "space",
|
|
2428
|
-
/** Lines are separated by a carriage return ('\r') character. */
|
|
2429
|
-
CarriageReturn = "carriageReturn",
|
|
2430
|
-
/** Lines are separated by a single line feed ('\n') character. */
|
|
2431
|
-
LineFeed = "lineFeed",
|
|
2432
|
-
/** Lines are separated by a carriage return and a line feed ('\r\n') character. */
|
|
2433
|
-
CarriageReturnLineFeed = "carriageReturnLineFeed"
|
|
2434
|
-
}
|
|
2435
|
-
|
|
2436
2168
|
/** Known values of {@link OcrSkillLanguage} that the service accepts. */
|
|
2437
|
-
export declare enum KnownOcrSkillLanguage {
|
|
2169
|
+
export declare const enum KnownOcrSkillLanguage {
|
|
2438
2170
|
/** Chinese-Simplified */
|
|
2439
2171
|
ZhHans = "zh-Hans",
|
|
2440
2172
|
/** Chinese-Traditional */
|
|
@@ -2486,193 +2218,11 @@ export declare enum KnownOcrSkillLanguage {
|
|
|
2486
2218
|
/** Serbian (Latin, Serbia) */
|
|
2487
2219
|
SrLatn = "sr-Latn",
|
|
2488
2220
|
/** Slovak */
|
|
2489
|
-
Sk = "sk"
|
|
2490
|
-
/** Unknown. If the language is explicitly set to "unk", the language will be auto-detected. */
|
|
2491
|
-
Unk = "unk"
|
|
2492
|
-
}
|
|
2493
|
-
|
|
2494
|
-
/** Known values of {@link PIIDetectionSkillMaskingMode} that the service accepts. */
|
|
2495
|
-
export declare enum KnownPIIDetectionSkillMaskingMode {
|
|
2496
|
-
/** No masking occurs and the maskedText output will not be returned. */
|
|
2497
|
-
None = "none",
|
|
2498
|
-
/** Replaces the detected entities with the character given in the maskingCharacter parameter. The character will be repeated to the length of the detected entity so that the offsets will correctly correspond to both the input text as well as the output maskedText. */
|
|
2499
|
-
Replace = "replace"
|
|
2500
|
-
}
|
|
2501
|
-
|
|
2502
|
-
/** Known values of {@link QueryAnswerType} that the service accepts. */
|
|
2503
|
-
export declare enum KnownQueryAnswerType {
|
|
2504
|
-
/** Do not return answers for the query. */
|
|
2505
|
-
None = "none",
|
|
2506
|
-
/** Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. */
|
|
2507
|
-
Extractive = "extractive"
|
|
2508
|
-
}
|
|
2509
|
-
|
|
2510
|
-
/** Known values of {@link QueryCaptionType} that the service accepts. */
|
|
2511
|
-
export declare enum KnownQueryCaptionType {
|
|
2512
|
-
/** Do not return captions for the query. */
|
|
2513
|
-
None = "none",
|
|
2514
|
-
/** Extracts captions from the matching documents that contain passages relevant to the search query. */
|
|
2515
|
-
Extractive = "extractive"
|
|
2516
|
-
}
|
|
2517
|
-
|
|
2518
|
-
/** Known values of {@link QueryLanguage} that the service accepts. */
|
|
2519
|
-
export declare enum KnownQueryLanguage {
|
|
2520
|
-
/** Query language not specified. */
|
|
2521
|
-
None = "none",
|
|
2522
|
-
/** Query language value for English (United States). */
|
|
2523
|
-
EnUs = "en-us",
|
|
2524
|
-
/** Query language value for English (Great Britain). */
|
|
2525
|
-
EnGb = "en-gb",
|
|
2526
|
-
/** Query language value for English (India). */
|
|
2527
|
-
EnIn = "en-in",
|
|
2528
|
-
/** Query language value for English (Canada). */
|
|
2529
|
-
EnCa = "en-ca",
|
|
2530
|
-
/** Query language value for English (Australia). */
|
|
2531
|
-
EnAu = "en-au",
|
|
2532
|
-
/** Query language value for French (France). */
|
|
2533
|
-
FrFr = "fr-fr",
|
|
2534
|
-
/** Query language value for French (Canada). */
|
|
2535
|
-
FrCa = "fr-ca",
|
|
2536
|
-
/** Query language value for German (Germany). */
|
|
2537
|
-
DeDe = "de-de",
|
|
2538
|
-
/** Query language value for Spanish (Spain). */
|
|
2539
|
-
EsEs = "es-es",
|
|
2540
|
-
/** Query language value for Spanish (Mexico). */
|
|
2541
|
-
EsMx = "es-mx",
|
|
2542
|
-
/** Query language value for Chinese (China). */
|
|
2543
|
-
ZhCn = "zh-cn",
|
|
2544
|
-
/** Query language value for Chinese (Taiwan). */
|
|
2545
|
-
ZhTw = "zh-tw",
|
|
2546
|
-
/** Query language value for Portuguese (Brazil). */
|
|
2547
|
-
PtBr = "pt-br",
|
|
2548
|
-
/** Query language value for Portuguese (Portugal). */
|
|
2549
|
-
PtPt = "pt-pt",
|
|
2550
|
-
/** Query language value for Italian (Italy). */
|
|
2551
|
-
ItIt = "it-it",
|
|
2552
|
-
/** Query language value for Japanese (Japan). */
|
|
2553
|
-
JaJp = "ja-jp",
|
|
2554
|
-
/** Query language value for Korean (Korea). */
|
|
2555
|
-
KoKr = "ko-kr",
|
|
2556
|
-
/** Query language value for Russian (Russia). */
|
|
2557
|
-
RuRu = "ru-ru",
|
|
2558
|
-
/** Query language value for Czech (Czech Republic). */
|
|
2559
|
-
CsCz = "cs-cz",
|
|
2560
|
-
/** Query language value for Dutch (Belgium). */
|
|
2561
|
-
NlBe = "nl-be",
|
|
2562
|
-
/** Query language value for Dutch (Netherlands). */
|
|
2563
|
-
NlNl = "nl-nl",
|
|
2564
|
-
/** Query language value for Hungarian (Hungary). */
|
|
2565
|
-
HuHu = "hu-hu",
|
|
2566
|
-
/** Query language value for Polish (Poland). */
|
|
2567
|
-
PlPl = "pl-pl",
|
|
2568
|
-
/** Query language value for Swedish (Sweden). */
|
|
2569
|
-
SvSe = "sv-se",
|
|
2570
|
-
/** Query language value for Turkish (Turkey). */
|
|
2571
|
-
TrTr = "tr-tr",
|
|
2572
|
-
/** Query language value for Hindi (India). */
|
|
2573
|
-
HiIn = "hi-in",
|
|
2574
|
-
/** Query language value for Arabic (Saudi Arabia). */
|
|
2575
|
-
ArSa = "ar-sa",
|
|
2576
|
-
/** Query language value for Arabic (Egypt). */
|
|
2577
|
-
ArEg = "ar-eg",
|
|
2578
|
-
/** Query language value for Arabic (Morocco). */
|
|
2579
|
-
ArMa = "ar-ma",
|
|
2580
|
-
/** Query language value for Arabic (Kuwait). */
|
|
2581
|
-
ArKw = "ar-kw",
|
|
2582
|
-
/** Query language value for Arabic (Jordan). */
|
|
2583
|
-
ArJo = "ar-jo",
|
|
2584
|
-
/** Query language value for Danish (Denmark). */
|
|
2585
|
-
DaDk = "da-dk",
|
|
2586
|
-
/** Query language value for Norwegian (Norway). */
|
|
2587
|
-
NoNo = "no-no",
|
|
2588
|
-
/** Query language value for Bulgarian (Bulgaria). */
|
|
2589
|
-
BgBg = "bg-bg",
|
|
2590
|
-
/** Query language value for Croatian (Croatia). */
|
|
2591
|
-
HrHr = "hr-hr",
|
|
2592
|
-
/** Query language value for Croatian (Bosnia and Herzegovina). */
|
|
2593
|
-
HrBa = "hr-ba",
|
|
2594
|
-
/** Query language value for Malay (Malaysia). */
|
|
2595
|
-
MsMy = "ms-my",
|
|
2596
|
-
/** Query language value for Malay (Brunei Darussalam). */
|
|
2597
|
-
MsBn = "ms-bn",
|
|
2598
|
-
/** Query language value for Slovenian (Slovenia). */
|
|
2599
|
-
SlSl = "sl-sl",
|
|
2600
|
-
/** Query language value for Tamil (India). */
|
|
2601
|
-
TaIn = "ta-in",
|
|
2602
|
-
/** Query language value for Vietnamese (Viet Nam). */
|
|
2603
|
-
ViVn = "vi-vn",
|
|
2604
|
-
/** Query language value for Greek (Greece). */
|
|
2605
|
-
ElGr = "el-gr",
|
|
2606
|
-
/** Query language value for Romanian (Romania). */
|
|
2607
|
-
RoRo = "ro-ro",
|
|
2608
|
-
/** Query language value for Icelandic (Iceland). */
|
|
2609
|
-
IsIs = "is-is",
|
|
2610
|
-
/** Query language value for Indonesian (Indonesia). */
|
|
2611
|
-
IdId = "id-id",
|
|
2612
|
-
/** Query language value for Thai (Thailand). */
|
|
2613
|
-
ThTh = "th-th",
|
|
2614
|
-
/** Query language value for Lithuanian (Lithuania). */
|
|
2615
|
-
LtLt = "lt-lt",
|
|
2616
|
-
/** Query language value for Ukrainian (Ukraine). */
|
|
2617
|
-
UkUa = "uk-ua",
|
|
2618
|
-
/** Query language value for Latvian (Latvia). */
|
|
2619
|
-
LvLv = "lv-lv",
|
|
2620
|
-
/** Query language value for Estonian (Estonia). */
|
|
2621
|
-
EtEe = "et-ee",
|
|
2622
|
-
/** Query language value for Catalan (Spain). */
|
|
2623
|
-
CaEs = "ca-es",
|
|
2624
|
-
/** Query language value for Finnish (Finland). */
|
|
2625
|
-
FiFi = "fi-fi",
|
|
2626
|
-
/** Query language value for Serbian (Bosnia and Herzegovina). */
|
|
2627
|
-
SrBa = "sr-ba",
|
|
2628
|
-
/** Query language value for Serbian (Montenegro). */
|
|
2629
|
-
SrMe = "sr-me",
|
|
2630
|
-
/** Query language value for Serbian (Serbia). */
|
|
2631
|
-
SrRs = "sr-rs",
|
|
2632
|
-
/** Query language value for Slovak (Slovakia). */
|
|
2633
|
-
SkSk = "sk-sk",
|
|
2634
|
-
/** Query language value for Norwegian (Norway). */
|
|
2635
|
-
NbNo = "nb-no",
|
|
2636
|
-
/** Query language value for Armenian (Armenia). */
|
|
2637
|
-
HyAm = "hy-am",
|
|
2638
|
-
/** Query language value for Bengali (India). */
|
|
2639
|
-
BnIn = "bn-in",
|
|
2640
|
-
/** Query language value for Basque (Spain). */
|
|
2641
|
-
EuEs = "eu-es",
|
|
2642
|
-
/** Query language value for Galician (Spain). */
|
|
2643
|
-
GlEs = "gl-es",
|
|
2644
|
-
/** Query language value for Gujarati (India). */
|
|
2645
|
-
GuIn = "gu-in",
|
|
2646
|
-
/** Query language value for Hebrew (Israel). */
|
|
2647
|
-
HeIl = "he-il",
|
|
2648
|
-
/** Query language value for Irish (Ireland). */
|
|
2649
|
-
GaIe = "ga-ie",
|
|
2650
|
-
/** Query language value for Kannada (India). */
|
|
2651
|
-
KnIn = "kn-in",
|
|
2652
|
-
/** Query language value for Malayalam (India). */
|
|
2653
|
-
MlIn = "ml-in",
|
|
2654
|
-
/** Query language value for Marathi (India). */
|
|
2655
|
-
MrIn = "mr-in",
|
|
2656
|
-
/** Query language value for Persian (U.A.E.). */
|
|
2657
|
-
FaAe = "fa-ae",
|
|
2658
|
-
/** Query language value for Punjabi (India). */
|
|
2659
|
-
PaIn = "pa-in",
|
|
2660
|
-
/** Query language value for Telugu (India). */
|
|
2661
|
-
TeIn = "te-in",
|
|
2662
|
-
/** Query language value for Urdu (Pakistan). */
|
|
2663
|
-
UrPk = "ur-pk"
|
|
2664
|
-
}
|
|
2665
|
-
|
|
2666
|
-
/** Known values of {@link QuerySpellerType} that the service accepts. */
|
|
2667
|
-
export declare enum KnownQuerySpellerType {
|
|
2668
|
-
/** Speller not enabled. */
|
|
2669
|
-
None = "none",
|
|
2670
|
-
/** Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. */
|
|
2671
|
-
Lexicon = "lexicon"
|
|
2221
|
+
Sk = "sk"
|
|
2672
2222
|
}
|
|
2673
2223
|
|
|
2674
2224
|
/** Known values of {@link RegexFlags} that the service accepts. */
|
|
2675
|
-
export declare enum KnownRegexFlags {
|
|
2225
|
+
export declare const enum KnownRegexFlags {
|
|
2676
2226
|
/** Enables canonical equivalence. */
|
|
2677
2227
|
CanonEq = "CANON_EQ",
|
|
2678
2228
|
/** Enables case-insensitive matching. */
|
|
@@ -2691,8 +2241,26 @@ export declare enum KnownRegexFlags {
|
|
|
2691
2241
|
UnixLines = "UNIX_LINES"
|
|
2692
2242
|
}
|
|
2693
2243
|
|
|
2244
|
+
/**
|
|
2245
|
+
* Known values for Search Audience
|
|
2246
|
+
*/
|
|
2247
|
+
export declare enum KnownSearchAudience {
|
|
2248
|
+
/**
|
|
2249
|
+
* Audience for Azure China
|
|
2250
|
+
*/
|
|
2251
|
+
AzureChina = "https://search.azure.cn",
|
|
2252
|
+
/**
|
|
2253
|
+
* Audience for Azure Government
|
|
2254
|
+
*/
|
|
2255
|
+
AzureGovernment = "https://search.azure.us",
|
|
2256
|
+
/**
|
|
2257
|
+
* Audience for Azure Public
|
|
2258
|
+
*/
|
|
2259
|
+
AzurePublicCloud = "https://search.azure.com"
|
|
2260
|
+
}
|
|
2261
|
+
|
|
2694
2262
|
/** Known values of {@link SearchIndexerDataSourceType} that the service accepts. */
|
|
2695
|
-
export declare enum KnownSearchIndexerDataSourceType {
|
|
2263
|
+
export declare const enum KnownSearchIndexerDataSourceType {
|
|
2696
2264
|
/** Indicates an Azure SQL datasource. */
|
|
2697
2265
|
AzureSql = "azuresql",
|
|
2698
2266
|
/** Indicates a CosmosDB datasource. */
|
|
@@ -2708,7 +2276,7 @@ export declare enum KnownSearchIndexerDataSourceType {
|
|
|
2708
2276
|
}
|
|
2709
2277
|
|
|
2710
2278
|
/** Known values of {@link SentimentSkillLanguage} that the service accepts. */
|
|
2711
|
-
export declare enum KnownSentimentSkillLanguage {
|
|
2279
|
+
export declare const enum KnownSentimentSkillLanguage {
|
|
2712
2280
|
/** Danish */
|
|
2713
2281
|
Da = "da",
|
|
2714
2282
|
/** Dutch */
|
|
@@ -2741,16 +2309,8 @@ export declare enum KnownSentimentSkillLanguage {
|
|
|
2741
2309
|
Tr = "tr"
|
|
2742
2310
|
}
|
|
2743
2311
|
|
|
2744
|
-
/** Known values of {@link Speller} that the service accepts. */
|
|
2745
|
-
export declare enum KnownSpeller {
|
|
2746
|
-
/** Speller not enabled. */
|
|
2747
|
-
None = "none",
|
|
2748
|
-
/** Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. */
|
|
2749
|
-
Lexicon = "lexicon"
|
|
2750
|
-
}
|
|
2751
|
-
|
|
2752
2312
|
/** Known values of {@link SplitSkillLanguage} that the service accepts. */
|
|
2753
|
-
export declare enum KnownSplitSkillLanguage {
|
|
2313
|
+
export declare const enum KnownSplitSkillLanguage {
|
|
2754
2314
|
/** Danish */
|
|
2755
2315
|
Da = "da",
|
|
2756
2316
|
/** German */
|
|
@@ -2772,7 +2332,7 @@ export declare enum KnownSplitSkillLanguage {
|
|
|
2772
2332
|
}
|
|
2773
2333
|
|
|
2774
2334
|
/** Known values of {@link TextSplitMode} that the service accepts. */
|
|
2775
|
-
export declare enum KnownTextSplitMode {
|
|
2335
|
+
export declare const enum KnownTextSplitMode {
|
|
2776
2336
|
/** Split the text into individual pages. */
|
|
2777
2337
|
Pages = "pages",
|
|
2778
2338
|
/** Split the text into individual sentences. */
|
|
@@ -2780,7 +2340,7 @@ export declare enum KnownTextSplitMode {
|
|
|
2780
2340
|
}
|
|
2781
2341
|
|
|
2782
2342
|
/** Known values of {@link TextTranslationSkillLanguage} that the service accepts. */
|
|
2783
|
-
export declare enum KnownTextTranslationSkillLanguage {
|
|
2343
|
+
export declare const enum KnownTextTranslationSkillLanguage {
|
|
2784
2344
|
/** Afrikaans */
|
|
2785
2345
|
Af = "af",
|
|
2786
2346
|
/** Arabic */
|
|
@@ -2845,10 +2405,6 @@ export declare enum KnownTextTranslationSkillLanguage {
|
|
|
2845
2405
|
Sw = "sw",
|
|
2846
2406
|
/** Klingon */
|
|
2847
2407
|
Tlh = "tlh",
|
|
2848
|
-
/** Klingon (Latin script) */
|
|
2849
|
-
TlhLatn = "tlh-Latn",
|
|
2850
|
-
/** Klingon (Klingon script) */
|
|
2851
|
-
TlhPiqd = "tlh-Piqd",
|
|
2852
2408
|
/** Korean */
|
|
2853
2409
|
Ko = "ko",
|
|
2854
2410
|
/** Latvian */
|
|
@@ -2869,10 +2425,6 @@ export declare enum KnownTextTranslationSkillLanguage {
|
|
|
2869
2425
|
Pl = "pl",
|
|
2870
2426
|
/** Portuguese */
|
|
2871
2427
|
Pt = "pt",
|
|
2872
|
-
/** Portuguese (Brazil) */
|
|
2873
|
-
PtBr = "pt-br",
|
|
2874
|
-
/** Portuguese (Portugal) */
|
|
2875
|
-
PtPT = "pt-PT",
|
|
2876
2428
|
/** Queretaro Otomi */
|
|
2877
2429
|
Otq = "otq",
|
|
2878
2430
|
/** Romanian */
|
|
@@ -2914,21 +2466,11 @@ export declare enum KnownTextTranslationSkillLanguage {
|
|
|
2914
2466
|
/** Welsh */
|
|
2915
2467
|
Cy = "cy",
|
|
2916
2468
|
/** Yucatec Maya */
|
|
2917
|
-
Yua = "yua"
|
|
2918
|
-
/** Irish */
|
|
2919
|
-
Ga = "ga",
|
|
2920
|
-
/** Kannada */
|
|
2921
|
-
Kn = "kn",
|
|
2922
|
-
/** Maori */
|
|
2923
|
-
Mi = "mi",
|
|
2924
|
-
/** Malayalam */
|
|
2925
|
-
Ml = "ml",
|
|
2926
|
-
/** Punjabi */
|
|
2927
|
-
Pa = "pa"
|
|
2469
|
+
Yua = "yua"
|
|
2928
2470
|
}
|
|
2929
2471
|
|
|
2930
2472
|
/** Known values of {@link TokenFilterName} that the service accepts. */
|
|
2931
|
-
export declare enum KnownTokenFilterName {
|
|
2473
|
+
export declare const enum KnownTokenFilterName {
|
|
2932
2474
|
/** 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 */
|
|
2933
2475
|
ArabicNormalization = "arabic_normalization",
|
|
2934
2476
|
/** 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 */
|
|
@@ -2961,7 +2503,7 @@ export declare enum KnownTokenFilterName {
|
|
|
2961
2503
|
Length = "length",
|
|
2962
2504
|
/** 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 */
|
|
2963
2505
|
Limit = "limit",
|
|
2964
|
-
/** Normalizes token text to lower case. See
|
|
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 */
|
|
2965
2507
|
Lowercase = "lowercase",
|
|
2966
2508
|
/** 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 */
|
|
2967
2509
|
NGram = "nGram_v2",
|
|
@@ -2993,7 +2535,7 @@ export declare enum KnownTokenFilterName {
|
|
|
2993
2535
|
Truncate = "truncate",
|
|
2994
2536
|
/** 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 */
|
|
2995
2537
|
Unique = "unique",
|
|
2996
|
-
/** Normalizes token text to upper case. See
|
|
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 */
|
|
2997
2539
|
Uppercase = "uppercase",
|
|
2998
2540
|
/** Splits words into subwords and performs optional transformations on subword groups. */
|
|
2999
2541
|
WordDelimiter = "word_delimiter"
|
|
@@ -3254,7 +2796,7 @@ export declare enum KnownTokenizerNames {
|
|
|
3254
2796
|
}
|
|
3255
2797
|
|
|
3256
2798
|
/** Known values of {@link VisualFeature} that the service accepts. */
|
|
3257
|
-
export declare enum KnownVisualFeature {
|
|
2799
|
+
export declare const enum KnownVisualFeature {
|
|
3258
2800
|
/** Visual features recognized as adult persons. */
|
|
3259
2801
|
Adult = "adult",
|
|
3260
2802
|
/** Visual features recognized as commercial brands. */
|
|
@@ -3276,9 +2818,9 @@ export declare type LanguageDetectionSkill = BaseSearchIndexerSkill & {
|
|
|
3276
2818
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
3277
2819
|
odatatype: "#Microsoft.Skills.Text.LanguageDetectionSkill";
|
|
3278
2820
|
/** A country code to use as a hint to the language detection model if it cannot disambiguate the language. */
|
|
3279
|
-
defaultCountryHint?: string;
|
|
2821
|
+
defaultCountryHint?: string | null;
|
|
3280
2822
|
/** 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. */
|
|
3281
|
-
modelVersion?: string;
|
|
2823
|
+
modelVersion?: string | null;
|
|
3282
2824
|
};
|
|
3283
2825
|
|
|
3284
2826
|
/** Removes words that are too long or too short. This token filter is implemented using Apache Lucene. */
|
|
@@ -3300,7 +2842,7 @@ export declare type LexicalAnalyzer = CustomAnalyzer | PatternAnalyzer | LuceneS
|
|
|
3300
2842
|
* Defines values for LexicalAnalyzerName. \
|
|
3301
2843
|
* {@link KnownLexicalAnalyzerName} can be used interchangeably with LexicalAnalyzerName,
|
|
3302
2844
|
* this enum contains the known values that the service supports.
|
|
3303
|
-
* ###
|
|
2845
|
+
* ### Know values supported by the service
|
|
3304
2846
|
* **ar.microsoft**: Microsoft analyzer for Arabic. \
|
|
3305
2847
|
* **ar.lucene**: Lucene analyzer for Arabic. \
|
|
3306
2848
|
* **hy.lucene**: Lucene analyzer for Armenian. \
|
|
@@ -3388,33 +2930,15 @@ export declare type LexicalAnalyzer = CustomAnalyzer | PatternAnalyzer | LuceneS
|
|
|
3388
2930
|
* **ur.microsoft**: Microsoft analyzer for Urdu. \
|
|
3389
2931
|
* **vi.microsoft**: Microsoft analyzer for Vietnamese. \
|
|
3390
2932
|
* **standard.lucene**: Standard Lucene analyzer. \
|
|
3391
|
-
* **standardasciifolding.lucene**: Standard ASCII Folding Lucene analyzer. See https
|
|
3392
|
-
* **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
|
|
3393
|
-
* **pattern**: Flexibly separates text into terms via a regular expression pattern. See http
|
|
3394
|
-
* **simple**: Divides text at non-letters and converts them to lower case. See http
|
|
3395
|
-
* **stop**: Divides text at non-letters; Applies the lowercase and stopword token filters. See http
|
|
3396
|
-
* **whitespace**: An analyzer that uses the whitespace tokenizer. See http
|
|
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
|
|
3397
2939
|
*/
|
|
3398
2940
|
export declare type LexicalAnalyzerName = string;
|
|
3399
2941
|
|
|
3400
|
-
/**
|
|
3401
|
-
* Contains the possible cases for LexicalNormalizer.
|
|
3402
|
-
*/
|
|
3403
|
-
export declare type LexicalNormalizer = CustomNormalizer;
|
|
3404
|
-
|
|
3405
|
-
/**
|
|
3406
|
-
* Defines values for LexicalNormalizerName. \
|
|
3407
|
-
* {@link KnownLexicalNormalizerName} can be used interchangeably with LexicalNormalizerName,
|
|
3408
|
-
* this enum contains the known values that the service supports.
|
|
3409
|
-
* ### Known values supported by the service
|
|
3410
|
-
* **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 \
|
|
3411
|
-
* **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 \
|
|
3412
|
-
* **lowercase**: Normalizes token text to lowercase. See https:\/\/lucene.apache.org\/core\/6_6_1\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/LowerCaseFilter.html \
|
|
3413
|
-
* **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 \
|
|
3414
|
-
* **uppercase**: Normalizes token text to uppercase. See https:\/\/lucene.apache.org\/core\/6_6_1\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/UpperCaseFilter.html
|
|
3415
|
-
*/
|
|
3416
|
-
export declare type LexicalNormalizerName = string;
|
|
3417
|
-
|
|
3418
2942
|
/**
|
|
3419
2943
|
* Contains the possible cases for Tokenizer.
|
|
3420
2944
|
*/
|
|
@@ -3430,18 +2954,6 @@ export declare type LimitTokenFilter = BaseTokenFilter & {
|
|
|
3430
2954
|
consumeAllTokens?: boolean;
|
|
3431
2955
|
};
|
|
3432
2956
|
|
|
3433
|
-
/**
|
|
3434
|
-
* Defines values for LineEnding. \
|
|
3435
|
-
* {@link KnownLineEnding} can be used interchangeably with LineEnding,
|
|
3436
|
-
* this enum contains the known values that the service supports.
|
|
3437
|
-
* ### Known values supported by the service
|
|
3438
|
-
* **space**: Lines are separated by a single space character. \
|
|
3439
|
-
* **carriageReturn**: Lines are separated by a carriage return ('\r') character. \
|
|
3440
|
-
* **lineFeed**: Lines are separated by a single line feed ('\n') character. \
|
|
3441
|
-
* **carriageReturnLineFeed**: Lines are separated by a carriage return and a line feed ('\r\n') character.
|
|
3442
|
-
*/
|
|
3443
|
-
export declare type LineEnding = string;
|
|
3444
|
-
|
|
3445
2957
|
/**
|
|
3446
2958
|
* Options for a list data sources operation.
|
|
3447
2959
|
*/
|
|
@@ -3631,15 +3143,13 @@ export declare type OcrSkill = BaseSearchIndexerSkill & {
|
|
|
3631
3143
|
defaultLanguageCode?: OcrSkillLanguage;
|
|
3632
3144
|
/** A value indicating to turn orientation detection on or not. Default is false. */
|
|
3633
3145
|
shouldDetectOrientation?: boolean;
|
|
3634
|
-
/** Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is "space". */
|
|
3635
|
-
lineEnding?: LineEnding;
|
|
3636
3146
|
};
|
|
3637
3147
|
|
|
3638
3148
|
/**
|
|
3639
3149
|
* Defines values for OcrSkillLanguage. \
|
|
3640
3150
|
* {@link KnownOcrSkillLanguage} can be used interchangeably with OcrSkillLanguage,
|
|
3641
3151
|
* this enum contains the known values that the service supports.
|
|
3642
|
-
* ###
|
|
3152
|
+
* ### Know values supported by the service
|
|
3643
3153
|
* **zh-Hans**: Chinese-Simplified \
|
|
3644
3154
|
* **zh-Hant**: Chinese-Traditional \
|
|
3645
3155
|
* **cs**: Czech \
|
|
@@ -3665,8 +3175,7 @@ export declare type OcrSkill = BaseSearchIndexerSkill & {
|
|
|
3665
3175
|
* **ro**: Romanian \
|
|
3666
3176
|
* **sr-Cyrl**: Serbian (Cyrillic, Serbia) \
|
|
3667
3177
|
* **sr-Latn**: Serbian (Latin, Serbia) \
|
|
3668
|
-
* **sk**: Slovak
|
|
3669
|
-
* **unk**: Unknown. If the language is explicitly set to "unk", the language will be auto-detected.
|
|
3178
|
+
* **sk**: Slovak
|
|
3670
3179
|
*/
|
|
3671
3180
|
export declare type OcrSkillLanguage = string;
|
|
3672
3181
|
|
|
@@ -3818,164 +3327,14 @@ export declare type PhoneticTokenFilter = BaseTokenFilter & {
|
|
|
3818
3327
|
replaceOriginalTokens?: boolean;
|
|
3819
3328
|
};
|
|
3820
3329
|
|
|
3821
|
-
/** Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it. */
|
|
3822
|
-
export declare type PIIDetectionSkill = BaseSearchIndexerSkill & {
|
|
3823
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
3824
|
-
odatatype: "#Microsoft.Skills.Text.PIIDetectionSkill";
|
|
3825
|
-
/** A value indicating which language code to use. Default is en. */
|
|
3826
|
-
defaultLanguageCode?: string;
|
|
3827
|
-
/** 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. */
|
|
3828
|
-
minimumPrecision?: number;
|
|
3829
|
-
/** A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'. */
|
|
3830
|
-
maskingMode?: PIIDetectionSkillMaskingMode;
|
|
3831
|
-
/** The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'. */
|
|
3832
|
-
maskingCharacter?: string;
|
|
3833
|
-
/** 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. */
|
|
3834
|
-
modelVersion?: string;
|
|
3835
|
-
/** A list of PII entity categories that should be extracted and masked. */
|
|
3836
|
-
piiCategories?: string[];
|
|
3837
|
-
/** If specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'phi', 'none'. Default is 'none'. */
|
|
3838
|
-
domain?: string;
|
|
3839
|
-
};
|
|
3840
|
-
|
|
3841
|
-
/**
|
|
3842
|
-
* Defines values for PIIDetectionSkillMaskingMode. \
|
|
3843
|
-
* {@link KnownPIIDetectionSkillMaskingMode} can be used interchangeably with PIIDetectionSkillMaskingMode,
|
|
3844
|
-
* this enum contains the known values that the service supports.
|
|
3845
|
-
* ### Known values supported by the service
|
|
3846
|
-
* **none**: No masking occurs and the maskedText output will not be returned. \
|
|
3847
|
-
* **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.
|
|
3848
|
-
*/
|
|
3849
|
-
export declare type PIIDetectionSkillMaskingMode = string;
|
|
3850
|
-
|
|
3851
|
-
/** Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers. */
|
|
3852
|
-
export declare interface PrioritizedFields {
|
|
3853
|
-
/** Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank. */
|
|
3854
|
-
titleField?: SemanticField;
|
|
3855
|
-
/** Defines the content fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. */
|
|
3856
|
-
prioritizedContentFields?: SemanticField[];
|
|
3857
|
-
/** Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. */
|
|
3858
|
-
prioritizedKeywordsFields?: SemanticField[];
|
|
3859
|
-
}
|
|
3860
|
-
|
|
3861
|
-
/**
|
|
3862
|
-
* Defines values for QueryAnswerType. \
|
|
3863
|
-
* {@link KnownQueryAnswerType} can be used interchangeably with QueryAnswerType,
|
|
3864
|
-
* this enum contains the known values that the service supports.
|
|
3865
|
-
* ### Known values supported by the service
|
|
3866
|
-
* **none**: Do not return answers for the query. \
|
|
3867
|
-
* **extractive**: Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language.
|
|
3868
|
-
*/
|
|
3869
|
-
export declare type QueryAnswerType = string;
|
|
3870
|
-
|
|
3871
|
-
/**
|
|
3872
|
-
* Defines values for QueryCaptionType. \
|
|
3873
|
-
* {@link KnownQueryCaptionType} can be used interchangeably with QueryCaptionType,
|
|
3874
|
-
* this enum contains the known values that the service supports.
|
|
3875
|
-
* ### Known values supported by the service
|
|
3876
|
-
* **none**: Do not return captions for the query. \
|
|
3877
|
-
* **extractive**: Extracts captions from the matching documents that contain passages relevant to the search query.
|
|
3878
|
-
*/
|
|
3879
|
-
export declare type QueryCaptionType = string;
|
|
3880
|
-
|
|
3881
|
-
/**
|
|
3882
|
-
* Defines values for QueryLanguage. \
|
|
3883
|
-
* {@link KnownQueryLanguage} can be used interchangeably with QueryLanguage,
|
|
3884
|
-
* this enum contains the known values that the service supports.
|
|
3885
|
-
* ### Known values supported by the service
|
|
3886
|
-
* **none**: Query language not specified. \
|
|
3887
|
-
* **en-us**: Query language value for English (United States). \
|
|
3888
|
-
* **en-gb**: Query language value for English (Great Britain). \
|
|
3889
|
-
* **en-in**: Query language value for English (India). \
|
|
3890
|
-
* **en-ca**: Query language value for English (Canada). \
|
|
3891
|
-
* **en-au**: Query language value for English (Australia). \
|
|
3892
|
-
* **fr-fr**: Query language value for French (France). \
|
|
3893
|
-
* **fr-ca**: Query language value for French (Canada). \
|
|
3894
|
-
* **de-de**: Query language value for German (Germany). \
|
|
3895
|
-
* **es-es**: Query language value for Spanish (Spain). \
|
|
3896
|
-
* **es-mx**: Query language value for Spanish (Mexico). \
|
|
3897
|
-
* **zh-cn**: Query language value for Chinese (China). \
|
|
3898
|
-
* **zh-tw**: Query language value for Chinese (Taiwan). \
|
|
3899
|
-
* **pt-br**: Query language value for Portuguese (Brazil). \
|
|
3900
|
-
* **pt-pt**: Query language value for Portuguese (Portugal). \
|
|
3901
|
-
* **it-it**: Query language value for Italian (Italy). \
|
|
3902
|
-
* **ja-jp**: Query language value for Japanese (Japan). \
|
|
3903
|
-
* **ko-kr**: Query language value for Korean (Korea). \
|
|
3904
|
-
* **ru-ru**: Query language value for Russian (Russia). \
|
|
3905
|
-
* **cs-cz**: Query language value for Czech (Czech Republic). \
|
|
3906
|
-
* **nl-be**: Query language value for Dutch (Belgium). \
|
|
3907
|
-
* **nl-nl**: Query language value for Dutch (Netherlands). \
|
|
3908
|
-
* **hu-hu**: Query language value for Hungarian (Hungary). \
|
|
3909
|
-
* **pl-pl**: Query language value for Polish (Poland). \
|
|
3910
|
-
* **sv-se**: Query language value for Swedish (Sweden). \
|
|
3911
|
-
* **tr-tr**: Query language value for Turkish (Turkey). \
|
|
3912
|
-
* **hi-in**: Query language value for Hindi (India). \
|
|
3913
|
-
* **ar-sa**: Query language value for Arabic (Saudi Arabia). \
|
|
3914
|
-
* **ar-eg**: Query language value for Arabic (Egypt). \
|
|
3915
|
-
* **ar-ma**: Query language value for Arabic (Morocco). \
|
|
3916
|
-
* **ar-kw**: Query language value for Arabic (Kuwait). \
|
|
3917
|
-
* **ar-jo**: Query language value for Arabic (Jordan). \
|
|
3918
|
-
* **da-dk**: Query language value for Danish (Denmark). \
|
|
3919
|
-
* **no-no**: Query language value for Norwegian (Norway). \
|
|
3920
|
-
* **bg-bg**: Query language value for Bulgarian (Bulgaria). \
|
|
3921
|
-
* **hr-hr**: Query language value for Croatian (Croatia). \
|
|
3922
|
-
* **hr-ba**: Query language value for Croatian (Bosnia and Herzegovina). \
|
|
3923
|
-
* **ms-my**: Query language value for Malay (Malaysia). \
|
|
3924
|
-
* **ms-bn**: Query language value for Malay (Brunei Darussalam). \
|
|
3925
|
-
* **sl-sl**: Query language value for Slovenian (Slovenia). \
|
|
3926
|
-
* **ta-in**: Query language value for Tamil (India). \
|
|
3927
|
-
* **vi-vn**: Query language value for Vietnamese (Viet Nam). \
|
|
3928
|
-
* **el-gr**: Query language value for Greek (Greece). \
|
|
3929
|
-
* **ro-ro**: Query language value for Romanian (Romania). \
|
|
3930
|
-
* **is-is**: Query language value for Icelandic (Iceland). \
|
|
3931
|
-
* **id-id**: Query language value for Indonesian (Indonesia). \
|
|
3932
|
-
* **th-th**: Query language value for Thai (Thailand). \
|
|
3933
|
-
* **lt-lt**: Query language value for Lithuanian (Lithuania). \
|
|
3934
|
-
* **uk-ua**: Query language value for Ukrainian (Ukraine). \
|
|
3935
|
-
* **lv-lv**: Query language value for Latvian (Latvia). \
|
|
3936
|
-
* **et-ee**: Query language value for Estonian (Estonia). \
|
|
3937
|
-
* **ca-es**: Query language value for Catalan (Spain). \
|
|
3938
|
-
* **fi-fi**: Query language value for Finnish (Finland). \
|
|
3939
|
-
* **sr-ba**: Query language value for Serbian (Bosnia and Herzegovina). \
|
|
3940
|
-
* **sr-me**: Query language value for Serbian (Montenegro). \
|
|
3941
|
-
* **sr-rs**: Query language value for Serbian (Serbia). \
|
|
3942
|
-
* **sk-sk**: Query language value for Slovak (Slovakia). \
|
|
3943
|
-
* **nb-no**: Query language value for Norwegian (Norway). \
|
|
3944
|
-
* **hy-am**: Query language value for Armenian (Armenia). \
|
|
3945
|
-
* **bn-in**: Query language value for Bengali (India). \
|
|
3946
|
-
* **eu-es**: Query language value for Basque (Spain). \
|
|
3947
|
-
* **gl-es**: Query language value for Galician (Spain). \
|
|
3948
|
-
* **gu-in**: Query language value for Gujarati (India). \
|
|
3949
|
-
* **he-il**: Query language value for Hebrew (Israel). \
|
|
3950
|
-
* **ga-ie**: Query language value for Irish (Ireland). \
|
|
3951
|
-
* **kn-in**: Query language value for Kannada (India). \
|
|
3952
|
-
* **ml-in**: Query language value for Malayalam (India). \
|
|
3953
|
-
* **mr-in**: Query language value for Marathi (India). \
|
|
3954
|
-
* **fa-ae**: Query language value for Persian (U.A.E.). \
|
|
3955
|
-
* **pa-in**: Query language value for Punjabi (India). \
|
|
3956
|
-
* **te-in**: Query language value for Telugu (India). \
|
|
3957
|
-
* **ur-pk**: Query language value for Urdu (Pakistan).
|
|
3958
|
-
*/
|
|
3959
|
-
export declare type QueryLanguage = string;
|
|
3960
|
-
|
|
3961
|
-
/**
|
|
3962
|
-
* Defines values for QuerySpellerType. \
|
|
3963
|
-
* {@link KnownQuerySpellerType} can be used interchangeably with QuerySpellerType,
|
|
3964
|
-
* this enum contains the known values that the service supports.
|
|
3965
|
-
* ### Known values supported by the service
|
|
3966
|
-
* **none**: Speller not enabled. \
|
|
3967
|
-
* **lexicon**: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter.
|
|
3968
|
-
*/
|
|
3969
|
-
export declare type QuerySpellerType = string;
|
|
3970
|
-
|
|
3971
3330
|
/** Defines values for QueryType. */
|
|
3972
|
-
export declare type QueryType = "simple" | "full"
|
|
3331
|
+
export declare type QueryType = "simple" | "full";
|
|
3973
3332
|
|
|
3974
3333
|
/**
|
|
3975
3334
|
* Defines values for RegexFlags. \
|
|
3976
3335
|
* {@link KnownRegexFlags} can be used interchangeably with RegexFlags,
|
|
3977
3336
|
* this enum contains the known values that the service supports.
|
|
3978
|
-
* ###
|
|
3337
|
+
* ### Know values supported by the service
|
|
3979
3338
|
* **CANON_EQ**: Enables canonical equivalence. \
|
|
3980
3339
|
* **CASE_INSENSITIVE**: Enables case-insensitive matching. \
|
|
3981
3340
|
* **COMMENTS**: Permits whitespace and comments in the pattern. \
|
|
@@ -3987,37 +3346,17 @@ export declare type QueryType = "simple" | "full" | "semantic";
|
|
|
3987
3346
|
*/
|
|
3988
3347
|
export declare type RegexFlags = string;
|
|
3989
3348
|
|
|
3990
|
-
/**
|
|
3991
|
-
* Options for reset docs operation.
|
|
3992
|
-
*/
|
|
3993
|
-
export declare interface ResetDocumentsOptions extends OperationOptions {
|
|
3994
|
-
/** document keys to be reset */
|
|
3995
|
-
documentKeys?: string[];
|
|
3996
|
-
/** datasource document identifiers to be reset */
|
|
3997
|
-
datasourceDocumentIds?: string[];
|
|
3998
|
-
/** If false, keys or ids will be appended to existing ones. If true, only the keys or ids in this payload will be queued to be re-ingested. */
|
|
3999
|
-
overwrite?: boolean;
|
|
4000
|
-
}
|
|
4001
|
-
|
|
4002
3349
|
/**
|
|
4003
3350
|
* Options for reset indexer operation.
|
|
4004
3351
|
*/
|
|
4005
3352
|
export declare type ResetIndexerOptions = OperationOptions;
|
|
4006
3353
|
|
|
4007
|
-
/**
|
|
4008
|
-
* Options for reset skills operation.
|
|
4009
|
-
*/
|
|
4010
|
-
export declare interface ResetSkillsOptions extends OperationOptions {
|
|
4011
|
-
/** the names of skills to be reset. */
|
|
4012
|
-
skillNames?: string[];
|
|
4013
|
-
}
|
|
4014
|
-
|
|
4015
3354
|
/** Represents a resource's usage and quota. */
|
|
4016
3355
|
export declare interface ResourceCounter {
|
|
4017
3356
|
/** The resource usage amount. */
|
|
4018
3357
|
usage: number;
|
|
4019
3358
|
/** The resource amount quota. */
|
|
4020
|
-
quota?: number;
|
|
3359
|
+
quota?: number | null;
|
|
4021
3360
|
}
|
|
4022
3361
|
|
|
4023
3362
|
/**
|
|
@@ -4069,13 +3408,8 @@ export declare type ScoringStatistics = "local" | "global";
|
|
|
4069
3408
|
* adding, updating, and removing them.
|
|
4070
3409
|
*/
|
|
4071
3410
|
export declare class SearchClient<T> implements IndexDocumentsClient<T> {
|
|
4072
|
-
/**
|
|
4073
|
-
* The service version to use when communicating with the service.
|
|
4074
|
-
*/
|
|
4075
|
-
readonly serviceVersion: string;
|
|
4076
3411
|
/**
|
|
4077
3412
|
* The API version to use when communicating with the service.
|
|
4078
|
-
* @deprecated use {@Link serviceVersion} instead
|
|
4079
3413
|
*/
|
|
4080
3414
|
readonly apiVersion: string;
|
|
4081
3415
|
/**
|
|
@@ -4143,7 +3477,7 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
|
|
|
4143
3477
|
* @param key - The primary key value of the document
|
|
4144
3478
|
* @param options - Additional options
|
|
4145
3479
|
*/
|
|
4146
|
-
getDocument<Fields extends
|
|
3480
|
+
getDocument<Fields extends keyof T>(key: string, options?: GetDocumentOptions<Fields>): Promise<T>;
|
|
4147
3481
|
/**
|
|
4148
3482
|
* Perform a set of index modifications (upload, merge, mergeOrUpload, delete)
|
|
4149
3483
|
* for the given set of documents.
|
|
@@ -4193,23 +3527,23 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
|
|
|
4193
3527
|
private extractOperationOptions;
|
|
4194
3528
|
private convertSelect;
|
|
4195
3529
|
private convertSearchFields;
|
|
4196
|
-
private convertSemanticFields;
|
|
4197
3530
|
private convertOrderBy;
|
|
4198
3531
|
}
|
|
4199
3532
|
|
|
4200
3533
|
/**
|
|
4201
3534
|
* Client options used to configure Cognitive Search API requests.
|
|
4202
3535
|
*/
|
|
4203
|
-
export declare interface SearchClientOptions extends
|
|
3536
|
+
export declare interface SearchClientOptions extends PipelineOptions {
|
|
4204
3537
|
/**
|
|
4205
3538
|
* The API version to use when communicating with the service.
|
|
4206
|
-
* @deprecated use {@Link serviceVersion} instead
|
|
4207
3539
|
*/
|
|
4208
3540
|
apiVersion?: string;
|
|
4209
3541
|
/**
|
|
4210
|
-
* The
|
|
3542
|
+
* The Audience to use for authentication with Azure Active Directory (AAD). The
|
|
3543
|
+
* audience is not considered when using a shared key.
|
|
3544
|
+
* {@link KnownSearchAudience} can be used interchangeably with audience
|
|
4211
3545
|
*/
|
|
4212
|
-
|
|
3546
|
+
audience?: string;
|
|
4213
3547
|
}
|
|
4214
3548
|
|
|
4215
3549
|
/**
|
|
@@ -4265,12 +3599,6 @@ export declare interface SearchDocumentsResultBase {
|
|
|
4265
3599
|
readonly facets?: {
|
|
4266
3600
|
[propertyName: string]: FacetResult[];
|
|
4267
3601
|
};
|
|
4268
|
-
/**
|
|
4269
|
-
* The answers query results for the search operation; null if the answers query parameter was
|
|
4270
|
-
* not specified or set to 'none'.
|
|
4271
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
4272
|
-
*/
|
|
4273
|
-
readonly answers?: AnswerResult[];
|
|
4274
3602
|
}
|
|
4275
3603
|
|
|
4276
3604
|
/**
|
|
@@ -4315,7 +3643,7 @@ export declare interface SearchIndex {
|
|
|
4315
3643
|
/**
|
|
4316
3644
|
* Options to control Cross-Origin Resource Sharing (CORS) for the index.
|
|
4317
3645
|
*/
|
|
4318
|
-
corsOptions?: CorsOptions;
|
|
3646
|
+
corsOptions?: CorsOptions | null;
|
|
4319
3647
|
/**
|
|
4320
3648
|
* The suggesters for the index.
|
|
4321
3649
|
*/
|
|
@@ -4336,10 +3664,6 @@ export declare interface SearchIndex {
|
|
|
4336
3664
|
* The character filters for the index.
|
|
4337
3665
|
*/
|
|
4338
3666
|
charFilters?: CharFilter[];
|
|
4339
|
-
/**
|
|
4340
|
-
* The normalizers for the index.
|
|
4341
|
-
*/
|
|
4342
|
-
normalizers?: LexicalNormalizer[];
|
|
4343
3667
|
/**
|
|
4344
3668
|
* A description of an encryption key that you create in Azure Key Vault. This key is used to
|
|
4345
3669
|
* provide an additional level of encryption-at-rest for your data when you want full assurance
|
|
@@ -4350,17 +3674,13 @@ export declare interface SearchIndex {
|
|
|
4350
3674
|
* keys is not available for free search services, and is only available for paid services
|
|
4351
3675
|
* created on or after January 1, 2019.
|
|
4352
3676
|
*/
|
|
4353
|
-
encryptionKey?: SearchResourceEncryptionKey;
|
|
3677
|
+
encryptionKey?: SearchResourceEncryptionKey | null;
|
|
4354
3678
|
/**
|
|
4355
3679
|
* The type of similarity algorithm to be used when scoring and ranking the documents matching a
|
|
4356
3680
|
* search query. The similarity algorithm can only be defined at index creation time and cannot
|
|
4357
3681
|
* be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.
|
|
4358
3682
|
*/
|
|
4359
3683
|
similarity?: SimilarityAlgorithm;
|
|
4360
|
-
/**
|
|
4361
|
-
* Defines parameters for a search index that influence semantic capabilities.
|
|
4362
|
-
*/
|
|
4363
|
-
semanticSettings?: SemanticSettings;
|
|
4364
3684
|
/**
|
|
4365
3685
|
* The ETag of the index.
|
|
4366
3686
|
*/
|
|
@@ -4376,11 +3696,6 @@ export declare class SearchIndexClient {
|
|
|
4376
3696
|
/**
|
|
4377
3697
|
* The API version to use when communicating with the service.
|
|
4378
3698
|
*/
|
|
4379
|
-
readonly serviceVersion: string;
|
|
4380
|
-
/**
|
|
4381
|
-
* The API version to use when communicating with the service.
|
|
4382
|
-
* @deprecated use {@Link serviceVersion} instead
|
|
4383
|
-
*/
|
|
4384
3699
|
readonly apiVersion: string;
|
|
4385
3700
|
/**
|
|
4386
3701
|
* The endpoint of the search service
|
|
@@ -4514,16 +3829,17 @@ export declare class SearchIndexClient {
|
|
|
4514
3829
|
/**
|
|
4515
3830
|
* Client options used to configure Cognitive Search API requests.
|
|
4516
3831
|
*/
|
|
4517
|
-
export declare interface SearchIndexClientOptions extends
|
|
3832
|
+
export declare interface SearchIndexClientOptions extends PipelineOptions {
|
|
4518
3833
|
/**
|
|
4519
3834
|
* The API version to use when communicating with the service.
|
|
4520
|
-
* @deprecated use {@Link serviceVersion} instead
|
|
4521
3835
|
*/
|
|
4522
3836
|
apiVersion?: string;
|
|
4523
3837
|
/**
|
|
4524
|
-
* The
|
|
3838
|
+
* The Audience to use for authentication with Azure Active Directory (AAD). The
|
|
3839
|
+
* audience is not considered when using a shared key.
|
|
3840
|
+
* {@link KnownSearchAudience} can be used interchangeably with audience
|
|
4525
3841
|
*/
|
|
4526
|
-
|
|
3842
|
+
audience?: string;
|
|
4527
3843
|
}
|
|
4528
3844
|
|
|
4529
3845
|
/**
|
|
@@ -4553,11 +3869,11 @@ export declare interface SearchIndexer {
|
|
|
4553
3869
|
/**
|
|
4554
3870
|
* The schedule for this indexer.
|
|
4555
3871
|
*/
|
|
4556
|
-
schedule?: IndexingSchedule;
|
|
3872
|
+
schedule?: IndexingSchedule | null;
|
|
4557
3873
|
/**
|
|
4558
3874
|
* Parameters for indexer execution.
|
|
4559
3875
|
*/
|
|
4560
|
-
parameters?: IndexingParameters;
|
|
3876
|
+
parameters?: IndexingParameters | null;
|
|
4561
3877
|
/**
|
|
4562
3878
|
* Defines mappings between fields in the data source and corresponding target fields in the
|
|
4563
3879
|
* index.
|
|
@@ -4570,7 +3886,7 @@ export declare interface SearchIndexer {
|
|
|
4570
3886
|
/**
|
|
4571
3887
|
* A value indicating whether the indexer is disabled. Default is false. Default value: false.
|
|
4572
3888
|
*/
|
|
4573
|
-
isDisabled?: boolean;
|
|
3889
|
+
isDisabled?: boolean | null;
|
|
4574
3890
|
/**
|
|
4575
3891
|
* The ETag of the indexer.
|
|
4576
3892
|
*/
|
|
@@ -4586,19 +3902,7 @@ export declare interface SearchIndexer {
|
|
|
4586
3902
|
* customer-managed keys is not available for free search services, and is only available for
|
|
4587
3903
|
* paid services created on or after January 1, 2019.
|
|
4588
3904
|
*/
|
|
4589
|
-
encryptionKey?: SearchResourceEncryptionKey;
|
|
4590
|
-
/**
|
|
4591
|
-
* Adds caching to an enrichment pipeline to allow for incremental modification steps without
|
|
4592
|
-
* having to rebuild the index every time.
|
|
4593
|
-
*/
|
|
4594
|
-
cache?: SearchIndexerCache;
|
|
4595
|
-
}
|
|
4596
|
-
|
|
4597
|
-
export declare interface SearchIndexerCache {
|
|
4598
|
-
/** The connection string to the storage account where the cache data will be persisted. */
|
|
4599
|
-
storageConnectionString?: string;
|
|
4600
|
-
/** Specifies whether incremental reprocessing is enabled. */
|
|
4601
|
-
enableReprocessing?: boolean;
|
|
3905
|
+
encryptionKey?: SearchResourceEncryptionKey | null;
|
|
4602
3906
|
}
|
|
4603
3907
|
|
|
4604
3908
|
/**
|
|
@@ -4610,11 +3914,6 @@ export declare class SearchIndexerClient {
|
|
|
4610
3914
|
/**
|
|
4611
3915
|
* The API version to use when communicating with the service.
|
|
4612
3916
|
*/
|
|
4613
|
-
readonly serviceVersion: string;
|
|
4614
|
-
/**
|
|
4615
|
-
* The API version to use when communicating with the service.
|
|
4616
|
-
* @deprecated use {@Link serviceVersion} instead
|
|
4617
|
-
*/
|
|
4618
3917
|
readonly apiVersion: string;
|
|
4619
3918
|
/**
|
|
4620
3919
|
* The endpoint of the search service
|
|
@@ -4758,34 +4057,22 @@ export declare class SearchIndexerClient {
|
|
|
4758
4057
|
* @param options - Additional optional arguments.
|
|
4759
4058
|
*/
|
|
4760
4059
|
runIndexer(indexerName: string, options?: RunIndexerOptions): Promise<void>;
|
|
4761
|
-
/**
|
|
4762
|
-
* Resets specific documents in the datasource to be selectively re-ingested by the indexer.
|
|
4763
|
-
* @param indexerName - The name of the indexer to reset documents for.
|
|
4764
|
-
* @param options - Additional optional arguments.
|
|
4765
|
-
*/
|
|
4766
|
-
resetDocuments(indexerName: string, options?: ResetDocumentsOptions): Promise<void>;
|
|
4767
|
-
/**
|
|
4768
|
-
* Reset an existing skillset in a search service.
|
|
4769
|
-
* @param skillsetName - The name of the skillset to reset.
|
|
4770
|
-
* @param skillNames - The names of skills to reset.
|
|
4771
|
-
* @param options - The options parameters.
|
|
4772
|
-
*/
|
|
4773
|
-
resetSkills(skillsetName: string, options?: ResetSkillsOptions): Promise<void>;
|
|
4774
4060
|
}
|
|
4775
4061
|
|
|
4776
4062
|
/**
|
|
4777
4063
|
* Client options used to configure Cognitive Search API requests.
|
|
4778
4064
|
*/
|
|
4779
|
-
export declare interface SearchIndexerClientOptions extends
|
|
4065
|
+
export declare interface SearchIndexerClientOptions extends PipelineOptions {
|
|
4780
4066
|
/**
|
|
4781
4067
|
* The API version to use when communicating with the service.
|
|
4782
|
-
* @deprecated use {@Link serviceVersion} instead
|
|
4783
4068
|
*/
|
|
4784
4069
|
apiVersion?: string;
|
|
4785
4070
|
/**
|
|
4786
|
-
* The
|
|
4071
|
+
* The Audience to use for authentication with Azure Active Directory (AAD). The
|
|
4072
|
+
* audience is not considered when using a shared key.
|
|
4073
|
+
* {@link KnownSearchAudience} can be used interchangeably with audience
|
|
4787
4074
|
*/
|
|
4788
|
-
|
|
4075
|
+
audience?: string;
|
|
4789
4076
|
}
|
|
4790
4077
|
|
|
4791
4078
|
/** Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed. */
|
|
@@ -4796,17 +4083,6 @@ export declare interface SearchIndexerDataContainer {
|
|
|
4796
4083
|
query?: string;
|
|
4797
4084
|
}
|
|
4798
4085
|
|
|
4799
|
-
/**
|
|
4800
|
-
* Contains the possible cases for SearchIndexerDataIdentity.
|
|
4801
|
-
*/
|
|
4802
|
-
export declare type SearchIndexerDataIdentity = SearchIndexerDataNoneIdentity | SearchIndexerDataUserAssignedIdentity;
|
|
4803
|
-
|
|
4804
|
-
/** Clears the identity property of a datasource. */
|
|
4805
|
-
export declare type SearchIndexerDataNoneIdentity = BaseSearchIndexerDataIdentity & {
|
|
4806
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
4807
|
-
odatatype: "#Microsoft.Azure.Search.SearchIndexerDataNoneIdentity";
|
|
4808
|
-
};
|
|
4809
|
-
|
|
4810
4086
|
/**
|
|
4811
4087
|
* Represents a datasource definition, which can be used to configure an indexer.
|
|
4812
4088
|
*/
|
|
@@ -4832,20 +4108,14 @@ export declare interface SearchIndexerDataSourceConnection {
|
|
|
4832
4108
|
* The data container for the datasource.
|
|
4833
4109
|
*/
|
|
4834
4110
|
container: SearchIndexerDataContainer;
|
|
4835
|
-
/**
|
|
4836
|
-
* An explicit managed identity to use for this datasource. If not specified and the connection
|
|
4837
|
-
* string is a managed identity, the system-assigned managed identity is used. If not specified,
|
|
4838
|
-
* the value remains unchanged. If "none" is specified, the value of this property is cleared.
|
|
4839
|
-
*/
|
|
4840
|
-
identity?: SearchIndexerDataIdentity;
|
|
4841
4111
|
/**
|
|
4842
4112
|
* The data change detection policy for the datasource.
|
|
4843
4113
|
*/
|
|
4844
|
-
dataChangeDetectionPolicy?: DataChangeDetectionPolicy;
|
|
4114
|
+
dataChangeDetectionPolicy?: DataChangeDetectionPolicy | null;
|
|
4845
4115
|
/**
|
|
4846
4116
|
* The data deletion detection policy for the datasource.
|
|
4847
4117
|
*/
|
|
4848
|
-
dataDeletionDetectionPolicy?: DataDeletionDetectionPolicy;
|
|
4118
|
+
dataDeletionDetectionPolicy?: DataDeletionDetectionPolicy | null;
|
|
4849
4119
|
/**
|
|
4850
4120
|
* The ETag of the DataSource.
|
|
4851
4121
|
*/
|
|
@@ -4861,14 +4131,14 @@ export declare interface SearchIndexerDataSourceConnection {
|
|
|
4861
4131
|
* available for free search services, and is only available for paid services created on or
|
|
4862
4132
|
* after January 1, 2019.
|
|
4863
4133
|
*/
|
|
4864
|
-
encryptionKey?: SearchResourceEncryptionKey;
|
|
4134
|
+
encryptionKey?: SearchResourceEncryptionKey | null;
|
|
4865
4135
|
}
|
|
4866
4136
|
|
|
4867
4137
|
/**
|
|
4868
4138
|
* Defines values for SearchIndexerDataSourceType. \
|
|
4869
4139
|
* {@link KnownSearchIndexerDataSourceType} can be used interchangeably with SearchIndexerDataSourceType,
|
|
4870
4140
|
* this enum contains the known values that the service supports.
|
|
4871
|
-
* ###
|
|
4141
|
+
* ### Know values supported by the service
|
|
4872
4142
|
* **azuresql**: Indicates an Azure SQL datasource. \
|
|
4873
4143
|
* **cosmosdb**: Indicates a CosmosDB datasource. \
|
|
4874
4144
|
* **azureblob**: Indicates an Azure Blob datasource. \
|
|
@@ -4878,14 +4148,6 @@ export declare interface SearchIndexerDataSourceConnection {
|
|
|
4878
4148
|
*/
|
|
4879
4149
|
export declare type SearchIndexerDataSourceType = string;
|
|
4880
4150
|
|
|
4881
|
-
/** Specifies the identity for a datasource to use. */
|
|
4882
|
-
export declare type SearchIndexerDataUserAssignedIdentity = BaseSearchIndexerDataIdentity & {
|
|
4883
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
4884
|
-
odatatype: "#Microsoft.Azure.Search.SearchIndexerDataUserAssignedIdentity";
|
|
4885
|
-
/** 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. */
|
|
4886
|
-
userAssignedIdentity: string;
|
|
4887
|
-
};
|
|
4888
|
-
|
|
4889
4151
|
/** Represents an item- or document-level indexing error. */
|
|
4890
4152
|
export declare interface SearchIndexerError {
|
|
4891
4153
|
/**
|
|
@@ -4991,7 +4253,7 @@ export declare interface SearchIndexerLimits {
|
|
|
4991
4253
|
/**
|
|
4992
4254
|
* Contains the possible cases for Skill.
|
|
4993
4255
|
*/
|
|
4994
|
-
export declare type SearchIndexerSkill = ConditionalSkill | KeyPhraseExtractionSkill | OcrSkill | ImageAnalysisSkill | LanguageDetectionSkill | ShaperSkill | MergeSkill | EntityRecognitionSkill | SentimentSkill | SplitSkill |
|
|
4256
|
+
export declare type SearchIndexerSkill = ConditionalSkill | KeyPhraseExtractionSkill | OcrSkill | ImageAnalysisSkill | LanguageDetectionSkill | ShaperSkill | MergeSkill | EntityRecognitionSkill | SentimentSkill | SplitSkill | CustomEntityLookupSkill | TextTranslationSkill | DocumentExtractionSkill | WebApiSkill;
|
|
4995
4257
|
|
|
4996
4258
|
/**
|
|
4997
4259
|
* A list of skills.
|
|
@@ -5031,7 +4293,7 @@ export declare interface SearchIndexerSkillset {
|
|
|
5031
4293
|
* definition will be unaffected. Encryption with customer-managed keys is not available for free
|
|
5032
4294
|
* search services, and is only available for paid services created on or after January 1, 2019.
|
|
5033
4295
|
*/
|
|
5034
|
-
encryptionKey?: SearchResourceEncryptionKey;
|
|
4296
|
+
encryptionKey?: SearchResourceEncryptionKey | null;
|
|
5035
4297
|
}
|
|
5036
4298
|
|
|
5037
4299
|
/** Represents the current status and execution history of an indexer. */
|
|
@@ -5426,11 +4688,6 @@ export declare interface SearchRequest {
|
|
|
5426
4688
|
* the results.
|
|
5427
4689
|
*/
|
|
5428
4690
|
scoringProfile?: string;
|
|
5429
|
-
/**
|
|
5430
|
-
* The name of a semantic configuration that will be used when processing documents for queries of
|
|
5431
|
-
* type semantic.
|
|
5432
|
-
*/
|
|
5433
|
-
semanticConfiguration?: string;
|
|
5434
4691
|
/**
|
|
5435
4692
|
* A full-text search query expression; Use "*" or omit this parameter to match all documents.
|
|
5436
4693
|
*/
|
|
@@ -5446,19 +4703,6 @@ export declare interface SearchRequest {
|
|
|
5446
4703
|
* count the document as a match. Possible values include: 'Any', 'All'
|
|
5447
4704
|
*/
|
|
5448
4705
|
searchMode?: SearchMode;
|
|
5449
|
-
/**
|
|
5450
|
-
* A value that specifies the language of the search query.
|
|
5451
|
-
*/
|
|
5452
|
-
queryLanguage?: QueryLanguage;
|
|
5453
|
-
/**
|
|
5454
|
-
* A value that specified the type of the speller to use to spell-correct individual search
|
|
5455
|
-
* query terms.
|
|
5456
|
-
*/
|
|
5457
|
-
speller?: QuerySpellerType;
|
|
5458
|
-
/**
|
|
5459
|
-
* A value that specifies whether answers should be returned as part of the search response.
|
|
5460
|
-
*/
|
|
5461
|
-
answers?: QueryAnswerType;
|
|
5462
4706
|
/**
|
|
5463
4707
|
* The comma-separated list of fields to retrieve. If unspecified, all fields marked as
|
|
5464
4708
|
* retrievable in the schema are included.
|
|
@@ -5477,14 +4721,6 @@ export declare interface SearchRequest {
|
|
|
5477
4721
|
* Search request for the next page of results.
|
|
5478
4722
|
*/
|
|
5479
4723
|
top?: number;
|
|
5480
|
-
/**
|
|
5481
|
-
* A value that specifies whether captions should be returned as part of the search response.
|
|
5482
|
-
*/
|
|
5483
|
-
captions?: QueryCaptionType;
|
|
5484
|
-
/**
|
|
5485
|
-
* The comma-separated list of field names used for semantic search.
|
|
5486
|
-
*/
|
|
5487
|
-
semanticFields?: string;
|
|
5488
4724
|
}
|
|
5489
4725
|
|
|
5490
4726
|
/**
|
|
@@ -5559,21 +4795,6 @@ export declare interface SearchRequestOptions<Fields> {
|
|
|
5559
4795
|
* fielded search expression take precedence over any field names listed in this parameter.
|
|
5560
4796
|
*/
|
|
5561
4797
|
searchFields?: Fields[];
|
|
5562
|
-
/**
|
|
5563
|
-
* The language of the query.
|
|
5564
|
-
*/
|
|
5565
|
-
queryLanguage?: QueryLanguage;
|
|
5566
|
-
/**
|
|
5567
|
-
* Improve search recall by spell-correcting individual search query terms.
|
|
5568
|
-
*/
|
|
5569
|
-
speller?: Speller;
|
|
5570
|
-
/**
|
|
5571
|
-
* This parameter is only valid if the query type is 'semantic'. If set, the query returns answers
|
|
5572
|
-
* extracted from key passages in the highest ranked documents. The number of answers returned can
|
|
5573
|
-
* be configured by appending the pipe character '|' followed by the 'count-\<number of answers\>' option
|
|
5574
|
-
* after the answers parameter value, such as 'extractive|count-3'. Default count is 1.
|
|
5575
|
-
*/
|
|
5576
|
-
answers?: Answers;
|
|
5577
4798
|
/**
|
|
5578
4799
|
* A value that specifies whether any or all of the search terms must be matched in order to
|
|
5579
4800
|
* count the document as a match. Possible values include: 'any', 'all'
|
|
@@ -5611,17 +4832,6 @@ export declare interface SearchRequestOptions<Fields> {
|
|
|
5611
4832
|
* Search request for the next page of results.
|
|
5612
4833
|
*/
|
|
5613
4834
|
top?: number;
|
|
5614
|
-
/**
|
|
5615
|
-
* This parameter is only valid if the query type is 'semantic'. If set, the query returns captions
|
|
5616
|
-
* extracted from key passages in the highest ranked documents. When Captions is set to 'extractive',
|
|
5617
|
-
* highlighting is enabled by default, and can be configured by appending the pipe character '|'
|
|
5618
|
-
* followed by the 'highlight-true'/'highlight-false' option, such as 'extractive|highlight-true'. Defaults to 'None'.
|
|
5619
|
-
*/
|
|
5620
|
-
captions?: Captions;
|
|
5621
|
-
/**
|
|
5622
|
-
* The list of field names used for semantic search.
|
|
5623
|
-
*/
|
|
5624
|
-
semanticFields?: string[];
|
|
5625
4835
|
}
|
|
5626
4836
|
|
|
5627
4837
|
/**
|
|
@@ -5654,13 +4864,6 @@ export declare interface SearchResourceEncryptionKey {
|
|
|
5654
4864
|
* The authentication key of the specified AAD application.
|
|
5655
4865
|
*/
|
|
5656
4866
|
applicationSecret?: string;
|
|
5657
|
-
/**
|
|
5658
|
-
* An explicit managed identity to use for this encryption key. If not specified and the access
|
|
5659
|
-
* credentials property is null, the system-assigned managed identity is used. On update to the
|
|
5660
|
-
* resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified,
|
|
5661
|
-
* the value of this property is cleared.
|
|
5662
|
-
*/
|
|
5663
|
-
identity?: SearchIndexerDataIdentity;
|
|
5664
4867
|
}
|
|
5665
4868
|
|
|
5666
4869
|
/**
|
|
@@ -5672,11 +4875,6 @@ export declare type SearchResult<T> = {
|
|
|
5672
4875
|
* **NOTE: This property will not be serialized. It can only be populated by the server.**
|
|
5673
4876
|
*/
|
|
5674
4877
|
readonly score: number;
|
|
5675
|
-
/**
|
|
5676
|
-
* 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'.
|
|
5677
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
5678
|
-
*/
|
|
5679
|
-
readonly rerankerScore?: number;
|
|
5680
4878
|
/**
|
|
5681
4879
|
* Text fragments from the document that indicate the matching search terms, organized by each
|
|
5682
4880
|
* applicable field; null if hit highlighting was not enabled for the query.
|
|
@@ -5685,11 +4883,6 @@ export declare type SearchResult<T> = {
|
|
|
5685
4883
|
readonly highlights?: {
|
|
5686
4884
|
[k in keyof T]?: string[];
|
|
5687
4885
|
};
|
|
5688
|
-
/**
|
|
5689
|
-
* 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'.
|
|
5690
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
5691
|
-
*/
|
|
5692
|
-
readonly captions?: CaptionResult[];
|
|
5693
4886
|
document: T;
|
|
5694
4887
|
};
|
|
5695
4888
|
|
|
@@ -5718,25 +4911,6 @@ export declare interface SearchSuggester {
|
|
|
5718
4911
|
sourceFields: string[];
|
|
5719
4912
|
}
|
|
5720
4913
|
|
|
5721
|
-
/** Defines a specific configuration to be used in the context of semantic capabilities. */
|
|
5722
|
-
export declare interface SemanticConfiguration {
|
|
5723
|
-
/** The name of the semantic configuration. */
|
|
5724
|
-
name: string;
|
|
5725
|
-
/** Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers. At least one of the three sub properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) need to be set. */
|
|
5726
|
-
prioritizedFields: PrioritizedFields;
|
|
5727
|
-
}
|
|
5728
|
-
|
|
5729
|
-
/** A field that is used as part of the semantic configuration. */
|
|
5730
|
-
export declare interface SemanticField {
|
|
5731
|
-
name?: string;
|
|
5732
|
-
}
|
|
5733
|
-
|
|
5734
|
-
/** Defines parameters for a search index that influence semantic capabilities. */
|
|
5735
|
-
export declare interface SemanticSettings {
|
|
5736
|
-
/** The semantic configurations for the index. */
|
|
5737
|
-
configurations?: SemanticConfiguration[];
|
|
5738
|
-
}
|
|
5739
|
-
|
|
5740
4914
|
/** Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1. */
|
|
5741
4915
|
export declare type SentimentSkill = BaseSearchIndexerSkill & {
|
|
5742
4916
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -5749,7 +4923,7 @@ export declare type SentimentSkill = BaseSearchIndexerSkill & {
|
|
|
5749
4923
|
* Defines values for SentimentSkillLanguage. \
|
|
5750
4924
|
* {@link KnownSentimentSkillLanguage} can be used interchangeably with SentimentSkillLanguage,
|
|
5751
4925
|
* this enum contains the known values that the service supports.
|
|
5752
|
-
* ###
|
|
4926
|
+
* ### Know values supported by the service
|
|
5753
4927
|
* **da**: Danish \
|
|
5754
4928
|
* **nl**: Dutch \
|
|
5755
4929
|
* **en**: English \
|
|
@@ -5768,18 +4942,6 @@ export declare type SentimentSkill = BaseSearchIndexerSkill & {
|
|
|
5768
4942
|
*/
|
|
5769
4943
|
export declare type SentimentSkillLanguage = string;
|
|
5770
4944
|
|
|
5771
|
-
/** 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. */
|
|
5772
|
-
export declare type SentimentSkillV3 = BaseSearchIndexerSkill & {
|
|
5773
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
5774
|
-
odatatype: "#Microsoft.Skills.Text.V3.SentimentSkill";
|
|
5775
|
-
/** A value indicating which language code to use. Default is en. */
|
|
5776
|
-
defaultLanguageCode?: string;
|
|
5777
|
-
/** 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. */
|
|
5778
|
-
includeOpinionMining?: boolean;
|
|
5779
|
-
/** 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. */
|
|
5780
|
-
modelVersion?: string;
|
|
5781
|
-
};
|
|
5782
|
-
|
|
5783
4945
|
/** Represents service-level resource counters and quotas. */
|
|
5784
4946
|
export declare interface ServiceCounters {
|
|
5785
4947
|
/** Total number of documents across all indexes in the service. */
|
|
@@ -5801,13 +4963,13 @@ export declare interface ServiceCounters {
|
|
|
5801
4963
|
/** Represents various service level limits. */
|
|
5802
4964
|
export declare interface ServiceLimits {
|
|
5803
4965
|
/** The maximum allowed fields per index. */
|
|
5804
|
-
maxFieldsPerIndex?: number;
|
|
4966
|
+
maxFieldsPerIndex?: number | null;
|
|
5805
4967
|
/** 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. */
|
|
5806
|
-
maxFieldNestingDepthPerIndex?: number;
|
|
4968
|
+
maxFieldNestingDepthPerIndex?: number | null;
|
|
5807
4969
|
/** The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index. */
|
|
5808
|
-
maxComplexCollectionFieldsPerIndex?: number;
|
|
4970
|
+
maxComplexCollectionFieldsPerIndex?: number | null;
|
|
5809
4971
|
/** The maximum number of objects in complex collections allowed per document. */
|
|
5810
|
-
maxComplexObjectsInCollectionsPerDocument?: number;
|
|
4972
|
+
maxComplexObjectsInCollectionsPerDocument?: number | null;
|
|
5811
4973
|
}
|
|
5812
4974
|
|
|
5813
4975
|
/** A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields). */
|
|
@@ -5946,10 +5108,6 @@ export declare interface SimpleField {
|
|
|
5946
5108
|
* fields.
|
|
5947
5109
|
*/
|
|
5948
5110
|
synonymMapNames?: string[];
|
|
5949
|
-
/**
|
|
5950
|
-
* The name of the normalizer used at indexing time for the field.
|
|
5951
|
-
*/
|
|
5952
|
-
normalizerName?: LexicalNormalizerName;
|
|
5953
5111
|
}
|
|
5954
5112
|
|
|
5955
5113
|
/** A filter that stems words using a Snowball-generated stemmer. This token filter is implemented using Apache Lucene. */
|
|
@@ -5973,16 +5131,6 @@ export declare type SoftDeleteColumnDeletionDetectionPolicy = BaseDataDeletionDe
|
|
|
5973
5131
|
softDeleteMarkerValue?: string;
|
|
5974
5132
|
};
|
|
5975
5133
|
|
|
5976
|
-
/**
|
|
5977
|
-
* Defines values for Speller. \
|
|
5978
|
-
* {@link KnownSpeller} can be used interchangeably with Speller,
|
|
5979
|
-
* this enum contains the known values that the service supports.
|
|
5980
|
-
* ### Known values supported by the service
|
|
5981
|
-
* **none**: Speller not enabled. \
|
|
5982
|
-
* **lexicon**: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter.
|
|
5983
|
-
*/
|
|
5984
|
-
export declare type Speller = string;
|
|
5985
|
-
|
|
5986
5134
|
/** A skill to split a string into chunks of text. */
|
|
5987
5135
|
export declare type SplitSkill = BaseSearchIndexerSkill & {
|
|
5988
5136
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -5992,14 +5140,14 @@ export declare type SplitSkill = BaseSearchIndexerSkill & {
|
|
|
5992
5140
|
/** A value indicating which split mode to perform. */
|
|
5993
5141
|
textSplitMode?: TextSplitMode;
|
|
5994
5142
|
/** The desired maximum page length. Default is 10000. */
|
|
5995
|
-
maxPageLength?: number;
|
|
5143
|
+
maxPageLength?: number | null;
|
|
5996
5144
|
};
|
|
5997
5145
|
|
|
5998
5146
|
/**
|
|
5999
5147
|
* Defines values for SplitSkillLanguage. \
|
|
6000
5148
|
* {@link KnownSplitSkillLanguage} can be used interchangeably with SplitSkillLanguage,
|
|
6001
5149
|
* this enum contains the known values that the service supports.
|
|
6002
|
-
* ###
|
|
5150
|
+
* ### Know values supported by the service
|
|
6003
5151
|
* **da**: Danish \
|
|
6004
5152
|
* **de**: German \
|
|
6005
5153
|
* **en**: English \
|
|
@@ -6177,7 +5325,7 @@ export declare interface SynonymMap {
|
|
|
6177
5325
|
* keys is not available for free search services, and is only available for paid services
|
|
6178
5326
|
* created on or after January 1, 2019.
|
|
6179
5327
|
*/
|
|
6180
|
-
encryptionKey?: SearchResourceEncryptionKey;
|
|
5328
|
+
encryptionKey?: SearchResourceEncryptionKey | null;
|
|
6181
5329
|
/**
|
|
6182
5330
|
* The ETag of the synonym map.
|
|
6183
5331
|
*/
|
|
@@ -6214,7 +5362,7 @@ export declare interface TagScoringParameters {
|
|
|
6214
5362
|
* Defines values for TextSplitMode. \
|
|
6215
5363
|
* {@link KnownTextSplitMode} can be used interchangeably with TextSplitMode,
|
|
6216
5364
|
* this enum contains the known values that the service supports.
|
|
6217
|
-
* ###
|
|
5365
|
+
* ### Know values supported by the service
|
|
6218
5366
|
* **pages**: Split the text into individual pages. \
|
|
6219
5367
|
* **sentences**: Split the text into individual sentences.
|
|
6220
5368
|
*/
|
|
@@ -6229,14 +5377,14 @@ export declare type TextTranslationSkill = BaseSearchIndexerSkill & {
|
|
|
6229
5377
|
/** The language code to translate documents from for documents that don't specify the from language explicitly. */
|
|
6230
5378
|
defaultFromLanguageCode?: TextTranslationSkillLanguage;
|
|
6231
5379
|
/** 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. */
|
|
6232
|
-
suggestedFrom?: TextTranslationSkillLanguage;
|
|
5380
|
+
suggestedFrom?: TextTranslationSkillLanguage | null;
|
|
6233
5381
|
};
|
|
6234
5382
|
|
|
6235
5383
|
/**
|
|
6236
5384
|
* Defines values for TextTranslationSkillLanguage. \
|
|
6237
5385
|
* {@link KnownTextTranslationSkillLanguage} can be used interchangeably with TextTranslationSkillLanguage,
|
|
6238
5386
|
* this enum contains the known values that the service supports.
|
|
6239
|
-
* ###
|
|
5387
|
+
* ### Know values supported by the service
|
|
6240
5388
|
* **af**: Afrikaans \
|
|
6241
5389
|
* **ar**: Arabic \
|
|
6242
5390
|
* **bn**: Bangla \
|
|
@@ -6269,8 +5417,6 @@ export declare type TextTranslationSkill = BaseSearchIndexerSkill & {
|
|
|
6269
5417
|
* **ja**: Japanese \
|
|
6270
5418
|
* **sw**: Kiswahili \
|
|
6271
5419
|
* **tlh**: Klingon \
|
|
6272
|
-
* **tlh-Latn**: Klingon (Latin script) \
|
|
6273
|
-
* **tlh-Piqd**: Klingon (Klingon script) \
|
|
6274
5420
|
* **ko**: Korean \
|
|
6275
5421
|
* **lv**: Latvian \
|
|
6276
5422
|
* **lt**: Lithuanian \
|
|
@@ -6281,8 +5427,6 @@ export declare type TextTranslationSkill = BaseSearchIndexerSkill & {
|
|
|
6281
5427
|
* **fa**: Persian \
|
|
6282
5428
|
* **pl**: Polish \
|
|
6283
5429
|
* **pt**: Portuguese \
|
|
6284
|
-
* **pt-br**: Portuguese (Brazil) \
|
|
6285
|
-
* **pt-PT**: Portuguese (Portugal) \
|
|
6286
5430
|
* **otq**: Queretaro Otomi \
|
|
6287
5431
|
* **ro**: Romanian \
|
|
6288
5432
|
* **ru**: Russian \
|
|
@@ -6303,12 +5447,7 @@ export declare type TextTranslationSkill = BaseSearchIndexerSkill & {
|
|
|
6303
5447
|
* **ur**: Urdu \
|
|
6304
5448
|
* **vi**: Vietnamese \
|
|
6305
5449
|
* **cy**: Welsh \
|
|
6306
|
-
* **yua**: Yucatec Maya
|
|
6307
|
-
* **ga**: Irish \
|
|
6308
|
-
* **kn**: Kannada \
|
|
6309
|
-
* **mi**: Maori \
|
|
6310
|
-
* **ml**: Malayalam \
|
|
6311
|
-
* **pa**: Punjabi
|
|
5450
|
+
* **yua**: Yucatec Maya
|
|
6312
5451
|
*/
|
|
6313
5452
|
export declare type TextTranslationSkillLanguage = string;
|
|
6314
5453
|
|
|
@@ -6332,40 +5471,40 @@ export declare type TokenFilter = AsciiFoldingTokenFilter | CjkBigramTokenFilter
|
|
|
6332
5471
|
* Defines values for TokenFilterName. \
|
|
6333
5472
|
* {@link KnownTokenFilterName} can be used interchangeably with TokenFilterName,
|
|
6334
5473
|
* this enum contains the known values that the service supports.
|
|
6335
|
-
* ###
|
|
6336
|
-
* **arabic_normalization**: A token filter that applies the Arabic normalizer to normalize the orthography. See http
|
|
6337
|
-
* **apostrophe**: Strips all characters after an apostrophe (including the apostrophe itself). See http
|
|
6338
|
-
* **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
|
|
6339
|
-
* **cjk_bigram**: Forms bigrams of CJK terms that are generated from the standard tokenizer. See http
|
|
6340
|
-
* **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
|
|
6341
|
-
* **classic**: Removes English possessives, and dots from acronyms. See http
|
|
6342
|
-
* **common_grams**: Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. See http
|
|
6343
|
-
* **edgeNGram_v2**: Generates n-grams of the given size(s) starting from the front or the back of an input token. See http
|
|
6344
|
-
* **elision**: Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http
|
|
6345
|
-
* **german_normalization**: Normalizes German characters according to the heuristics of the German2 snowball algorithm. See http
|
|
6346
|
-
* **hindi_normalization**: Normalizes text in Hindi to remove some differences in spelling variations. See http
|
|
6347
|
-
* **indic_normalization**: Normalizes the Unicode representation of text in Indian languages. See http
|
|
6348
|
-
* **keyword_repeat**: Emits each incoming token twice, once as keyword and once as non-keyword. See http
|
|
6349
|
-
* **kstem**: A high-performance kstem filter for English. See http
|
|
6350
|
-
* **length**: Removes words that are too long or too short. See http
|
|
6351
|
-
* **limit**: Limits the number of tokens while indexing. See http
|
|
6352
|
-
* **lowercase**: Normalizes token text to lower case. See
|
|
6353
|
-
* **nGram_v2**: Generates n-grams of the given size(s). See http
|
|
6354
|
-
* **persian_normalization**: Applies normalization for Persian. See http
|
|
6355
|
-
* **phonetic**: Create tokens for phonetic matches. See https
|
|
6356
|
-
* **porter_stem**: Uses the Porter stemming algorithm to transform the token stream. See http
|
|
6357
|
-
* **reverse**: Reverses the token string. See http
|
|
6358
|
-
* **scandinavian_normalization**: Normalizes use of the interchangeable Scandinavian characters. See http
|
|
6359
|
-
* **scandinavian_folding**: Folds Scandinavian characters åÅäæÄÆ->a and öÖøØ->o. It also discriminates against use of double vowels aa, ae, ao, oe and oo, leaving just the first one. See http
|
|
6360
|
-
* **shingle**: Creates combinations of tokens as a single token. See http
|
|
6361
|
-
* **snowball**: A filter that stems words using a Snowball-generated stemmer. See http
|
|
6362
|
-
* **sorani_normalization**: Normalizes the Unicode representation of Sorani text. See http
|
|
6363
|
-
* **stemmer**: Language specific stemming filter. See https
|
|
6364
|
-
* **stopwords**: Removes stop words from a token stream. See http
|
|
6365
|
-
* **trim**: Trims leading and trailing whitespace from tokens. See http
|
|
6366
|
-
* **truncate**: Truncates the terms to a specific length. See http
|
|
6367
|
-
* **unique**: Filters out tokens with same text as the previous token. See http
|
|
6368
|
-
* **uppercase**: Normalizes token text to upper case. See
|
|
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 åÅäæÄÆ->a and öÖøØ->o. It also discriminates against use of double vowels aa, ae, ao, oe and oo, leaving just the first one. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianFoldingFilter.html \
|
|
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 \
|
|
6369
5508
|
* **word_delimiter**: Splits words into subwords and performs optional transformations on subword groups.
|
|
6370
5509
|
*/
|
|
6371
5510
|
export declare type TokenFilterName = string;
|
|
@@ -6403,7 +5542,7 @@ export declare type UploadDocumentsOptions = IndexDocumentsOptions;
|
|
|
6403
5542
|
* Defines values for VisualFeature. \
|
|
6404
5543
|
* {@link KnownVisualFeature} can be used interchangeably with VisualFeature,
|
|
6405
5544
|
* this enum contains the known values that the service supports.
|
|
6406
|
-
* ###
|
|
5545
|
+
* ### Know values supported by the service
|
|
6407
5546
|
* **adult**: Visual features recognized as adult persons. \
|
|
6408
5547
|
* **brands**: Visual features recognized as commercial brands. \
|
|
6409
5548
|
* **categories**: Categories. \
|
|
@@ -6429,9 +5568,9 @@ export declare type WebApiSkill = BaseSearchIndexerSkill & {
|
|
|
6429
5568
|
/** The desired timeout for the request. Default is 30 seconds. */
|
|
6430
5569
|
timeout?: string;
|
|
6431
5570
|
/** The desired batch size which indicates number of documents. */
|
|
6432
|
-
batchSize?: number;
|
|
5571
|
+
batchSize?: number | null;
|
|
6433
5572
|
/** If set, the number of parallel calls that can be made to the Web API. */
|
|
6434
|
-
degreeOfParallelism?: number;
|
|
5573
|
+
degreeOfParallelism?: number | null;
|
|
6435
5574
|
};
|
|
6436
5575
|
|
|
6437
5576
|
/** Splits words into subwords and performs optional transformations on subword groups. This token filter is implemented using Apache Lucene. */
|