@azure/search-documents 11.3.0-beta.1 → 11.3.0-beta.5
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 +62 -1
- package/dist/index.js +1794 -407
- 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 -0
- package/dist-esm/src/generated/data/index.js.map +1 -1
- package/dist-esm/src/generated/data/models/index.js +202 -1
- package/dist-esm/src/generated/data/models/index.js.map +1 -1
- package/dist-esm/src/generated/data/models/mappers.js +6 -0
- package/dist-esm/src/generated/data/models/mappers.js.map +1 -1
- package/dist-esm/src/generated/data/models/parameters.js +21 -13
- package/dist-esm/src/generated/data/models/parameters.js.map +1 -1
- package/dist-esm/src/generated/data/operations/documents.js +17 -50
- package/dist-esm/src/generated/data/operations/documents.js.map +1 -1
- package/dist-esm/src/generated/data/operationsInterfaces/documents.js +9 -0
- package/dist-esm/src/generated/data/operationsInterfaces/documents.js.map +1 -0
- package/dist-esm/src/generated/data/operationsInterfaces/index.js +9 -0
- package/dist-esm/src/generated/data/operationsInterfaces/index.js.map +1 -0
- package/dist-esm/src/generated/data/searchClient.js +2 -2
- package/dist-esm/src/generated/data/searchClient.js.map +1 -1
- package/dist-esm/src/generated/data/searchClientContext.js +13 -11
- package/dist-esm/src/generated/data/searchClientContext.js.map +1 -1
- package/dist-esm/src/generated/service/index.js +1 -0
- package/dist-esm/src/generated/service/index.js.map +1 -1
- package/dist-esm/src/generated/service/models/index.js +902 -1
- package/dist-esm/src/generated/service/models/index.js.map +1 -1
- package/dist-esm/src/generated/service/models/mappers.js +316 -13
- package/dist-esm/src/generated/service/models/mappers.js.map +1 -1
- package/dist-esm/src/generated/service/models/parameters.js +37 -1
- package/dist-esm/src/generated/service/models/parameters.js.map +1 -1
- package/dist-esm/src/generated/service/operations/dataSources.js +13 -30
- package/dist-esm/src/generated/service/operations/dataSources.js.map +1 -1
- package/dist-esm/src/generated/service/operations/indexers.js +45 -45
- package/dist-esm/src/generated/service/operations/indexers.js.map +1 -1
- package/dist-esm/src/generated/service/operations/indexes.js +11 -40
- package/dist-esm/src/generated/service/operations/indexes.js.map +1 -1
- package/dist-esm/src/generated/service/operations/skillsets.js +43 -30
- package/dist-esm/src/generated/service/operations/skillsets.js.map +1 -1
- package/dist-esm/src/generated/service/operations/synonymMaps.js +9 -29
- package/dist-esm/src/generated/service/operations/synonymMaps.js.map +1 -1
- package/dist-esm/src/generated/service/operationsInterfaces/dataSources.js +9 -0
- package/dist-esm/src/generated/service/operationsInterfaces/dataSources.js.map +1 -0
- package/dist-esm/src/generated/service/operationsInterfaces/index.js +13 -0
- package/dist-esm/src/generated/service/operationsInterfaces/index.js.map +1 -0
- package/dist-esm/src/generated/service/operationsInterfaces/indexers.js +9 -0
- package/dist-esm/src/generated/service/operationsInterfaces/indexers.js.map +1 -0
- package/dist-esm/src/generated/service/operationsInterfaces/indexes.js +9 -0
- package/dist-esm/src/generated/service/operationsInterfaces/indexes.js.map +1 -0
- package/dist-esm/src/generated/service/operationsInterfaces/skillsets.js +9 -0
- package/dist-esm/src/generated/service/operationsInterfaces/skillsets.js.map +1 -0
- package/dist-esm/src/generated/service/operationsInterfaces/synonymMaps.js +9 -0
- package/dist-esm/src/generated/service/operationsInterfaces/synonymMaps.js.map +1 -0
- package/dist-esm/src/generated/service/searchServiceClient.js +9 -12
- package/dist-esm/src/generated/service/searchServiceClient.js.map +1 -1
- package/dist-esm/src/generated/service/searchServiceClientContext.js +13 -11
- package/dist-esm/src/generated/service/searchServiceClientContext.js.map +1 -1
- package/dist-esm/src/index.js +2 -0
- package/dist-esm/src/index.js.map +1 -1
- package/dist-esm/src/indexModels.js.map +1 -1
- package/dist-esm/src/odataMetadataPolicy.js +6 -14
- package/dist-esm/src/odataMetadataPolicy.js.map +1 -1
- package/dist-esm/src/searchApiKeyCredentialPolicy.js +7 -20
- package/dist-esm/src/searchApiKeyCredentialPolicy.js.map +1 -1
- package/dist-esm/src/searchClient.js +35 -24
- package/dist-esm/src/searchClient.js.map +1 -1
- package/dist-esm/src/searchIndexClient.js +34 -29
- package/dist-esm/src/searchIndexClient.js.map +1 -1
- package/dist-esm/src/searchIndexerClient.js +79 -33
- package/dist-esm/src/searchIndexerClient.js.map +1 -1
- package/dist-esm/src/searchIndexingBufferedSender.js +1 -1
- package/dist-esm/src/searchIndexingBufferedSender.js.map +1 -1
- package/dist-esm/src/serialization.js +1 -1
- package/dist-esm/src/serialization.js.map +1 -1
- package/dist-esm/src/serviceModels.js.map +1 -1
- package/dist-esm/src/serviceUtils.js +26 -19
- package/dist-esm/src/serviceUtils.js.map +1 -1
- package/package.json +26 -14
- package/types/search-documents.d.ts +661 -194
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
/// <reference lib="esnext.asynciterable" />
|
|
2
|
+
|
|
2
3
|
import { AzureKeyCredential } from '@azure/core-auth';
|
|
4
|
+
import { CommonClientOptions } from '@azure/core-client';
|
|
3
5
|
import { KeyCredential } from '@azure/core-auth';
|
|
4
|
-
import { OperationOptions } from '@azure/core-
|
|
6
|
+
import { OperationOptions } from '@azure/core-client';
|
|
5
7
|
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
|
6
|
-
import {
|
|
7
|
-
import { RestError } from '@azure/core-http';
|
|
8
|
+
import { RestError } from '@azure/core-rest-pipeline';
|
|
8
9
|
import { TokenCredential } from '@azure/core-auth';
|
|
9
10
|
|
|
10
11
|
/** Information about a token returned by an analyzer. */
|
|
@@ -53,6 +54,10 @@ export declare interface AnalyzeRequest {
|
|
|
53
54
|
* NOTE: Either analyzerName or tokenizerName is required in an AnalyzeRequest.
|
|
54
55
|
*/
|
|
55
56
|
tokenizerName?: string;
|
|
57
|
+
/**
|
|
58
|
+
* The name of the normalizer to use to normalize the given text.
|
|
59
|
+
*/
|
|
60
|
+
normalizerName?: LexicalNormalizerName;
|
|
56
61
|
/**
|
|
57
62
|
* An optional list of token filters to use when breaking the given text. This parameter can only
|
|
58
63
|
* be set when using the tokenizer parameter.
|
|
@@ -99,14 +104,14 @@ export declare interface AnswerResult {
|
|
|
99
104
|
* Same text passage as in the Text property with highlighted text phrases most relevant to the query.
|
|
100
105
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
101
106
|
*/
|
|
102
|
-
readonly highlights?: string
|
|
107
|
+
readonly highlights?: string;
|
|
103
108
|
}
|
|
104
109
|
|
|
105
110
|
/**
|
|
106
111
|
* Defines values for Answers. \
|
|
107
112
|
* {@link KnownAnswers} can be used interchangeably with Answers,
|
|
108
113
|
* this enum contains the known values that the service supports.
|
|
109
|
-
* ###
|
|
114
|
+
* ### Known values supported by the service
|
|
110
115
|
* **none**: Do not return answers for the query. \
|
|
111
116
|
* **extractive**: Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language.
|
|
112
117
|
*/
|
|
@@ -215,6 +220,7 @@ export declare interface AzureActiveDirectoryApplicationCredentials {
|
|
|
215
220
|
/** The authentication key of the specified AAD application. */
|
|
216
221
|
applicationSecret?: string;
|
|
217
222
|
}
|
|
223
|
+
|
|
218
224
|
export { AzureKeyCredential }
|
|
219
225
|
|
|
220
226
|
/** Base type for character filters. */
|
|
@@ -315,7 +321,7 @@ export declare interface BaseTokenFilter {
|
|
|
315
321
|
* Defines values for BlobIndexerDataToExtract. \
|
|
316
322
|
* {@link KnownBlobIndexerDataToExtract} can be used interchangeably with BlobIndexerDataToExtract,
|
|
317
323
|
* this enum contains the known values that the service supports.
|
|
318
|
-
* ###
|
|
324
|
+
* ### Known values supported by the service
|
|
319
325
|
* **storageMetadata**: Indexes just the standard blob properties and user-specified metadata. \
|
|
320
326
|
* **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). \
|
|
321
327
|
* **contentAndMetadata**: Extracts all metadata and textual content from each blob.
|
|
@@ -326,7 +332,7 @@ export declare type BlobIndexerDataToExtract = string;
|
|
|
326
332
|
* Defines values for BlobIndexerImageAction. \
|
|
327
333
|
* {@link KnownBlobIndexerImageAction} can be used interchangeably with BlobIndexerImageAction,
|
|
328
334
|
* this enum contains the known values that the service supports.
|
|
329
|
-
* ###
|
|
335
|
+
* ### Known values supported by the service
|
|
330
336
|
* **none**: Ignores embedded images or image files in the data set. This is the default. \
|
|
331
337
|
* **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. \
|
|
332
338
|
* **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.
|
|
@@ -337,7 +343,7 @@ export declare type BlobIndexerImageAction = string;
|
|
|
337
343
|
* Defines values for BlobIndexerParsingMode. \
|
|
338
344
|
* {@link KnownBlobIndexerParsingMode} can be used interchangeably with BlobIndexerParsingMode,
|
|
339
345
|
* this enum contains the known values that the service supports.
|
|
340
|
-
* ###
|
|
346
|
+
* ### Known values supported by the service
|
|
341
347
|
* **default**: Set to default for normal file processing. \
|
|
342
348
|
* **text**: Set to text to improve indexing performance on plain text files in blob storage. \
|
|
343
349
|
* **delimitedText**: Set to delimitedText when blobs are plain CSV files. \
|
|
@@ -351,7 +357,7 @@ export declare type BlobIndexerParsingMode = string;
|
|
|
351
357
|
* Defines values for BlobIndexerPDFTextRotationAlgorithm. \
|
|
352
358
|
* {@link KnownBlobIndexerPDFTextRotationAlgorithm} can be used interchangeably with BlobIndexerPDFTextRotationAlgorithm,
|
|
353
359
|
* this enum contains the known values that the service supports.
|
|
354
|
-
* ###
|
|
360
|
+
* ### Known values supported by the service
|
|
355
361
|
* **none**: Leverages normal text extraction. This is the default. \
|
|
356
362
|
* **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.
|
|
357
363
|
*/
|
|
@@ -362,9 +368,9 @@ export declare type BM25Similarity = Similarity & {
|
|
|
362
368
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
363
369
|
odatatype: "#Microsoft.Azure.Search.BM25Similarity";
|
|
364
370
|
/** 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. */
|
|
365
|
-
k1?: number
|
|
371
|
+
k1?: number;
|
|
366
372
|
/** 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. */
|
|
367
|
-
b?: number
|
|
373
|
+
b?: number;
|
|
368
374
|
};
|
|
369
375
|
|
|
370
376
|
/** 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'.. */
|
|
@@ -380,14 +386,14 @@ export declare interface CaptionResult {
|
|
|
380
386
|
* Same text passage as in the Text property with highlighted phrases most relevant to the query.
|
|
381
387
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
382
388
|
*/
|
|
383
|
-
readonly highlights?: string
|
|
389
|
+
readonly highlights?: string;
|
|
384
390
|
}
|
|
385
391
|
|
|
386
392
|
/**
|
|
387
393
|
* Defines values for Captions. \
|
|
388
394
|
* {@link KnownCaptions} can be used interchangeably with Captions,
|
|
389
395
|
* this enum contains the known values that the service supports.
|
|
390
|
-
* ###
|
|
396
|
+
* ### Known values supported by the service
|
|
391
397
|
* **none**: Do not return captions for the query. \
|
|
392
398
|
* **extractive**: Extracts captions from the matching documents that contain passages relevant to the search query.
|
|
393
399
|
*/
|
|
@@ -402,8 +408,8 @@ export declare type CharFilter = MappingCharFilter | PatternReplaceCharFilter;
|
|
|
402
408
|
* Defines values for CharFilterName. \
|
|
403
409
|
* {@link KnownCharFilterName} can be used interchangeably with CharFilterName,
|
|
404
410
|
* this enum contains the known values that the service supports.
|
|
405
|
-
* ###
|
|
406
|
-
* **html_strip**: A character filter that attempts to strip out HTML constructs. See https
|
|
411
|
+
* ### Known values supported by the service
|
|
412
|
+
* **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
|
|
407
413
|
*/
|
|
408
414
|
export declare type CharFilterName = string;
|
|
409
415
|
|
|
@@ -498,7 +504,7 @@ export declare interface CorsOptions {
|
|
|
498
504
|
/** 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). */
|
|
499
505
|
allowedOrigins: string[];
|
|
500
506
|
/** The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes. */
|
|
501
|
-
maxAgeInSeconds?: number
|
|
507
|
+
maxAgeInSeconds?: number;
|
|
502
508
|
}
|
|
503
509
|
|
|
504
510
|
/**
|
|
@@ -529,6 +535,10 @@ export declare interface CreateorUpdateDataSourceConnectionOptions extends Opera
|
|
|
529
535
|
* If set to true, Resource will be deleted only if the etag matches.
|
|
530
536
|
*/
|
|
531
537
|
onlyIfUnchanged?: boolean;
|
|
538
|
+
/**
|
|
539
|
+
* Ignores cache reset requirements.
|
|
540
|
+
*/
|
|
541
|
+
skipIndexerResetRequirementForCache?: boolean;
|
|
532
542
|
}
|
|
533
543
|
|
|
534
544
|
/**
|
|
@@ -539,6 +549,10 @@ export declare interface CreateorUpdateIndexerOptions extends OperationOptions {
|
|
|
539
549
|
* If set to true, Resource will be deleted only if the etag matches.
|
|
540
550
|
*/
|
|
541
551
|
onlyIfUnchanged?: boolean;
|
|
552
|
+
/** Ignores cache reset requirements. */
|
|
553
|
+
skipIndexerResetRequirementForCache?: boolean;
|
|
554
|
+
/** Disables cache reprocessing change detection. */
|
|
555
|
+
disableCacheReprocessingChangeDetection?: boolean;
|
|
542
556
|
}
|
|
543
557
|
|
|
544
558
|
/**
|
|
@@ -566,6 +580,14 @@ export declare interface CreateOrUpdateSkillsetOptions extends OperationOptions
|
|
|
566
580
|
* If set to true, Resource will be deleted only if the etag matches.
|
|
567
581
|
*/
|
|
568
582
|
onlyIfUnchanged?: boolean;
|
|
583
|
+
/**
|
|
584
|
+
* Ignores cache reset requirements.
|
|
585
|
+
*/
|
|
586
|
+
skipIndexerResetRequirementForCache?: boolean;
|
|
587
|
+
/**
|
|
588
|
+
* Disables cache reprocessing change detection.
|
|
589
|
+
*/
|
|
590
|
+
disableCacheReprocessingChangeDetection?: boolean;
|
|
569
591
|
}
|
|
570
592
|
|
|
571
593
|
/**
|
|
@@ -637,27 +659,27 @@ export declare interface CustomEntity {
|
|
|
637
659
|
/** 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. */
|
|
638
660
|
name: string;
|
|
639
661
|
/** 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. */
|
|
640
|
-
description?: string
|
|
662
|
+
description?: string;
|
|
641
663
|
/** 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. */
|
|
642
|
-
type?: string
|
|
664
|
+
type?: string;
|
|
643
665
|
/** 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. */
|
|
644
|
-
subtype?: string
|
|
666
|
+
subtype?: string;
|
|
645
667
|
/** 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. */
|
|
646
|
-
id?: string
|
|
668
|
+
id?: string;
|
|
647
669
|
/** 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. */
|
|
648
|
-
caseSensitive?: boolean
|
|
670
|
+
caseSensitive?: boolean;
|
|
649
671
|
/** Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent. */
|
|
650
|
-
accentSensitive?: boolean
|
|
672
|
+
accentSensitive?: boolean;
|
|
651
673
|
/** 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. */
|
|
652
|
-
fuzzyEditDistance?: number
|
|
674
|
+
fuzzyEditDistance?: number;
|
|
653
675
|
/** Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values. */
|
|
654
|
-
defaultCaseSensitive?: boolean
|
|
676
|
+
defaultCaseSensitive?: boolean;
|
|
655
677
|
/** Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values. */
|
|
656
|
-
defaultAccentSensitive?: boolean
|
|
678
|
+
defaultAccentSensitive?: boolean;
|
|
657
679
|
/** Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values. */
|
|
658
|
-
defaultFuzzyEditDistance?: number
|
|
680
|
+
defaultFuzzyEditDistance?: number;
|
|
659
681
|
/** An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name. */
|
|
660
|
-
aliases?: CustomEntityAlias[]
|
|
682
|
+
aliases?: CustomEntityAlias[];
|
|
661
683
|
}
|
|
662
684
|
|
|
663
685
|
/** A complex object that can be used to specify alternative spellings or synonyms to the root entity name. */
|
|
@@ -665,11 +687,11 @@ export declare interface CustomEntityAlias {
|
|
|
665
687
|
/** The text of the alias. */
|
|
666
688
|
text: string;
|
|
667
689
|
/** Determine if the alias is case sensitive. */
|
|
668
|
-
caseSensitive?: boolean
|
|
690
|
+
caseSensitive?: boolean;
|
|
669
691
|
/** Determine if the alias is accent sensitive. */
|
|
670
|
-
accentSensitive?: boolean
|
|
692
|
+
accentSensitive?: boolean;
|
|
671
693
|
/** Determine the fuzzy edit distance of the alias. */
|
|
672
|
-
fuzzyEditDistance?: number
|
|
694
|
+
fuzzyEditDistance?: number;
|
|
673
695
|
}
|
|
674
696
|
|
|
675
697
|
/** A skill looks for text from a custom, user-defined list of words and phrases. */
|
|
@@ -677,24 +699,24 @@ export declare type CustomEntityLookupSkill = BaseSearchIndexerSkill & {
|
|
|
677
699
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
678
700
|
odatatype: "#Microsoft.Skills.Text.CustomEntityLookupSkill";
|
|
679
701
|
/** A value indicating which language code to use. Default is en. */
|
|
680
|
-
defaultLanguageCode?: CustomEntityLookupSkillLanguage
|
|
702
|
+
defaultLanguageCode?: CustomEntityLookupSkillLanguage;
|
|
681
703
|
/** 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. */
|
|
682
|
-
entitiesDefinitionUri?: string
|
|
704
|
+
entitiesDefinitionUri?: string;
|
|
683
705
|
/** The inline CustomEntity definition. */
|
|
684
|
-
inlineEntitiesDefinition?: CustomEntity[]
|
|
706
|
+
inlineEntitiesDefinition?: CustomEntity[];
|
|
685
707
|
/** A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value. */
|
|
686
|
-
globalDefaultCaseSensitive?: boolean
|
|
708
|
+
globalDefaultCaseSensitive?: boolean;
|
|
687
709
|
/** A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value. */
|
|
688
|
-
globalDefaultAccentSensitive?: boolean
|
|
710
|
+
globalDefaultAccentSensitive?: boolean;
|
|
689
711
|
/** A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value. */
|
|
690
|
-
globalDefaultFuzzyEditDistance?: number
|
|
712
|
+
globalDefaultFuzzyEditDistance?: number;
|
|
691
713
|
};
|
|
692
714
|
|
|
693
715
|
/**
|
|
694
716
|
* Defines values for CustomEntityLookupSkillLanguage. \
|
|
695
717
|
* {@link KnownCustomEntityLookupSkillLanguage} can be used interchangeably with CustomEntityLookupSkillLanguage,
|
|
696
718
|
* this enum contains the known values that the service supports.
|
|
697
|
-
* ###
|
|
719
|
+
* ### Known values supported by the service
|
|
698
720
|
* **da**: Danish \
|
|
699
721
|
* **de**: German \
|
|
700
722
|
* **en**: English \
|
|
@@ -840,13 +862,13 @@ export declare type DocumentExtractionSkill = BaseSearchIndexerSkill & {
|
|
|
840
862
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
841
863
|
odatatype: "#Microsoft.Skills.Util.DocumentExtractionSkill";
|
|
842
864
|
/** The parsingMode for the skill. Will be set to 'default' if not defined. */
|
|
843
|
-
parsingMode?: string
|
|
865
|
+
parsingMode?: string;
|
|
844
866
|
/** The type of data to be extracted for the skill. Will be set to 'contentAndMetadata' if not defined. */
|
|
845
|
-
dataToExtract?: string
|
|
867
|
+
dataToExtract?: string;
|
|
846
868
|
/** A dictionary of configurations for the skill. */
|
|
847
869
|
configuration?: {
|
|
848
|
-
[propertyName: string]:
|
|
849
|
-
}
|
|
870
|
+
[propertyName: string]: Record<string, unknown>;
|
|
871
|
+
};
|
|
850
872
|
};
|
|
851
873
|
|
|
852
874
|
/**
|
|
@@ -907,7 +929,7 @@ export declare type ElisionTokenFilter = BaseTokenFilter & {
|
|
|
907
929
|
* Defines values for EntityCategory. \
|
|
908
930
|
* {@link KnownEntityCategory} can be used interchangeably with EntityCategory,
|
|
909
931
|
* this enum contains the known values that the service supports.
|
|
910
|
-
* ###
|
|
932
|
+
* ### Known values supported by the service
|
|
911
933
|
* **location**: Entities describing a physical location. \
|
|
912
934
|
* **organization**: Entities describing an organization. \
|
|
913
935
|
* **person**: Entities describing a person. \
|
|
@@ -923,11 +945,11 @@ export declare type EntityLinkingSkill = BaseSearchIndexerSkill & {
|
|
|
923
945
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
924
946
|
odatatype: "#Microsoft.Skills.Text.V3.EntityLinkingSkill";
|
|
925
947
|
/** A value indicating which language code to use. Default is en. */
|
|
926
|
-
defaultLanguageCode?: string
|
|
948
|
+
defaultLanguageCode?: string;
|
|
927
949
|
/** 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. */
|
|
928
|
-
minimumPrecision?: number
|
|
950
|
+
minimumPrecision?: number;
|
|
929
951
|
/** 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. */
|
|
930
|
-
modelVersion?: string
|
|
952
|
+
modelVersion?: string;
|
|
931
953
|
};
|
|
932
954
|
|
|
933
955
|
/** Text analytics entity recognition. */
|
|
@@ -939,16 +961,16 @@ export declare type EntityRecognitionSkill = BaseSearchIndexerSkill & {
|
|
|
939
961
|
/** A value indicating which language code to use. Default is en. */
|
|
940
962
|
defaultLanguageCode?: EntityRecognitionSkillLanguage;
|
|
941
963
|
/** 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. */
|
|
942
|
-
includeTypelessEntities?: boolean
|
|
964
|
+
includeTypelessEntities?: boolean;
|
|
943
965
|
/** 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. */
|
|
944
|
-
minimumPrecision?: number
|
|
966
|
+
minimumPrecision?: number;
|
|
945
967
|
};
|
|
946
968
|
|
|
947
969
|
/**
|
|
948
970
|
* Defines values for EntityRecognitionSkillLanguage. \
|
|
949
971
|
* {@link KnownEntityRecognitionSkillLanguage} can be used interchangeably with EntityRecognitionSkillLanguage,
|
|
950
972
|
* this enum contains the known values that the service supports.
|
|
951
|
-
* ###
|
|
973
|
+
* ### Known values supported by the service
|
|
952
974
|
* **ar**: Arabic \
|
|
953
975
|
* **cs**: Czech \
|
|
954
976
|
* **zh-Hans**: Chinese-Simplified \
|
|
@@ -982,11 +1004,11 @@ export declare type EntityRecognitionSkillV3 = BaseSearchIndexerSkill & {
|
|
|
982
1004
|
/** A list of entity categories that should be extracted. */
|
|
983
1005
|
categories?: string[];
|
|
984
1006
|
/** A value indicating which language code to use. Default is en. */
|
|
985
|
-
defaultLanguageCode?: string
|
|
1007
|
+
defaultLanguageCode?: string;
|
|
986
1008
|
/** 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. */
|
|
987
|
-
minimumPrecision?: number
|
|
1009
|
+
minimumPrecision?: number;
|
|
988
1010
|
/** 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. */
|
|
989
|
-
modelVersion?: string
|
|
1011
|
+
modelVersion?: string;
|
|
990
1012
|
};
|
|
991
1013
|
|
|
992
1014
|
/** 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. */
|
|
@@ -1007,7 +1029,7 @@ export declare interface FieldMapping {
|
|
|
1007
1029
|
/** The name of the target field in the index. Same as the source field name by default. */
|
|
1008
1030
|
targetFieldName?: string;
|
|
1009
1031
|
/** A function to apply to each source field value before indexing. */
|
|
1010
|
-
mappingFunction?: FieldMappingFunction
|
|
1032
|
+
mappingFunction?: FieldMappingFunction;
|
|
1011
1033
|
}
|
|
1012
1034
|
|
|
1013
1035
|
/** Represents a function that transforms a value from a data source before indexing. */
|
|
@@ -1016,7 +1038,7 @@ export declare interface FieldMappingFunction {
|
|
|
1016
1038
|
name: string;
|
|
1017
1039
|
/** A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. */
|
|
1018
1040
|
parameters?: {
|
|
1019
|
-
[propertyName: string]:
|
|
1041
|
+
[propertyName: string]: Record<string, unknown>;
|
|
1020
1042
|
};
|
|
1021
1043
|
}
|
|
1022
1044
|
|
|
@@ -1136,7 +1158,7 @@ export declare type ImageAnalysisSkill = BaseSearchIndexerSkill & {
|
|
|
1136
1158
|
* Defines values for ImageAnalysisSkillLanguage. \
|
|
1137
1159
|
* {@link KnownImageAnalysisSkillLanguage} can be used interchangeably with ImageAnalysisSkillLanguage,
|
|
1138
1160
|
* this enum contains the known values that the service supports.
|
|
1139
|
-
* ###
|
|
1161
|
+
* ### Known values supported by the service
|
|
1140
1162
|
* **en**: English \
|
|
1141
1163
|
* **es**: Spanish \
|
|
1142
1164
|
* **ja**: Japanese \
|
|
@@ -1149,7 +1171,7 @@ export declare type ImageAnalysisSkillLanguage = string;
|
|
|
1149
1171
|
* Defines values for ImageDetail. \
|
|
1150
1172
|
* {@link KnownImageDetail} can be used interchangeably with ImageDetail,
|
|
1151
1173
|
* this enum contains the known values that the service supports.
|
|
1152
|
-
* ###
|
|
1174
|
+
* ### Known values supported by the service
|
|
1153
1175
|
* **celebrities**: Details recognized as celebrities. \
|
|
1154
1176
|
* **landmarks**: Details recognized as landmarks.
|
|
1155
1177
|
*/
|
|
@@ -1247,7 +1269,7 @@ export declare interface IndexDocumentsResult {
|
|
|
1247
1269
|
* Defines values for IndexerExecutionEnvironment. \
|
|
1248
1270
|
* {@link KnownIndexerExecutionEnvironment} can be used interchangeably with IndexerExecutionEnvironment,
|
|
1249
1271
|
* this enum contains the known values that the service supports.
|
|
1250
|
-
* ###
|
|
1272
|
+
* ### Known values supported by the service
|
|
1251
1273
|
* **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. \
|
|
1252
1274
|
* **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.
|
|
1253
1275
|
*/
|
|
@@ -1260,6 +1282,16 @@ export declare interface IndexerExecutionResult {
|
|
|
1260
1282
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1261
1283
|
*/
|
|
1262
1284
|
readonly status: IndexerExecutionStatus;
|
|
1285
|
+
/**
|
|
1286
|
+
* The outcome of this indexer execution.
|
|
1287
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1288
|
+
*/
|
|
1289
|
+
readonly statusDetail?: IndexerExecutionStatusDetail;
|
|
1290
|
+
/**
|
|
1291
|
+
* All of the state that defines and dictates the indexer's current execution.
|
|
1292
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1293
|
+
*/
|
|
1294
|
+
readonly currentState?: IndexerState;
|
|
1263
1295
|
/**
|
|
1264
1296
|
* The error message indicating the top-level error, if any.
|
|
1265
1297
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
@@ -1274,7 +1306,7 @@ export declare interface IndexerExecutionResult {
|
|
|
1274
1306
|
* The end time of this indexer execution, if the execution has already completed.
|
|
1275
1307
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1276
1308
|
*/
|
|
1277
|
-
readonly endTime?: Date
|
|
1309
|
+
readonly endTime?: Date;
|
|
1278
1310
|
/**
|
|
1279
1311
|
* The item-level indexing errors.
|
|
1280
1312
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
@@ -1310,17 +1342,75 @@ export declare interface IndexerExecutionResult {
|
|
|
1310
1342
|
/** Defines values for IndexerExecutionStatus. */
|
|
1311
1343
|
export declare type IndexerExecutionStatus = "transientFailure" | "success" | "inProgress" | "reset";
|
|
1312
1344
|
|
|
1345
|
+
/**
|
|
1346
|
+
* Defines values for IndexerExecutionStatusDetail. \
|
|
1347
|
+
* {@link KnownIndexerExecutionStatusDetail} can be used interchangeably with IndexerExecutionStatusDetail,
|
|
1348
|
+
* this enum contains the known values that the service supports.
|
|
1349
|
+
* ### Known values supported by the service
|
|
1350
|
+
* **resetDocs**: Indicates that the reset that occurred was for a call to ResetDocs.
|
|
1351
|
+
*/
|
|
1352
|
+
export declare type IndexerExecutionStatusDetail = string;
|
|
1353
|
+
|
|
1354
|
+
/** Represents all of the state that defines and dictates the indexer's current execution. */
|
|
1355
|
+
export declare interface IndexerState {
|
|
1356
|
+
/**
|
|
1357
|
+
* The mode the indexer is running in.
|
|
1358
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1359
|
+
*/
|
|
1360
|
+
readonly mode?: IndexingMode;
|
|
1361
|
+
/**
|
|
1362
|
+
* Change tracking state used when indexing starts on all documents in the datasource.
|
|
1363
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1364
|
+
*/
|
|
1365
|
+
readonly allDocumentsInitialChangeTrackingState?: string;
|
|
1366
|
+
/**
|
|
1367
|
+
* Change tracking state value when indexing finishes on all documents in the datasource.
|
|
1368
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1369
|
+
*/
|
|
1370
|
+
readonly allDocumentsFinalChangeTrackingState?: string;
|
|
1371
|
+
/**
|
|
1372
|
+
* Change tracking state used when indexing starts on select, reset documents in the datasource.
|
|
1373
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1374
|
+
*/
|
|
1375
|
+
readonly resetDocumentsInitialChangeTrackingState?: string;
|
|
1376
|
+
/**
|
|
1377
|
+
* Change tracking state value when indexing finishes on select, reset documents in the datasource.
|
|
1378
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1379
|
+
*/
|
|
1380
|
+
readonly resetDocumentsFinalChangeTrackingState?: string;
|
|
1381
|
+
/**
|
|
1382
|
+
* 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.
|
|
1383
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1384
|
+
*/
|
|
1385
|
+
readonly resetDocumentKeys?: string[];
|
|
1386
|
+
/**
|
|
1387
|
+
* 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.
|
|
1388
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1389
|
+
*/
|
|
1390
|
+
readonly resetDatasourceDocumentIds?: string[];
|
|
1391
|
+
}
|
|
1392
|
+
|
|
1313
1393
|
/** Defines values for IndexerStatus. */
|
|
1314
1394
|
export declare type IndexerStatus = "unknown" | "error" | "running";
|
|
1315
1395
|
|
|
1396
|
+
/**
|
|
1397
|
+
* Defines values for IndexingMode. \
|
|
1398
|
+
* {@link KnownIndexingMode} can be used interchangeably with IndexingMode,
|
|
1399
|
+
* this enum contains the known values that the service supports.
|
|
1400
|
+
* ### Known values supported by the service
|
|
1401
|
+
* **indexingAllDocs**: The indexer is indexing all documents in the datasource. \
|
|
1402
|
+
* **indexingResetDocs**: The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status.
|
|
1403
|
+
*/
|
|
1404
|
+
export declare type IndexingMode = string;
|
|
1405
|
+
|
|
1316
1406
|
/** Represents parameters for indexer execution. */
|
|
1317
1407
|
export declare interface IndexingParameters {
|
|
1318
1408
|
/** The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type. */
|
|
1319
|
-
batchSize?: number
|
|
1409
|
+
batchSize?: number;
|
|
1320
1410
|
/** The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. */
|
|
1321
|
-
maxFailedItems?: number
|
|
1411
|
+
maxFailedItems?: number;
|
|
1322
1412
|
/** 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. */
|
|
1323
|
-
maxFailedItemsPerBatch?: number
|
|
1413
|
+
maxFailedItemsPerBatch?: number;
|
|
1324
1414
|
/** A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. */
|
|
1325
1415
|
configuration?: IndexingParametersConfiguration;
|
|
1326
1416
|
}
|
|
@@ -1438,16 +1528,16 @@ export declare type KeyPhraseExtractionSkill = BaseSearchIndexerSkill & {
|
|
|
1438
1528
|
/** A value indicating which language code to use. Default is en. */
|
|
1439
1529
|
defaultLanguageCode?: KeyPhraseExtractionSkillLanguage;
|
|
1440
1530
|
/** A number indicating how many key phrases to return. If absent, all identified key phrases will be returned. */
|
|
1441
|
-
maxKeyPhraseCount?: number
|
|
1531
|
+
maxKeyPhraseCount?: number;
|
|
1442
1532
|
/** 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. */
|
|
1443
|
-
modelVersion?: string
|
|
1533
|
+
modelVersion?: string;
|
|
1444
1534
|
};
|
|
1445
1535
|
|
|
1446
1536
|
/**
|
|
1447
1537
|
* Defines values for KeyPhraseExtractionSkillLanguage. \
|
|
1448
1538
|
* {@link KnownKeyPhraseExtractionSkillLanguage} can be used interchangeably with KeyPhraseExtractionSkillLanguage,
|
|
1449
1539
|
* this enum contains the known values that the service supports.
|
|
1450
|
-
* ###
|
|
1540
|
+
* ### Known values supported by the service
|
|
1451
1541
|
* **da**: Danish \
|
|
1452
1542
|
* **nl**: Dutch \
|
|
1453
1543
|
* **en**: English \
|
|
@@ -1878,7 +1968,7 @@ export declare enum KnownAnalyzerNames {
|
|
|
1878
1968
|
}
|
|
1879
1969
|
|
|
1880
1970
|
/** Known values of {@link Answers} that the service accepts. */
|
|
1881
|
-
export declare
|
|
1971
|
+
export declare enum KnownAnswers {
|
|
1882
1972
|
/** Do not return answers for the query. */
|
|
1883
1973
|
None = "none",
|
|
1884
1974
|
/** Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. */
|
|
@@ -1886,7 +1976,7 @@ export declare const enum KnownAnswers {
|
|
|
1886
1976
|
}
|
|
1887
1977
|
|
|
1888
1978
|
/** Known values of {@link BlobIndexerDataToExtract} that the service accepts. */
|
|
1889
|
-
export declare
|
|
1979
|
+
export declare enum KnownBlobIndexerDataToExtract {
|
|
1890
1980
|
/** Indexes just the standard blob properties and user-specified metadata. */
|
|
1891
1981
|
StorageMetadata = "storageMetadata",
|
|
1892
1982
|
/** Extracts metadata provided by the Azure blob storage subsystem and the content-type specific metadata (for example, metadata unique to just .png files are indexed). */
|
|
@@ -1896,7 +1986,7 @@ export declare const enum KnownBlobIndexerDataToExtract {
|
|
|
1896
1986
|
}
|
|
1897
1987
|
|
|
1898
1988
|
/** Known values of {@link BlobIndexerImageAction} that the service accepts. */
|
|
1899
|
-
export declare
|
|
1989
|
+
export declare enum KnownBlobIndexerImageAction {
|
|
1900
1990
|
/** Ignores embedded images or image files in the data set. This is the default. */
|
|
1901
1991
|
None = "none",
|
|
1902
1992
|
/** Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field. This action requires that "dataToExtract" is set to "contentAndMetadata". A normalized image refers to additional processing resulting in uniform image output, sized and rotated to promote consistent rendering when you include images in visual search results. This information is generated for each image when you use this option. */
|
|
@@ -1906,7 +1996,7 @@ export declare const enum KnownBlobIndexerImageAction {
|
|
|
1906
1996
|
}
|
|
1907
1997
|
|
|
1908
1998
|
/** Known values of {@link BlobIndexerParsingMode} that the service accepts. */
|
|
1909
|
-
export declare
|
|
1999
|
+
export declare enum KnownBlobIndexerParsingMode {
|
|
1910
2000
|
/** Set to default for normal file processing. */
|
|
1911
2001
|
Default = "default",
|
|
1912
2002
|
/** Set to text to improve indexing performance on plain text files in blob storage. */
|
|
@@ -1922,7 +2012,7 @@ export declare const enum KnownBlobIndexerParsingMode {
|
|
|
1922
2012
|
}
|
|
1923
2013
|
|
|
1924
2014
|
/** Known values of {@link BlobIndexerPDFTextRotationAlgorithm} that the service accepts. */
|
|
1925
|
-
export declare
|
|
2015
|
+
export declare enum KnownBlobIndexerPDFTextRotationAlgorithm {
|
|
1926
2016
|
/** Leverages normal text extraction. This is the default. */
|
|
1927
2017
|
None = "none",
|
|
1928
2018
|
/** May produce better and more readable text extraction from PDF files that have rotated text within them. Note that there may be a small performance speed impact when this parameter is used. This parameter only applies to PDF files, and only to PDFs with embedded text. If the rotated text appears within an embedded image in the PDF, this parameter does not apply. */
|
|
@@ -1930,7 +2020,7 @@ export declare const enum KnownBlobIndexerPDFTextRotationAlgorithm {
|
|
|
1930
2020
|
}
|
|
1931
2021
|
|
|
1932
2022
|
/** Known values of {@link CharFilterName} that the service accepts. */
|
|
1933
|
-
export declare
|
|
2023
|
+
export declare enum KnownCharFilterName {
|
|
1934
2024
|
/** A character filter that attempts to strip out HTML constructs. See https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html */
|
|
1935
2025
|
HtmlStrip = "html_strip"
|
|
1936
2026
|
}
|
|
@@ -1948,7 +2038,7 @@ export declare enum KnownCharFilterNames {
|
|
|
1948
2038
|
}
|
|
1949
2039
|
|
|
1950
2040
|
/** Known values of {@link CustomEntityLookupSkillLanguage} that the service accepts. */
|
|
1951
|
-
export declare
|
|
2041
|
+
export declare enum KnownCustomEntityLookupSkillLanguage {
|
|
1952
2042
|
/** Danish */
|
|
1953
2043
|
Da = "da",
|
|
1954
2044
|
/** German */
|
|
@@ -1970,7 +2060,7 @@ export declare const enum KnownCustomEntityLookupSkillLanguage {
|
|
|
1970
2060
|
}
|
|
1971
2061
|
|
|
1972
2062
|
/** Known values of {@link EntityCategory} that the service accepts. */
|
|
1973
|
-
export declare
|
|
2063
|
+
export declare enum KnownEntityCategory {
|
|
1974
2064
|
/** Entities describing a physical location. */
|
|
1975
2065
|
Location = "location",
|
|
1976
2066
|
/** Entities describing an organization. */
|
|
@@ -1988,7 +2078,7 @@ export declare const enum KnownEntityCategory {
|
|
|
1988
2078
|
}
|
|
1989
2079
|
|
|
1990
2080
|
/** Known values of {@link EntityRecognitionSkillLanguage} that the service accepts. */
|
|
1991
|
-
export declare
|
|
2081
|
+
export declare enum KnownEntityRecognitionSkillLanguage {
|
|
1992
2082
|
/** Arabic */
|
|
1993
2083
|
Ar = "ar",
|
|
1994
2084
|
/** Czech */
|
|
@@ -2038,7 +2128,7 @@ export declare const enum KnownEntityRecognitionSkillLanguage {
|
|
|
2038
2128
|
}
|
|
2039
2129
|
|
|
2040
2130
|
/** Known values of {@link ImageAnalysisSkillLanguage} that the service accepts. */
|
|
2041
|
-
export declare
|
|
2131
|
+
export declare enum KnownImageAnalysisSkillLanguage {
|
|
2042
2132
|
/** English */
|
|
2043
2133
|
En = "en",
|
|
2044
2134
|
/** Spanish */
|
|
@@ -2052,15 +2142,29 @@ export declare const enum KnownImageAnalysisSkillLanguage {
|
|
|
2052
2142
|
}
|
|
2053
2143
|
|
|
2054
2144
|
/** Known values of {@link ImageDetail} that the service accepts. */
|
|
2055
|
-
export declare
|
|
2145
|
+
export declare enum KnownImageDetail {
|
|
2056
2146
|
/** Details recognized as celebrities. */
|
|
2057
2147
|
Celebrities = "celebrities",
|
|
2058
2148
|
/** Details recognized as landmarks. */
|
|
2059
2149
|
Landmarks = "landmarks"
|
|
2060
2150
|
}
|
|
2061
2151
|
|
|
2152
|
+
/** Known values of {@link IndexerExecutionStatusDetail} that the service accepts. */
|
|
2153
|
+
export declare enum KnownIndexerExecutionStatusDetail {
|
|
2154
|
+
/** Indicates that the reset that occurred was for a call to ResetDocs. */
|
|
2155
|
+
ResetDocs = "resetDocs"
|
|
2156
|
+
}
|
|
2157
|
+
|
|
2158
|
+
/** Known values of {@link IndexingMode} that the service accepts. */
|
|
2159
|
+
export declare enum KnownIndexingMode {
|
|
2160
|
+
/** The indexer is indexing all documents in the datasource. */
|
|
2161
|
+
IndexingAllDocs = "indexingAllDocs",
|
|
2162
|
+
/** The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status. */
|
|
2163
|
+
IndexingResetDocs = "indexingResetDocs"
|
|
2164
|
+
}
|
|
2165
|
+
|
|
2062
2166
|
/** Known values of {@link KeyPhraseExtractionSkillLanguage} that the service accepts. */
|
|
2063
|
-
export declare
|
|
2167
|
+
export declare enum KnownKeyPhraseExtractionSkillLanguage {
|
|
2064
2168
|
/** Danish */
|
|
2065
2169
|
Da = "da",
|
|
2066
2170
|
/** Dutch */
|
|
@@ -2096,7 +2200,7 @@ export declare const enum KnownKeyPhraseExtractionSkillLanguage {
|
|
|
2096
2200
|
}
|
|
2097
2201
|
|
|
2098
2202
|
/** Known values of {@link LexicalAnalyzerName} that the service accepts. */
|
|
2099
|
-
export declare
|
|
2203
|
+
export declare enum KnownLexicalAnalyzerName {
|
|
2100
2204
|
/** Microsoft analyzer for Arabic. */
|
|
2101
2205
|
ArMicrosoft = "ar.microsoft",
|
|
2102
2206
|
/** Lucene analyzer for Arabic. */
|
|
@@ -2286,7 +2390,7 @@ export declare const enum KnownLexicalAnalyzerName {
|
|
|
2286
2390
|
}
|
|
2287
2391
|
|
|
2288
2392
|
/** Known values of {@link LexicalNormalizerName} that the service accepts. */
|
|
2289
|
-
export declare
|
|
2393
|
+
export declare enum KnownLexicalNormalizerName {
|
|
2290
2394
|
/** Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html */
|
|
2291
2395
|
AsciiFolding = "asciifolding",
|
|
2292
2396
|
/** Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html */
|
|
@@ -2300,7 +2404,7 @@ export declare const enum KnownLexicalNormalizerName {
|
|
|
2300
2404
|
}
|
|
2301
2405
|
|
|
2302
2406
|
/** Known values of {@link LineEnding} that the service accepts. */
|
|
2303
|
-
export declare
|
|
2407
|
+
export declare enum KnownLineEnding {
|
|
2304
2408
|
/** Lines are separated by a single space character. */
|
|
2305
2409
|
Space = "space",
|
|
2306
2410
|
/** Lines are separated by a carriage return ('\r') character. */
|
|
@@ -2312,7 +2416,7 @@ export declare const enum KnownLineEnding {
|
|
|
2312
2416
|
}
|
|
2313
2417
|
|
|
2314
2418
|
/** Known values of {@link OcrSkillLanguage} that the service accepts. */
|
|
2315
|
-
export declare
|
|
2419
|
+
export declare enum KnownOcrSkillLanguage {
|
|
2316
2420
|
/** Chinese-Simplified */
|
|
2317
2421
|
ZhHans = "zh-Hans",
|
|
2318
2422
|
/** Chinese-Traditional */
|
|
@@ -2368,23 +2472,187 @@ export declare const enum KnownOcrSkillLanguage {
|
|
|
2368
2472
|
}
|
|
2369
2473
|
|
|
2370
2474
|
/** Known values of {@link PIIDetectionSkillMaskingMode} that the service accepts. */
|
|
2371
|
-
export declare
|
|
2475
|
+
export declare enum KnownPIIDetectionSkillMaskingMode {
|
|
2372
2476
|
/** No masking occurs and the maskedText output will not be returned. */
|
|
2373
2477
|
None = "none",
|
|
2374
2478
|
/** Replaces the detected entities with the character given in the maskingCharacter parameter. The character will be repeated to the length of the detected entity so that the offsets will correctly correspond to both the input text as well as the output maskedText. */
|
|
2375
2479
|
Replace = "replace"
|
|
2376
2480
|
}
|
|
2377
2481
|
|
|
2482
|
+
/** Known values of {@link QueryAnswerType} that the service accepts. */
|
|
2483
|
+
export declare enum KnownQueryAnswerType {
|
|
2484
|
+
/** Do not return answers for the query. */
|
|
2485
|
+
None = "none",
|
|
2486
|
+
/** Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. */
|
|
2487
|
+
Extractive = "extractive"
|
|
2488
|
+
}
|
|
2489
|
+
|
|
2490
|
+
/** Known values of {@link QueryCaptionType} that the service accepts. */
|
|
2491
|
+
export declare enum KnownQueryCaptionType {
|
|
2492
|
+
/** Do not return captions for the query. */
|
|
2493
|
+
None = "none",
|
|
2494
|
+
/** Extracts captions from the matching documents that contain passages relevant to the search query. */
|
|
2495
|
+
Extractive = "extractive"
|
|
2496
|
+
}
|
|
2497
|
+
|
|
2378
2498
|
/** Known values of {@link QueryLanguage} that the service accepts. */
|
|
2379
|
-
export declare
|
|
2499
|
+
export declare enum KnownQueryLanguage {
|
|
2380
2500
|
/** Query language not specified. */
|
|
2381
2501
|
None = "none",
|
|
2382
|
-
/** English */
|
|
2383
|
-
EnUs = "en-us"
|
|
2502
|
+
/** Query language value for English (United States). */
|
|
2503
|
+
EnUs = "en-us",
|
|
2504
|
+
/** Query language value for English (Great Britain). */
|
|
2505
|
+
EnGb = "en-gb",
|
|
2506
|
+
/** Query language value for English (India). */
|
|
2507
|
+
EnIn = "en-in",
|
|
2508
|
+
/** Query language value for English (Canada). */
|
|
2509
|
+
EnCa = "en-ca",
|
|
2510
|
+
/** Query language value for English (Australia). */
|
|
2511
|
+
EnAu = "en-au",
|
|
2512
|
+
/** Query language value for French (France). */
|
|
2513
|
+
FrFr = "fr-fr",
|
|
2514
|
+
/** Query language value for French (Canada). */
|
|
2515
|
+
FrCa = "fr-ca",
|
|
2516
|
+
/** Query language value for German (Germany). */
|
|
2517
|
+
DeDe = "de-de",
|
|
2518
|
+
/** Query language value for Spanish (Spain). */
|
|
2519
|
+
EsEs = "es-es",
|
|
2520
|
+
/** Query language value for Spanish (Mexico). */
|
|
2521
|
+
EsMx = "es-mx",
|
|
2522
|
+
/** Query language value for Chinese (China). */
|
|
2523
|
+
ZhCn = "zh-cn",
|
|
2524
|
+
/** Query language value for Chinese (Taiwan). */
|
|
2525
|
+
ZhTw = "zh-tw",
|
|
2526
|
+
/** Query language value for Portuguese (Brazil). */
|
|
2527
|
+
PtBr = "pt-br",
|
|
2528
|
+
/** Query language value for Portuguese (Portugal). */
|
|
2529
|
+
PtPt = "pt-pt",
|
|
2530
|
+
/** Query language value for Italian (Italy). */
|
|
2531
|
+
ItIt = "it-it",
|
|
2532
|
+
/** Query language value for Japanese (Japan). */
|
|
2533
|
+
JaJp = "ja-jp",
|
|
2534
|
+
/** Query language value for Korean (Korea). */
|
|
2535
|
+
KoKr = "ko-kr",
|
|
2536
|
+
/** Query language value for Russian (Russia). */
|
|
2537
|
+
RuRu = "ru-ru",
|
|
2538
|
+
/** Query language value for Czech (Czech Republic). */
|
|
2539
|
+
CsCz = "cs-cz",
|
|
2540
|
+
/** Query language value for Dutch (Belgium). */
|
|
2541
|
+
NlBe = "nl-be",
|
|
2542
|
+
/** Query language value for Dutch (Netherlands). */
|
|
2543
|
+
NlNl = "nl-nl",
|
|
2544
|
+
/** Query language value for Hungarian (Hungary). */
|
|
2545
|
+
HuHu = "hu-hu",
|
|
2546
|
+
/** Query language value for Polish (Poland). */
|
|
2547
|
+
PlPl = "pl-pl",
|
|
2548
|
+
/** Query language value for Swedish (Sweden). */
|
|
2549
|
+
SvSe = "sv-se",
|
|
2550
|
+
/** Query language value for Turkish (Turkey). */
|
|
2551
|
+
TrTr = "tr-tr",
|
|
2552
|
+
/** Query language value for Hindi (India). */
|
|
2553
|
+
HiIn = "hi-in",
|
|
2554
|
+
/** Query language value for Arabic (Saudi Arabia). */
|
|
2555
|
+
ArSa = "ar-sa",
|
|
2556
|
+
/** Query language value for Arabic (Egypt). */
|
|
2557
|
+
ArEg = "ar-eg",
|
|
2558
|
+
/** Query language value for Arabic (Morocco). */
|
|
2559
|
+
ArMa = "ar-ma",
|
|
2560
|
+
/** Query language value for Arabic (Kuwait). */
|
|
2561
|
+
ArKw = "ar-kw",
|
|
2562
|
+
/** Query language value for Arabic (Jordan). */
|
|
2563
|
+
ArJo = "ar-jo",
|
|
2564
|
+
/** Query language value for Danish (Denmark). */
|
|
2565
|
+
DaDk = "da-dk",
|
|
2566
|
+
/** Query language value for Norwegian (Normway). */
|
|
2567
|
+
NoNo = "no-no",
|
|
2568
|
+
/** Query language value for Bulgarian (Bulgary). */
|
|
2569
|
+
BgBg = "bg-bg",
|
|
2570
|
+
/** Query language value for Croatian (Croatia). */
|
|
2571
|
+
HrHr = "hr-hr",
|
|
2572
|
+
/** Query language value for Croatian (Bosnia and Herzegovina). */
|
|
2573
|
+
HrBa = "hr-ba",
|
|
2574
|
+
/** Query language value for Malay (Malaysia). */
|
|
2575
|
+
MsMy = "ms-my",
|
|
2576
|
+
/** Query language value for Malay (Brunei Darussalam). */
|
|
2577
|
+
MsBn = "ms-bn",
|
|
2578
|
+
/** Query language value for Slovenian (Slovenia). */
|
|
2579
|
+
SlSl = "sl-sl",
|
|
2580
|
+
/** Query language value for Tamil (India). */
|
|
2581
|
+
TaIn = "ta-in",
|
|
2582
|
+
/** Query language value for Vietnamese (Viet Nam). */
|
|
2583
|
+
ViVn = "vi-vn",
|
|
2584
|
+
/** Query language value for Greek (Greece). */
|
|
2585
|
+
ElGr = "el-gr",
|
|
2586
|
+
/** Query language value for Romanian (Romania). */
|
|
2587
|
+
RoRo = "ro-ro",
|
|
2588
|
+
/** Query language value for Icelandic (Iceland). */
|
|
2589
|
+
IsIs = "is-is",
|
|
2590
|
+
/** Query language value for Indonesian (Indonesia). */
|
|
2591
|
+
IdId = "id-id",
|
|
2592
|
+
/** Query language value for Thai (Thailand). */
|
|
2593
|
+
ThTh = "th-th",
|
|
2594
|
+
/** Query language value for Lithuanian (Lithuania). */
|
|
2595
|
+
LtLt = "lt-lt",
|
|
2596
|
+
/** Query language value for Ukrainian (Ukraine). */
|
|
2597
|
+
UkUa = "uk-ua",
|
|
2598
|
+
/** Query language value for Latvian (Latvia). */
|
|
2599
|
+
LvLv = "lv-lv",
|
|
2600
|
+
/** Query language value for Estonian (Estonia). */
|
|
2601
|
+
EtEe = "et-ee",
|
|
2602
|
+
/** Query language value for Catalan (Spain). */
|
|
2603
|
+
CaEs = "ca-es",
|
|
2604
|
+
/** Query language value for Finnish (Finland). */
|
|
2605
|
+
FiFi = "fi-fi",
|
|
2606
|
+
/** Query language value for Serbian (Bosnia and Herzegovina). */
|
|
2607
|
+
SrBa = "sr-ba",
|
|
2608
|
+
/** Query language value for Serbian (Montenegro). */
|
|
2609
|
+
SrMe = "sr-me",
|
|
2610
|
+
/** Query language value for Serbian (Serbia). */
|
|
2611
|
+
SrRs = "sr-rs",
|
|
2612
|
+
/** Query language value for Slovak (Slovakia). */
|
|
2613
|
+
SkSk = "sk-sk",
|
|
2614
|
+
/** Query language value for Norwegian (Norway). */
|
|
2615
|
+
NbNo = "nb-no",
|
|
2616
|
+
/** Query language value for Armenian (Armenia). */
|
|
2617
|
+
HyAm = "hy-am",
|
|
2618
|
+
/** Query language value for Bengali (India). */
|
|
2619
|
+
BnIn = "bn-in",
|
|
2620
|
+
/** Query language value for Basque (Spain). */
|
|
2621
|
+
EuEs = "eu-es",
|
|
2622
|
+
/** Query language value for Galician (Spain). */
|
|
2623
|
+
GlEs = "gl-es",
|
|
2624
|
+
/** Query language value for Gujarati (India). */
|
|
2625
|
+
GuIn = "gu-in",
|
|
2626
|
+
/** Query language value for Hebrew (Israel). */
|
|
2627
|
+
HeIl = "he-il",
|
|
2628
|
+
/** Query language value for Irish (Ireland). */
|
|
2629
|
+
GaIe = "ga-ie",
|
|
2630
|
+
/** Query language value for Kannada (India). */
|
|
2631
|
+
KnIn = "kn-in",
|
|
2632
|
+
/** Query language value for Malayalam (India). */
|
|
2633
|
+
MlIn = "ml-in",
|
|
2634
|
+
/** Query language value for Marathi (India). */
|
|
2635
|
+
MrIn = "mr-in",
|
|
2636
|
+
/** Query language value for Persian (U.A.E.). */
|
|
2637
|
+
FaAe = "fa-ae",
|
|
2638
|
+
/** Query language value for Punjabi (India). */
|
|
2639
|
+
PaIn = "pa-in",
|
|
2640
|
+
/** Query language value for Telugu (India). */
|
|
2641
|
+
TeIn = "te-in",
|
|
2642
|
+
/** Query language value for Urdu (Pakistan). */
|
|
2643
|
+
UrPk = "ur-pk"
|
|
2644
|
+
}
|
|
2645
|
+
|
|
2646
|
+
/** Known values of {@link QuerySpellerType} that the service accepts. */
|
|
2647
|
+
export declare enum KnownQuerySpellerType {
|
|
2648
|
+
/** Speller not enabled. */
|
|
2649
|
+
None = "none",
|
|
2650
|
+
/** Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. */
|
|
2651
|
+
Lexicon = "lexicon"
|
|
2384
2652
|
}
|
|
2385
2653
|
|
|
2386
2654
|
/** Known values of {@link RegexFlags} that the service accepts. */
|
|
2387
|
-
export declare
|
|
2655
|
+
export declare enum KnownRegexFlags {
|
|
2388
2656
|
/** Enables canonical equivalence. */
|
|
2389
2657
|
CanonEq = "CANON_EQ",
|
|
2390
2658
|
/** Enables case-insensitive matching. */
|
|
@@ -2404,7 +2672,7 @@ export declare const enum KnownRegexFlags {
|
|
|
2404
2672
|
}
|
|
2405
2673
|
|
|
2406
2674
|
/** Known values of {@link SearchIndexerDataSourceType} that the service accepts. */
|
|
2407
|
-
export declare
|
|
2675
|
+
export declare enum KnownSearchIndexerDataSourceType {
|
|
2408
2676
|
/** Indicates an Azure SQL datasource. */
|
|
2409
2677
|
AzureSql = "azuresql",
|
|
2410
2678
|
/** Indicates a CosmosDB datasource. */
|
|
@@ -2420,7 +2688,7 @@ export declare const enum KnownSearchIndexerDataSourceType {
|
|
|
2420
2688
|
}
|
|
2421
2689
|
|
|
2422
2690
|
/** Known values of {@link SentimentSkillLanguage} that the service accepts. */
|
|
2423
|
-
export declare
|
|
2691
|
+
export declare enum KnownSentimentSkillLanguage {
|
|
2424
2692
|
/** Danish */
|
|
2425
2693
|
Da = "da",
|
|
2426
2694
|
/** Dutch */
|
|
@@ -2454,7 +2722,7 @@ export declare const enum KnownSentimentSkillLanguage {
|
|
|
2454
2722
|
}
|
|
2455
2723
|
|
|
2456
2724
|
/** Known values of {@link Speller} that the service accepts. */
|
|
2457
|
-
export declare
|
|
2725
|
+
export declare enum KnownSpeller {
|
|
2458
2726
|
/** Speller not enabled. */
|
|
2459
2727
|
None = "none",
|
|
2460
2728
|
/** Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. */
|
|
@@ -2462,7 +2730,7 @@ export declare const enum KnownSpeller {
|
|
|
2462
2730
|
}
|
|
2463
2731
|
|
|
2464
2732
|
/** Known values of {@link SplitSkillLanguage} that the service accepts. */
|
|
2465
|
-
export declare
|
|
2733
|
+
export declare enum KnownSplitSkillLanguage {
|
|
2466
2734
|
/** Danish */
|
|
2467
2735
|
Da = "da",
|
|
2468
2736
|
/** German */
|
|
@@ -2484,7 +2752,7 @@ export declare const enum KnownSplitSkillLanguage {
|
|
|
2484
2752
|
}
|
|
2485
2753
|
|
|
2486
2754
|
/** Known values of {@link TextSplitMode} that the service accepts. */
|
|
2487
|
-
export declare
|
|
2755
|
+
export declare enum KnownTextSplitMode {
|
|
2488
2756
|
/** Split the text into individual pages. */
|
|
2489
2757
|
Pages = "pages",
|
|
2490
2758
|
/** Split the text into individual sentences. */
|
|
@@ -2492,7 +2760,7 @@ export declare const enum KnownTextSplitMode {
|
|
|
2492
2760
|
}
|
|
2493
2761
|
|
|
2494
2762
|
/** Known values of {@link TextTranslationSkillLanguage} that the service accepts. */
|
|
2495
|
-
export declare
|
|
2763
|
+
export declare enum KnownTextTranslationSkillLanguage {
|
|
2496
2764
|
/** Afrikaans */
|
|
2497
2765
|
Af = "af",
|
|
2498
2766
|
/** Arabic */
|
|
@@ -2640,7 +2908,7 @@ export declare const enum KnownTextTranslationSkillLanguage {
|
|
|
2640
2908
|
}
|
|
2641
2909
|
|
|
2642
2910
|
/** Known values of {@link TokenFilterName} that the service accepts. */
|
|
2643
|
-
export declare
|
|
2911
|
+
export declare enum KnownTokenFilterName {
|
|
2644
2912
|
/** 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 */
|
|
2645
2913
|
ArabicNormalization = "arabic_normalization",
|
|
2646
2914
|
/** 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 */
|
|
@@ -2966,7 +3234,7 @@ export declare enum KnownTokenizerNames {
|
|
|
2966
3234
|
}
|
|
2967
3235
|
|
|
2968
3236
|
/** Known values of {@link VisualFeature} that the service accepts. */
|
|
2969
|
-
export declare
|
|
3237
|
+
export declare enum KnownVisualFeature {
|
|
2970
3238
|
/** Visual features recognized as adult persons. */
|
|
2971
3239
|
Adult = "adult",
|
|
2972
3240
|
/** Visual features recognized as commercial brands. */
|
|
@@ -2988,9 +3256,9 @@ export declare type LanguageDetectionSkill = BaseSearchIndexerSkill & {
|
|
|
2988
3256
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
2989
3257
|
odatatype: "#Microsoft.Skills.Text.LanguageDetectionSkill";
|
|
2990
3258
|
/** A country code to use as a hint to the language detection model if it cannot disambiguate the language. */
|
|
2991
|
-
defaultCountryHint?: string
|
|
3259
|
+
defaultCountryHint?: string;
|
|
2992
3260
|
/** 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. */
|
|
2993
|
-
modelVersion?: string
|
|
3261
|
+
modelVersion?: string;
|
|
2994
3262
|
};
|
|
2995
3263
|
|
|
2996
3264
|
/** Removes words that are too long or too short. This token filter is implemented using Apache Lucene. */
|
|
@@ -3012,7 +3280,7 @@ export declare type LexicalAnalyzer = CustomAnalyzer | PatternAnalyzer | LuceneS
|
|
|
3012
3280
|
* Defines values for LexicalAnalyzerName. \
|
|
3013
3281
|
* {@link KnownLexicalAnalyzerName} can be used interchangeably with LexicalAnalyzerName,
|
|
3014
3282
|
* this enum contains the known values that the service supports.
|
|
3015
|
-
* ###
|
|
3283
|
+
* ### Known values supported by the service
|
|
3016
3284
|
* **ar.microsoft**: Microsoft analyzer for Arabic. \
|
|
3017
3285
|
* **ar.lucene**: Lucene analyzer for Arabic. \
|
|
3018
3286
|
* **hy.lucene**: Lucene analyzer for Armenian. \
|
|
@@ -3100,12 +3368,12 @@ export declare type LexicalAnalyzer = CustomAnalyzer | PatternAnalyzer | LuceneS
|
|
|
3100
3368
|
* **ur.microsoft**: Microsoft analyzer for Urdu. \
|
|
3101
3369
|
* **vi.microsoft**: Microsoft analyzer for Vietnamese. \
|
|
3102
3370
|
* **standard.lucene**: Standard Lucene analyzer. \
|
|
3103
|
-
* **standardasciifolding.lucene**: Standard ASCII Folding Lucene analyzer. See https
|
|
3104
|
-
* **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
|
|
3105
|
-
* **pattern**: Flexibly separates text into terms via a regular expression pattern. See http
|
|
3106
|
-
* **simple**: Divides text at non-letters and converts them to lower case. See http
|
|
3107
|
-
* **stop**: Divides text at non-letters; Applies the lowercase and stopword token filters. See http
|
|
3108
|
-
* **whitespace**: An analyzer that uses the whitespace tokenizer. See http
|
|
3371
|
+
* **standardasciifolding.lucene**: Standard ASCII Folding Lucene analyzer. See https:\/\/docs.microsoft.com\/rest\/api\/searchservice\/Custom-analyzers-in-Azure-Search#Analyzers \
|
|
3372
|
+
* **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 \
|
|
3373
|
+
* **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 \
|
|
3374
|
+
* **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 \
|
|
3375
|
+
* **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 \
|
|
3376
|
+
* **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
|
|
3109
3377
|
*/
|
|
3110
3378
|
export declare type LexicalAnalyzerName = string;
|
|
3111
3379
|
|
|
@@ -3118,12 +3386,12 @@ export declare type LexicalNormalizer = CustomNormalizer;
|
|
|
3118
3386
|
* Defines values for LexicalNormalizerName. \
|
|
3119
3387
|
* {@link KnownLexicalNormalizerName} can be used interchangeably with LexicalNormalizerName,
|
|
3120
3388
|
* this enum contains the known values that the service supports.
|
|
3121
|
-
* ###
|
|
3122
|
-
* **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
|
|
3123
|
-
* **elision**: Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http
|
|
3124
|
-
* **lowercase**: Normalizes token text to lowercase. See https
|
|
3125
|
-
* **standard**: Standard normalizer, which consists of lowercase and asciifolding. See http
|
|
3126
|
-
* **uppercase**: Normalizes token text to uppercase. See https
|
|
3389
|
+
* ### Known values supported by the service
|
|
3390
|
+
* **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 \
|
|
3391
|
+
* **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 \
|
|
3392
|
+
* **lowercase**: Normalizes token text to lowercase. See https:\/\/lucene.apache.org\/core\/6_6_1\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/LowerCaseFilter.html \
|
|
3393
|
+
* **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 \
|
|
3394
|
+
* **uppercase**: Normalizes token text to uppercase. See https:\/\/lucene.apache.org\/core\/6_6_1\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/UpperCaseFilter.html
|
|
3127
3395
|
*/
|
|
3128
3396
|
export declare type LexicalNormalizerName = string;
|
|
3129
3397
|
|
|
@@ -3146,7 +3414,7 @@ export declare type LimitTokenFilter = BaseTokenFilter & {
|
|
|
3146
3414
|
* Defines values for LineEnding. \
|
|
3147
3415
|
* {@link KnownLineEnding} can be used interchangeably with LineEnding,
|
|
3148
3416
|
* this enum contains the known values that the service supports.
|
|
3149
|
-
* ###
|
|
3417
|
+
* ### Known values supported by the service
|
|
3150
3418
|
* **space**: Lines are separated by a single space character. \
|
|
3151
3419
|
* **carriageReturn**: Lines are separated by a carriage return ('\r') character. \
|
|
3152
3420
|
* **lineFeed**: Lines are separated by a single line feed ('\n') character. \
|
|
@@ -3351,7 +3619,7 @@ export declare type OcrSkill = BaseSearchIndexerSkill & {
|
|
|
3351
3619
|
* Defines values for OcrSkillLanguage. \
|
|
3352
3620
|
* {@link KnownOcrSkillLanguage} can be used interchangeably with OcrSkillLanguage,
|
|
3353
3621
|
* this enum contains the known values that the service supports.
|
|
3354
|
-
* ###
|
|
3622
|
+
* ### Known values supported by the service
|
|
3355
3623
|
* **zh-Hans**: Chinese-Simplified \
|
|
3356
3624
|
* **zh-Hant**: Chinese-Traditional \
|
|
3357
3625
|
* **cs**: Czech \
|
|
@@ -3534,41 +3802,151 @@ export declare type PIIDetectionSkill = BaseSearchIndexerSkill & {
|
|
|
3534
3802
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
3535
3803
|
odatatype: "#Microsoft.Skills.Text.PIIDetectionSkill";
|
|
3536
3804
|
/** A value indicating which language code to use. Default is en. */
|
|
3537
|
-
defaultLanguageCode?: string
|
|
3805
|
+
defaultLanguageCode?: string;
|
|
3538
3806
|
/** 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. */
|
|
3539
|
-
minimumPrecision?: number
|
|
3807
|
+
minimumPrecision?: number;
|
|
3540
3808
|
/** A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'. */
|
|
3541
3809
|
maskingMode?: PIIDetectionSkillMaskingMode;
|
|
3542
3810
|
/** The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'. */
|
|
3543
|
-
maskingCharacter?: string
|
|
3811
|
+
maskingCharacter?: string;
|
|
3544
3812
|
/** 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. */
|
|
3545
|
-
modelVersion?: string
|
|
3813
|
+
modelVersion?: string;
|
|
3546
3814
|
/** A list of PII entity categories that should be extracted and masked. */
|
|
3547
3815
|
piiCategories?: string[];
|
|
3548
3816
|
/** If specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'phi', 'none'. Default is 'none'. */
|
|
3549
|
-
domain?: string
|
|
3817
|
+
domain?: string;
|
|
3550
3818
|
};
|
|
3551
3819
|
|
|
3552
3820
|
/**
|
|
3553
3821
|
* Defines values for PIIDetectionSkillMaskingMode. \
|
|
3554
3822
|
* {@link KnownPIIDetectionSkillMaskingMode} can be used interchangeably with PIIDetectionSkillMaskingMode,
|
|
3555
3823
|
* this enum contains the known values that the service supports.
|
|
3556
|
-
* ###
|
|
3824
|
+
* ### Known values supported by the service
|
|
3557
3825
|
* **none**: No masking occurs and the maskedText output will not be returned. \
|
|
3558
3826
|
* **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.
|
|
3559
3827
|
*/
|
|
3560
3828
|
export declare type PIIDetectionSkillMaskingMode = string;
|
|
3561
3829
|
|
|
3830
|
+
/** Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers. */
|
|
3831
|
+
export declare interface PrioritizedFields {
|
|
3832
|
+
/** 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. */
|
|
3833
|
+
titleField?: SemanticField;
|
|
3834
|
+
/** 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. */
|
|
3835
|
+
prioritizedContentFields?: SemanticField[];
|
|
3836
|
+
/** 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. */
|
|
3837
|
+
prioritizedKeywordsFields?: SemanticField[];
|
|
3838
|
+
}
|
|
3839
|
+
|
|
3840
|
+
/**
|
|
3841
|
+
* Defines values for QueryAnswerType. \
|
|
3842
|
+
* {@link KnownQueryAnswerType} can be used interchangeably with QueryAnswerType,
|
|
3843
|
+
* this enum contains the known values that the service supports.
|
|
3844
|
+
* ### Known values supported by the service
|
|
3845
|
+
* **none**: Do not return answers for the query. \
|
|
3846
|
+
* **extractive**: Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language.
|
|
3847
|
+
*/
|
|
3848
|
+
export declare type QueryAnswerType = string;
|
|
3849
|
+
|
|
3850
|
+
/**
|
|
3851
|
+
* Defines values for QueryCaptionType. \
|
|
3852
|
+
* {@link KnownQueryCaptionType} can be used interchangeably with QueryCaptionType,
|
|
3853
|
+
* this enum contains the known values that the service supports.
|
|
3854
|
+
* ### Known values supported by the service
|
|
3855
|
+
* **none**: Do not return captions for the query. \
|
|
3856
|
+
* **extractive**: Extracts captions from the matching documents that contain passages relevant to the search query.
|
|
3857
|
+
*/
|
|
3858
|
+
export declare type QueryCaptionType = string;
|
|
3859
|
+
|
|
3562
3860
|
/**
|
|
3563
3861
|
* Defines values for QueryLanguage. \
|
|
3564
3862
|
* {@link KnownQueryLanguage} can be used interchangeably with QueryLanguage,
|
|
3565
3863
|
* this enum contains the known values that the service supports.
|
|
3566
|
-
* ###
|
|
3864
|
+
* ### Known values supported by the service
|
|
3567
3865
|
* **none**: Query language not specified. \
|
|
3568
|
-
* **en-us**: English
|
|
3866
|
+
* **en-us**: Query language value for English (United States). \
|
|
3867
|
+
* **en-gb**: Query language value for English (Great Britain). \
|
|
3868
|
+
* **en-in**: Query language value for English (India). \
|
|
3869
|
+
* **en-ca**: Query language value for English (Canada). \
|
|
3870
|
+
* **en-au**: Query language value for English (Australia). \
|
|
3871
|
+
* **fr-fr**: Query language value for French (France). \
|
|
3872
|
+
* **fr-ca**: Query language value for French (Canada). \
|
|
3873
|
+
* **de-de**: Query language value for German (Germany). \
|
|
3874
|
+
* **es-es**: Query language value for Spanish (Spain). \
|
|
3875
|
+
* **es-mx**: Query language value for Spanish (Mexico). \
|
|
3876
|
+
* **zh-cn**: Query language value for Chinese (China). \
|
|
3877
|
+
* **zh-tw**: Query language value for Chinese (Taiwan). \
|
|
3878
|
+
* **pt-br**: Query language value for Portuguese (Brazil). \
|
|
3879
|
+
* **pt-pt**: Query language value for Portuguese (Portugal). \
|
|
3880
|
+
* **it-it**: Query language value for Italian (Italy). \
|
|
3881
|
+
* **ja-jp**: Query language value for Japanese (Japan). \
|
|
3882
|
+
* **ko-kr**: Query language value for Korean (Korea). \
|
|
3883
|
+
* **ru-ru**: Query language value for Russian (Russia). \
|
|
3884
|
+
* **cs-cz**: Query language value for Czech (Czech Republic). \
|
|
3885
|
+
* **nl-be**: Query language value for Dutch (Belgium). \
|
|
3886
|
+
* **nl-nl**: Query language value for Dutch (Netherlands). \
|
|
3887
|
+
* **hu-hu**: Query language value for Hungarian (Hungary). \
|
|
3888
|
+
* **pl-pl**: Query language value for Polish (Poland). \
|
|
3889
|
+
* **sv-se**: Query language value for Swedish (Sweden). \
|
|
3890
|
+
* **tr-tr**: Query language value for Turkish (Turkey). \
|
|
3891
|
+
* **hi-in**: Query language value for Hindi (India). \
|
|
3892
|
+
* **ar-sa**: Query language value for Arabic (Saudi Arabia). \
|
|
3893
|
+
* **ar-eg**: Query language value for Arabic (Egypt). \
|
|
3894
|
+
* **ar-ma**: Query language value for Arabic (Morocco). \
|
|
3895
|
+
* **ar-kw**: Query language value for Arabic (Kuwait). \
|
|
3896
|
+
* **ar-jo**: Query language value for Arabic (Jordan). \
|
|
3897
|
+
* **da-dk**: Query language value for Danish (Denmark). \
|
|
3898
|
+
* **no-no**: Query language value for Norwegian (Normway). \
|
|
3899
|
+
* **bg-bg**: Query language value for Bulgarian (Bulgary). \
|
|
3900
|
+
* **hr-hr**: Query language value for Croatian (Croatia). \
|
|
3901
|
+
* **hr-ba**: Query language value for Croatian (Bosnia and Herzegovina). \
|
|
3902
|
+
* **ms-my**: Query language value for Malay (Malaysia). \
|
|
3903
|
+
* **ms-bn**: Query language value for Malay (Brunei Darussalam). \
|
|
3904
|
+
* **sl-sl**: Query language value for Slovenian (Slovenia). \
|
|
3905
|
+
* **ta-in**: Query language value for Tamil (India). \
|
|
3906
|
+
* **vi-vn**: Query language value for Vietnamese (Viet Nam). \
|
|
3907
|
+
* **el-gr**: Query language value for Greek (Greece). \
|
|
3908
|
+
* **ro-ro**: Query language value for Romanian (Romania). \
|
|
3909
|
+
* **is-is**: Query language value for Icelandic (Iceland). \
|
|
3910
|
+
* **id-id**: Query language value for Indonesian (Indonesia). \
|
|
3911
|
+
* **th-th**: Query language value for Thai (Thailand). \
|
|
3912
|
+
* **lt-lt**: Query language value for Lithuanian (Lithuania). \
|
|
3913
|
+
* **uk-ua**: Query language value for Ukrainian (Ukraine). \
|
|
3914
|
+
* **lv-lv**: Query language value for Latvian (Latvia). \
|
|
3915
|
+
* **et-ee**: Query language value for Estonian (Estonia). \
|
|
3916
|
+
* **ca-es**: Query language value for Catalan (Spain). \
|
|
3917
|
+
* **fi-fi**: Query language value for Finnish (Finland). \
|
|
3918
|
+
* **sr-ba**: Query language value for Serbian (Bosnia and Herzegovina). \
|
|
3919
|
+
* **sr-me**: Query language value for Serbian (Montenegro). \
|
|
3920
|
+
* **sr-rs**: Query language value for Serbian (Serbia). \
|
|
3921
|
+
* **sk-sk**: Query language value for Slovak (Slovakia). \
|
|
3922
|
+
* **nb-no**: Query language value for Norwegian (Norway). \
|
|
3923
|
+
* **hy-am**: Query language value for Armenian (Armenia). \
|
|
3924
|
+
* **bn-in**: Query language value for Bengali (India). \
|
|
3925
|
+
* **eu-es**: Query language value for Basque (Spain). \
|
|
3926
|
+
* **gl-es**: Query language value for Galician (Spain). \
|
|
3927
|
+
* **gu-in**: Query language value for Gujarati (India). \
|
|
3928
|
+
* **he-il**: Query language value for Hebrew (Israel). \
|
|
3929
|
+
* **ga-ie**: Query language value for Irish (Ireland). \
|
|
3930
|
+
* **kn-in**: Query language value for Kannada (India). \
|
|
3931
|
+
* **ml-in**: Query language value for Malayalam (India). \
|
|
3932
|
+
* **mr-in**: Query language value for Marathi (India). \
|
|
3933
|
+
* **fa-ae**: Query language value for Persian (U.A.E.). \
|
|
3934
|
+
* **pa-in**: Query language value for Punjabi (India). \
|
|
3935
|
+
* **te-in**: Query language value for Telugu (India). \
|
|
3936
|
+
* **ur-pk**: Query language value for Urdu (Pakistan).
|
|
3569
3937
|
*/
|
|
3570
3938
|
export declare type QueryLanguage = string;
|
|
3571
3939
|
|
|
3940
|
+
/**
|
|
3941
|
+
* Defines values for QuerySpellerType. \
|
|
3942
|
+
* {@link KnownQuerySpellerType} can be used interchangeably with QuerySpellerType,
|
|
3943
|
+
* this enum contains the known values that the service supports.
|
|
3944
|
+
* ### Known values supported by the service
|
|
3945
|
+
* **none**: Speller not enabled. \
|
|
3946
|
+
* **lexicon**: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter.
|
|
3947
|
+
*/
|
|
3948
|
+
export declare type QuerySpellerType = string;
|
|
3949
|
+
|
|
3572
3950
|
/** Defines values for QueryType. */
|
|
3573
3951
|
export declare type QueryType = "simple" | "full" | "semantic";
|
|
3574
3952
|
|
|
@@ -3576,7 +3954,7 @@ export declare type QueryType = "simple" | "full" | "semantic";
|
|
|
3576
3954
|
* Defines values for RegexFlags. \
|
|
3577
3955
|
* {@link KnownRegexFlags} can be used interchangeably with RegexFlags,
|
|
3578
3956
|
* this enum contains the known values that the service supports.
|
|
3579
|
-
* ###
|
|
3957
|
+
* ### Known values supported by the service
|
|
3580
3958
|
* **CANON_EQ**: Enables canonical equivalence. \
|
|
3581
3959
|
* **CASE_INSENSITIVE**: Enables case-insensitive matching. \
|
|
3582
3960
|
* **COMMENTS**: Permits whitespace and comments in the pattern. \
|
|
@@ -3588,17 +3966,37 @@ export declare type QueryType = "simple" | "full" | "semantic";
|
|
|
3588
3966
|
*/
|
|
3589
3967
|
export declare type RegexFlags = string;
|
|
3590
3968
|
|
|
3969
|
+
/**
|
|
3970
|
+
* Options for reset docs operation.
|
|
3971
|
+
*/
|
|
3972
|
+
export declare interface ResetDocumentsOptions extends OperationOptions {
|
|
3973
|
+
/** document keys to be reset */
|
|
3974
|
+
documentKeys?: string[];
|
|
3975
|
+
/** datasource document identifiers to be reset */
|
|
3976
|
+
datasourceDocumentIds?: string[];
|
|
3977
|
+
/** 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. */
|
|
3978
|
+
overwrite?: boolean;
|
|
3979
|
+
}
|
|
3980
|
+
|
|
3591
3981
|
/**
|
|
3592
3982
|
* Options for reset indexer operation.
|
|
3593
3983
|
*/
|
|
3594
3984
|
export declare type ResetIndexerOptions = OperationOptions;
|
|
3595
3985
|
|
|
3986
|
+
/**
|
|
3987
|
+
* Options for reset skills operation.
|
|
3988
|
+
*/
|
|
3989
|
+
export declare interface ResetSkillsOptions extends OperationOptions {
|
|
3990
|
+
/** the names of skills to be reset. */
|
|
3991
|
+
skillNames?: string[];
|
|
3992
|
+
}
|
|
3993
|
+
|
|
3596
3994
|
/** Represents a resource's usage and quota. */
|
|
3597
3995
|
export declare interface ResourceCounter {
|
|
3598
3996
|
/** The resource usage amount. */
|
|
3599
3997
|
usage: number;
|
|
3600
3998
|
/** The resource amount quota. */
|
|
3601
|
-
quota?: number
|
|
3999
|
+
quota?: number;
|
|
3602
4000
|
}
|
|
3603
4001
|
|
|
3604
4002
|
/**
|
|
@@ -3719,7 +4117,7 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
|
|
|
3719
4117
|
* @param key - The primary key value of the document
|
|
3720
4118
|
* @param options - Additional options
|
|
3721
4119
|
*/
|
|
3722
|
-
getDocument<Fields extends keyof T
|
|
4120
|
+
getDocument<Fields extends Extract<keyof T, string>>(key: string, options?: GetDocumentOptions<Fields>): Promise<T>;
|
|
3723
4121
|
/**
|
|
3724
4122
|
* Perform a set of index modifications (upload, merge, mergeOrUpload, delete)
|
|
3725
4123
|
* for the given set of documents.
|
|
@@ -3769,13 +4167,14 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
|
|
|
3769
4167
|
private extractOperationOptions;
|
|
3770
4168
|
private convertSelect;
|
|
3771
4169
|
private convertSearchFields;
|
|
4170
|
+
private convertSemanticFields;
|
|
3772
4171
|
private convertOrderBy;
|
|
3773
4172
|
}
|
|
3774
4173
|
|
|
3775
4174
|
/**
|
|
3776
4175
|
* Client options used to configure Cognitive Search API requests.
|
|
3777
4176
|
*/
|
|
3778
|
-
export declare interface SearchClientOptions extends
|
|
4177
|
+
export declare interface SearchClientOptions extends CommonClientOptions {
|
|
3779
4178
|
/**
|
|
3780
4179
|
* The API version to use when communicating with the service.
|
|
3781
4180
|
*/
|
|
@@ -3840,7 +4239,7 @@ export declare interface SearchDocumentsResultBase {
|
|
|
3840
4239
|
* not specified or set to 'none'.
|
|
3841
4240
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
3842
4241
|
*/
|
|
3843
|
-
readonly answers?: AnswerResult[]
|
|
4242
|
+
readonly answers?: AnswerResult[];
|
|
3844
4243
|
}
|
|
3845
4244
|
|
|
3846
4245
|
/**
|
|
@@ -3885,7 +4284,7 @@ export declare interface SearchIndex {
|
|
|
3885
4284
|
/**
|
|
3886
4285
|
* Options to control Cross-Origin Resource Sharing (CORS) for the index.
|
|
3887
4286
|
*/
|
|
3888
|
-
corsOptions?: CorsOptions
|
|
4287
|
+
corsOptions?: CorsOptions;
|
|
3889
4288
|
/**
|
|
3890
4289
|
* The suggesters for the index.
|
|
3891
4290
|
*/
|
|
@@ -3920,13 +4319,17 @@ export declare interface SearchIndex {
|
|
|
3920
4319
|
* keys is not available for free search services, and is only available for paid services
|
|
3921
4320
|
* created on or after January 1, 2019.
|
|
3922
4321
|
*/
|
|
3923
|
-
encryptionKey?: SearchResourceEncryptionKey
|
|
4322
|
+
encryptionKey?: SearchResourceEncryptionKey;
|
|
3924
4323
|
/**
|
|
3925
4324
|
* The type of similarity algorithm to be used when scoring and ranking the documents matching a
|
|
3926
4325
|
* search query. The similarity algorithm can only be defined at index creation time and cannot
|
|
3927
4326
|
* be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.
|
|
3928
4327
|
*/
|
|
3929
4328
|
similarity?: SimilarityAlgorithm;
|
|
4329
|
+
/**
|
|
4330
|
+
* Defines parameters for a search index that influence semantic capabilities.
|
|
4331
|
+
*/
|
|
4332
|
+
semanticSettings?: SemanticSettings;
|
|
3930
4333
|
/**
|
|
3931
4334
|
* The ETag of the index.
|
|
3932
4335
|
*/
|
|
@@ -4075,7 +4478,7 @@ export declare class SearchIndexClient {
|
|
|
4075
4478
|
/**
|
|
4076
4479
|
* Client options used to configure Cognitive Search API requests.
|
|
4077
4480
|
*/
|
|
4078
|
-
export declare interface SearchIndexClientOptions extends
|
|
4481
|
+
export declare interface SearchIndexClientOptions extends CommonClientOptions {
|
|
4079
4482
|
/**
|
|
4080
4483
|
* The API version to use when communicating with the service.
|
|
4081
4484
|
*/
|
|
@@ -4109,11 +4512,11 @@ export declare interface SearchIndexer {
|
|
|
4109
4512
|
/**
|
|
4110
4513
|
* The schedule for this indexer.
|
|
4111
4514
|
*/
|
|
4112
|
-
schedule?: IndexingSchedule
|
|
4515
|
+
schedule?: IndexingSchedule;
|
|
4113
4516
|
/**
|
|
4114
4517
|
* Parameters for indexer execution.
|
|
4115
4518
|
*/
|
|
4116
|
-
parameters?: IndexingParameters
|
|
4519
|
+
parameters?: IndexingParameters;
|
|
4117
4520
|
/**
|
|
4118
4521
|
* Defines mappings between fields in the data source and corresponding target fields in the
|
|
4119
4522
|
* index.
|
|
@@ -4126,7 +4529,7 @@ export declare interface SearchIndexer {
|
|
|
4126
4529
|
/**
|
|
4127
4530
|
* A value indicating whether the indexer is disabled. Default is false. Default value: false.
|
|
4128
4531
|
*/
|
|
4129
|
-
isDisabled?: boolean
|
|
4532
|
+
isDisabled?: boolean;
|
|
4130
4533
|
/**
|
|
4131
4534
|
* The ETag of the indexer.
|
|
4132
4535
|
*/
|
|
@@ -4142,7 +4545,19 @@ export declare interface SearchIndexer {
|
|
|
4142
4545
|
* customer-managed keys is not available for free search services, and is only available for
|
|
4143
4546
|
* paid services created on or after January 1, 2019.
|
|
4144
4547
|
*/
|
|
4145
|
-
encryptionKey?: SearchResourceEncryptionKey
|
|
4548
|
+
encryptionKey?: SearchResourceEncryptionKey;
|
|
4549
|
+
/**
|
|
4550
|
+
* Adds caching to an enrichment pipeline to allow for incremental modification steps without
|
|
4551
|
+
* having to rebuild the index every time.
|
|
4552
|
+
*/
|
|
4553
|
+
cache?: SearchIndexerCache;
|
|
4554
|
+
}
|
|
4555
|
+
|
|
4556
|
+
export declare interface SearchIndexerCache {
|
|
4557
|
+
/** The connection string to the storage account where the cache data will be persisted. */
|
|
4558
|
+
storageConnectionString?: string;
|
|
4559
|
+
/** Specifies whether incremental reprocessing is enabled. */
|
|
4560
|
+
enableReprocessing?: boolean;
|
|
4146
4561
|
}
|
|
4147
4562
|
|
|
4148
4563
|
/**
|
|
@@ -4297,12 +4712,25 @@ export declare class SearchIndexerClient {
|
|
|
4297
4712
|
* @param options - Additional optional arguments.
|
|
4298
4713
|
*/
|
|
4299
4714
|
runIndexer(indexerName: string, options?: RunIndexerOptions): Promise<void>;
|
|
4715
|
+
/**
|
|
4716
|
+
* Resets specific documents in the datasource to be selectively re-ingested by the indexer.
|
|
4717
|
+
* @param indexerName - The name of the indexer to reset documents for.
|
|
4718
|
+
* @param options - Additional optional arguments.
|
|
4719
|
+
*/
|
|
4720
|
+
resetDocuments(indexerName: string, options?: ResetDocumentsOptions): Promise<void>;
|
|
4721
|
+
/**
|
|
4722
|
+
* Reset an existing skillset in a search service.
|
|
4723
|
+
* @param skillsetName - The name of the skillset to reset.
|
|
4724
|
+
* @param skillNames - The names of skills to reset.
|
|
4725
|
+
* @param options - The options parameters.
|
|
4726
|
+
*/
|
|
4727
|
+
resetSkills(skillsetName: string, options?: ResetSkillsOptions): Promise<void>;
|
|
4300
4728
|
}
|
|
4301
4729
|
|
|
4302
4730
|
/**
|
|
4303
4731
|
* Client options used to configure Cognitive Search API requests.
|
|
4304
4732
|
*/
|
|
4305
|
-
export declare interface SearchIndexerClientOptions extends
|
|
4733
|
+
export declare interface SearchIndexerClientOptions extends CommonClientOptions {
|
|
4306
4734
|
/**
|
|
4307
4735
|
* The API version to use when communicating with the service.
|
|
4308
4736
|
*/
|
|
@@ -4358,15 +4786,15 @@ export declare interface SearchIndexerDataSourceConnection {
|
|
|
4358
4786
|
* string is a managed identity, the system-assigned managed identity is used. If not specified,
|
|
4359
4787
|
* the value remains unchanged. If "none" is specified, the value of this property is cleared.
|
|
4360
4788
|
*/
|
|
4361
|
-
identity?: SearchIndexerDataIdentity
|
|
4789
|
+
identity?: SearchIndexerDataIdentity;
|
|
4362
4790
|
/**
|
|
4363
4791
|
* The data change detection policy for the datasource.
|
|
4364
4792
|
*/
|
|
4365
|
-
dataChangeDetectionPolicy?: DataChangeDetectionPolicy
|
|
4793
|
+
dataChangeDetectionPolicy?: DataChangeDetectionPolicy;
|
|
4366
4794
|
/**
|
|
4367
4795
|
* The data deletion detection policy for the datasource.
|
|
4368
4796
|
*/
|
|
4369
|
-
dataDeletionDetectionPolicy?: DataDeletionDetectionPolicy
|
|
4797
|
+
dataDeletionDetectionPolicy?: DataDeletionDetectionPolicy;
|
|
4370
4798
|
/**
|
|
4371
4799
|
* The ETag of the DataSource.
|
|
4372
4800
|
*/
|
|
@@ -4382,14 +4810,14 @@ export declare interface SearchIndexerDataSourceConnection {
|
|
|
4382
4810
|
* available for free search services, and is only available for paid services created on or
|
|
4383
4811
|
* after January 1, 2019.
|
|
4384
4812
|
*/
|
|
4385
|
-
encryptionKey?: SearchResourceEncryptionKey
|
|
4813
|
+
encryptionKey?: SearchResourceEncryptionKey;
|
|
4386
4814
|
}
|
|
4387
4815
|
|
|
4388
4816
|
/**
|
|
4389
4817
|
* Defines values for SearchIndexerDataSourceType. \
|
|
4390
4818
|
* {@link KnownSearchIndexerDataSourceType} can be used interchangeably with SearchIndexerDataSourceType,
|
|
4391
4819
|
* this enum contains the known values that the service supports.
|
|
4392
|
-
* ###
|
|
4820
|
+
* ### Known values supported by the service
|
|
4393
4821
|
* **azuresql**: Indicates an Azure SQL datasource. \
|
|
4394
4822
|
* **cosmosdb**: Indicates a CosmosDB datasource. \
|
|
4395
4823
|
* **azureblob**: Indicates an Azure Blob datasource. \
|
|
@@ -4552,7 +4980,7 @@ export declare interface SearchIndexerSkillset {
|
|
|
4552
4980
|
* definition will be unaffected. Encryption with customer-managed keys is not available for free
|
|
4553
4981
|
* search services, and is only available for paid services created on or after January 1, 2019.
|
|
4554
4982
|
*/
|
|
4555
|
-
encryptionKey?: SearchResourceEncryptionKey
|
|
4983
|
+
encryptionKey?: SearchResourceEncryptionKey;
|
|
4556
4984
|
}
|
|
4557
4985
|
|
|
4558
4986
|
/** Represents the current status and execution history of an indexer. */
|
|
@@ -4947,6 +5375,11 @@ export declare interface SearchRequest {
|
|
|
4947
5375
|
* the results.
|
|
4948
5376
|
*/
|
|
4949
5377
|
scoringProfile?: string;
|
|
5378
|
+
/**
|
|
5379
|
+
* The name of a semantic configuration that will be used when processing documents for queries of
|
|
5380
|
+
* type semantic.
|
|
5381
|
+
*/
|
|
5382
|
+
semanticConfiguration?: string;
|
|
4950
5383
|
/**
|
|
4951
5384
|
* A full-text search query expression; Use "*" or omit this parameter to match all documents.
|
|
4952
5385
|
*/
|
|
@@ -4970,11 +5403,11 @@ export declare interface SearchRequest {
|
|
|
4970
5403
|
* A value that specified the type of the speller to use to spell-correct individual search
|
|
4971
5404
|
* query terms.
|
|
4972
5405
|
*/
|
|
4973
|
-
speller?:
|
|
5406
|
+
speller?: QuerySpellerType;
|
|
4974
5407
|
/**
|
|
4975
5408
|
* A value that specifies whether answers should be returned as part of the search response.
|
|
4976
5409
|
*/
|
|
4977
|
-
answers?:
|
|
5410
|
+
answers?: QueryAnswerType;
|
|
4978
5411
|
/**
|
|
4979
5412
|
* The comma-separated list of fields to retrieve. If unspecified, all fields marked as
|
|
4980
5413
|
* retrievable in the schema are included.
|
|
@@ -4993,9 +5426,13 @@ export declare interface SearchRequest {
|
|
|
4993
5426
|
* Search request for the next page of results.
|
|
4994
5427
|
*/
|
|
4995
5428
|
top?: number;
|
|
4996
|
-
/**
|
|
4997
|
-
|
|
4998
|
-
|
|
5429
|
+
/**
|
|
5430
|
+
* A value that specifies whether captions should be returned as part of the search response.
|
|
5431
|
+
*/
|
|
5432
|
+
captions?: QueryCaptionType;
|
|
5433
|
+
/**
|
|
5434
|
+
* The comma-separated list of field names used for semantic search.
|
|
5435
|
+
*/
|
|
4999
5436
|
semanticFields?: string;
|
|
5000
5437
|
}
|
|
5001
5438
|
|
|
@@ -5123,6 +5560,17 @@ export declare interface SearchRequestOptions<Fields> {
|
|
|
5123
5560
|
* Search request for the next page of results.
|
|
5124
5561
|
*/
|
|
5125
5562
|
top?: number;
|
|
5563
|
+
/**
|
|
5564
|
+
* This parameter is only valid if the query type is 'semantic'. If set, the query returns captions
|
|
5565
|
+
* extracted from key passages in the highest ranked documents. When Captions is set to 'extractive',
|
|
5566
|
+
* highlighting is enabled by default, and can be configured by appending the pipe character '|'
|
|
5567
|
+
* followed by the 'highlight-true'/'highlight-false' option, such as 'extractive|highlight-true'. Defaults to 'None'.
|
|
5568
|
+
*/
|
|
5569
|
+
captions?: Captions;
|
|
5570
|
+
/**
|
|
5571
|
+
* The list of field names used for semantic search.
|
|
5572
|
+
*/
|
|
5573
|
+
semanticFields?: string[];
|
|
5126
5574
|
}
|
|
5127
5575
|
|
|
5128
5576
|
/**
|
|
@@ -5161,7 +5609,7 @@ export declare interface SearchResourceEncryptionKey {
|
|
|
5161
5609
|
* resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified,
|
|
5162
5610
|
* the value of this property is cleared.
|
|
5163
5611
|
*/
|
|
5164
|
-
identity?: SearchIndexerDataIdentity
|
|
5612
|
+
identity?: SearchIndexerDataIdentity;
|
|
5165
5613
|
}
|
|
5166
5614
|
|
|
5167
5615
|
/**
|
|
@@ -5190,7 +5638,7 @@ export declare type SearchResult<T> = {
|
|
|
5190
5638
|
* 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'.
|
|
5191
5639
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
5192
5640
|
*/
|
|
5193
|
-
readonly captions?: CaptionResult[]
|
|
5641
|
+
readonly captions?: CaptionResult[];
|
|
5194
5642
|
document: T;
|
|
5195
5643
|
};
|
|
5196
5644
|
|
|
@@ -5219,6 +5667,25 @@ export declare interface SearchSuggester {
|
|
|
5219
5667
|
sourceFields: string[];
|
|
5220
5668
|
}
|
|
5221
5669
|
|
|
5670
|
+
/** Defines a specific configuration to be used in the context of semantic capabilities. */
|
|
5671
|
+
export declare interface SemanticConfiguration {
|
|
5672
|
+
/** The name of the semantic configuration. */
|
|
5673
|
+
name: string;
|
|
5674
|
+
/** 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. */
|
|
5675
|
+
prioritizedFields: PrioritizedFields;
|
|
5676
|
+
}
|
|
5677
|
+
|
|
5678
|
+
/** A field that is used as part of the semantic configuration. */
|
|
5679
|
+
export declare interface SemanticField {
|
|
5680
|
+
name?: string;
|
|
5681
|
+
}
|
|
5682
|
+
|
|
5683
|
+
/** Defines parameters for a search index that influence semantic capabilities. */
|
|
5684
|
+
export declare interface SemanticSettings {
|
|
5685
|
+
/** The semantic configurations for the index. */
|
|
5686
|
+
configurations?: SemanticConfiguration[];
|
|
5687
|
+
}
|
|
5688
|
+
|
|
5222
5689
|
/** Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1. */
|
|
5223
5690
|
export declare type SentimentSkill = BaseSearchIndexerSkill & {
|
|
5224
5691
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -5231,7 +5698,7 @@ export declare type SentimentSkill = BaseSearchIndexerSkill & {
|
|
|
5231
5698
|
* Defines values for SentimentSkillLanguage. \
|
|
5232
5699
|
* {@link KnownSentimentSkillLanguage} can be used interchangeably with SentimentSkillLanguage,
|
|
5233
5700
|
* this enum contains the known values that the service supports.
|
|
5234
|
-
* ###
|
|
5701
|
+
* ### Known values supported by the service
|
|
5235
5702
|
* **da**: Danish \
|
|
5236
5703
|
* **nl**: Dutch \
|
|
5237
5704
|
* **en**: English \
|
|
@@ -5255,11 +5722,11 @@ export declare type SentimentSkillV3 = BaseSearchIndexerSkill & {
|
|
|
5255
5722
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
5256
5723
|
odatatype: "#Microsoft.Skills.Text.V3.SentimentSkill";
|
|
5257
5724
|
/** A value indicating which language code to use. Default is en. */
|
|
5258
|
-
defaultLanguageCode?: string
|
|
5725
|
+
defaultLanguageCode?: string;
|
|
5259
5726
|
/** 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. */
|
|
5260
5727
|
includeOpinionMining?: boolean;
|
|
5261
5728
|
/** 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. */
|
|
5262
|
-
modelVersion?: string
|
|
5729
|
+
modelVersion?: string;
|
|
5263
5730
|
};
|
|
5264
5731
|
|
|
5265
5732
|
/** Represents service-level resource counters and quotas. */
|
|
@@ -5283,13 +5750,13 @@ export declare interface ServiceCounters {
|
|
|
5283
5750
|
/** Represents various service level limits. */
|
|
5284
5751
|
export declare interface ServiceLimits {
|
|
5285
5752
|
/** The maximum allowed fields per index. */
|
|
5286
|
-
maxFieldsPerIndex?: number
|
|
5753
|
+
maxFieldsPerIndex?: number;
|
|
5287
5754
|
/** 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. */
|
|
5288
|
-
maxFieldNestingDepthPerIndex?: number
|
|
5755
|
+
maxFieldNestingDepthPerIndex?: number;
|
|
5289
5756
|
/** The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index. */
|
|
5290
|
-
maxComplexCollectionFieldsPerIndex?: number
|
|
5757
|
+
maxComplexCollectionFieldsPerIndex?: number;
|
|
5291
5758
|
/** The maximum number of objects in complex collections allowed per document. */
|
|
5292
|
-
maxComplexObjectsInCollectionsPerDocument?: number
|
|
5759
|
+
maxComplexObjectsInCollectionsPerDocument?: number;
|
|
5293
5760
|
}
|
|
5294
5761
|
|
|
5295
5762
|
/** A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields). */
|
|
@@ -5459,7 +5926,7 @@ export declare type SoftDeleteColumnDeletionDetectionPolicy = BaseDataDeletionDe
|
|
|
5459
5926
|
* Defines values for Speller. \
|
|
5460
5927
|
* {@link KnownSpeller} can be used interchangeably with Speller,
|
|
5461
5928
|
* this enum contains the known values that the service supports.
|
|
5462
|
-
* ###
|
|
5929
|
+
* ### Known values supported by the service
|
|
5463
5930
|
* **none**: Speller not enabled. \
|
|
5464
5931
|
* **lexicon**: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter.
|
|
5465
5932
|
*/
|
|
@@ -5474,14 +5941,14 @@ export declare type SplitSkill = BaseSearchIndexerSkill & {
|
|
|
5474
5941
|
/** A value indicating which split mode to perform. */
|
|
5475
5942
|
textSplitMode?: TextSplitMode;
|
|
5476
5943
|
/** The desired maximum page length. Default is 10000. */
|
|
5477
|
-
maxPageLength?: number
|
|
5944
|
+
maxPageLength?: number;
|
|
5478
5945
|
};
|
|
5479
5946
|
|
|
5480
5947
|
/**
|
|
5481
5948
|
* Defines values for SplitSkillLanguage. \
|
|
5482
5949
|
* {@link KnownSplitSkillLanguage} can be used interchangeably with SplitSkillLanguage,
|
|
5483
5950
|
* this enum contains the known values that the service supports.
|
|
5484
|
-
* ###
|
|
5951
|
+
* ### Known values supported by the service
|
|
5485
5952
|
* **da**: Danish \
|
|
5486
5953
|
* **de**: German \
|
|
5487
5954
|
* **en**: English \
|
|
@@ -5659,7 +6126,7 @@ export declare interface SynonymMap {
|
|
|
5659
6126
|
* keys is not available for free search services, and is only available for paid services
|
|
5660
6127
|
* created on or after January 1, 2019.
|
|
5661
6128
|
*/
|
|
5662
|
-
encryptionKey?: SearchResourceEncryptionKey
|
|
6129
|
+
encryptionKey?: SearchResourceEncryptionKey;
|
|
5663
6130
|
/**
|
|
5664
6131
|
* The ETag of the synonym map.
|
|
5665
6132
|
*/
|
|
@@ -5696,7 +6163,7 @@ export declare interface TagScoringParameters {
|
|
|
5696
6163
|
* Defines values for TextSplitMode. \
|
|
5697
6164
|
* {@link KnownTextSplitMode} can be used interchangeably with TextSplitMode,
|
|
5698
6165
|
* this enum contains the known values that the service supports.
|
|
5699
|
-
* ###
|
|
6166
|
+
* ### Known values supported by the service
|
|
5700
6167
|
* **pages**: Split the text into individual pages. \
|
|
5701
6168
|
* **sentences**: Split the text into individual sentences.
|
|
5702
6169
|
*/
|
|
@@ -5711,14 +6178,14 @@ export declare type TextTranslationSkill = BaseSearchIndexerSkill & {
|
|
|
5711
6178
|
/** The language code to translate documents from for documents that don't specify the from language explicitly. */
|
|
5712
6179
|
defaultFromLanguageCode?: TextTranslationSkillLanguage;
|
|
5713
6180
|
/** 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. */
|
|
5714
|
-
suggestedFrom?: TextTranslationSkillLanguage
|
|
6181
|
+
suggestedFrom?: TextTranslationSkillLanguage;
|
|
5715
6182
|
};
|
|
5716
6183
|
|
|
5717
6184
|
/**
|
|
5718
6185
|
* Defines values for TextTranslationSkillLanguage. \
|
|
5719
6186
|
* {@link KnownTextTranslationSkillLanguage} can be used interchangeably with TextTranslationSkillLanguage,
|
|
5720
6187
|
* this enum contains the known values that the service supports.
|
|
5721
|
-
* ###
|
|
6188
|
+
* ### Known values supported by the service
|
|
5722
6189
|
* **af**: Afrikaans \
|
|
5723
6190
|
* **ar**: Arabic \
|
|
5724
6191
|
* **bn**: Bangla \
|
|
@@ -5814,40 +6281,40 @@ export declare type TokenFilter = AsciiFoldingTokenFilter | CjkBigramTokenFilter
|
|
|
5814
6281
|
* Defines values for TokenFilterName. \
|
|
5815
6282
|
* {@link KnownTokenFilterName} can be used interchangeably with TokenFilterName,
|
|
5816
6283
|
* this enum contains the known values that the service supports.
|
|
5817
|
-
* ###
|
|
5818
|
-
* **arabic_normalization**: A token filter that applies the Arabic normalizer to normalize the orthography. See http
|
|
5819
|
-
* **apostrophe**: Strips all characters after an apostrophe (including the apostrophe itself). See http
|
|
5820
|
-
* **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
|
|
5821
|
-
* **cjk_bigram**: Forms bigrams of CJK terms that are generated from the standard tokenizer. See http
|
|
5822
|
-
* **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
|
|
5823
|
-
* **classic**: Removes English possessives, and dots from acronyms. See http
|
|
5824
|
-
* **common_grams**: Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. See http
|
|
5825
|
-
* **edgeNGram_v2**: Generates n-grams of the given size(s) starting from the front or the back of an input token. See http
|
|
5826
|
-
* **elision**: Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http
|
|
5827
|
-
* **german_normalization**: Normalizes German characters according to the heuristics of the German2 snowball algorithm. See http
|
|
5828
|
-
* **hindi_normalization**: Normalizes text in Hindi to remove some differences in spelling variations. See http
|
|
5829
|
-
* **indic_normalization**: Normalizes the Unicode representation of text in Indian languages. See http
|
|
5830
|
-
* **keyword_repeat**: Emits each incoming token twice, once as keyword and once as non-keyword. See http
|
|
5831
|
-
* **kstem**: A high-performance kstem filter for English. See http
|
|
5832
|
-
* **length**: Removes words that are too long or too short. See http
|
|
5833
|
-
* **limit**: Limits the number of tokens while indexing. See http
|
|
5834
|
-
* **lowercase**: Normalizes token text to lower case. See https
|
|
5835
|
-
* **nGram_v2**: Generates n-grams of the given size(s). See http
|
|
5836
|
-
* **persian_normalization**: Applies normalization for Persian. See http
|
|
5837
|
-
* **phonetic**: Create tokens for phonetic matches. See https
|
|
5838
|
-
* **porter_stem**: Uses the Porter stemming algorithm to transform the token stream. See http
|
|
5839
|
-
* **reverse**: Reverses the token string. See http
|
|
5840
|
-
* **scandinavian_normalization**: Normalizes use of the interchangeable Scandinavian characters. See http
|
|
5841
|
-
* **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
|
|
5842
|
-
* **shingle**: Creates combinations of tokens as a single token. See http
|
|
5843
|
-
* **snowball**: A filter that stems words using a Snowball-generated stemmer. See http
|
|
5844
|
-
* **sorani_normalization**: Normalizes the Unicode representation of Sorani text. See http
|
|
5845
|
-
* **stemmer**: Language specific stemming filter. See https
|
|
5846
|
-
* **stopwords**: Removes stop words from a token stream. See http
|
|
5847
|
-
* **trim**: Trims leading and trailing whitespace from tokens. See http
|
|
5848
|
-
* **truncate**: Truncates the terms to a specific length. See http
|
|
5849
|
-
* **unique**: Filters out tokens with same text as the previous token. See http
|
|
5850
|
-
* **uppercase**: Normalizes token text to upper case. See https
|
|
6284
|
+
* ### Known values supported by the service
|
|
6285
|
+
* **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 \
|
|
6286
|
+
* **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 \
|
|
6287
|
+
* **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 \
|
|
6288
|
+
* **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 \
|
|
6289
|
+
* **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 \
|
|
6290
|
+
* **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 \
|
|
6291
|
+
* **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 \
|
|
6292
|
+
* **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 \
|
|
6293
|
+
* **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 \
|
|
6294
|
+
* **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 \
|
|
6295
|
+
* **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 \
|
|
6296
|
+
* **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 \
|
|
6297
|
+
* **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 \
|
|
6298
|
+
* **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 \
|
|
6299
|
+
* **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 \
|
|
6300
|
+
* **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 \
|
|
6301
|
+
* **lowercase**: Normalizes token text to lower case. See https:\/\/lucene.apache.org\/core\/6_6_1\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/LowerCaseFilter.html \
|
|
6302
|
+
* **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 \
|
|
6303
|
+
* **persian_normalization**: Applies normalization for Persian. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/fa\/PersianNormalizationFilter.html \
|
|
6304
|
+
* **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 \
|
|
6305
|
+
* **porter_stem**: Uses the Porter stemming algorithm to transform the token stream. See http:\/\/tartarus.org\/~martin\/PorterStemmer \
|
|
6306
|
+
* **reverse**: Reverses the token string. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/reverse\/ReverseStringFilter.html \
|
|
6307
|
+
* **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 \
|
|
6308
|
+
* **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 \
|
|
6309
|
+
* **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 \
|
|
6310
|
+
* **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 \
|
|
6311
|
+
* **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 \
|
|
6312
|
+
* **stemmer**: Language specific stemming filter. See https:\/\/docs.microsoft.com\/rest\/api\/searchservice\/Custom-analyzers-in-Azure-Search#TokenFilters \
|
|
6313
|
+
* **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 \
|
|
6314
|
+
* **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 \
|
|
6315
|
+
* **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 \
|
|
6316
|
+
* **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 \
|
|
6317
|
+
* **uppercase**: Normalizes token text to upper case. See https:\/\/lucene.apache.org\/core\/6_6_1\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/UpperCaseFilter.html \
|
|
5851
6318
|
* **word_delimiter**: Splits words into subwords and performs optional transformations on subword groups.
|
|
5852
6319
|
*/
|
|
5853
6320
|
export declare type TokenFilterName = string;
|
|
@@ -5885,7 +6352,7 @@ export declare type UploadDocumentsOptions = IndexDocumentsOptions;
|
|
|
5885
6352
|
* Defines values for VisualFeature. \
|
|
5886
6353
|
* {@link KnownVisualFeature} can be used interchangeably with VisualFeature,
|
|
5887
6354
|
* this enum contains the known values that the service supports.
|
|
5888
|
-
* ###
|
|
6355
|
+
* ### Known values supported by the service
|
|
5889
6356
|
* **adult**: Visual features recognized as adult persons. \
|
|
5890
6357
|
* **brands**: Visual features recognized as commercial brands. \
|
|
5891
6358
|
* **categories**: Categories. \
|
|
@@ -5911,9 +6378,9 @@ export declare type WebApiSkill = BaseSearchIndexerSkill & {
|
|
|
5911
6378
|
/** The desired timeout for the request. Default is 30 seconds. */
|
|
5912
6379
|
timeout?: string;
|
|
5913
6380
|
/** The desired batch size which indicates number of documents. */
|
|
5914
|
-
batchSize?: number
|
|
6381
|
+
batchSize?: number;
|
|
5915
6382
|
/** If set, the number of parallel calls that can be made to the Web API. */
|
|
5916
|
-
degreeOfParallelism?: number
|
|
6383
|
+
degreeOfParallelism?: number;
|
|
5917
6384
|
};
|
|
5918
6385
|
|
|
5919
6386
|
/** Splits words into subwords and performs optional transformations on subword groups. This token filter is implemented using Apache Lucene. */
|