@azure/search-documents 11.3.0-beta.8 → 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 +227 -0
- package/README.md +40 -18
- package/dist/index.js +961 -3443
- 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 +1 -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 +5 -33
- 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 +1 -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 +25 -750
- package/dist-esm/src/generated/service/models/mappers.js.map +1 -1
- package/dist-esm/src/generated/service/models/parameters.js +1 -51
- 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/index.js +0 -1
- package/dist-esm/src/generated/service/operations/index.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 +15 -37
- 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 +2 -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.map +1 -1
- package/dist-esm/src/searchClient.js +67 -91
- package/dist-esm/src/searchClient.js.map +1 -1
- package/dist-esm/src/searchIndexClient.js +74 -236
- package/dist-esm/src/searchIndexClient.js.map +1 -1
- package/dist-esm/src/searchIndexerClient.js +86 -143
- package/dist-esm/src/searchIndexerClient.js.map +1 -1
- package/dist-esm/src/searchIndexingBufferedSender.js +17 -16
- 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 -68
- 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 +5 -6
- package/dist-esm/src/tracing.js.map +1 -1
- package/package.json +44 -45
- package/types/search-documents.d.ts +162 -1150
- 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/operations/aliases.js +0 -166
- package/dist-esm/src/generated/service/operations/aliases.js.map +0 -1
- package/dist-esm/src/generated/service/operationsInterfaces/aliases.js +0 -9
- package/dist-esm/src/generated/service/operationsInterfaces/aliases.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 -14
- 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,20 +1,12 @@
|
|
|
1
1
|
/// <reference lib="esnext.asynciterable" />
|
|
2
|
-
|
|
3
2
|
import { AzureKeyCredential } from '@azure/core-auth';
|
|
4
|
-
import { ExtendedCommonClientOptions } from '@azure/core-http-compat';
|
|
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
|
-
/**
|
|
12
|
-
* An iterator for listing the aliases that exist in the Search service. Will make requests
|
|
13
|
-
* as needed during iteration. Use .byPage() to make one request to the server
|
|
14
|
-
* per iteration.
|
|
15
|
-
*/
|
|
16
|
-
export declare type AliasIterator = PagedAsyncIterableIterator<SearchIndexAlias, SearchIndexAlias[], {}>;
|
|
17
|
-
|
|
18
10
|
/** Information about a token returned by an analyzer. */
|
|
19
11
|
export declare interface AnalyzedTokenInfo {
|
|
20
12
|
/**
|
|
@@ -61,10 +53,6 @@ export declare interface AnalyzeRequest {
|
|
|
61
53
|
* NOTE: Either analyzerName or tokenizerName is required in an AnalyzeRequest.
|
|
62
54
|
*/
|
|
63
55
|
tokenizerName?: string;
|
|
64
|
-
/**
|
|
65
|
-
* The name of the normalizer to use to normalize the given text.
|
|
66
|
-
*/
|
|
67
|
-
normalizerName?: LexicalNormalizerName;
|
|
68
56
|
/**
|
|
69
57
|
* An optional list of token filters to use when breaking the given text. This parameter can only
|
|
70
58
|
* be set when using the tokenizer parameter.
|
|
@@ -88,42 +76,6 @@ export declare interface AnalyzeResult {
|
|
|
88
76
|
*/
|
|
89
77
|
export declare type AnalyzeTextOptions = OperationOptions & AnalyzeRequest;
|
|
90
78
|
|
|
91
|
-
/** An answer is a text passage extracted from the contents of the most relevant documents that matched the query. Answers are extracted from the top search results. Answer candidates are scored and the top answers are selected. */
|
|
92
|
-
export declare interface AnswerResult {
|
|
93
|
-
/** Describes unknown properties. The value of an unknown property can be of "any" type. */
|
|
94
|
-
[property: string]: any;
|
|
95
|
-
/**
|
|
96
|
-
* The score value represents how relevant the answer is to the query relative to other answers returned for the query.
|
|
97
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
98
|
-
*/
|
|
99
|
-
readonly score: number;
|
|
100
|
-
/**
|
|
101
|
-
* The key of the document the answer was extracted from.
|
|
102
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
103
|
-
*/
|
|
104
|
-
readonly key: string;
|
|
105
|
-
/**
|
|
106
|
-
* The text passage extracted from the document contents as the answer.
|
|
107
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
108
|
-
*/
|
|
109
|
-
readonly text: string;
|
|
110
|
-
/**
|
|
111
|
-
* Same text passage as in the Text property with highlighted text phrases most relevant to the query.
|
|
112
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
113
|
-
*/
|
|
114
|
-
readonly highlights?: string;
|
|
115
|
-
}
|
|
116
|
-
|
|
117
|
-
/**
|
|
118
|
-
* Defines values for Answers. \
|
|
119
|
-
* {@link KnownAnswers} can be used interchangeably with Answers,
|
|
120
|
-
* this enum contains the known values that the service supports.
|
|
121
|
-
* ### Known values supported by the service
|
|
122
|
-
* **none**: Do not return answers for the query. \
|
|
123
|
-
* **extractive**: Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language.
|
|
124
|
-
*/
|
|
125
|
-
export declare type Answers = string;
|
|
126
|
-
|
|
127
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. */
|
|
128
80
|
export declare type AsciiFoldingTokenFilter = BaseTokenFilter & {
|
|
129
81
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -227,27 +179,8 @@ export declare interface AzureActiveDirectoryApplicationCredentials {
|
|
|
227
179
|
/** The authentication key of the specified AAD application. */
|
|
228
180
|
applicationSecret?: string;
|
|
229
181
|
}
|
|
230
|
-
|
|
231
182
|
export { AzureKeyCredential }
|
|
232
183
|
|
|
233
|
-
/** The AML skill allows you to extend AI enrichment with a custom Azure Machine Learning (AML) model. Once an AML model is trained and deployed, an AML skill integrates it into AI enrichment. */
|
|
234
|
-
export declare type AzureMachineLearningSkill = BaseSearchIndexerSkill & {
|
|
235
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
236
|
-
odatatype: "#Microsoft.Skills.Custom.AmlSkill";
|
|
237
|
-
/** (Required for no authentication or key authentication) The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed. */
|
|
238
|
-
scoringUri?: string;
|
|
239
|
-
/** (Required for key authentication) The key for the AML service. */
|
|
240
|
-
authenticationKey?: string;
|
|
241
|
-
/** (Required for token authentication). The Azure Resource Manager resource ID of the AML service. It should be in the format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}. */
|
|
242
|
-
resourceId?: string;
|
|
243
|
-
/** (Optional) When specified, indicates the timeout for the http client making the API call. */
|
|
244
|
-
timeout?: string;
|
|
245
|
-
/** (Optional for token authentication). The region the AML service is deployed in. */
|
|
246
|
-
region?: string;
|
|
247
|
-
/** (Optional) When specified, indicates the number of calls the indexer will make in parallel to the endpoint you have provided. You can decrease this value if your endpoint is failing under too high of a request load, or raise it if your endpoint is able to accept more requests and you would like an increase in the performance of the indexer. If not set, a default value of 5 is used. The degreeOfParallelism can be set to a maximum of 10 and a minimum of 1. */
|
|
248
|
-
degreeOfParallelism?: number;
|
|
249
|
-
};
|
|
250
|
-
|
|
251
184
|
/** Base type for character filters. */
|
|
252
185
|
export declare interface BaseCharFilter {
|
|
253
186
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -284,14 +217,6 @@ export declare interface BaseLexicalAnalyzer {
|
|
|
284
217
|
name: string;
|
|
285
218
|
}
|
|
286
219
|
|
|
287
|
-
/** Base type for normalizers. */
|
|
288
|
-
export declare interface BaseLexicalNormalizer {
|
|
289
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
290
|
-
odatatype: "#Microsoft.Azure.Search.CustomNormalizer";
|
|
291
|
-
/** The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'. */
|
|
292
|
-
name: string;
|
|
293
|
-
}
|
|
294
|
-
|
|
295
220
|
/** Base type for tokenizers. */
|
|
296
221
|
export declare interface BaseLexicalTokenizer {
|
|
297
222
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -312,16 +237,10 @@ export declare interface BaseScoringFunction {
|
|
|
312
237
|
interpolation?: ScoringFunctionInterpolation;
|
|
313
238
|
}
|
|
314
239
|
|
|
315
|
-
/** Abstract base type for data identities. */
|
|
316
|
-
export declare interface BaseSearchIndexerDataIdentity {
|
|
317
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
318
|
-
odatatype: "#Microsoft.Azure.Search.SearchIndexerDataNoneIdentity" | "#Microsoft.Azure.Search.SearchIndexerDataUserAssignedIdentity";
|
|
319
|
-
}
|
|
320
|
-
|
|
321
240
|
/** Base type for skills. */
|
|
322
241
|
export declare interface BaseSearchIndexerSkill {
|
|
323
242
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
324
|
-
odatatype: "#Microsoft.Skills.Util.ConditionalSkill" | "#Microsoft.Skills.Text.KeyPhraseExtractionSkill" | "#Microsoft.Skills.Vision.OcrSkill" | "#Microsoft.Skills.Vision.ImageAnalysisSkill" | "#Microsoft.Skills.Text.LanguageDetectionSkill" | "#Microsoft.Skills.Util.ShaperSkill" | "#Microsoft.Skills.Text.MergeSkill" | "#Microsoft.Skills.Text.EntityRecognitionSkill" | "#Microsoft.Skills.Text.SentimentSkill" | "#Microsoft.Skills.Text.
|
|
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";
|
|
325
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 '#'. */
|
|
326
245
|
name?: string;
|
|
327
246
|
/** The description of the skill which describes the inputs, outputs, and usage of the skill. */
|
|
@@ -346,7 +265,7 @@ export declare interface BaseTokenFilter {
|
|
|
346
265
|
* Defines values for BlobIndexerDataToExtract. \
|
|
347
266
|
* {@link KnownBlobIndexerDataToExtract} can be used interchangeably with BlobIndexerDataToExtract,
|
|
348
267
|
* this enum contains the known values that the service supports.
|
|
349
|
-
* ###
|
|
268
|
+
* ### Know values supported by the service
|
|
350
269
|
* **storageMetadata**: Indexes just the standard blob properties and user-specified metadata. \
|
|
351
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). \
|
|
352
271
|
* **contentAndMetadata**: Extracts all metadata and textual content from each blob.
|
|
@@ -357,7 +276,7 @@ export declare type BlobIndexerDataToExtract = string;
|
|
|
357
276
|
* Defines values for BlobIndexerImageAction. \
|
|
358
277
|
* {@link KnownBlobIndexerImageAction} can be used interchangeably with BlobIndexerImageAction,
|
|
359
278
|
* this enum contains the known values that the service supports.
|
|
360
|
-
* ###
|
|
279
|
+
* ### Know values supported by the service
|
|
361
280
|
* **none**: Ignores embedded images or image files in the data set. This is the default. \
|
|
362
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. \
|
|
363
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.
|
|
@@ -368,7 +287,7 @@ export declare type BlobIndexerImageAction = string;
|
|
|
368
287
|
* Defines values for BlobIndexerParsingMode. \
|
|
369
288
|
* {@link KnownBlobIndexerParsingMode} can be used interchangeably with BlobIndexerParsingMode,
|
|
370
289
|
* this enum contains the known values that the service supports.
|
|
371
|
-
* ###
|
|
290
|
+
* ### Know values supported by the service
|
|
372
291
|
* **default**: Set to default for normal file processing. \
|
|
373
292
|
* **text**: Set to text to improve indexing performance on plain text files in blob storage. \
|
|
374
293
|
* **delimitedText**: Set to delimitedText when blobs are plain CSV files. \
|
|
@@ -382,7 +301,7 @@ export declare type BlobIndexerParsingMode = string;
|
|
|
382
301
|
* Defines values for BlobIndexerPDFTextRotationAlgorithm. \
|
|
383
302
|
* {@link KnownBlobIndexerPDFTextRotationAlgorithm} can be used interchangeably with BlobIndexerPDFTextRotationAlgorithm,
|
|
384
303
|
* this enum contains the known values that the service supports.
|
|
385
|
-
* ###
|
|
304
|
+
* ### Know values supported by the service
|
|
386
305
|
* **none**: Leverages normal text extraction. This is the default. \
|
|
387
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.
|
|
388
307
|
*/
|
|
@@ -393,37 +312,11 @@ export declare type BM25Similarity = Similarity & {
|
|
|
393
312
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
394
313
|
odatatype: "#Microsoft.Azure.Search.BM25Similarity";
|
|
395
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. */
|
|
396
|
-
k1?: number;
|
|
315
|
+
k1?: number | null;
|
|
397
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. */
|
|
398
|
-
b?: number;
|
|
317
|
+
b?: number | null;
|
|
399
318
|
};
|
|
400
319
|
|
|
401
|
-
/** Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'.. */
|
|
402
|
-
export declare interface CaptionResult {
|
|
403
|
-
/** Describes unknown properties. The value of an unknown property can be of "any" type. */
|
|
404
|
-
[property: string]: any;
|
|
405
|
-
/**
|
|
406
|
-
* A representative text passage extracted from the document most relevant to the search query.
|
|
407
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
408
|
-
*/
|
|
409
|
-
readonly text?: string;
|
|
410
|
-
/**
|
|
411
|
-
* Same text passage as in the Text property with highlighted phrases most relevant to the query.
|
|
412
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
413
|
-
*/
|
|
414
|
-
readonly highlights?: string;
|
|
415
|
-
}
|
|
416
|
-
|
|
417
|
-
/**
|
|
418
|
-
* Defines values for Captions. \
|
|
419
|
-
* {@link KnownCaptions} can be used interchangeably with Captions,
|
|
420
|
-
* this enum contains the known values that the service supports.
|
|
421
|
-
* ### Known values supported by the service
|
|
422
|
-
* **none**: Do not return captions for the query. \
|
|
423
|
-
* **extractive**: Extracts captions from the matching documents that contain passages relevant to the search query.
|
|
424
|
-
*/
|
|
425
|
-
export declare type Captions = string;
|
|
426
|
-
|
|
427
320
|
/**
|
|
428
321
|
* Contains the possible cases for CharFilter.
|
|
429
322
|
*/
|
|
@@ -433,8 +326,8 @@ export declare type CharFilter = MappingCharFilter | PatternReplaceCharFilter;
|
|
|
433
326
|
* Defines values for CharFilterName. \
|
|
434
327
|
* {@link KnownCharFilterName} can be used interchangeably with CharFilterName,
|
|
435
328
|
* this enum contains the known values that the service supports.
|
|
436
|
-
* ###
|
|
437
|
-
* **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
|
|
438
331
|
*/
|
|
439
332
|
export declare type CharFilterName = string;
|
|
440
333
|
|
|
@@ -529,7 +422,7 @@ export declare interface CorsOptions {
|
|
|
529
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). */
|
|
530
423
|
allowedOrigins: string[];
|
|
531
424
|
/** The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes. */
|
|
532
|
-
maxAgeInSeconds?: number;
|
|
425
|
+
maxAgeInSeconds?: number | null;
|
|
533
426
|
}
|
|
534
427
|
|
|
535
428
|
/**
|
|
@@ -537,11 +430,6 @@ export declare interface CorsOptions {
|
|
|
537
430
|
*/
|
|
538
431
|
export declare type CountDocumentsOptions = OperationOptions;
|
|
539
432
|
|
|
540
|
-
/**
|
|
541
|
-
* Options for create alias operation.
|
|
542
|
-
*/
|
|
543
|
-
export declare type CreateAliasOptions = OperationOptions;
|
|
544
|
-
|
|
545
433
|
/**
|
|
546
434
|
* Options for create datasource operation.
|
|
547
435
|
*/
|
|
@@ -557,28 +445,14 @@ export declare type CreateIndexerOptions = OperationOptions;
|
|
|
557
445
|
*/
|
|
558
446
|
export declare type CreateIndexOptions = OperationOptions;
|
|
559
447
|
|
|
560
|
-
/**
|
|
561
|
-
* Options for create or update alias operation.
|
|
562
|
-
*/
|
|
563
|
-
export declare interface CreateOrUpdateAliasOptions extends OperationOptions {
|
|
564
|
-
/**
|
|
565
|
-
* If set to true, Resource will be deleted only if the etag matches.
|
|
566
|
-
*/
|
|
567
|
-
onlyIfUnchanged?: boolean;
|
|
568
|
-
}
|
|
569
|
-
|
|
570
448
|
/**
|
|
571
449
|
* Options for create/update datasource operation.
|
|
572
450
|
*/
|
|
573
451
|
export declare interface CreateorUpdateDataSourceConnectionOptions extends OperationOptions {
|
|
574
452
|
/**
|
|
575
|
-
* If set to true, Resource will be
|
|
453
|
+
* If set to true, Resource will be deleted only if the etag matches.
|
|
576
454
|
*/
|
|
577
455
|
onlyIfUnchanged?: boolean;
|
|
578
|
-
/**
|
|
579
|
-
* Ignores cache reset requirements.
|
|
580
|
-
*/
|
|
581
|
-
skipIndexerResetRequirementForCache?: boolean;
|
|
582
456
|
}
|
|
583
457
|
|
|
584
458
|
/**
|
|
@@ -586,13 +460,9 @@ export declare interface CreateorUpdateDataSourceConnectionOptions extends Opera
|
|
|
586
460
|
*/
|
|
587
461
|
export declare interface CreateorUpdateIndexerOptions extends OperationOptions {
|
|
588
462
|
/**
|
|
589
|
-
* If set to true, Resource will be
|
|
463
|
+
* If set to true, Resource will be deleted only if the etag matches.
|
|
590
464
|
*/
|
|
591
465
|
onlyIfUnchanged?: boolean;
|
|
592
|
-
/** Ignores cache reset requirements. */
|
|
593
|
-
skipIndexerResetRequirementForCache?: boolean;
|
|
594
|
-
/** Disables cache reprocessing change detection. */
|
|
595
|
-
disableCacheReprocessingChangeDetection?: boolean;
|
|
596
466
|
}
|
|
597
467
|
|
|
598
468
|
/**
|
|
@@ -617,17 +487,9 @@ export declare interface CreateOrUpdateIndexOptions extends OperationOptions {
|
|
|
617
487
|
*/
|
|
618
488
|
export declare interface CreateOrUpdateSkillsetOptions extends OperationOptions {
|
|
619
489
|
/**
|
|
620
|
-
* If set to true, Resource will be
|
|
490
|
+
* If set to true, Resource will be deleted only if the etag matches.
|
|
621
491
|
*/
|
|
622
492
|
onlyIfUnchanged?: boolean;
|
|
623
|
-
/**
|
|
624
|
-
* Ignores cache reset requirements.
|
|
625
|
-
*/
|
|
626
|
-
skipIndexerResetRequirementForCache?: boolean;
|
|
627
|
-
/**
|
|
628
|
-
* Disables cache reprocessing change detection.
|
|
629
|
-
*/
|
|
630
|
-
disableCacheReprocessingChangeDetection?: boolean;
|
|
631
493
|
}
|
|
632
494
|
|
|
633
495
|
/**
|
|
@@ -635,7 +497,7 @@ export declare interface CreateOrUpdateSkillsetOptions extends OperationOptions
|
|
|
635
497
|
*/
|
|
636
498
|
export declare interface CreateOrUpdateSynonymMapOptions extends OperationOptions {
|
|
637
499
|
/**
|
|
638
|
-
* If set to true, Resource will be
|
|
500
|
+
* If set to true, Resource will be deleted only if the etag matches.
|
|
639
501
|
*/
|
|
640
502
|
onlyIfUnchanged?: boolean;
|
|
641
503
|
}
|
|
@@ -699,27 +561,27 @@ export declare interface CustomEntity {
|
|
|
699
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. */
|
|
700
562
|
name: string;
|
|
701
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. */
|
|
702
|
-
description?: string;
|
|
564
|
+
description?: string | null;
|
|
703
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. */
|
|
704
|
-
type?: string;
|
|
566
|
+
type?: string | null;
|
|
705
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. */
|
|
706
|
-
subtype?: string;
|
|
568
|
+
subtype?: string | null;
|
|
707
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. */
|
|
708
|
-
id?: string;
|
|
570
|
+
id?: string | null;
|
|
709
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. */
|
|
710
|
-
caseSensitive?: boolean;
|
|
572
|
+
caseSensitive?: boolean | null;
|
|
711
573
|
/** Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent. */
|
|
712
|
-
accentSensitive?: boolean;
|
|
574
|
+
accentSensitive?: boolean | null;
|
|
713
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. */
|
|
714
|
-
fuzzyEditDistance?: number;
|
|
576
|
+
fuzzyEditDistance?: number | null;
|
|
715
577
|
/** Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values. */
|
|
716
|
-
defaultCaseSensitive?: boolean;
|
|
578
|
+
defaultCaseSensitive?: boolean | null;
|
|
717
579
|
/** Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values. */
|
|
718
|
-
defaultAccentSensitive?: boolean;
|
|
580
|
+
defaultAccentSensitive?: boolean | null;
|
|
719
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. */
|
|
720
|
-
defaultFuzzyEditDistance?: number;
|
|
582
|
+
defaultFuzzyEditDistance?: number | null;
|
|
721
583
|
/** An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name. */
|
|
722
|
-
aliases?: CustomEntityAlias[];
|
|
584
|
+
aliases?: CustomEntityAlias[] | null;
|
|
723
585
|
}
|
|
724
586
|
|
|
725
587
|
/** A complex object that can be used to specify alternative spellings or synonyms to the root entity name. */
|
|
@@ -727,11 +589,11 @@ export declare interface CustomEntityAlias {
|
|
|
727
589
|
/** The text of the alias. */
|
|
728
590
|
text: string;
|
|
729
591
|
/** Determine if the alias is case sensitive. */
|
|
730
|
-
caseSensitive?: boolean;
|
|
592
|
+
caseSensitive?: boolean | null;
|
|
731
593
|
/** Determine if the alias is accent sensitive. */
|
|
732
|
-
accentSensitive?: boolean;
|
|
594
|
+
accentSensitive?: boolean | null;
|
|
733
595
|
/** Determine the fuzzy edit distance of the alias. */
|
|
734
|
-
fuzzyEditDistance?: number;
|
|
596
|
+
fuzzyEditDistance?: number | null;
|
|
735
597
|
}
|
|
736
598
|
|
|
737
599
|
/** A skill looks for text from a custom, user-defined list of words and phrases. */
|
|
@@ -739,24 +601,24 @@ export declare type CustomEntityLookupSkill = BaseSearchIndexerSkill & {
|
|
|
739
601
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
740
602
|
odatatype: "#Microsoft.Skills.Text.CustomEntityLookupSkill";
|
|
741
603
|
/** A value indicating which language code to use. Default is en. */
|
|
742
|
-
defaultLanguageCode?: CustomEntityLookupSkillLanguage;
|
|
604
|
+
defaultLanguageCode?: CustomEntityLookupSkillLanguage | null;
|
|
743
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. */
|
|
744
|
-
entitiesDefinitionUri?: string;
|
|
606
|
+
entitiesDefinitionUri?: string | null;
|
|
745
607
|
/** The inline CustomEntity definition. */
|
|
746
|
-
inlineEntitiesDefinition?: CustomEntity[];
|
|
608
|
+
inlineEntitiesDefinition?: CustomEntity[] | null;
|
|
747
609
|
/** A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value. */
|
|
748
|
-
globalDefaultCaseSensitive?: boolean;
|
|
610
|
+
globalDefaultCaseSensitive?: boolean | null;
|
|
749
611
|
/** A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value. */
|
|
750
|
-
globalDefaultAccentSensitive?: boolean;
|
|
612
|
+
globalDefaultAccentSensitive?: boolean | null;
|
|
751
613
|
/** A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value. */
|
|
752
|
-
globalDefaultFuzzyEditDistance?: number;
|
|
614
|
+
globalDefaultFuzzyEditDistance?: number | null;
|
|
753
615
|
};
|
|
754
616
|
|
|
755
617
|
/**
|
|
756
618
|
* Defines values for CustomEntityLookupSkillLanguage. \
|
|
757
619
|
* {@link KnownCustomEntityLookupSkillLanguage} can be used interchangeably with CustomEntityLookupSkillLanguage,
|
|
758
620
|
* this enum contains the known values that the service supports.
|
|
759
|
-
* ###
|
|
621
|
+
* ### Know values supported by the service
|
|
760
622
|
* **da**: Danish \
|
|
761
623
|
* **de**: German \
|
|
762
624
|
* **en**: English \
|
|
@@ -769,16 +631,6 @@ export declare type CustomEntityLookupSkill = BaseSearchIndexerSkill & {
|
|
|
769
631
|
*/
|
|
770
632
|
export declare type CustomEntityLookupSkillLanguage = string;
|
|
771
633
|
|
|
772
|
-
/** Allows you to configure normalization for filterable, sortable, and facetable fields, which by default operate with strict matching. This is a user-defined configuration consisting of at least one or more filters, which modify the token that is stored. */
|
|
773
|
-
export declare type CustomNormalizer = BaseLexicalNormalizer & {
|
|
774
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
775
|
-
odatatype: "#Microsoft.Azure.Search.CustomNormalizer";
|
|
776
|
-
/** A list of token filters used to filter out or modify the input token. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed. */
|
|
777
|
-
tokenFilters?: TokenFilterName[];
|
|
778
|
-
/** A list of character filters used to prepare input text before it is processed. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed. */
|
|
779
|
-
charFilters?: CharFilterName[];
|
|
780
|
-
};
|
|
781
|
-
|
|
782
634
|
/**
|
|
783
635
|
* Contains the possible cases for DataChangeDetectionPolicy.
|
|
784
636
|
*/
|
|
@@ -810,16 +662,6 @@ export declare type DefaultCognitiveServicesAccount = BaseCognitiveServicesAccou
|
|
|
810
662
|
odatatype: "#Microsoft.Azure.Search.DefaultCognitiveServices";
|
|
811
663
|
};
|
|
812
664
|
|
|
813
|
-
/**
|
|
814
|
-
* Options for delete alias operation.
|
|
815
|
-
*/
|
|
816
|
-
export declare interface DeleteAliasOptions extends OperationOptions {
|
|
817
|
-
/**
|
|
818
|
-
* If set to true, Resource will be deleted only if the etag matches.
|
|
819
|
-
*/
|
|
820
|
-
onlyIfUnchanged?: boolean;
|
|
821
|
-
}
|
|
822
|
-
|
|
823
665
|
/**
|
|
824
666
|
* Options for delete datasource operation.
|
|
825
667
|
*/
|
|
@@ -912,13 +754,13 @@ export declare type DocumentExtractionSkill = BaseSearchIndexerSkill & {
|
|
|
912
754
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
913
755
|
odatatype: "#Microsoft.Skills.Util.DocumentExtractionSkill";
|
|
914
756
|
/** The parsingMode for the skill. Will be set to 'default' if not defined. */
|
|
915
|
-
parsingMode?: string;
|
|
757
|
+
parsingMode?: string | null;
|
|
916
758
|
/** The type of data to be extracted for the skill. Will be set to 'contentAndMetadata' if not defined. */
|
|
917
|
-
dataToExtract?: string;
|
|
759
|
+
dataToExtract?: string | null;
|
|
918
760
|
/** A dictionary of configurations for the skill. */
|
|
919
761
|
configuration?: {
|
|
920
|
-
[propertyName: string]:
|
|
921
|
-
};
|
|
762
|
+
[propertyName: string]: any;
|
|
763
|
+
} | null;
|
|
922
764
|
};
|
|
923
765
|
|
|
924
766
|
/**
|
|
@@ -979,7 +821,7 @@ export declare type ElisionTokenFilter = BaseTokenFilter & {
|
|
|
979
821
|
* Defines values for EntityCategory. \
|
|
980
822
|
* {@link KnownEntityCategory} can be used interchangeably with EntityCategory,
|
|
981
823
|
* this enum contains the known values that the service supports.
|
|
982
|
-
* ###
|
|
824
|
+
* ### Know values supported by the service
|
|
983
825
|
* **location**: Entities describing a physical location. \
|
|
984
826
|
* **organization**: Entities describing an organization. \
|
|
985
827
|
* **person**: Entities describing a person. \
|
|
@@ -990,18 +832,6 @@ export declare type ElisionTokenFilter = BaseTokenFilter & {
|
|
|
990
832
|
*/
|
|
991
833
|
export declare type EntityCategory = string;
|
|
992
834
|
|
|
993
|
-
/** Using the Text Analytics API, extracts linked entities from text. */
|
|
994
|
-
export declare type EntityLinkingSkill = BaseSearchIndexerSkill & {
|
|
995
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
996
|
-
odatatype: "#Microsoft.Skills.Text.V3.EntityLinkingSkill";
|
|
997
|
-
/** A value indicating which language code to use. Default is en. */
|
|
998
|
-
defaultLanguageCode?: string;
|
|
999
|
-
/** A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included. */
|
|
1000
|
-
minimumPrecision?: number;
|
|
1001
|
-
/** The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary. */
|
|
1002
|
-
modelVersion?: string;
|
|
1003
|
-
};
|
|
1004
|
-
|
|
1005
835
|
/** Text analytics entity recognition. */
|
|
1006
836
|
export declare type EntityRecognitionSkill = BaseSearchIndexerSkill & {
|
|
1007
837
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -1011,16 +841,16 @@ export declare type EntityRecognitionSkill = BaseSearchIndexerSkill & {
|
|
|
1011
841
|
/** A value indicating which language code to use. Default is en. */
|
|
1012
842
|
defaultLanguageCode?: EntityRecognitionSkillLanguage;
|
|
1013
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. */
|
|
1014
|
-
includeTypelessEntities?: boolean;
|
|
844
|
+
includeTypelessEntities?: boolean | null;
|
|
1015
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. */
|
|
1016
|
-
minimumPrecision?: number;
|
|
846
|
+
minimumPrecision?: number | null;
|
|
1017
847
|
};
|
|
1018
848
|
|
|
1019
849
|
/**
|
|
1020
850
|
* Defines values for EntityRecognitionSkillLanguage. \
|
|
1021
851
|
* {@link KnownEntityRecognitionSkillLanguage} can be used interchangeably with EntityRecognitionSkillLanguage,
|
|
1022
852
|
* this enum contains the known values that the service supports.
|
|
1023
|
-
* ###
|
|
853
|
+
* ### Know values supported by the service
|
|
1024
854
|
* **ar**: Arabic \
|
|
1025
855
|
* **cs**: Czech \
|
|
1026
856
|
* **zh-Hans**: Chinese-Simplified \
|
|
@@ -1047,20 +877,6 @@ export declare type EntityRecognitionSkill = BaseSearchIndexerSkill & {
|
|
|
1047
877
|
*/
|
|
1048
878
|
export declare type EntityRecognitionSkillLanguage = string;
|
|
1049
879
|
|
|
1050
|
-
/** Using the Text Analytics API, extracts entities of different types from text. */
|
|
1051
|
-
export declare type EntityRecognitionSkillV3 = BaseSearchIndexerSkill & {
|
|
1052
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1053
|
-
odatatype: "#Microsoft.Skills.Text.V3.EntityRecognitionSkill";
|
|
1054
|
-
/** A list of entity categories that should be extracted. */
|
|
1055
|
-
categories?: string[];
|
|
1056
|
-
/** A value indicating which language code to use. Default is en. */
|
|
1057
|
-
defaultLanguageCode?: string;
|
|
1058
|
-
/** A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included. */
|
|
1059
|
-
minimumPrecision?: number;
|
|
1060
|
-
/** The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary. */
|
|
1061
|
-
modelVersion?: string;
|
|
1062
|
-
};
|
|
1063
|
-
|
|
1064
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. */
|
|
1065
881
|
export declare interface FacetResult {
|
|
1066
882
|
/** Describes unknown properties. The value of an unknown property can be of "any" type. */
|
|
@@ -1079,7 +895,7 @@ export declare interface FieldMapping {
|
|
|
1079
895
|
/** The name of the target field in the index. Same as the source field name by default. */
|
|
1080
896
|
targetFieldName?: string;
|
|
1081
897
|
/** A function to apply to each source field value before indexing. */
|
|
1082
|
-
mappingFunction?: FieldMappingFunction;
|
|
898
|
+
mappingFunction?: FieldMappingFunction | null;
|
|
1083
899
|
}
|
|
1084
900
|
|
|
1085
901
|
/** Represents a function that transforms a value from a data source before indexing. */
|
|
@@ -1088,7 +904,7 @@ export declare interface FieldMappingFunction {
|
|
|
1088
904
|
name: string;
|
|
1089
905
|
/** A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. */
|
|
1090
906
|
parameters?: {
|
|
1091
|
-
[propertyName: string]:
|
|
907
|
+
[propertyName: string]: any;
|
|
1092
908
|
};
|
|
1093
909
|
}
|
|
1094
910
|
|
|
@@ -1133,11 +949,6 @@ export declare class GeographyPoint {
|
|
|
1133
949
|
toJSON(): Record<string, unknown>;
|
|
1134
950
|
}
|
|
1135
951
|
|
|
1136
|
-
/**
|
|
1137
|
-
* Options for get alias operation.
|
|
1138
|
-
*/
|
|
1139
|
-
export declare type GetAliasOptions = OperationOptions;
|
|
1140
|
-
|
|
1141
952
|
/**
|
|
1142
953
|
* Options for get datasource operation.
|
|
1143
954
|
*/
|
|
@@ -1213,7 +1024,7 @@ export declare type ImageAnalysisSkill = BaseSearchIndexerSkill & {
|
|
|
1213
1024
|
* Defines values for ImageAnalysisSkillLanguage. \
|
|
1214
1025
|
* {@link KnownImageAnalysisSkillLanguage} can be used interchangeably with ImageAnalysisSkillLanguage,
|
|
1215
1026
|
* this enum contains the known values that the service supports.
|
|
1216
|
-
* ###
|
|
1027
|
+
* ### Know values supported by the service
|
|
1217
1028
|
* **en**: English \
|
|
1218
1029
|
* **es**: Spanish \
|
|
1219
1030
|
* **ja**: Japanese \
|
|
@@ -1226,7 +1037,7 @@ export declare type ImageAnalysisSkillLanguage = string;
|
|
|
1226
1037
|
* Defines values for ImageDetail. \
|
|
1227
1038
|
* {@link KnownImageDetail} can be used interchangeably with ImageDetail,
|
|
1228
1039
|
* this enum contains the known values that the service supports.
|
|
1229
|
-
* ###
|
|
1040
|
+
* ### Know values supported by the service
|
|
1230
1041
|
* **celebrities**: Details recognized as celebrities. \
|
|
1231
1042
|
* **landmarks**: Details recognized as landmarks.
|
|
1232
1043
|
*/
|
|
@@ -1324,7 +1135,7 @@ export declare interface IndexDocumentsResult {
|
|
|
1324
1135
|
* Defines values for IndexerExecutionEnvironment. \
|
|
1325
1136
|
* {@link KnownIndexerExecutionEnvironment} can be used interchangeably with IndexerExecutionEnvironment,
|
|
1326
1137
|
* this enum contains the known values that the service supports.
|
|
1327
|
-
* ###
|
|
1138
|
+
* ### Know values supported by the service
|
|
1328
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. \
|
|
1329
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.
|
|
1330
1141
|
*/
|
|
@@ -1337,16 +1148,6 @@ export declare interface IndexerExecutionResult {
|
|
|
1337
1148
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1338
1149
|
*/
|
|
1339
1150
|
readonly status: IndexerExecutionStatus;
|
|
1340
|
-
/**
|
|
1341
|
-
* The outcome of this indexer execution.
|
|
1342
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1343
|
-
*/
|
|
1344
|
-
readonly statusDetail?: IndexerExecutionStatusDetail;
|
|
1345
|
-
/**
|
|
1346
|
-
* All of the state that defines and dictates the indexer's current execution.
|
|
1347
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1348
|
-
*/
|
|
1349
|
-
readonly currentState?: IndexerState;
|
|
1350
1151
|
/**
|
|
1351
1152
|
* The error message indicating the top-level error, if any.
|
|
1352
1153
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
@@ -1361,7 +1162,7 @@ export declare interface IndexerExecutionResult {
|
|
|
1361
1162
|
* The end time of this indexer execution, if the execution has already completed.
|
|
1362
1163
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1363
1164
|
*/
|
|
1364
|
-
readonly endTime?: Date;
|
|
1165
|
+
readonly endTime?: Date | null;
|
|
1365
1166
|
/**
|
|
1366
1167
|
* The item-level indexing errors.
|
|
1367
1168
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
@@ -1397,75 +1198,17 @@ export declare interface IndexerExecutionResult {
|
|
|
1397
1198
|
/** Defines values for IndexerExecutionStatus. */
|
|
1398
1199
|
export declare type IndexerExecutionStatus = "transientFailure" | "success" | "inProgress" | "reset";
|
|
1399
1200
|
|
|
1400
|
-
/**
|
|
1401
|
-
* Defines values for IndexerExecutionStatusDetail. \
|
|
1402
|
-
* {@link KnownIndexerExecutionStatusDetail} can be used interchangeably with IndexerExecutionStatusDetail,
|
|
1403
|
-
* this enum contains the known values that the service supports.
|
|
1404
|
-
* ### Known values supported by the service
|
|
1405
|
-
* **resetDocs**: Indicates that the reset that occurred was for a call to ResetDocs.
|
|
1406
|
-
*/
|
|
1407
|
-
export declare type IndexerExecutionStatusDetail = string;
|
|
1408
|
-
|
|
1409
|
-
/** Represents all of the state that defines and dictates the indexer's current execution. */
|
|
1410
|
-
export declare interface IndexerState {
|
|
1411
|
-
/**
|
|
1412
|
-
* The mode the indexer is running in.
|
|
1413
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1414
|
-
*/
|
|
1415
|
-
readonly mode?: IndexingMode;
|
|
1416
|
-
/**
|
|
1417
|
-
* Change tracking state used when indexing starts on all documents in the datasource.
|
|
1418
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1419
|
-
*/
|
|
1420
|
-
readonly allDocumentsInitialChangeTrackingState?: string;
|
|
1421
|
-
/**
|
|
1422
|
-
* Change tracking state value when indexing finishes on all documents in the datasource.
|
|
1423
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1424
|
-
*/
|
|
1425
|
-
readonly allDocumentsFinalChangeTrackingState?: string;
|
|
1426
|
-
/**
|
|
1427
|
-
* Change tracking state used when indexing starts on select, reset documents in the datasource.
|
|
1428
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1429
|
-
*/
|
|
1430
|
-
readonly resetDocumentsInitialChangeTrackingState?: string;
|
|
1431
|
-
/**
|
|
1432
|
-
* Change tracking state value when indexing finishes on select, reset documents in the datasource.
|
|
1433
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1434
|
-
*/
|
|
1435
|
-
readonly resetDocumentsFinalChangeTrackingState?: string;
|
|
1436
|
-
/**
|
|
1437
|
-
* 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.
|
|
1438
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1439
|
-
*/
|
|
1440
|
-
readonly resetDocumentKeys?: string[];
|
|
1441
|
-
/**
|
|
1442
|
-
* 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.
|
|
1443
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1444
|
-
*/
|
|
1445
|
-
readonly resetDatasourceDocumentIds?: string[];
|
|
1446
|
-
}
|
|
1447
|
-
|
|
1448
1201
|
/** Defines values for IndexerStatus. */
|
|
1449
1202
|
export declare type IndexerStatus = "unknown" | "error" | "running";
|
|
1450
1203
|
|
|
1451
|
-
/**
|
|
1452
|
-
* Defines values for IndexingMode. \
|
|
1453
|
-
* {@link KnownIndexingMode} can be used interchangeably with IndexingMode,
|
|
1454
|
-
* this enum contains the known values that the service supports.
|
|
1455
|
-
* ### Known values supported by the service
|
|
1456
|
-
* **indexingAllDocs**: The indexer is indexing all documents in the datasource. \
|
|
1457
|
-
* **indexingResetDocs**: The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status.
|
|
1458
|
-
*/
|
|
1459
|
-
export declare type IndexingMode = string;
|
|
1460
|
-
|
|
1461
1204
|
/** Represents parameters for indexer execution. */
|
|
1462
1205
|
export declare interface IndexingParameters {
|
|
1463
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. */
|
|
1464
|
-
batchSize?: number;
|
|
1207
|
+
batchSize?: number | null;
|
|
1465
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. */
|
|
1466
|
-
maxFailedItems?: number;
|
|
1209
|
+
maxFailedItems?: number | null;
|
|
1467
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. */
|
|
1468
|
-
maxFailedItemsPerBatch?: number;
|
|
1211
|
+
maxFailedItemsPerBatch?: number | null;
|
|
1469
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. */
|
|
1470
1213
|
configuration?: IndexingParametersConfiguration;
|
|
1471
1214
|
}
|
|
@@ -1583,16 +1326,16 @@ export declare type KeyPhraseExtractionSkill = BaseSearchIndexerSkill & {
|
|
|
1583
1326
|
/** A value indicating which language code to use. Default is en. */
|
|
1584
1327
|
defaultLanguageCode?: KeyPhraseExtractionSkillLanguage;
|
|
1585
1328
|
/** A number indicating how many key phrases to return. If absent, all identified key phrases will be returned. */
|
|
1586
|
-
maxKeyPhraseCount?: number;
|
|
1329
|
+
maxKeyPhraseCount?: number | null;
|
|
1587
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. */
|
|
1588
|
-
modelVersion?: string;
|
|
1331
|
+
modelVersion?: string | null;
|
|
1589
1332
|
};
|
|
1590
1333
|
|
|
1591
1334
|
/**
|
|
1592
1335
|
* Defines values for KeyPhraseExtractionSkillLanguage. \
|
|
1593
1336
|
* {@link KnownKeyPhraseExtractionSkillLanguage} can be used interchangeably with KeyPhraseExtractionSkillLanguage,
|
|
1594
1337
|
* this enum contains the known values that the service supports.
|
|
1595
|
-
* ###
|
|
1338
|
+
* ### Know values supported by the service
|
|
1596
1339
|
* **da**: Danish \
|
|
1597
1340
|
* **nl**: Dutch \
|
|
1598
1341
|
* **en**: English \
|
|
@@ -2022,16 +1765,8 @@ export declare enum KnownAnalyzerNames {
|
|
|
2022
1765
|
Whitespace = "whitespace"
|
|
2023
1766
|
}
|
|
2024
1767
|
|
|
2025
|
-
/** Known values of {@link Answers} that the service accepts. */
|
|
2026
|
-
export declare enum KnownAnswers {
|
|
2027
|
-
/** Do not return answers for the query. */
|
|
2028
|
-
None = "none",
|
|
2029
|
-
/** Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. */
|
|
2030
|
-
Extractive = "extractive"
|
|
2031
|
-
}
|
|
2032
|
-
|
|
2033
1768
|
/** Known values of {@link BlobIndexerDataToExtract} that the service accepts. */
|
|
2034
|
-
export declare enum KnownBlobIndexerDataToExtract {
|
|
1769
|
+
export declare const enum KnownBlobIndexerDataToExtract {
|
|
2035
1770
|
/** Indexes just the standard blob properties and user-specified metadata. */
|
|
2036
1771
|
StorageMetadata = "storageMetadata",
|
|
2037
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). */
|
|
@@ -2041,7 +1776,7 @@ export declare enum KnownBlobIndexerDataToExtract {
|
|
|
2041
1776
|
}
|
|
2042
1777
|
|
|
2043
1778
|
/** Known values of {@link BlobIndexerImageAction} that the service accepts. */
|
|
2044
|
-
export declare enum KnownBlobIndexerImageAction {
|
|
1779
|
+
export declare const enum KnownBlobIndexerImageAction {
|
|
2045
1780
|
/** Ignores embedded images or image files in the data set. This is the default. */
|
|
2046
1781
|
None = "none",
|
|
2047
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. */
|
|
@@ -2051,7 +1786,7 @@ export declare enum KnownBlobIndexerImageAction {
|
|
|
2051
1786
|
}
|
|
2052
1787
|
|
|
2053
1788
|
/** Known values of {@link BlobIndexerParsingMode} that the service accepts. */
|
|
2054
|
-
export declare enum KnownBlobIndexerParsingMode {
|
|
1789
|
+
export declare const enum KnownBlobIndexerParsingMode {
|
|
2055
1790
|
/** Set to default for normal file processing. */
|
|
2056
1791
|
Default = "default",
|
|
2057
1792
|
/** Set to text to improve indexing performance on plain text files in blob storage. */
|
|
@@ -2067,7 +1802,7 @@ export declare enum KnownBlobIndexerParsingMode {
|
|
|
2067
1802
|
}
|
|
2068
1803
|
|
|
2069
1804
|
/** Known values of {@link BlobIndexerPDFTextRotationAlgorithm} that the service accepts. */
|
|
2070
|
-
export declare enum KnownBlobIndexerPDFTextRotationAlgorithm {
|
|
1805
|
+
export declare const enum KnownBlobIndexerPDFTextRotationAlgorithm {
|
|
2071
1806
|
/** Leverages normal text extraction. This is the default. */
|
|
2072
1807
|
None = "none",
|
|
2073
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. */
|
|
@@ -2075,7 +1810,7 @@ export declare enum KnownBlobIndexerPDFTextRotationAlgorithm {
|
|
|
2075
1810
|
}
|
|
2076
1811
|
|
|
2077
1812
|
/** Known values of {@link CharFilterName} that the service accepts. */
|
|
2078
|
-
export declare enum KnownCharFilterName {
|
|
1813
|
+
export declare const enum KnownCharFilterName {
|
|
2079
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 */
|
|
2080
1815
|
HtmlStrip = "html_strip"
|
|
2081
1816
|
}
|
|
@@ -2093,7 +1828,7 @@ export declare enum KnownCharFilterNames {
|
|
|
2093
1828
|
}
|
|
2094
1829
|
|
|
2095
1830
|
/** Known values of {@link CustomEntityLookupSkillLanguage} that the service accepts. */
|
|
2096
|
-
export declare enum KnownCustomEntityLookupSkillLanguage {
|
|
1831
|
+
export declare const enum KnownCustomEntityLookupSkillLanguage {
|
|
2097
1832
|
/** Danish */
|
|
2098
1833
|
Da = "da",
|
|
2099
1834
|
/** German */
|
|
@@ -2115,7 +1850,7 @@ export declare enum KnownCustomEntityLookupSkillLanguage {
|
|
|
2115
1850
|
}
|
|
2116
1851
|
|
|
2117
1852
|
/** Known values of {@link EntityCategory} that the service accepts. */
|
|
2118
|
-
export declare enum KnownEntityCategory {
|
|
1853
|
+
export declare const enum KnownEntityCategory {
|
|
2119
1854
|
/** Entities describing a physical location. */
|
|
2120
1855
|
Location = "location",
|
|
2121
1856
|
/** Entities describing an organization. */
|
|
@@ -2133,7 +1868,7 @@ export declare enum KnownEntityCategory {
|
|
|
2133
1868
|
}
|
|
2134
1869
|
|
|
2135
1870
|
/** Known values of {@link EntityRecognitionSkillLanguage} that the service accepts. */
|
|
2136
|
-
export declare enum KnownEntityRecognitionSkillLanguage {
|
|
1871
|
+
export declare const enum KnownEntityRecognitionSkillLanguage {
|
|
2137
1872
|
/** Arabic */
|
|
2138
1873
|
Ar = "ar",
|
|
2139
1874
|
/** Czech */
|
|
@@ -2183,7 +1918,7 @@ export declare enum KnownEntityRecognitionSkillLanguage {
|
|
|
2183
1918
|
}
|
|
2184
1919
|
|
|
2185
1920
|
/** Known values of {@link ImageAnalysisSkillLanguage} that the service accepts. */
|
|
2186
|
-
export declare enum KnownImageAnalysisSkillLanguage {
|
|
1921
|
+
export declare const enum KnownImageAnalysisSkillLanguage {
|
|
2187
1922
|
/** English */
|
|
2188
1923
|
En = "en",
|
|
2189
1924
|
/** Spanish */
|
|
@@ -2197,29 +1932,15 @@ export declare enum KnownImageAnalysisSkillLanguage {
|
|
|
2197
1932
|
}
|
|
2198
1933
|
|
|
2199
1934
|
/** Known values of {@link ImageDetail} that the service accepts. */
|
|
2200
|
-
export declare enum KnownImageDetail {
|
|
1935
|
+
export declare const enum KnownImageDetail {
|
|
2201
1936
|
/** Details recognized as celebrities. */
|
|
2202
1937
|
Celebrities = "celebrities",
|
|
2203
1938
|
/** Details recognized as landmarks. */
|
|
2204
1939
|
Landmarks = "landmarks"
|
|
2205
1940
|
}
|
|
2206
1941
|
|
|
2207
|
-
/** Known values of {@link IndexerExecutionStatusDetail} that the service accepts. */
|
|
2208
|
-
export declare enum KnownIndexerExecutionStatusDetail {
|
|
2209
|
-
/** Indicates that the reset that occurred was for a call to ResetDocs. */
|
|
2210
|
-
ResetDocs = "resetDocs"
|
|
2211
|
-
}
|
|
2212
|
-
|
|
2213
|
-
/** Known values of {@link IndexingMode} that the service accepts. */
|
|
2214
|
-
export declare enum KnownIndexingMode {
|
|
2215
|
-
/** The indexer is indexing all documents in the datasource. */
|
|
2216
|
-
IndexingAllDocs = "indexingAllDocs",
|
|
2217
|
-
/** The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status. */
|
|
2218
|
-
IndexingResetDocs = "indexingResetDocs"
|
|
2219
|
-
}
|
|
2220
|
-
|
|
2221
1942
|
/** Known values of {@link KeyPhraseExtractionSkillLanguage} that the service accepts. */
|
|
2222
|
-
export declare enum KnownKeyPhraseExtractionSkillLanguage {
|
|
1943
|
+
export declare const enum KnownKeyPhraseExtractionSkillLanguage {
|
|
2223
1944
|
/** Danish */
|
|
2224
1945
|
Da = "da",
|
|
2225
1946
|
/** Dutch */
|
|
@@ -2255,7 +1976,7 @@ export declare enum KnownKeyPhraseExtractionSkillLanguage {
|
|
|
2255
1976
|
}
|
|
2256
1977
|
|
|
2257
1978
|
/** Known values of {@link LexicalAnalyzerName} that the service accepts. */
|
|
2258
|
-
export declare enum KnownLexicalAnalyzerName {
|
|
1979
|
+
export declare const enum KnownLexicalAnalyzerName {
|
|
2259
1980
|
/** Microsoft analyzer for Arabic. */
|
|
2260
1981
|
ArMicrosoft = "ar.microsoft",
|
|
2261
1982
|
/** Lucene analyzer for Arabic. */
|
|
@@ -2444,34 +2165,8 @@ export declare enum KnownLexicalAnalyzerName {
|
|
|
2444
2165
|
Whitespace = "whitespace"
|
|
2445
2166
|
}
|
|
2446
2167
|
|
|
2447
|
-
/** Known values of {@link LexicalNormalizerName} that the service accepts. */
|
|
2448
|
-
export declare enum KnownLexicalNormalizerName {
|
|
2449
|
-
/** 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 */
|
|
2450
|
-
AsciiFolding = "asciifolding",
|
|
2451
|
-
/** 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 */
|
|
2452
|
-
Elision = "elision",
|
|
2453
|
-
/** Normalizes token text to lowercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html */
|
|
2454
|
-
Lowercase = "lowercase",
|
|
2455
|
-
/** 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 */
|
|
2456
|
-
Standard = "standard",
|
|
2457
|
-
/** Normalizes token text to uppercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html */
|
|
2458
|
-
Uppercase = "uppercase"
|
|
2459
|
-
}
|
|
2460
|
-
|
|
2461
|
-
/** Known values of {@link LineEnding} that the service accepts. */
|
|
2462
|
-
export declare enum KnownLineEnding {
|
|
2463
|
-
/** Lines are separated by a single space character. */
|
|
2464
|
-
Space = "space",
|
|
2465
|
-
/** Lines are separated by a carriage return ('\r') character. */
|
|
2466
|
-
CarriageReturn = "carriageReturn",
|
|
2467
|
-
/** Lines are separated by a single line feed ('\n') character. */
|
|
2468
|
-
LineFeed = "lineFeed",
|
|
2469
|
-
/** Lines are separated by a carriage return and a line feed ('\r\n') character. */
|
|
2470
|
-
CarriageReturnLineFeed = "carriageReturnLineFeed"
|
|
2471
|
-
}
|
|
2472
|
-
|
|
2473
2168
|
/** Known values of {@link OcrSkillLanguage} that the service accepts. */
|
|
2474
|
-
export declare enum KnownOcrSkillLanguage {
|
|
2169
|
+
export declare const enum KnownOcrSkillLanguage {
|
|
2475
2170
|
/** Chinese-Simplified */
|
|
2476
2171
|
ZhHans = "zh-Hans",
|
|
2477
2172
|
/** Chinese-Traditional */
|
|
@@ -2523,193 +2218,11 @@ export declare enum KnownOcrSkillLanguage {
|
|
|
2523
2218
|
/** Serbian (Latin, Serbia) */
|
|
2524
2219
|
SrLatn = "sr-Latn",
|
|
2525
2220
|
/** Slovak */
|
|
2526
|
-
Sk = "sk"
|
|
2527
|
-
/** Unknown. If the language is explicitly set to "unk", the language will be auto-detected. */
|
|
2528
|
-
Unk = "unk"
|
|
2529
|
-
}
|
|
2530
|
-
|
|
2531
|
-
/** Known values of {@link PIIDetectionSkillMaskingMode} that the service accepts. */
|
|
2532
|
-
export declare enum KnownPIIDetectionSkillMaskingMode {
|
|
2533
|
-
/** No masking occurs and the maskedText output will not be returned. */
|
|
2534
|
-
None = "none",
|
|
2535
|
-
/** 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. */
|
|
2536
|
-
Replace = "replace"
|
|
2537
|
-
}
|
|
2538
|
-
|
|
2539
|
-
/** Known values of {@link QueryAnswerType} that the service accepts. */
|
|
2540
|
-
export declare enum KnownQueryAnswerType {
|
|
2541
|
-
/** Do not return answers for the query. */
|
|
2542
|
-
None = "none",
|
|
2543
|
-
/** Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. */
|
|
2544
|
-
Extractive = "extractive"
|
|
2545
|
-
}
|
|
2546
|
-
|
|
2547
|
-
/** Known values of {@link QueryCaptionType} that the service accepts. */
|
|
2548
|
-
export declare enum KnownQueryCaptionType {
|
|
2549
|
-
/** Do not return captions for the query. */
|
|
2550
|
-
None = "none",
|
|
2551
|
-
/** Extracts captions from the matching documents that contain passages relevant to the search query. */
|
|
2552
|
-
Extractive = "extractive"
|
|
2553
|
-
}
|
|
2554
|
-
|
|
2555
|
-
/** Known values of {@link QueryLanguage} that the service accepts. */
|
|
2556
|
-
export declare enum KnownQueryLanguage {
|
|
2557
|
-
/** Query language not specified. */
|
|
2558
|
-
None = "none",
|
|
2559
|
-
/** Query language value for English (United States). */
|
|
2560
|
-
EnUs = "en-us",
|
|
2561
|
-
/** Query language value for English (Great Britain). */
|
|
2562
|
-
EnGb = "en-gb",
|
|
2563
|
-
/** Query language value for English (India). */
|
|
2564
|
-
EnIn = "en-in",
|
|
2565
|
-
/** Query language value for English (Canada). */
|
|
2566
|
-
EnCa = "en-ca",
|
|
2567
|
-
/** Query language value for English (Australia). */
|
|
2568
|
-
EnAu = "en-au",
|
|
2569
|
-
/** Query language value for French (France). */
|
|
2570
|
-
FrFr = "fr-fr",
|
|
2571
|
-
/** Query language value for French (Canada). */
|
|
2572
|
-
FrCa = "fr-ca",
|
|
2573
|
-
/** Query language value for German (Germany). */
|
|
2574
|
-
DeDe = "de-de",
|
|
2575
|
-
/** Query language value for Spanish (Spain). */
|
|
2576
|
-
EsEs = "es-es",
|
|
2577
|
-
/** Query language value for Spanish (Mexico). */
|
|
2578
|
-
EsMx = "es-mx",
|
|
2579
|
-
/** Query language value for Chinese (China). */
|
|
2580
|
-
ZhCn = "zh-cn",
|
|
2581
|
-
/** Query language value for Chinese (Taiwan). */
|
|
2582
|
-
ZhTw = "zh-tw",
|
|
2583
|
-
/** Query language value for Portuguese (Brazil). */
|
|
2584
|
-
PtBr = "pt-br",
|
|
2585
|
-
/** Query language value for Portuguese (Portugal). */
|
|
2586
|
-
PtPt = "pt-pt",
|
|
2587
|
-
/** Query language value for Italian (Italy). */
|
|
2588
|
-
ItIt = "it-it",
|
|
2589
|
-
/** Query language value for Japanese (Japan). */
|
|
2590
|
-
JaJp = "ja-jp",
|
|
2591
|
-
/** Query language value for Korean (Korea). */
|
|
2592
|
-
KoKr = "ko-kr",
|
|
2593
|
-
/** Query language value for Russian (Russia). */
|
|
2594
|
-
RuRu = "ru-ru",
|
|
2595
|
-
/** Query language value for Czech (Czech Republic). */
|
|
2596
|
-
CsCz = "cs-cz",
|
|
2597
|
-
/** Query language value for Dutch (Belgium). */
|
|
2598
|
-
NlBe = "nl-be",
|
|
2599
|
-
/** Query language value for Dutch (Netherlands). */
|
|
2600
|
-
NlNl = "nl-nl",
|
|
2601
|
-
/** Query language value for Hungarian (Hungary). */
|
|
2602
|
-
HuHu = "hu-hu",
|
|
2603
|
-
/** Query language value for Polish (Poland). */
|
|
2604
|
-
PlPl = "pl-pl",
|
|
2605
|
-
/** Query language value for Swedish (Sweden). */
|
|
2606
|
-
SvSe = "sv-se",
|
|
2607
|
-
/** Query language value for Turkish (Turkey). */
|
|
2608
|
-
TrTr = "tr-tr",
|
|
2609
|
-
/** Query language value for Hindi (India). */
|
|
2610
|
-
HiIn = "hi-in",
|
|
2611
|
-
/** Query language value for Arabic (Saudi Arabia). */
|
|
2612
|
-
ArSa = "ar-sa",
|
|
2613
|
-
/** Query language value for Arabic (Egypt). */
|
|
2614
|
-
ArEg = "ar-eg",
|
|
2615
|
-
/** Query language value for Arabic (Morocco). */
|
|
2616
|
-
ArMa = "ar-ma",
|
|
2617
|
-
/** Query language value for Arabic (Kuwait). */
|
|
2618
|
-
ArKw = "ar-kw",
|
|
2619
|
-
/** Query language value for Arabic (Jordan). */
|
|
2620
|
-
ArJo = "ar-jo",
|
|
2621
|
-
/** Query language value for Danish (Denmark). */
|
|
2622
|
-
DaDk = "da-dk",
|
|
2623
|
-
/** Query language value for Norwegian (Norway). */
|
|
2624
|
-
NoNo = "no-no",
|
|
2625
|
-
/** Query language value for Bulgarian (Bulgaria). */
|
|
2626
|
-
BgBg = "bg-bg",
|
|
2627
|
-
/** Query language value for Croatian (Croatia). */
|
|
2628
|
-
HrHr = "hr-hr",
|
|
2629
|
-
/** Query language value for Croatian (Bosnia and Herzegovina). */
|
|
2630
|
-
HrBa = "hr-ba",
|
|
2631
|
-
/** Query language value for Malay (Malaysia). */
|
|
2632
|
-
MsMy = "ms-my",
|
|
2633
|
-
/** Query language value for Malay (Brunei Darussalam). */
|
|
2634
|
-
MsBn = "ms-bn",
|
|
2635
|
-
/** Query language value for Slovenian (Slovenia). */
|
|
2636
|
-
SlSl = "sl-sl",
|
|
2637
|
-
/** Query language value for Tamil (India). */
|
|
2638
|
-
TaIn = "ta-in",
|
|
2639
|
-
/** Query language value for Vietnamese (Viet Nam). */
|
|
2640
|
-
ViVn = "vi-vn",
|
|
2641
|
-
/** Query language value for Greek (Greece). */
|
|
2642
|
-
ElGr = "el-gr",
|
|
2643
|
-
/** Query language value for Romanian (Romania). */
|
|
2644
|
-
RoRo = "ro-ro",
|
|
2645
|
-
/** Query language value for Icelandic (Iceland). */
|
|
2646
|
-
IsIs = "is-is",
|
|
2647
|
-
/** Query language value for Indonesian (Indonesia). */
|
|
2648
|
-
IdId = "id-id",
|
|
2649
|
-
/** Query language value for Thai (Thailand). */
|
|
2650
|
-
ThTh = "th-th",
|
|
2651
|
-
/** Query language value for Lithuanian (Lithuania). */
|
|
2652
|
-
LtLt = "lt-lt",
|
|
2653
|
-
/** Query language value for Ukrainian (Ukraine). */
|
|
2654
|
-
UkUa = "uk-ua",
|
|
2655
|
-
/** Query language value for Latvian (Latvia). */
|
|
2656
|
-
LvLv = "lv-lv",
|
|
2657
|
-
/** Query language value for Estonian (Estonia). */
|
|
2658
|
-
EtEe = "et-ee",
|
|
2659
|
-
/** Query language value for Catalan (Spain). */
|
|
2660
|
-
CaEs = "ca-es",
|
|
2661
|
-
/** Query language value for Finnish (Finland). */
|
|
2662
|
-
FiFi = "fi-fi",
|
|
2663
|
-
/** Query language value for Serbian (Bosnia and Herzegovina). */
|
|
2664
|
-
SrBa = "sr-ba",
|
|
2665
|
-
/** Query language value for Serbian (Montenegro). */
|
|
2666
|
-
SrMe = "sr-me",
|
|
2667
|
-
/** Query language value for Serbian (Serbia). */
|
|
2668
|
-
SrRs = "sr-rs",
|
|
2669
|
-
/** Query language value for Slovak (Slovakia). */
|
|
2670
|
-
SkSk = "sk-sk",
|
|
2671
|
-
/** Query language value for Norwegian (Norway). */
|
|
2672
|
-
NbNo = "nb-no",
|
|
2673
|
-
/** Query language value for Armenian (Armenia). */
|
|
2674
|
-
HyAm = "hy-am",
|
|
2675
|
-
/** Query language value for Bengali (India). */
|
|
2676
|
-
BnIn = "bn-in",
|
|
2677
|
-
/** Query language value for Basque (Spain). */
|
|
2678
|
-
EuEs = "eu-es",
|
|
2679
|
-
/** Query language value for Galician (Spain). */
|
|
2680
|
-
GlEs = "gl-es",
|
|
2681
|
-
/** Query language value for Gujarati (India). */
|
|
2682
|
-
GuIn = "gu-in",
|
|
2683
|
-
/** Query language value for Hebrew (Israel). */
|
|
2684
|
-
HeIl = "he-il",
|
|
2685
|
-
/** Query language value for Irish (Ireland). */
|
|
2686
|
-
GaIe = "ga-ie",
|
|
2687
|
-
/** Query language value for Kannada (India). */
|
|
2688
|
-
KnIn = "kn-in",
|
|
2689
|
-
/** Query language value for Malayalam (India). */
|
|
2690
|
-
MlIn = "ml-in",
|
|
2691
|
-
/** Query language value for Marathi (India). */
|
|
2692
|
-
MrIn = "mr-in",
|
|
2693
|
-
/** Query language value for Persian (U.A.E.). */
|
|
2694
|
-
FaAe = "fa-ae",
|
|
2695
|
-
/** Query language value for Punjabi (India). */
|
|
2696
|
-
PaIn = "pa-in",
|
|
2697
|
-
/** Query language value for Telugu (India). */
|
|
2698
|
-
TeIn = "te-in",
|
|
2699
|
-
/** Query language value for Urdu (Pakistan). */
|
|
2700
|
-
UrPk = "ur-pk"
|
|
2701
|
-
}
|
|
2702
|
-
|
|
2703
|
-
/** Known values of {@link QuerySpellerType} that the service accepts. */
|
|
2704
|
-
export declare enum KnownQuerySpellerType {
|
|
2705
|
-
/** Speller not enabled. */
|
|
2706
|
-
None = "none",
|
|
2707
|
-
/** Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. */
|
|
2708
|
-
Lexicon = "lexicon"
|
|
2221
|
+
Sk = "sk"
|
|
2709
2222
|
}
|
|
2710
2223
|
|
|
2711
2224
|
/** Known values of {@link RegexFlags} that the service accepts. */
|
|
2712
|
-
export declare enum KnownRegexFlags {
|
|
2225
|
+
export declare const enum KnownRegexFlags {
|
|
2713
2226
|
/** Enables canonical equivalence. */
|
|
2714
2227
|
CanonEq = "CANON_EQ",
|
|
2715
2228
|
/** Enables case-insensitive matching. */
|
|
@@ -2747,7 +2260,7 @@ export declare enum KnownSearchAudience {
|
|
|
2747
2260
|
}
|
|
2748
2261
|
|
|
2749
2262
|
/** Known values of {@link SearchIndexerDataSourceType} that the service accepts. */
|
|
2750
|
-
export declare enum KnownSearchIndexerDataSourceType {
|
|
2263
|
+
export declare const enum KnownSearchIndexerDataSourceType {
|
|
2751
2264
|
/** Indicates an Azure SQL datasource. */
|
|
2752
2265
|
AzureSql = "azuresql",
|
|
2753
2266
|
/** Indicates a CosmosDB datasource. */
|
|
@@ -2763,7 +2276,7 @@ export declare enum KnownSearchIndexerDataSourceType {
|
|
|
2763
2276
|
}
|
|
2764
2277
|
|
|
2765
2278
|
/** Known values of {@link SentimentSkillLanguage} that the service accepts. */
|
|
2766
|
-
export declare enum KnownSentimentSkillLanguage {
|
|
2279
|
+
export declare const enum KnownSentimentSkillLanguage {
|
|
2767
2280
|
/** Danish */
|
|
2768
2281
|
Da = "da",
|
|
2769
2282
|
/** Dutch */
|
|
@@ -2796,16 +2309,8 @@ export declare enum KnownSentimentSkillLanguage {
|
|
|
2796
2309
|
Tr = "tr"
|
|
2797
2310
|
}
|
|
2798
2311
|
|
|
2799
|
-
/** Known values of {@link Speller} that the service accepts. */
|
|
2800
|
-
export declare enum KnownSpeller {
|
|
2801
|
-
/** Speller not enabled. */
|
|
2802
|
-
None = "none",
|
|
2803
|
-
/** Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. */
|
|
2804
|
-
Lexicon = "lexicon"
|
|
2805
|
-
}
|
|
2806
|
-
|
|
2807
2312
|
/** Known values of {@link SplitSkillLanguage} that the service accepts. */
|
|
2808
|
-
export declare enum KnownSplitSkillLanguage {
|
|
2313
|
+
export declare const enum KnownSplitSkillLanguage {
|
|
2809
2314
|
/** Danish */
|
|
2810
2315
|
Da = "da",
|
|
2811
2316
|
/** German */
|
|
@@ -2827,7 +2332,7 @@ export declare enum KnownSplitSkillLanguage {
|
|
|
2827
2332
|
}
|
|
2828
2333
|
|
|
2829
2334
|
/** Known values of {@link TextSplitMode} that the service accepts. */
|
|
2830
|
-
export declare enum KnownTextSplitMode {
|
|
2335
|
+
export declare const enum KnownTextSplitMode {
|
|
2831
2336
|
/** Split the text into individual pages. */
|
|
2832
2337
|
Pages = "pages",
|
|
2833
2338
|
/** Split the text into individual sentences. */
|
|
@@ -2835,7 +2340,7 @@ export declare enum KnownTextSplitMode {
|
|
|
2835
2340
|
}
|
|
2836
2341
|
|
|
2837
2342
|
/** Known values of {@link TextTranslationSkillLanguage} that the service accepts. */
|
|
2838
|
-
export declare enum KnownTextTranslationSkillLanguage {
|
|
2343
|
+
export declare const enum KnownTextTranslationSkillLanguage {
|
|
2839
2344
|
/** Afrikaans */
|
|
2840
2345
|
Af = "af",
|
|
2841
2346
|
/** Arabic */
|
|
@@ -2900,10 +2405,6 @@ export declare enum KnownTextTranslationSkillLanguage {
|
|
|
2900
2405
|
Sw = "sw",
|
|
2901
2406
|
/** Klingon */
|
|
2902
2407
|
Tlh = "tlh",
|
|
2903
|
-
/** Klingon (Latin script) */
|
|
2904
|
-
TlhLatn = "tlh-Latn",
|
|
2905
|
-
/** Klingon (Klingon script) */
|
|
2906
|
-
TlhPiqd = "tlh-Piqd",
|
|
2907
2408
|
/** Korean */
|
|
2908
2409
|
Ko = "ko",
|
|
2909
2410
|
/** Latvian */
|
|
@@ -2924,10 +2425,6 @@ export declare enum KnownTextTranslationSkillLanguage {
|
|
|
2924
2425
|
Pl = "pl",
|
|
2925
2426
|
/** Portuguese */
|
|
2926
2427
|
Pt = "pt",
|
|
2927
|
-
/** Portuguese (Brazil) */
|
|
2928
|
-
PtBr = "pt-br",
|
|
2929
|
-
/** Portuguese (Portugal) */
|
|
2930
|
-
PtPT = "pt-PT",
|
|
2931
2428
|
/** Queretaro Otomi */
|
|
2932
2429
|
Otq = "otq",
|
|
2933
2430
|
/** Romanian */
|
|
@@ -2969,21 +2466,11 @@ export declare enum KnownTextTranslationSkillLanguage {
|
|
|
2969
2466
|
/** Welsh */
|
|
2970
2467
|
Cy = "cy",
|
|
2971
2468
|
/** Yucatec Maya */
|
|
2972
|
-
Yua = "yua"
|
|
2973
|
-
/** Irish */
|
|
2974
|
-
Ga = "ga",
|
|
2975
|
-
/** Kannada */
|
|
2976
|
-
Kn = "kn",
|
|
2977
|
-
/** Maori */
|
|
2978
|
-
Mi = "mi",
|
|
2979
|
-
/** Malayalam */
|
|
2980
|
-
Ml = "ml",
|
|
2981
|
-
/** Punjabi */
|
|
2982
|
-
Pa = "pa"
|
|
2469
|
+
Yua = "yua"
|
|
2983
2470
|
}
|
|
2984
2471
|
|
|
2985
2472
|
/** Known values of {@link TokenFilterName} that the service accepts. */
|
|
2986
|
-
export declare enum KnownTokenFilterName {
|
|
2473
|
+
export declare const enum KnownTokenFilterName {
|
|
2987
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 */
|
|
2988
2475
|
ArabicNormalization = "arabic_normalization",
|
|
2989
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 */
|
|
@@ -3016,7 +2503,7 @@ export declare enum KnownTokenFilterName {
|
|
|
3016
2503
|
Length = "length",
|
|
3017
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 */
|
|
3018
2505
|
Limit = "limit",
|
|
3019
|
-
/** 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 */
|
|
3020
2507
|
Lowercase = "lowercase",
|
|
3021
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 */
|
|
3022
2509
|
NGram = "nGram_v2",
|
|
@@ -3048,7 +2535,7 @@ export declare enum KnownTokenFilterName {
|
|
|
3048
2535
|
Truncate = "truncate",
|
|
3049
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 */
|
|
3050
2537
|
Unique = "unique",
|
|
3051
|
-
/** 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 */
|
|
3052
2539
|
Uppercase = "uppercase",
|
|
3053
2540
|
/** Splits words into subwords and performs optional transformations on subword groups. */
|
|
3054
2541
|
WordDelimiter = "word_delimiter"
|
|
@@ -3309,7 +2796,7 @@ export declare enum KnownTokenizerNames {
|
|
|
3309
2796
|
}
|
|
3310
2797
|
|
|
3311
2798
|
/** Known values of {@link VisualFeature} that the service accepts. */
|
|
3312
|
-
export declare enum KnownVisualFeature {
|
|
2799
|
+
export declare const enum KnownVisualFeature {
|
|
3313
2800
|
/** Visual features recognized as adult persons. */
|
|
3314
2801
|
Adult = "adult",
|
|
3315
2802
|
/** Visual features recognized as commercial brands. */
|
|
@@ -3331,9 +2818,9 @@ export declare type LanguageDetectionSkill = BaseSearchIndexerSkill & {
|
|
|
3331
2818
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
3332
2819
|
odatatype: "#Microsoft.Skills.Text.LanguageDetectionSkill";
|
|
3333
2820
|
/** A country code to use as a hint to the language detection model if it cannot disambiguate the language. */
|
|
3334
|
-
defaultCountryHint?: string;
|
|
2821
|
+
defaultCountryHint?: string | null;
|
|
3335
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. */
|
|
3336
|
-
modelVersion?: string;
|
|
2823
|
+
modelVersion?: string | null;
|
|
3337
2824
|
};
|
|
3338
2825
|
|
|
3339
2826
|
/** Removes words that are too long or too short. This token filter is implemented using Apache Lucene. */
|
|
@@ -3355,7 +2842,7 @@ export declare type LexicalAnalyzer = CustomAnalyzer | PatternAnalyzer | LuceneS
|
|
|
3355
2842
|
* Defines values for LexicalAnalyzerName. \
|
|
3356
2843
|
* {@link KnownLexicalAnalyzerName} can be used interchangeably with LexicalAnalyzerName,
|
|
3357
2844
|
* this enum contains the known values that the service supports.
|
|
3358
|
-
* ###
|
|
2845
|
+
* ### Know values supported by the service
|
|
3359
2846
|
* **ar.microsoft**: Microsoft analyzer for Arabic. \
|
|
3360
2847
|
* **ar.lucene**: Lucene analyzer for Arabic. \
|
|
3361
2848
|
* **hy.lucene**: Lucene analyzer for Armenian. \
|
|
@@ -3443,33 +2930,15 @@ export declare type LexicalAnalyzer = CustomAnalyzer | PatternAnalyzer | LuceneS
|
|
|
3443
2930
|
* **ur.microsoft**: Microsoft analyzer for Urdu. \
|
|
3444
2931
|
* **vi.microsoft**: Microsoft analyzer for Vietnamese. \
|
|
3445
2932
|
* **standard.lucene**: Standard Lucene analyzer. \
|
|
3446
|
-
* **standardasciifolding.lucene**: Standard ASCII Folding Lucene analyzer. See https
|
|
3447
|
-
* **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
|
|
3448
|
-
* **pattern**: Flexibly separates text into terms via a regular expression pattern. See http
|
|
3449
|
-
* **simple**: Divides text at non-letters and converts them to lower case. See http
|
|
3450
|
-
* **stop**: Divides text at non-letters; Applies the lowercase and stopword token filters. See http
|
|
3451
|
-
* **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
|
|
3452
2939
|
*/
|
|
3453
2940
|
export declare type LexicalAnalyzerName = string;
|
|
3454
2941
|
|
|
3455
|
-
/**
|
|
3456
|
-
* Contains the possible cases for LexicalNormalizer.
|
|
3457
|
-
*/
|
|
3458
|
-
export declare type LexicalNormalizer = CustomNormalizer;
|
|
3459
|
-
|
|
3460
|
-
/**
|
|
3461
|
-
* Defines values for LexicalNormalizerName. \
|
|
3462
|
-
* {@link KnownLexicalNormalizerName} can be used interchangeably with LexicalNormalizerName,
|
|
3463
|
-
* this enum contains the known values that the service supports.
|
|
3464
|
-
* ### Known values supported by the service
|
|
3465
|
-
* **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 \
|
|
3466
|
-
* **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 \
|
|
3467
|
-
* **lowercase**: Normalizes token text to lowercase. See https:\/\/lucene.apache.org\/core\/6_6_1\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/LowerCaseFilter.html \
|
|
3468
|
-
* **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 \
|
|
3469
|
-
* **uppercase**: Normalizes token text to uppercase. See https:\/\/lucene.apache.org\/core\/6_6_1\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/UpperCaseFilter.html
|
|
3470
|
-
*/
|
|
3471
|
-
export declare type LexicalNormalizerName = string;
|
|
3472
|
-
|
|
3473
2942
|
/**
|
|
3474
2943
|
* Contains the possible cases for Tokenizer.
|
|
3475
2944
|
*/
|
|
@@ -3485,23 +2954,6 @@ export declare type LimitTokenFilter = BaseTokenFilter & {
|
|
|
3485
2954
|
consumeAllTokens?: boolean;
|
|
3486
2955
|
};
|
|
3487
2956
|
|
|
3488
|
-
/**
|
|
3489
|
-
* Defines values for LineEnding. \
|
|
3490
|
-
* {@link KnownLineEnding} can be used interchangeably with LineEnding,
|
|
3491
|
-
* this enum contains the known values that the service supports.
|
|
3492
|
-
* ### Known values supported by the service
|
|
3493
|
-
* **space**: Lines are separated by a single space character. \
|
|
3494
|
-
* **carriageReturn**: Lines are separated by a carriage return ('\r') character. \
|
|
3495
|
-
* **lineFeed**: Lines are separated by a single line feed ('\n') character. \
|
|
3496
|
-
* **carriageReturnLineFeed**: Lines are separated by a carriage return and a line feed ('\r\n') character.
|
|
3497
|
-
*/
|
|
3498
|
-
export declare type LineEnding = string;
|
|
3499
|
-
|
|
3500
|
-
/**
|
|
3501
|
-
* Options for list aliases operation.
|
|
3502
|
-
*/
|
|
3503
|
-
export declare type ListAliasesOptions = OperationOptions;
|
|
3504
|
-
|
|
3505
2957
|
/**
|
|
3506
2958
|
* Options for a list data sources operation.
|
|
3507
2959
|
*/
|
|
@@ -3691,15 +3143,13 @@ export declare type OcrSkill = BaseSearchIndexerSkill & {
|
|
|
3691
3143
|
defaultLanguageCode?: OcrSkillLanguage;
|
|
3692
3144
|
/** A value indicating to turn orientation detection on or not. Default is false. */
|
|
3693
3145
|
shouldDetectOrientation?: boolean;
|
|
3694
|
-
/** Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is "space". */
|
|
3695
|
-
lineEnding?: LineEnding;
|
|
3696
3146
|
};
|
|
3697
3147
|
|
|
3698
3148
|
/**
|
|
3699
3149
|
* Defines values for OcrSkillLanguage. \
|
|
3700
3150
|
* {@link KnownOcrSkillLanguage} can be used interchangeably with OcrSkillLanguage,
|
|
3701
3151
|
* this enum contains the known values that the service supports.
|
|
3702
|
-
* ###
|
|
3152
|
+
* ### Know values supported by the service
|
|
3703
3153
|
* **zh-Hans**: Chinese-Simplified \
|
|
3704
3154
|
* **zh-Hant**: Chinese-Traditional \
|
|
3705
3155
|
* **cs**: Czech \
|
|
@@ -3725,8 +3175,7 @@ export declare type OcrSkill = BaseSearchIndexerSkill & {
|
|
|
3725
3175
|
* **ro**: Romanian \
|
|
3726
3176
|
* **sr-Cyrl**: Serbian (Cyrillic, Serbia) \
|
|
3727
3177
|
* **sr-Latn**: Serbian (Latin, Serbia) \
|
|
3728
|
-
* **sk**: Slovak
|
|
3729
|
-
* **unk**: Unknown. If the language is explicitly set to "unk", the language will be auto-detected.
|
|
3178
|
+
* **sk**: Slovak
|
|
3730
3179
|
*/
|
|
3731
3180
|
export declare type OcrSkillLanguage = string;
|
|
3732
3181
|
|
|
@@ -3878,164 +3327,14 @@ export declare type PhoneticTokenFilter = BaseTokenFilter & {
|
|
|
3878
3327
|
replaceOriginalTokens?: boolean;
|
|
3879
3328
|
};
|
|
3880
3329
|
|
|
3881
|
-
/** Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it. */
|
|
3882
|
-
export declare type PIIDetectionSkill = BaseSearchIndexerSkill & {
|
|
3883
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
3884
|
-
odatatype: "#Microsoft.Skills.Text.PIIDetectionSkill";
|
|
3885
|
-
/** A value indicating which language code to use. Default is en. */
|
|
3886
|
-
defaultLanguageCode?: string;
|
|
3887
|
-
/** 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. */
|
|
3888
|
-
minimumPrecision?: number;
|
|
3889
|
-
/** A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'. */
|
|
3890
|
-
maskingMode?: PIIDetectionSkillMaskingMode;
|
|
3891
|
-
/** The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'. */
|
|
3892
|
-
maskingCharacter?: string;
|
|
3893
|
-
/** 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. */
|
|
3894
|
-
modelVersion?: string;
|
|
3895
|
-
/** A list of PII entity categories that should be extracted and masked. */
|
|
3896
|
-
piiCategories?: string[];
|
|
3897
|
-
/** If specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'phi', 'none'. Default is 'none'. */
|
|
3898
|
-
domain?: string;
|
|
3899
|
-
};
|
|
3900
|
-
|
|
3901
|
-
/**
|
|
3902
|
-
* Defines values for PIIDetectionSkillMaskingMode. \
|
|
3903
|
-
* {@link KnownPIIDetectionSkillMaskingMode} can be used interchangeably with PIIDetectionSkillMaskingMode,
|
|
3904
|
-
* this enum contains the known values that the service supports.
|
|
3905
|
-
* ### Known values supported by the service
|
|
3906
|
-
* **none**: No masking occurs and the maskedText output will not be returned. \
|
|
3907
|
-
* **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.
|
|
3908
|
-
*/
|
|
3909
|
-
export declare type PIIDetectionSkillMaskingMode = string;
|
|
3910
|
-
|
|
3911
|
-
/** Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers. */
|
|
3912
|
-
export declare interface PrioritizedFields {
|
|
3913
|
-
/** 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. */
|
|
3914
|
-
titleField?: SemanticField;
|
|
3915
|
-
/** 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. */
|
|
3916
|
-
prioritizedContentFields?: SemanticField[];
|
|
3917
|
-
/** 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. */
|
|
3918
|
-
prioritizedKeywordsFields?: SemanticField[];
|
|
3919
|
-
}
|
|
3920
|
-
|
|
3921
|
-
/**
|
|
3922
|
-
* Defines values for QueryAnswerType. \
|
|
3923
|
-
* {@link KnownQueryAnswerType} can be used interchangeably with QueryAnswerType,
|
|
3924
|
-
* this enum contains the known values that the service supports.
|
|
3925
|
-
* ### Known values supported by the service
|
|
3926
|
-
* **none**: Do not return answers for the query. \
|
|
3927
|
-
* **extractive**: Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language.
|
|
3928
|
-
*/
|
|
3929
|
-
export declare type QueryAnswerType = string;
|
|
3930
|
-
|
|
3931
|
-
/**
|
|
3932
|
-
* Defines values for QueryCaptionType. \
|
|
3933
|
-
* {@link KnownQueryCaptionType} can be used interchangeably with QueryCaptionType,
|
|
3934
|
-
* this enum contains the known values that the service supports.
|
|
3935
|
-
* ### Known values supported by the service
|
|
3936
|
-
* **none**: Do not return captions for the query. \
|
|
3937
|
-
* **extractive**: Extracts captions from the matching documents that contain passages relevant to the search query.
|
|
3938
|
-
*/
|
|
3939
|
-
export declare type QueryCaptionType = string;
|
|
3940
|
-
|
|
3941
|
-
/**
|
|
3942
|
-
* Defines values for QueryLanguage. \
|
|
3943
|
-
* {@link KnownQueryLanguage} can be used interchangeably with QueryLanguage,
|
|
3944
|
-
* this enum contains the known values that the service supports.
|
|
3945
|
-
* ### Known values supported by the service
|
|
3946
|
-
* **none**: Query language not specified. \
|
|
3947
|
-
* **en-us**: Query language value for English (United States). \
|
|
3948
|
-
* **en-gb**: Query language value for English (Great Britain). \
|
|
3949
|
-
* **en-in**: Query language value for English (India). \
|
|
3950
|
-
* **en-ca**: Query language value for English (Canada). \
|
|
3951
|
-
* **en-au**: Query language value for English (Australia). \
|
|
3952
|
-
* **fr-fr**: Query language value for French (France). \
|
|
3953
|
-
* **fr-ca**: Query language value for French (Canada). \
|
|
3954
|
-
* **de-de**: Query language value for German (Germany). \
|
|
3955
|
-
* **es-es**: Query language value for Spanish (Spain). \
|
|
3956
|
-
* **es-mx**: Query language value for Spanish (Mexico). \
|
|
3957
|
-
* **zh-cn**: Query language value for Chinese (China). \
|
|
3958
|
-
* **zh-tw**: Query language value for Chinese (Taiwan). \
|
|
3959
|
-
* **pt-br**: Query language value for Portuguese (Brazil). \
|
|
3960
|
-
* **pt-pt**: Query language value for Portuguese (Portugal). \
|
|
3961
|
-
* **it-it**: Query language value for Italian (Italy). \
|
|
3962
|
-
* **ja-jp**: Query language value for Japanese (Japan). \
|
|
3963
|
-
* **ko-kr**: Query language value for Korean (Korea). \
|
|
3964
|
-
* **ru-ru**: Query language value for Russian (Russia). \
|
|
3965
|
-
* **cs-cz**: Query language value for Czech (Czech Republic). \
|
|
3966
|
-
* **nl-be**: Query language value for Dutch (Belgium). \
|
|
3967
|
-
* **nl-nl**: Query language value for Dutch (Netherlands). \
|
|
3968
|
-
* **hu-hu**: Query language value for Hungarian (Hungary). \
|
|
3969
|
-
* **pl-pl**: Query language value for Polish (Poland). \
|
|
3970
|
-
* **sv-se**: Query language value for Swedish (Sweden). \
|
|
3971
|
-
* **tr-tr**: Query language value for Turkish (Turkey). \
|
|
3972
|
-
* **hi-in**: Query language value for Hindi (India). \
|
|
3973
|
-
* **ar-sa**: Query language value for Arabic (Saudi Arabia). \
|
|
3974
|
-
* **ar-eg**: Query language value for Arabic (Egypt). \
|
|
3975
|
-
* **ar-ma**: Query language value for Arabic (Morocco). \
|
|
3976
|
-
* **ar-kw**: Query language value for Arabic (Kuwait). \
|
|
3977
|
-
* **ar-jo**: Query language value for Arabic (Jordan). \
|
|
3978
|
-
* **da-dk**: Query language value for Danish (Denmark). \
|
|
3979
|
-
* **no-no**: Query language value for Norwegian (Norway). \
|
|
3980
|
-
* **bg-bg**: Query language value for Bulgarian (Bulgaria). \
|
|
3981
|
-
* **hr-hr**: Query language value for Croatian (Croatia). \
|
|
3982
|
-
* **hr-ba**: Query language value for Croatian (Bosnia and Herzegovina). \
|
|
3983
|
-
* **ms-my**: Query language value for Malay (Malaysia). \
|
|
3984
|
-
* **ms-bn**: Query language value for Malay (Brunei Darussalam). \
|
|
3985
|
-
* **sl-sl**: Query language value for Slovenian (Slovenia). \
|
|
3986
|
-
* **ta-in**: Query language value for Tamil (India). \
|
|
3987
|
-
* **vi-vn**: Query language value for Vietnamese (Viet Nam). \
|
|
3988
|
-
* **el-gr**: Query language value for Greek (Greece). \
|
|
3989
|
-
* **ro-ro**: Query language value for Romanian (Romania). \
|
|
3990
|
-
* **is-is**: Query language value for Icelandic (Iceland). \
|
|
3991
|
-
* **id-id**: Query language value for Indonesian (Indonesia). \
|
|
3992
|
-
* **th-th**: Query language value for Thai (Thailand). \
|
|
3993
|
-
* **lt-lt**: Query language value for Lithuanian (Lithuania). \
|
|
3994
|
-
* **uk-ua**: Query language value for Ukrainian (Ukraine). \
|
|
3995
|
-
* **lv-lv**: Query language value for Latvian (Latvia). \
|
|
3996
|
-
* **et-ee**: Query language value for Estonian (Estonia). \
|
|
3997
|
-
* **ca-es**: Query language value for Catalan (Spain). \
|
|
3998
|
-
* **fi-fi**: Query language value for Finnish (Finland). \
|
|
3999
|
-
* **sr-ba**: Query language value for Serbian (Bosnia and Herzegovina). \
|
|
4000
|
-
* **sr-me**: Query language value for Serbian (Montenegro). \
|
|
4001
|
-
* **sr-rs**: Query language value for Serbian (Serbia). \
|
|
4002
|
-
* **sk-sk**: Query language value for Slovak (Slovakia). \
|
|
4003
|
-
* **nb-no**: Query language value for Norwegian (Norway). \
|
|
4004
|
-
* **hy-am**: Query language value for Armenian (Armenia). \
|
|
4005
|
-
* **bn-in**: Query language value for Bengali (India). \
|
|
4006
|
-
* **eu-es**: Query language value for Basque (Spain). \
|
|
4007
|
-
* **gl-es**: Query language value for Galician (Spain). \
|
|
4008
|
-
* **gu-in**: Query language value for Gujarati (India). \
|
|
4009
|
-
* **he-il**: Query language value for Hebrew (Israel). \
|
|
4010
|
-
* **ga-ie**: Query language value for Irish (Ireland). \
|
|
4011
|
-
* **kn-in**: Query language value for Kannada (India). \
|
|
4012
|
-
* **ml-in**: Query language value for Malayalam (India). \
|
|
4013
|
-
* **mr-in**: Query language value for Marathi (India). \
|
|
4014
|
-
* **fa-ae**: Query language value for Persian (U.A.E.). \
|
|
4015
|
-
* **pa-in**: Query language value for Punjabi (India). \
|
|
4016
|
-
* **te-in**: Query language value for Telugu (India). \
|
|
4017
|
-
* **ur-pk**: Query language value for Urdu (Pakistan).
|
|
4018
|
-
*/
|
|
4019
|
-
export declare type QueryLanguage = string;
|
|
4020
|
-
|
|
4021
|
-
/**
|
|
4022
|
-
* Defines values for QuerySpellerType. \
|
|
4023
|
-
* {@link KnownQuerySpellerType} can be used interchangeably with QuerySpellerType,
|
|
4024
|
-
* this enum contains the known values that the service supports.
|
|
4025
|
-
* ### Known values supported by the service
|
|
4026
|
-
* **none**: Speller not enabled. \
|
|
4027
|
-
* **lexicon**: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter.
|
|
4028
|
-
*/
|
|
4029
|
-
export declare type QuerySpellerType = string;
|
|
4030
|
-
|
|
4031
3330
|
/** Defines values for QueryType. */
|
|
4032
|
-
export declare type QueryType = "simple" | "full"
|
|
3331
|
+
export declare type QueryType = "simple" | "full";
|
|
4033
3332
|
|
|
4034
3333
|
/**
|
|
4035
3334
|
* Defines values for RegexFlags. \
|
|
4036
3335
|
* {@link KnownRegexFlags} can be used interchangeably with RegexFlags,
|
|
4037
3336
|
* this enum contains the known values that the service supports.
|
|
4038
|
-
* ###
|
|
3337
|
+
* ### Know values supported by the service
|
|
4039
3338
|
* **CANON_EQ**: Enables canonical equivalence. \
|
|
4040
3339
|
* **CASE_INSENSITIVE**: Enables case-insensitive matching. \
|
|
4041
3340
|
* **COMMENTS**: Permits whitespace and comments in the pattern. \
|
|
@@ -4047,37 +3346,17 @@ export declare type QueryType = "simple" | "full" | "semantic";
|
|
|
4047
3346
|
*/
|
|
4048
3347
|
export declare type RegexFlags = string;
|
|
4049
3348
|
|
|
4050
|
-
/**
|
|
4051
|
-
* Options for reset docs operation.
|
|
4052
|
-
*/
|
|
4053
|
-
export declare interface ResetDocumentsOptions extends OperationOptions {
|
|
4054
|
-
/** document keys to be reset */
|
|
4055
|
-
documentKeys?: string[];
|
|
4056
|
-
/** datasource document identifiers to be reset */
|
|
4057
|
-
datasourceDocumentIds?: string[];
|
|
4058
|
-
/** 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. */
|
|
4059
|
-
overwrite?: boolean;
|
|
4060
|
-
}
|
|
4061
|
-
|
|
4062
3349
|
/**
|
|
4063
3350
|
* Options for reset indexer operation.
|
|
4064
3351
|
*/
|
|
4065
3352
|
export declare type ResetIndexerOptions = OperationOptions;
|
|
4066
3353
|
|
|
4067
|
-
/**
|
|
4068
|
-
* Options for reset skills operation.
|
|
4069
|
-
*/
|
|
4070
|
-
export declare interface ResetSkillsOptions extends OperationOptions {
|
|
4071
|
-
/** the names of skills to be reset. */
|
|
4072
|
-
skillNames?: string[];
|
|
4073
|
-
}
|
|
4074
|
-
|
|
4075
3354
|
/** Represents a resource's usage and quota. */
|
|
4076
3355
|
export declare interface ResourceCounter {
|
|
4077
3356
|
/** The resource usage amount. */
|
|
4078
3357
|
usage: number;
|
|
4079
3358
|
/** The resource amount quota. */
|
|
4080
|
-
quota?: number;
|
|
3359
|
+
quota?: number | null;
|
|
4081
3360
|
}
|
|
4082
3361
|
|
|
4083
3362
|
/**
|
|
@@ -4123,29 +3402,14 @@ export declare interface ScoringProfile {
|
|
|
4123
3402
|
/** Defines values for ScoringStatistics. */
|
|
4124
3403
|
export declare type ScoringStatistics = "local" | "global";
|
|
4125
3404
|
|
|
4126
|
-
/** Represents an index alias, which describes a mapping from the alias name to an index. The alias name can be used in place of the index name for supported operations. */
|
|
4127
|
-
export declare interface SearchAlias {
|
|
4128
|
-
/** The name of the alias. */
|
|
4129
|
-
name: string;
|
|
4130
|
-
/** The name of the index this alias maps to. Only one index name may be specified. */
|
|
4131
|
-
indexes: string[];
|
|
4132
|
-
/** The ETag of the alias. */
|
|
4133
|
-
etag?: string;
|
|
4134
|
-
}
|
|
4135
|
-
|
|
4136
3405
|
/**
|
|
4137
3406
|
* Class used to perform operations against a search index,
|
|
4138
3407
|
* including querying documents in the index as well as
|
|
4139
3408
|
* adding, updating, and removing them.
|
|
4140
3409
|
*/
|
|
4141
3410
|
export declare class SearchClient<T> implements IndexDocumentsClient<T> {
|
|
4142
|
-
/**
|
|
4143
|
-
* The service version to use when communicating with the service.
|
|
4144
|
-
*/
|
|
4145
|
-
readonly serviceVersion: string;
|
|
4146
3411
|
/**
|
|
4147
3412
|
* The API version to use when communicating with the service.
|
|
4148
|
-
* @deprecated use {@Link serviceVersion} instead
|
|
4149
3413
|
*/
|
|
4150
3414
|
readonly apiVersion: string;
|
|
4151
3415
|
/**
|
|
@@ -4213,7 +3477,7 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
|
|
|
4213
3477
|
* @param key - The primary key value of the document
|
|
4214
3478
|
* @param options - Additional options
|
|
4215
3479
|
*/
|
|
4216
|
-
getDocument<Fields extends
|
|
3480
|
+
getDocument<Fields extends keyof T>(key: string, options?: GetDocumentOptions<Fields>): Promise<T>;
|
|
4217
3481
|
/**
|
|
4218
3482
|
* Perform a set of index modifications (upload, merge, mergeOrUpload, delete)
|
|
4219
3483
|
* for the given set of documents.
|
|
@@ -4263,23 +3527,17 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
|
|
|
4263
3527
|
private extractOperationOptions;
|
|
4264
3528
|
private convertSelect;
|
|
4265
3529
|
private convertSearchFields;
|
|
4266
|
-
private convertSemanticFields;
|
|
4267
3530
|
private convertOrderBy;
|
|
4268
3531
|
}
|
|
4269
3532
|
|
|
4270
3533
|
/**
|
|
4271
3534
|
* Client options used to configure Cognitive Search API requests.
|
|
4272
3535
|
*/
|
|
4273
|
-
export declare interface SearchClientOptions extends
|
|
3536
|
+
export declare interface SearchClientOptions extends PipelineOptions {
|
|
4274
3537
|
/**
|
|
4275
3538
|
* The API version to use when communicating with the service.
|
|
4276
|
-
* @deprecated use {@Link serviceVersion} instead
|
|
4277
3539
|
*/
|
|
4278
3540
|
apiVersion?: string;
|
|
4279
|
-
/**
|
|
4280
|
-
* The service version to use when communicating with the service.
|
|
4281
|
-
*/
|
|
4282
|
-
serviceVersion?: string;
|
|
4283
3541
|
/**
|
|
4284
3542
|
* The Audience to use for authentication with Azure Active Directory (AAD). The
|
|
4285
3543
|
* audience is not considered when using a shared key.
|
|
@@ -4341,12 +3599,6 @@ export declare interface SearchDocumentsResultBase {
|
|
|
4341
3599
|
readonly facets?: {
|
|
4342
3600
|
[propertyName: string]: FacetResult[];
|
|
4343
3601
|
};
|
|
4344
|
-
/**
|
|
4345
|
-
* The answers query results for the search operation; null if the answers query parameter was
|
|
4346
|
-
* not specified or set to 'none'.
|
|
4347
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
4348
|
-
*/
|
|
4349
|
-
readonly answers?: AnswerResult[];
|
|
4350
3602
|
}
|
|
4351
3603
|
|
|
4352
3604
|
/**
|
|
@@ -4391,7 +3643,7 @@ export declare interface SearchIndex {
|
|
|
4391
3643
|
/**
|
|
4392
3644
|
* Options to control Cross-Origin Resource Sharing (CORS) for the index.
|
|
4393
3645
|
*/
|
|
4394
|
-
corsOptions?: CorsOptions;
|
|
3646
|
+
corsOptions?: CorsOptions | null;
|
|
4395
3647
|
/**
|
|
4396
3648
|
* The suggesters for the index.
|
|
4397
3649
|
*/
|
|
@@ -4412,10 +3664,6 @@ export declare interface SearchIndex {
|
|
|
4412
3664
|
* The character filters for the index.
|
|
4413
3665
|
*/
|
|
4414
3666
|
charFilters?: CharFilter[];
|
|
4415
|
-
/**
|
|
4416
|
-
* The normalizers for the index.
|
|
4417
|
-
*/
|
|
4418
|
-
normalizers?: LexicalNormalizer[];
|
|
4419
3667
|
/**
|
|
4420
3668
|
* A description of an encryption key that you create in Azure Key Vault. This key is used to
|
|
4421
3669
|
* provide an additional level of encryption-at-rest for your data when you want full assurance
|
|
@@ -4426,28 +3674,19 @@ export declare interface SearchIndex {
|
|
|
4426
3674
|
* keys is not available for free search services, and is only available for paid services
|
|
4427
3675
|
* created on or after January 1, 2019.
|
|
4428
3676
|
*/
|
|
4429
|
-
encryptionKey?: SearchResourceEncryptionKey;
|
|
3677
|
+
encryptionKey?: SearchResourceEncryptionKey | null;
|
|
4430
3678
|
/**
|
|
4431
3679
|
* The type of similarity algorithm to be used when scoring and ranking the documents matching a
|
|
4432
3680
|
* search query. The similarity algorithm can only be defined at index creation time and cannot
|
|
4433
3681
|
* be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.
|
|
4434
3682
|
*/
|
|
4435
3683
|
similarity?: SimilarityAlgorithm;
|
|
4436
|
-
/**
|
|
4437
|
-
* Defines parameters for a search index that influence semantic capabilities.
|
|
4438
|
-
*/
|
|
4439
|
-
semanticSettings?: SemanticSettings;
|
|
4440
3684
|
/**
|
|
4441
3685
|
* The ETag of the index.
|
|
4442
3686
|
*/
|
|
4443
3687
|
etag?: string;
|
|
4444
3688
|
}
|
|
4445
3689
|
|
|
4446
|
-
/**
|
|
4447
|
-
* Search Alias object.
|
|
4448
|
-
*/
|
|
4449
|
-
export declare type SearchIndexAlias = SearchAlias;
|
|
4450
|
-
|
|
4451
3690
|
/**
|
|
4452
3691
|
* Class to perform operations to manage
|
|
4453
3692
|
* (create, update, list/delete)
|
|
@@ -4457,11 +3696,6 @@ export declare class SearchIndexClient {
|
|
|
4457
3696
|
/**
|
|
4458
3697
|
* The API version to use when communicating with the service.
|
|
4459
3698
|
*/
|
|
4460
|
-
readonly serviceVersion: string;
|
|
4461
|
-
/**
|
|
4462
|
-
* The API version to use when communicating with the service.
|
|
4463
|
-
* @deprecated use {@Link serviceVersion} instead
|
|
4464
|
-
*/
|
|
4465
3699
|
readonly apiVersion: string;
|
|
4466
3700
|
/**
|
|
4467
3701
|
* The endpoint of the search service
|
|
@@ -4500,13 +3734,6 @@ export declare class SearchIndexClient {
|
|
|
4500
3734
|
* @param options - Options to the list index operation.
|
|
4501
3735
|
*/
|
|
4502
3736
|
listIndexes(options?: ListIndexesOptions): IndexIterator;
|
|
4503
|
-
private listAliasesPage;
|
|
4504
|
-
private listAliasesAll;
|
|
4505
|
-
/**
|
|
4506
|
-
* Lists all aliases available for a search service.
|
|
4507
|
-
* @param options - The options parameters.
|
|
4508
|
-
*/
|
|
4509
|
-
listAliases(options?: ListAliasesOptions): AliasIterator;
|
|
4510
3737
|
private listIndexesNamesPage;
|
|
4511
3738
|
private listIndexesNamesAll;
|
|
4512
3739
|
/**
|
|
@@ -4572,31 +3799,6 @@ export declare class SearchIndexClient {
|
|
|
4572
3799
|
* @param options - Additional optional arguments.
|
|
4573
3800
|
*/
|
|
4574
3801
|
deleteSynonymMap(synonymMap: string | SynonymMap, options?: DeleteSynonymMapOptions): Promise<void>;
|
|
4575
|
-
/**
|
|
4576
|
-
* Creates a new search alias or updates an alias if it already exists.
|
|
4577
|
-
* @param alias - The definition of the alias to create or update.
|
|
4578
|
-
* @param options - The options parameters.
|
|
4579
|
-
*/
|
|
4580
|
-
createOrUpdateAlias(alias: SearchIndexAlias, options?: CreateOrUpdateAliasOptions): Promise<SearchIndexAlias>;
|
|
4581
|
-
/**
|
|
4582
|
-
* Creates a new search alias.
|
|
4583
|
-
* @param alias - The definition of the alias to create.
|
|
4584
|
-
* @param options - The options parameters.
|
|
4585
|
-
*/
|
|
4586
|
-
createAlias(alias: SearchIndexAlias, options?: CreateAliasOptions): Promise<SearchIndexAlias>;
|
|
4587
|
-
/**
|
|
4588
|
-
* Deletes a search alias and its associated mapping to an index. This operation is permanent, with no
|
|
4589
|
-
* recovery option. The mapped index is untouched by this operation.
|
|
4590
|
-
* @param alias - Alias/Name name of the alias to delete.
|
|
4591
|
-
* @param options - The options parameters.
|
|
4592
|
-
*/
|
|
4593
|
-
deleteAlias(alias: string | SearchIndexAlias, options?: DeleteAliasOptions): Promise<void>;
|
|
4594
|
-
/**
|
|
4595
|
-
* Retrieves an alias definition.
|
|
4596
|
-
* @param aliasName - The name of the alias to retrieve.
|
|
4597
|
-
* @param options - The options parameters.
|
|
4598
|
-
*/
|
|
4599
|
-
getAlias(aliasName: string, options?: GetAliasOptions): Promise<SearchIndexAlias>;
|
|
4600
3802
|
/**
|
|
4601
3803
|
* Retrieves statistics about an index, such as the count of documents and the size
|
|
4602
3804
|
* of index storage.
|
|
@@ -4627,16 +3829,11 @@ export declare class SearchIndexClient {
|
|
|
4627
3829
|
/**
|
|
4628
3830
|
* Client options used to configure Cognitive Search API requests.
|
|
4629
3831
|
*/
|
|
4630
|
-
export declare interface SearchIndexClientOptions extends
|
|
3832
|
+
export declare interface SearchIndexClientOptions extends PipelineOptions {
|
|
4631
3833
|
/**
|
|
4632
3834
|
* The API version to use when communicating with the service.
|
|
4633
|
-
* @deprecated use {@Link serviceVersion} instead
|
|
4634
3835
|
*/
|
|
4635
3836
|
apiVersion?: string;
|
|
4636
|
-
/**
|
|
4637
|
-
* The service version to use when communicating with the service.
|
|
4638
|
-
*/
|
|
4639
|
-
serviceVersion?: string;
|
|
4640
3837
|
/**
|
|
4641
3838
|
* The Audience to use for authentication with Azure Active Directory (AAD). The
|
|
4642
3839
|
* audience is not considered when using a shared key.
|
|
@@ -4672,11 +3869,11 @@ export declare interface SearchIndexer {
|
|
|
4672
3869
|
/**
|
|
4673
3870
|
* The schedule for this indexer.
|
|
4674
3871
|
*/
|
|
4675
|
-
schedule?: IndexingSchedule;
|
|
3872
|
+
schedule?: IndexingSchedule | null;
|
|
4676
3873
|
/**
|
|
4677
3874
|
* Parameters for indexer execution.
|
|
4678
3875
|
*/
|
|
4679
|
-
parameters?: IndexingParameters;
|
|
3876
|
+
parameters?: IndexingParameters | null;
|
|
4680
3877
|
/**
|
|
4681
3878
|
* Defines mappings between fields in the data source and corresponding target fields in the
|
|
4682
3879
|
* index.
|
|
@@ -4689,7 +3886,7 @@ export declare interface SearchIndexer {
|
|
|
4689
3886
|
/**
|
|
4690
3887
|
* A value indicating whether the indexer is disabled. Default is false. Default value: false.
|
|
4691
3888
|
*/
|
|
4692
|
-
isDisabled?: boolean;
|
|
3889
|
+
isDisabled?: boolean | null;
|
|
4693
3890
|
/**
|
|
4694
3891
|
* The ETag of the indexer.
|
|
4695
3892
|
*/
|
|
@@ -4705,19 +3902,7 @@ export declare interface SearchIndexer {
|
|
|
4705
3902
|
* customer-managed keys is not available for free search services, and is only available for
|
|
4706
3903
|
* paid services created on or after January 1, 2019.
|
|
4707
3904
|
*/
|
|
4708
|
-
encryptionKey?: SearchResourceEncryptionKey;
|
|
4709
|
-
/**
|
|
4710
|
-
* Adds caching to an enrichment pipeline to allow for incremental modification steps without
|
|
4711
|
-
* having to rebuild the index every time.
|
|
4712
|
-
*/
|
|
4713
|
-
cache?: SearchIndexerCache;
|
|
4714
|
-
}
|
|
4715
|
-
|
|
4716
|
-
export declare interface SearchIndexerCache {
|
|
4717
|
-
/** The connection string to the storage account where the cache data will be persisted. */
|
|
4718
|
-
storageConnectionString?: string;
|
|
4719
|
-
/** Specifies whether incremental reprocessing is enabled. */
|
|
4720
|
-
enableReprocessing?: boolean;
|
|
3905
|
+
encryptionKey?: SearchResourceEncryptionKey | null;
|
|
4721
3906
|
}
|
|
4722
3907
|
|
|
4723
3908
|
/**
|
|
@@ -4729,11 +3914,6 @@ export declare class SearchIndexerClient {
|
|
|
4729
3914
|
/**
|
|
4730
3915
|
* The API version to use when communicating with the service.
|
|
4731
3916
|
*/
|
|
4732
|
-
readonly serviceVersion: string;
|
|
4733
|
-
/**
|
|
4734
|
-
* The API version to use when communicating with the service.
|
|
4735
|
-
* @deprecated use {@Link serviceVersion} instead
|
|
4736
|
-
*/
|
|
4737
3917
|
readonly apiVersion: string;
|
|
4738
3918
|
/**
|
|
4739
3919
|
* The endpoint of the search service
|
|
@@ -4877,34 +4057,16 @@ export declare class SearchIndexerClient {
|
|
|
4877
4057
|
* @param options - Additional optional arguments.
|
|
4878
4058
|
*/
|
|
4879
4059
|
runIndexer(indexerName: string, options?: RunIndexerOptions): Promise<void>;
|
|
4880
|
-
/**
|
|
4881
|
-
* Resets specific documents in the datasource to be selectively re-ingested by the indexer.
|
|
4882
|
-
* @param indexerName - The name of the indexer to reset documents for.
|
|
4883
|
-
* @param options - Additional optional arguments.
|
|
4884
|
-
*/
|
|
4885
|
-
resetDocuments(indexerName: string, options?: ResetDocumentsOptions): Promise<void>;
|
|
4886
|
-
/**
|
|
4887
|
-
* Reset an existing skillset in a search service.
|
|
4888
|
-
* @param skillsetName - The name of the skillset to reset.
|
|
4889
|
-
* @param skillNames - The names of skills to reset.
|
|
4890
|
-
* @param options - The options parameters.
|
|
4891
|
-
*/
|
|
4892
|
-
resetSkills(skillsetName: string, options?: ResetSkillsOptions): Promise<void>;
|
|
4893
4060
|
}
|
|
4894
4061
|
|
|
4895
4062
|
/**
|
|
4896
4063
|
* Client options used to configure Cognitive Search API requests.
|
|
4897
4064
|
*/
|
|
4898
|
-
export declare interface SearchIndexerClientOptions extends
|
|
4065
|
+
export declare interface SearchIndexerClientOptions extends PipelineOptions {
|
|
4899
4066
|
/**
|
|
4900
4067
|
* The API version to use when communicating with the service.
|
|
4901
|
-
* @deprecated use {@Link serviceVersion} instead
|
|
4902
4068
|
*/
|
|
4903
4069
|
apiVersion?: string;
|
|
4904
|
-
/**
|
|
4905
|
-
* The service version to use when communicating with the service.
|
|
4906
|
-
*/
|
|
4907
|
-
serviceVersion?: string;
|
|
4908
4070
|
/**
|
|
4909
4071
|
* The Audience to use for authentication with Azure Active Directory (AAD). The
|
|
4910
4072
|
* audience is not considered when using a shared key.
|
|
@@ -4921,17 +4083,6 @@ export declare interface SearchIndexerDataContainer {
|
|
|
4921
4083
|
query?: string;
|
|
4922
4084
|
}
|
|
4923
4085
|
|
|
4924
|
-
/**
|
|
4925
|
-
* Contains the possible cases for SearchIndexerDataIdentity.
|
|
4926
|
-
*/
|
|
4927
|
-
export declare type SearchIndexerDataIdentity = SearchIndexerDataNoneIdentity | SearchIndexerDataUserAssignedIdentity;
|
|
4928
|
-
|
|
4929
|
-
/** Clears the identity property of a datasource. */
|
|
4930
|
-
export declare type SearchIndexerDataNoneIdentity = BaseSearchIndexerDataIdentity & {
|
|
4931
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
4932
|
-
odatatype: "#Microsoft.Azure.Search.SearchIndexerDataNoneIdentity";
|
|
4933
|
-
};
|
|
4934
|
-
|
|
4935
4086
|
/**
|
|
4936
4087
|
* Represents a datasource definition, which can be used to configure an indexer.
|
|
4937
4088
|
*/
|
|
@@ -4957,20 +4108,14 @@ export declare interface SearchIndexerDataSourceConnection {
|
|
|
4957
4108
|
* The data container for the datasource.
|
|
4958
4109
|
*/
|
|
4959
4110
|
container: SearchIndexerDataContainer;
|
|
4960
|
-
/**
|
|
4961
|
-
* An explicit managed identity to use for this datasource. If not specified and the connection
|
|
4962
|
-
* string is a managed identity, the system-assigned managed identity is used. If not specified,
|
|
4963
|
-
* the value remains unchanged. If "none" is specified, the value of this property is cleared.
|
|
4964
|
-
*/
|
|
4965
|
-
identity?: SearchIndexerDataIdentity;
|
|
4966
4111
|
/**
|
|
4967
4112
|
* The data change detection policy for the datasource.
|
|
4968
4113
|
*/
|
|
4969
|
-
dataChangeDetectionPolicy?: DataChangeDetectionPolicy;
|
|
4114
|
+
dataChangeDetectionPolicy?: DataChangeDetectionPolicy | null;
|
|
4970
4115
|
/**
|
|
4971
4116
|
* The data deletion detection policy for the datasource.
|
|
4972
4117
|
*/
|
|
4973
|
-
dataDeletionDetectionPolicy?: DataDeletionDetectionPolicy;
|
|
4118
|
+
dataDeletionDetectionPolicy?: DataDeletionDetectionPolicy | null;
|
|
4974
4119
|
/**
|
|
4975
4120
|
* The ETag of the DataSource.
|
|
4976
4121
|
*/
|
|
@@ -4986,14 +4131,14 @@ export declare interface SearchIndexerDataSourceConnection {
|
|
|
4986
4131
|
* available for free search services, and is only available for paid services created on or
|
|
4987
4132
|
* after January 1, 2019.
|
|
4988
4133
|
*/
|
|
4989
|
-
encryptionKey?: SearchResourceEncryptionKey;
|
|
4134
|
+
encryptionKey?: SearchResourceEncryptionKey | null;
|
|
4990
4135
|
}
|
|
4991
4136
|
|
|
4992
4137
|
/**
|
|
4993
4138
|
* Defines values for SearchIndexerDataSourceType. \
|
|
4994
4139
|
* {@link KnownSearchIndexerDataSourceType} can be used interchangeably with SearchIndexerDataSourceType,
|
|
4995
4140
|
* this enum contains the known values that the service supports.
|
|
4996
|
-
* ###
|
|
4141
|
+
* ### Know values supported by the service
|
|
4997
4142
|
* **azuresql**: Indicates an Azure SQL datasource. \
|
|
4998
4143
|
* **cosmosdb**: Indicates a CosmosDB datasource. \
|
|
4999
4144
|
* **azureblob**: Indicates an Azure Blob datasource. \
|
|
@@ -5003,14 +4148,6 @@ export declare interface SearchIndexerDataSourceConnection {
|
|
|
5003
4148
|
*/
|
|
5004
4149
|
export declare type SearchIndexerDataSourceType = string;
|
|
5005
4150
|
|
|
5006
|
-
/** Specifies the identity for a datasource to use. */
|
|
5007
|
-
export declare type SearchIndexerDataUserAssignedIdentity = BaseSearchIndexerDataIdentity & {
|
|
5008
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
5009
|
-
odatatype: "#Microsoft.Azure.Search.SearchIndexerDataUserAssignedIdentity";
|
|
5010
|
-
/** 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. */
|
|
5011
|
-
userAssignedIdentity: string;
|
|
5012
|
-
};
|
|
5013
|
-
|
|
5014
4151
|
/** Represents an item- or document-level indexing error. */
|
|
5015
4152
|
export declare interface SearchIndexerError {
|
|
5016
4153
|
/**
|
|
@@ -5116,7 +4253,7 @@ export declare interface SearchIndexerLimits {
|
|
|
5116
4253
|
/**
|
|
5117
4254
|
* Contains the possible cases for Skill.
|
|
5118
4255
|
*/
|
|
5119
|
-
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;
|
|
5120
4257
|
|
|
5121
4258
|
/**
|
|
5122
4259
|
* A list of skills.
|
|
@@ -5156,7 +4293,7 @@ export declare interface SearchIndexerSkillset {
|
|
|
5156
4293
|
* definition will be unaffected. Encryption with customer-managed keys is not available for free
|
|
5157
4294
|
* search services, and is only available for paid services created on or after January 1, 2019.
|
|
5158
4295
|
*/
|
|
5159
|
-
encryptionKey?: SearchResourceEncryptionKey;
|
|
4296
|
+
encryptionKey?: SearchResourceEncryptionKey | null;
|
|
5160
4297
|
}
|
|
5161
4298
|
|
|
5162
4299
|
/** Represents the current status and execution history of an indexer. */
|
|
@@ -5551,11 +4688,6 @@ export declare interface SearchRequest {
|
|
|
5551
4688
|
* the results.
|
|
5552
4689
|
*/
|
|
5553
4690
|
scoringProfile?: string;
|
|
5554
|
-
/**
|
|
5555
|
-
* The name of a semantic configuration that will be used when processing documents for queries of
|
|
5556
|
-
* type semantic.
|
|
5557
|
-
*/
|
|
5558
|
-
semanticConfiguration?: string;
|
|
5559
4691
|
/**
|
|
5560
4692
|
* A full-text search query expression; Use "*" or omit this parameter to match all documents.
|
|
5561
4693
|
*/
|
|
@@ -5571,19 +4703,6 @@ export declare interface SearchRequest {
|
|
|
5571
4703
|
* count the document as a match. Possible values include: 'Any', 'All'
|
|
5572
4704
|
*/
|
|
5573
4705
|
searchMode?: SearchMode;
|
|
5574
|
-
/**
|
|
5575
|
-
* A value that specifies the language of the search query.
|
|
5576
|
-
*/
|
|
5577
|
-
queryLanguage?: QueryLanguage;
|
|
5578
|
-
/**
|
|
5579
|
-
* A value that specified the type of the speller to use to spell-correct individual search
|
|
5580
|
-
* query terms.
|
|
5581
|
-
*/
|
|
5582
|
-
speller?: QuerySpellerType;
|
|
5583
|
-
/**
|
|
5584
|
-
* A value that specifies whether answers should be returned as part of the search response.
|
|
5585
|
-
*/
|
|
5586
|
-
answers?: QueryAnswerType;
|
|
5587
4706
|
/**
|
|
5588
4707
|
* The comma-separated list of fields to retrieve. If unspecified, all fields marked as
|
|
5589
4708
|
* retrievable in the schema are included.
|
|
@@ -5602,14 +4721,6 @@ export declare interface SearchRequest {
|
|
|
5602
4721
|
* Search request for the next page of results.
|
|
5603
4722
|
*/
|
|
5604
4723
|
top?: number;
|
|
5605
|
-
/**
|
|
5606
|
-
* A value that specifies whether captions should be returned as part of the search response.
|
|
5607
|
-
*/
|
|
5608
|
-
captions?: QueryCaptionType;
|
|
5609
|
-
/**
|
|
5610
|
-
* The comma-separated list of field names used for semantic search.
|
|
5611
|
-
*/
|
|
5612
|
-
semanticFields?: string;
|
|
5613
4724
|
}
|
|
5614
4725
|
|
|
5615
4726
|
/**
|
|
@@ -5684,21 +4795,6 @@ export declare interface SearchRequestOptions<Fields> {
|
|
|
5684
4795
|
* fielded search expression take precedence over any field names listed in this parameter.
|
|
5685
4796
|
*/
|
|
5686
4797
|
searchFields?: Fields[];
|
|
5687
|
-
/**
|
|
5688
|
-
* The language of the query.
|
|
5689
|
-
*/
|
|
5690
|
-
queryLanguage?: QueryLanguage;
|
|
5691
|
-
/**
|
|
5692
|
-
* Improve search recall by spell-correcting individual search query terms.
|
|
5693
|
-
*/
|
|
5694
|
-
speller?: Speller;
|
|
5695
|
-
/**
|
|
5696
|
-
* This parameter is only valid if the query type is 'semantic'. If set, the query returns answers
|
|
5697
|
-
* extracted from key passages in the highest ranked documents. The number of answers returned can
|
|
5698
|
-
* be configured by appending the pipe character '|' followed by the 'count-\<number of answers\>' option
|
|
5699
|
-
* after the answers parameter value, such as 'extractive|count-3'. Default count is 1.
|
|
5700
|
-
*/
|
|
5701
|
-
answers?: Answers;
|
|
5702
4798
|
/**
|
|
5703
4799
|
* A value that specifies whether any or all of the search terms must be matched in order to
|
|
5704
4800
|
* count the document as a match. Possible values include: 'any', 'all'
|
|
@@ -5736,17 +4832,6 @@ export declare interface SearchRequestOptions<Fields> {
|
|
|
5736
4832
|
* Search request for the next page of results.
|
|
5737
4833
|
*/
|
|
5738
4834
|
top?: number;
|
|
5739
|
-
/**
|
|
5740
|
-
* This parameter is only valid if the query type is 'semantic'. If set, the query returns captions
|
|
5741
|
-
* extracted from key passages in the highest ranked documents. When Captions is set to 'extractive',
|
|
5742
|
-
* highlighting is enabled by default, and can be configured by appending the pipe character '|'
|
|
5743
|
-
* followed by the 'highlight-true'/'highlight-false' option, such as 'extractive|highlight-true'. Defaults to 'None'.
|
|
5744
|
-
*/
|
|
5745
|
-
captions?: Captions;
|
|
5746
|
-
/**
|
|
5747
|
-
* The list of field names used for semantic search.
|
|
5748
|
-
*/
|
|
5749
|
-
semanticFields?: string[];
|
|
5750
4835
|
}
|
|
5751
4836
|
|
|
5752
4837
|
/**
|
|
@@ -5779,13 +4864,6 @@ export declare interface SearchResourceEncryptionKey {
|
|
|
5779
4864
|
* The authentication key of the specified AAD application.
|
|
5780
4865
|
*/
|
|
5781
4866
|
applicationSecret?: string;
|
|
5782
|
-
/**
|
|
5783
|
-
* An explicit managed identity to use for this encryption key. If not specified and the access
|
|
5784
|
-
* credentials property is null, the system-assigned managed identity is used. On update to the
|
|
5785
|
-
* resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified,
|
|
5786
|
-
* the value of this property is cleared.
|
|
5787
|
-
*/
|
|
5788
|
-
identity?: SearchIndexerDataIdentity;
|
|
5789
4867
|
}
|
|
5790
4868
|
|
|
5791
4869
|
/**
|
|
@@ -5797,11 +4875,6 @@ export declare type SearchResult<T> = {
|
|
|
5797
4875
|
* **NOTE: This property will not be serialized. It can only be populated by the server.**
|
|
5798
4876
|
*/
|
|
5799
4877
|
readonly score: number;
|
|
5800
|
-
/**
|
|
5801
|
-
* 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'.
|
|
5802
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
5803
|
-
*/
|
|
5804
|
-
readonly rerankerScore?: number;
|
|
5805
4878
|
/**
|
|
5806
4879
|
* Text fragments from the document that indicate the matching search terms, organized by each
|
|
5807
4880
|
* applicable field; null if hit highlighting was not enabled for the query.
|
|
@@ -5810,11 +4883,6 @@ export declare type SearchResult<T> = {
|
|
|
5810
4883
|
readonly highlights?: {
|
|
5811
4884
|
[k in keyof T]?: string[];
|
|
5812
4885
|
};
|
|
5813
|
-
/**
|
|
5814
|
-
* 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'.
|
|
5815
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
5816
|
-
*/
|
|
5817
|
-
readonly captions?: CaptionResult[];
|
|
5818
4886
|
document: T;
|
|
5819
4887
|
};
|
|
5820
4888
|
|
|
@@ -5843,25 +4911,6 @@ export declare interface SearchSuggester {
|
|
|
5843
4911
|
sourceFields: string[];
|
|
5844
4912
|
}
|
|
5845
4913
|
|
|
5846
|
-
/** Defines a specific configuration to be used in the context of semantic capabilities. */
|
|
5847
|
-
export declare interface SemanticConfiguration {
|
|
5848
|
-
/** The name of the semantic configuration. */
|
|
5849
|
-
name: string;
|
|
5850
|
-
/** 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. */
|
|
5851
|
-
prioritizedFields: PrioritizedFields;
|
|
5852
|
-
}
|
|
5853
|
-
|
|
5854
|
-
/** A field that is used as part of the semantic configuration. */
|
|
5855
|
-
export declare interface SemanticField {
|
|
5856
|
-
name?: string;
|
|
5857
|
-
}
|
|
5858
|
-
|
|
5859
|
-
/** Defines parameters for a search index that influence semantic capabilities. */
|
|
5860
|
-
export declare interface SemanticSettings {
|
|
5861
|
-
/** The semantic configurations for the index. */
|
|
5862
|
-
configurations?: SemanticConfiguration[];
|
|
5863
|
-
}
|
|
5864
|
-
|
|
5865
4914
|
/** Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1. */
|
|
5866
4915
|
export declare type SentimentSkill = BaseSearchIndexerSkill & {
|
|
5867
4916
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -5874,7 +4923,7 @@ export declare type SentimentSkill = BaseSearchIndexerSkill & {
|
|
|
5874
4923
|
* Defines values for SentimentSkillLanguage. \
|
|
5875
4924
|
* {@link KnownSentimentSkillLanguage} can be used interchangeably with SentimentSkillLanguage,
|
|
5876
4925
|
* this enum contains the known values that the service supports.
|
|
5877
|
-
* ###
|
|
4926
|
+
* ### Know values supported by the service
|
|
5878
4927
|
* **da**: Danish \
|
|
5879
4928
|
* **nl**: Dutch \
|
|
5880
4929
|
* **en**: English \
|
|
@@ -5893,22 +4942,8 @@ export declare type SentimentSkill = BaseSearchIndexerSkill & {
|
|
|
5893
4942
|
*/
|
|
5894
4943
|
export declare type SentimentSkillLanguage = string;
|
|
5895
4944
|
|
|
5896
|
-
/** 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. */
|
|
5897
|
-
export declare type SentimentSkillV3 = BaseSearchIndexerSkill & {
|
|
5898
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
5899
|
-
odatatype: "#Microsoft.Skills.Text.V3.SentimentSkill";
|
|
5900
|
-
/** A value indicating which language code to use. Default is en. */
|
|
5901
|
-
defaultLanguageCode?: string;
|
|
5902
|
-
/** 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. */
|
|
5903
|
-
includeOpinionMining?: boolean;
|
|
5904
|
-
/** 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. */
|
|
5905
|
-
modelVersion?: string;
|
|
5906
|
-
};
|
|
5907
|
-
|
|
5908
4945
|
/** Represents service-level resource counters and quotas. */
|
|
5909
4946
|
export declare interface ServiceCounters {
|
|
5910
|
-
/** Total number of aliases. */
|
|
5911
|
-
aliasCounter?: ResourceCounter;
|
|
5912
4947
|
/** Total number of documents across all indexes in the service. */
|
|
5913
4948
|
documentCounter: ResourceCounter;
|
|
5914
4949
|
/** Total number of indexes. */
|
|
@@ -5928,13 +4963,13 @@ export declare interface ServiceCounters {
|
|
|
5928
4963
|
/** Represents various service level limits. */
|
|
5929
4964
|
export declare interface ServiceLimits {
|
|
5930
4965
|
/** The maximum allowed fields per index. */
|
|
5931
|
-
maxFieldsPerIndex?: number;
|
|
4966
|
+
maxFieldsPerIndex?: number | null;
|
|
5932
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. */
|
|
5933
|
-
maxFieldNestingDepthPerIndex?: number;
|
|
4968
|
+
maxFieldNestingDepthPerIndex?: number | null;
|
|
5934
4969
|
/** The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index. */
|
|
5935
|
-
maxComplexCollectionFieldsPerIndex?: number;
|
|
4970
|
+
maxComplexCollectionFieldsPerIndex?: number | null;
|
|
5936
4971
|
/** The maximum number of objects in complex collections allowed per document. */
|
|
5937
|
-
maxComplexObjectsInCollectionsPerDocument?: number;
|
|
4972
|
+
maxComplexObjectsInCollectionsPerDocument?: number | null;
|
|
5938
4973
|
}
|
|
5939
4974
|
|
|
5940
4975
|
/** A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields). */
|
|
@@ -6073,10 +5108,6 @@ export declare interface SimpleField {
|
|
|
6073
5108
|
* fields.
|
|
6074
5109
|
*/
|
|
6075
5110
|
synonymMapNames?: string[];
|
|
6076
|
-
/**
|
|
6077
|
-
* The name of the normalizer used at indexing time for the field.
|
|
6078
|
-
*/
|
|
6079
|
-
normalizerName?: LexicalNormalizerName;
|
|
6080
5111
|
}
|
|
6081
5112
|
|
|
6082
5113
|
/** A filter that stems words using a Snowball-generated stemmer. This token filter is implemented using Apache Lucene. */
|
|
@@ -6100,16 +5131,6 @@ export declare type SoftDeleteColumnDeletionDetectionPolicy = BaseDataDeletionDe
|
|
|
6100
5131
|
softDeleteMarkerValue?: string;
|
|
6101
5132
|
};
|
|
6102
5133
|
|
|
6103
|
-
/**
|
|
6104
|
-
* Defines values for Speller. \
|
|
6105
|
-
* {@link KnownSpeller} can be used interchangeably with Speller,
|
|
6106
|
-
* this enum contains the known values that the service supports.
|
|
6107
|
-
* ### Known values supported by the service
|
|
6108
|
-
* **none**: Speller not enabled. \
|
|
6109
|
-
* **lexicon**: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter.
|
|
6110
|
-
*/
|
|
6111
|
-
export declare type Speller = string;
|
|
6112
|
-
|
|
6113
5134
|
/** A skill to split a string into chunks of text. */
|
|
6114
5135
|
export declare type SplitSkill = BaseSearchIndexerSkill & {
|
|
6115
5136
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -6119,14 +5140,14 @@ export declare type SplitSkill = BaseSearchIndexerSkill & {
|
|
|
6119
5140
|
/** A value indicating which split mode to perform. */
|
|
6120
5141
|
textSplitMode?: TextSplitMode;
|
|
6121
5142
|
/** The desired maximum page length. Default is 10000. */
|
|
6122
|
-
maxPageLength?: number;
|
|
5143
|
+
maxPageLength?: number | null;
|
|
6123
5144
|
};
|
|
6124
5145
|
|
|
6125
5146
|
/**
|
|
6126
5147
|
* Defines values for SplitSkillLanguage. \
|
|
6127
5148
|
* {@link KnownSplitSkillLanguage} can be used interchangeably with SplitSkillLanguage,
|
|
6128
5149
|
* this enum contains the known values that the service supports.
|
|
6129
|
-
* ###
|
|
5150
|
+
* ### Know values supported by the service
|
|
6130
5151
|
* **da**: Danish \
|
|
6131
5152
|
* **de**: German \
|
|
6132
5153
|
* **en**: English \
|
|
@@ -6304,7 +5325,7 @@ export declare interface SynonymMap {
|
|
|
6304
5325
|
* keys is not available for free search services, and is only available for paid services
|
|
6305
5326
|
* created on or after January 1, 2019.
|
|
6306
5327
|
*/
|
|
6307
|
-
encryptionKey?: SearchResourceEncryptionKey;
|
|
5328
|
+
encryptionKey?: SearchResourceEncryptionKey | null;
|
|
6308
5329
|
/**
|
|
6309
5330
|
* The ETag of the synonym map.
|
|
6310
5331
|
*/
|
|
@@ -6341,7 +5362,7 @@ export declare interface TagScoringParameters {
|
|
|
6341
5362
|
* Defines values for TextSplitMode. \
|
|
6342
5363
|
* {@link KnownTextSplitMode} can be used interchangeably with TextSplitMode,
|
|
6343
5364
|
* this enum contains the known values that the service supports.
|
|
6344
|
-
* ###
|
|
5365
|
+
* ### Know values supported by the service
|
|
6345
5366
|
* **pages**: Split the text into individual pages. \
|
|
6346
5367
|
* **sentences**: Split the text into individual sentences.
|
|
6347
5368
|
*/
|
|
@@ -6356,14 +5377,14 @@ export declare type TextTranslationSkill = BaseSearchIndexerSkill & {
|
|
|
6356
5377
|
/** The language code to translate documents from for documents that don't specify the from language explicitly. */
|
|
6357
5378
|
defaultFromLanguageCode?: TextTranslationSkillLanguage;
|
|
6358
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. */
|
|
6359
|
-
suggestedFrom?: TextTranslationSkillLanguage;
|
|
5380
|
+
suggestedFrom?: TextTranslationSkillLanguage | null;
|
|
6360
5381
|
};
|
|
6361
5382
|
|
|
6362
5383
|
/**
|
|
6363
5384
|
* Defines values for TextTranslationSkillLanguage. \
|
|
6364
5385
|
* {@link KnownTextTranslationSkillLanguage} can be used interchangeably with TextTranslationSkillLanguage,
|
|
6365
5386
|
* this enum contains the known values that the service supports.
|
|
6366
|
-
* ###
|
|
5387
|
+
* ### Know values supported by the service
|
|
6367
5388
|
* **af**: Afrikaans \
|
|
6368
5389
|
* **ar**: Arabic \
|
|
6369
5390
|
* **bn**: Bangla \
|
|
@@ -6396,8 +5417,6 @@ export declare type TextTranslationSkill = BaseSearchIndexerSkill & {
|
|
|
6396
5417
|
* **ja**: Japanese \
|
|
6397
5418
|
* **sw**: Kiswahili \
|
|
6398
5419
|
* **tlh**: Klingon \
|
|
6399
|
-
* **tlh-Latn**: Klingon (Latin script) \
|
|
6400
|
-
* **tlh-Piqd**: Klingon (Klingon script) \
|
|
6401
5420
|
* **ko**: Korean \
|
|
6402
5421
|
* **lv**: Latvian \
|
|
6403
5422
|
* **lt**: Lithuanian \
|
|
@@ -6408,8 +5427,6 @@ export declare type TextTranslationSkill = BaseSearchIndexerSkill & {
|
|
|
6408
5427
|
* **fa**: Persian \
|
|
6409
5428
|
* **pl**: Polish \
|
|
6410
5429
|
* **pt**: Portuguese \
|
|
6411
|
-
* **pt-br**: Portuguese (Brazil) \
|
|
6412
|
-
* **pt-PT**: Portuguese (Portugal) \
|
|
6413
5430
|
* **otq**: Queretaro Otomi \
|
|
6414
5431
|
* **ro**: Romanian \
|
|
6415
5432
|
* **ru**: Russian \
|
|
@@ -6430,12 +5447,7 @@ export declare type TextTranslationSkill = BaseSearchIndexerSkill & {
|
|
|
6430
5447
|
* **ur**: Urdu \
|
|
6431
5448
|
* **vi**: Vietnamese \
|
|
6432
5449
|
* **cy**: Welsh \
|
|
6433
|
-
* **yua**: Yucatec Maya
|
|
6434
|
-
* **ga**: Irish \
|
|
6435
|
-
* **kn**: Kannada \
|
|
6436
|
-
* **mi**: Maori \
|
|
6437
|
-
* **ml**: Malayalam \
|
|
6438
|
-
* **pa**: Punjabi
|
|
5450
|
+
* **yua**: Yucatec Maya
|
|
6439
5451
|
*/
|
|
6440
5452
|
export declare type TextTranslationSkillLanguage = string;
|
|
6441
5453
|
|
|
@@ -6459,40 +5471,40 @@ export declare type TokenFilter = AsciiFoldingTokenFilter | CjkBigramTokenFilter
|
|
|
6459
5471
|
* Defines values for TokenFilterName. \
|
|
6460
5472
|
* {@link KnownTokenFilterName} can be used interchangeably with TokenFilterName,
|
|
6461
5473
|
* this enum contains the known values that the service supports.
|
|
6462
|
-
* ###
|
|
6463
|
-
* **arabic_normalization**: A token filter that applies the Arabic normalizer to normalize the orthography. See http
|
|
6464
|
-
* **apostrophe**: Strips all characters after an apostrophe (including the apostrophe itself). See http
|
|
6465
|
-
* **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
|
|
6466
|
-
* **cjk_bigram**: Forms bigrams of CJK terms that are generated from the standard tokenizer. See http
|
|
6467
|
-
* **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
|
|
6468
|
-
* **classic**: Removes English possessives, and dots from acronyms. See http
|
|
6469
|
-
* **common_grams**: Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. See http
|
|
6470
|
-
* **edgeNGram_v2**: Generates n-grams of the given size(s) starting from the front or the back of an input token. See http
|
|
6471
|
-
* **elision**: Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http
|
|
6472
|
-
* **german_normalization**: Normalizes German characters according to the heuristics of the German2 snowball algorithm. See http
|
|
6473
|
-
* **hindi_normalization**: Normalizes text in Hindi to remove some differences in spelling variations. See http
|
|
6474
|
-
* **indic_normalization**: Normalizes the Unicode representation of text in Indian languages. See http
|
|
6475
|
-
* **keyword_repeat**: Emits each incoming token twice, once as keyword and once as non-keyword. See http
|
|
6476
|
-
* **kstem**: A high-performance kstem filter for English. See http
|
|
6477
|
-
* **length**: Removes words that are too long or too short. See http
|
|
6478
|
-
* **limit**: Limits the number of tokens while indexing. See http
|
|
6479
|
-
* **lowercase**: Normalizes token text to lower case. See
|
|
6480
|
-
* **nGram_v2**: Generates n-grams of the given size(s). See http
|
|
6481
|
-
* **persian_normalization**: Applies normalization for Persian. See http
|
|
6482
|
-
* **phonetic**: Create tokens for phonetic matches. See https
|
|
6483
|
-
* **porter_stem**: Uses the Porter stemming algorithm to transform the token stream. See http
|
|
6484
|
-
* **reverse**: Reverses the token string. See http
|
|
6485
|
-
* **scandinavian_normalization**: Normalizes use of the interchangeable Scandinavian characters. See http
|
|
6486
|
-
* **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
|
|
6487
|
-
* **shingle**: Creates combinations of tokens as a single token. See http
|
|
6488
|
-
* **snowball**: A filter that stems words using a Snowball-generated stemmer. See http
|
|
6489
|
-
* **sorani_normalization**: Normalizes the Unicode representation of Sorani text. See http
|
|
6490
|
-
* **stemmer**: Language specific stemming filter. See https
|
|
6491
|
-
* **stopwords**: Removes stop words from a token stream. See http
|
|
6492
|
-
* **trim**: Trims leading and trailing whitespace from tokens. See http
|
|
6493
|
-
* **truncate**: Truncates the terms to a specific length. See http
|
|
6494
|
-
* **unique**: Filters out tokens with same text as the previous token. See http
|
|
6495
|
-
* **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 \
|
|
6496
5508
|
* **word_delimiter**: Splits words into subwords and performs optional transformations on subword groups.
|
|
6497
5509
|
*/
|
|
6498
5510
|
export declare type TokenFilterName = string;
|
|
@@ -6530,7 +5542,7 @@ export declare type UploadDocumentsOptions = IndexDocumentsOptions;
|
|
|
6530
5542
|
* Defines values for VisualFeature. \
|
|
6531
5543
|
* {@link KnownVisualFeature} can be used interchangeably with VisualFeature,
|
|
6532
5544
|
* this enum contains the known values that the service supports.
|
|
6533
|
-
* ###
|
|
5545
|
+
* ### Know values supported by the service
|
|
6534
5546
|
* **adult**: Visual features recognized as adult persons. \
|
|
6535
5547
|
* **brands**: Visual features recognized as commercial brands. \
|
|
6536
5548
|
* **categories**: Categories. \
|
|
@@ -6556,9 +5568,9 @@ export declare type WebApiSkill = BaseSearchIndexerSkill & {
|
|
|
6556
5568
|
/** The desired timeout for the request. Default is 30 seconds. */
|
|
6557
5569
|
timeout?: string;
|
|
6558
5570
|
/** The desired batch size which indicates number of documents. */
|
|
6559
|
-
batchSize?: number;
|
|
5571
|
+
batchSize?: number | null;
|
|
6560
5572
|
/** If set, the number of parallel calls that can be made to the Web API. */
|
|
6561
|
-
degreeOfParallelism?: number;
|
|
5573
|
+
degreeOfParallelism?: number | null;
|
|
6562
5574
|
};
|
|
6563
5575
|
|
|
6564
5576
|
/** Splits words into subwords and performs optional transformations on subword groups. This token filter is implemented using Apache Lucene. */
|