@azure/search-documents 12.2.0-beta.1 → 12.2.0-beta.2
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/dist/index.js +430 -46
- package/dist/index.js.map +1 -1
- package/dist-esm/src/generated/data/models/index.js +26 -14
- package/dist-esm/src/generated/data/models/index.js.map +1 -1
- package/dist-esm/src/generated/data/models/mappers.js +112 -9
- package/dist-esm/src/generated/data/models/mappers.js.map +1 -1
- package/dist-esm/src/generated/data/models/parameters.js +9 -0
- package/dist-esm/src/generated/data/models/parameters.js.map +1 -1
- package/dist-esm/src/generated/data/operations/documents.js +1 -0
- package/dist-esm/src/generated/data/operations/documents.js.map +1 -1
- package/dist-esm/src/generated/data/searchClient.js +1 -1
- package/dist-esm/src/generated/data/searchClient.js.map +1 -1
- package/dist-esm/src/generated/service/models/index.js +62 -6
- package/dist-esm/src/generated/service/models/index.js.map +1 -1
- package/dist-esm/src/generated/service/models/mappers.js +124 -0
- package/dist-esm/src/generated/service/models/mappers.js.map +1 -1
- package/dist-esm/src/generated/service/searchServiceClient.js +1 -1
- package/dist-esm/src/generated/service/searchServiceClient.js.map +1 -1
- package/dist-esm/src/index.js +2 -2
- package/dist-esm/src/index.js.map +1 -1
- package/dist-esm/src/indexDocumentsBatch.js.map +1 -1
- package/dist-esm/src/indexModels.js.map +1 -1
- package/dist-esm/src/odataMetadataPolicy.js.map +1 -1
- package/dist-esm/src/searchApiKeyCredentialPolicy.js.map +1 -1
- package/dist-esm/src/searchClient.js +43 -6
- package/dist-esm/src/searchClient.js.map +1 -1
- package/dist-esm/src/searchIndexClient.js +5 -2
- package/dist-esm/src/searchIndexClient.js.map +1 -1
- package/dist-esm/src/searchIndexerClient.js +5 -1
- package/dist-esm/src/searchIndexerClient.js.map +1 -1
- package/dist-esm/src/searchIndexingBufferedSender.js.map +1 -1
- package/dist-esm/src/serviceModels.js.map +1 -1
- package/dist-esm/src/serviceUtils.js +33 -7
- package/dist-esm/src/serviceUtils.js.map +1 -1
- package/dist-esm/src/synonymMapHelper.browser.js.map +1 -1
- package/dist-esm/src/synonymMapHelper.js.map +1 -1
- package/package.json +8 -11
- package/types/search-documents.d.ts +286 -37
|
@@ -1,13 +1,33 @@
|
|
|
1
1
|
/// <reference lib="esnext.asynciterable" />
|
|
2
2
|
|
|
3
3
|
import { AzureKeyCredential } from '@azure/core-auth';
|
|
4
|
-
import { ExtendedCommonClientOptions } from '@azure/core-http-compat';
|
|
5
|
-
import { KeyCredential } from '@azure/core-auth';
|
|
6
|
-
import { OperationOptions } from '@azure/core-client';
|
|
7
|
-
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
|
8
|
-
import { Pipeline } from '@azure/core-rest-pipeline';
|
|
9
|
-
import { RestError } from '@azure/core-rest-pipeline';
|
|
10
|
-
import { TokenCredential } from '@azure/core-auth';
|
|
4
|
+
import type { ExtendedCommonClientOptions } from '@azure/core-http-compat';
|
|
5
|
+
import type { KeyCredential } from '@azure/core-auth';
|
|
6
|
+
import type { OperationOptions } from '@azure/core-client';
|
|
7
|
+
import type { PagedAsyncIterableIterator } from '@azure/core-paging';
|
|
8
|
+
import type { Pipeline } from '@azure/core-rest-pipeline';
|
|
9
|
+
import type { RestError } from '@azure/core-rest-pipeline';
|
|
10
|
+
import type { TokenCredential } from '@azure/core-auth';
|
|
11
|
+
|
|
12
|
+
/** The multi-region account of an Azure AI service resource that's attached to a skillset. */
|
|
13
|
+
export declare interface AIServicesAccountIdentity extends BaseCognitiveServicesAccount {
|
|
14
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
15
|
+
odatatype: "#Microsoft.Azure.Search.AIServicesByIdentity";
|
|
16
|
+
/** The user-assigned managed identity used for connections to AI Service. If not specified, the system-assigned managed identity is used. On updates to the skillset, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. */
|
|
17
|
+
identity?: SearchIndexerDataIdentity;
|
|
18
|
+
/** The subdomain url for the corresponding AI Service. */
|
|
19
|
+
subdomainUrl: string;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
/** The account key of an Azure AI service resource that's attached to a skillset, to be used with the resource's subdomain. */
|
|
23
|
+
export declare interface AIServicesAccountKey extends BaseCognitiveServicesAccount {
|
|
24
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
25
|
+
odatatype: "#Microsoft.Azure.Search.AIServicesByKey";
|
|
26
|
+
/** The key used to provision the Azure AI service resource attached to a skillset. */
|
|
27
|
+
key: string;
|
|
28
|
+
/** The subdomain url for the corresponding AI Service. */
|
|
29
|
+
subdomainUrl: string;
|
|
30
|
+
}
|
|
11
31
|
|
|
12
32
|
/** Specifies the AI Services Vision parameters for vectorizing a query image or text. */
|
|
13
33
|
export declare interface AIServicesVisionParameters {
|
|
@@ -326,7 +346,7 @@ export declare interface BaseCharFilter {
|
|
|
326
346
|
/** Base type for describing any Azure AI service resource attached to a skillset. */
|
|
327
347
|
export declare interface BaseCognitiveServicesAccount {
|
|
328
348
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
329
|
-
odatatype: "#Microsoft.Azure.Search.DefaultCognitiveServices" | "#Microsoft.Azure.Search.CognitiveServicesByKey";
|
|
349
|
+
odatatype: "#Microsoft.Azure.Search.DefaultCognitiveServices" | "#Microsoft.Azure.Search.CognitiveServicesByKey" | "#Microsoft.Azure.Search.AIServicesByKey" | "#Microsoft.Azure.Search.AIServicesByIdentity";
|
|
330
350
|
/** Description of the Azure AI service resource attached to a skillset. */
|
|
331
351
|
description?: string;
|
|
332
352
|
}
|
|
@@ -388,7 +408,7 @@ export declare interface BaseSearchIndexerDataIdentity {
|
|
|
388
408
|
/** Base type for skills. */
|
|
389
409
|
export declare interface BaseSearchIndexerSkill {
|
|
390
410
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
391
|
-
odatatype: "#Microsoft.Skills.Util.ConditionalSkill" | "#Microsoft.Skills.Text.KeyPhraseExtractionSkill" | "#Microsoft.Skills.Vision.OcrSkill" | "#Microsoft.Skills.Vision.ImageAnalysisSkill" | "#Microsoft.Skills.Text.LanguageDetectionSkill" | "#Microsoft.Skills.Util.ShaperSkill" | "#Microsoft.Skills.Text.MergeSkill" | "#Microsoft.Skills.Text.EntityRecognitionSkill" | "#Microsoft.Skills.Text.SentimentSkill" | "#Microsoft.Skills.Text.V3.SentimentSkill" | "#Microsoft.Skills.Text.V3.EntityLinkingSkill" | "#Microsoft.Skills.Text.V3.EntityRecognitionSkill" | "#Microsoft.Skills.Text.PIIDetectionSkill" | "#Microsoft.Skills.Text.SplitSkill" | "#Microsoft.Skills.Text.CustomEntityLookupSkill" | "#Microsoft.Skills.Text.TranslationSkill" | "#Microsoft.Skills.Util.DocumentExtractionSkill" | "#Microsoft.Skills.Custom.WebApiSkill" | "#Microsoft.Skills.Custom.AmlSkill" | "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill" | "#Microsoft.Skills.Vision.VectorizeSkill";
|
|
411
|
+
odatatype: "#Microsoft.Skills.Util.ConditionalSkill" | "#Microsoft.Skills.Text.KeyPhraseExtractionSkill" | "#Microsoft.Skills.Vision.OcrSkill" | "#Microsoft.Skills.Vision.ImageAnalysisSkill" | "#Microsoft.Skills.Text.LanguageDetectionSkill" | "#Microsoft.Skills.Util.ShaperSkill" | "#Microsoft.Skills.Text.MergeSkill" | "#Microsoft.Skills.Text.EntityRecognitionSkill" | "#Microsoft.Skills.Text.SentimentSkill" | "#Microsoft.Skills.Text.V3.SentimentSkill" | "#Microsoft.Skills.Text.V3.EntityLinkingSkill" | "#Microsoft.Skills.Text.V3.EntityRecognitionSkill" | "#Microsoft.Skills.Text.PIIDetectionSkill" | "#Microsoft.Skills.Text.SplitSkill" | "#Microsoft.Skills.Text.CustomEntityLookupSkill" | "#Microsoft.Skills.Text.TranslationSkill" | "#Microsoft.Skills.Util.DocumentExtractionSkill" | "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill" | "#Microsoft.Skills.Custom.WebApiSkill" | "#Microsoft.Skills.Custom.AmlSkill" | "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill" | "#Microsoft.Skills.Vision.VectorizeSkill";
|
|
392
412
|
/** The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. */
|
|
393
413
|
name?: string;
|
|
394
414
|
/** The description of the skill which describes the inputs, outputs, and usage of the skill. */
|
|
@@ -480,7 +500,7 @@ export declare interface BaseSearchRequestOptions<TModel extends object, TFields
|
|
|
480
500
|
/**
|
|
481
501
|
* Improve search recall by spell-correcting individual search query terms.
|
|
482
502
|
*/
|
|
483
|
-
speller?:
|
|
503
|
+
speller?: QuerySpeller;
|
|
484
504
|
/**
|
|
485
505
|
* A value that specifies whether any or all of the search terms must be matched in order to
|
|
486
506
|
* count the document as a match. Possible values include: 'any', 'all'
|
|
@@ -588,6 +608,8 @@ export declare interface BaseVectorSearchCompression {
|
|
|
588
608
|
rerankWithOriginalVectors?: boolean;
|
|
589
609
|
/** Default oversampling factor. Oversampling will internally request more documents (specified by this multiplier) in the initial search. This increases the set of results that will be reranked using recomputed similarity scores from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when rerankWithOriginalVectors is true. Higher values improve recall at the expense of latency. */
|
|
590
610
|
defaultOversampling?: number;
|
|
611
|
+
/** Contains the options for rescoring. */
|
|
612
|
+
rescoringOptions?: RescoringOptions;
|
|
591
613
|
/** The number of dimensions to truncate the vectors to. Truncating the vectors reduces the size of the vectors and the amount of data that needs to be transferred during search. This can save storage cost and improve search performance at the expense of recall. It should be only used for embeddings trained with Matryoshka Representation Learning (MRL) such as OpenAI text-embedding-3-large (small). The default value is null, which means no truncation. */
|
|
592
614
|
truncationDimension?: number;
|
|
593
615
|
}
|
|
@@ -674,7 +696,7 @@ export declare interface ClassicTokenizer extends BaseLexicalTokenizer {
|
|
|
674
696
|
/**
|
|
675
697
|
* Contains the possible cases for CognitiveServicesAccount.
|
|
676
698
|
*/
|
|
677
|
-
export declare type CognitiveServicesAccount = DefaultCognitiveServicesAccount | CognitiveServicesAccountKey;
|
|
699
|
+
export declare type CognitiveServicesAccount = DefaultCognitiveServicesAccount | CognitiveServicesAccountKey | AIServicesAccountKey | AIServicesAccountIdentity;
|
|
678
700
|
|
|
679
701
|
/** The multi-region account key of an Azure AI service resource that's attached to a skillset. */
|
|
680
702
|
export declare interface CognitiveServicesAccountKey extends BaseCognitiveServicesAccount {
|
|
@@ -980,6 +1002,15 @@ export declare type DataChangeDetectionPolicy = HighWaterMarkChangeDetectionPoli
|
|
|
980
1002
|
*/
|
|
981
1003
|
export declare type DataDeletionDetectionPolicy = SoftDeleteColumnDeletionDetectionPolicy | NativeBlobSoftDeleteDeletionDetectionPolicy;
|
|
982
1004
|
|
|
1005
|
+
/** Contains debugging information that can be used to further explore your search results. */
|
|
1006
|
+
export declare interface DebugInfo {
|
|
1007
|
+
/**
|
|
1008
|
+
* Contains debugging information specific to query rewrites.
|
|
1009
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1010
|
+
*/
|
|
1011
|
+
readonly queryRewrites?: QueryRewritesDebugInfo;
|
|
1012
|
+
}
|
|
1013
|
+
|
|
983
1014
|
/**
|
|
984
1015
|
* Default Batch Size
|
|
985
1016
|
*/
|
|
@@ -1126,6 +1157,39 @@ export declare interface DocumentExtractionSkill extends BaseSearchIndexerSkill
|
|
|
1126
1157
|
};
|
|
1127
1158
|
}
|
|
1128
1159
|
|
|
1160
|
+
/** A skill that extracts content and layout information (as markdown), via Azure AI Services, from files within the enrichment pipeline. */
|
|
1161
|
+
export declare interface DocumentIntelligenceLayoutSkill extends BaseSearchIndexerSkill {
|
|
1162
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1163
|
+
odatatype: "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill";
|
|
1164
|
+
/** Controls the cardinality of the output produced by the skill. Default is 'oneToMany'. */
|
|
1165
|
+
outputMode?: DocumentIntelligenceLayoutSkillOutputMode;
|
|
1166
|
+
/** The depth of headers in the markdown output. Default is h6. */
|
|
1167
|
+
markdownHeaderDepth?: DocumentIntelligenceLayoutSkillMarkdownHeaderDepth;
|
|
1168
|
+
}
|
|
1169
|
+
|
|
1170
|
+
/**
|
|
1171
|
+
* Defines values for DocumentIntelligenceLayoutSkillMarkdownHeaderDepth. \
|
|
1172
|
+
* {@link KnownDocumentIntelligenceLayoutSkillMarkdownHeaderDepth} can be used interchangeably with DocumentIntelligenceLayoutSkillMarkdownHeaderDepth,
|
|
1173
|
+
* this enum contains the known values that the service supports.
|
|
1174
|
+
* ### Known values supported by the service
|
|
1175
|
+
* **h1**: Header level 1. \
|
|
1176
|
+
* **h2**: Header level 2. \
|
|
1177
|
+
* **h3**: Header level 3. \
|
|
1178
|
+
* **h4**: Header level 4. \
|
|
1179
|
+
* **h5**: Header level 5. \
|
|
1180
|
+
* **h6**: Header level 6.
|
|
1181
|
+
*/
|
|
1182
|
+
export declare type DocumentIntelligenceLayoutSkillMarkdownHeaderDepth = string;
|
|
1183
|
+
|
|
1184
|
+
/**
|
|
1185
|
+
* Defines values for DocumentIntelligenceLayoutSkillOutputMode. \
|
|
1186
|
+
* {@link KnownDocumentIntelligenceLayoutSkillOutputMode} can be used interchangeably with DocumentIntelligenceLayoutSkillOutputMode,
|
|
1187
|
+
* this enum contains the known values that the service supports.
|
|
1188
|
+
* ### Known values supported by the service
|
|
1189
|
+
* **oneToMany**: Specify the deepest markdown header section to parse.
|
|
1190
|
+
*/
|
|
1191
|
+
export declare type DocumentIntelligenceLayoutSkillOutputMode = string;
|
|
1192
|
+
|
|
1129
1193
|
/**
|
|
1130
1194
|
* Generates n-grams of the given size(s) starting from the front or the back of an input token.
|
|
1131
1195
|
* This token filter is implemented using Apache Lucene.
|
|
@@ -1262,12 +1326,20 @@ export declare interface ExtractiveQueryAnswer {
|
|
|
1262
1326
|
* The confidence threshold. Default threshold is 0.7
|
|
1263
1327
|
*/
|
|
1264
1328
|
threshold?: number;
|
|
1329
|
+
/**
|
|
1330
|
+
* An optional upper bound on the number of characters in each answer.
|
|
1331
|
+
*/
|
|
1332
|
+
maxAnswerLength?: number;
|
|
1265
1333
|
}
|
|
1266
1334
|
|
|
1267
1335
|
/** Extracts captions from the matching documents that contain passages relevant to the search query. */
|
|
1268
1336
|
export declare interface ExtractiveQueryCaption {
|
|
1269
1337
|
captionType: "extractive";
|
|
1270
1338
|
highlight?: boolean;
|
|
1339
|
+
/**
|
|
1340
|
+
* An optional upper bound on the number of characters in each caption.
|
|
1341
|
+
*/
|
|
1342
|
+
maxCaptionLength?: number;
|
|
1271
1343
|
}
|
|
1272
1344
|
|
|
1273
1345
|
/** 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. */
|
|
@@ -1279,6 +1351,13 @@ export declare interface FacetResult {
|
|
|
1279
1351
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1280
1352
|
*/
|
|
1281
1353
|
readonly count?: number;
|
|
1354
|
+
/**
|
|
1355
|
+
* The nested facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not contain any nested facets.
|
|
1356
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1357
|
+
*/
|
|
1358
|
+
readonly facets?: {
|
|
1359
|
+
[propertyName: string]: FacetResult[];
|
|
1360
|
+
};
|
|
1282
1361
|
}
|
|
1283
1362
|
|
|
1284
1363
|
/** Defines a mapping between a field in a data source and a target field in an index. */
|
|
@@ -1315,6 +1394,14 @@ export declare interface FreshnessScoringParameters {
|
|
|
1315
1394
|
boostingDuration: string;
|
|
1316
1395
|
}
|
|
1317
1396
|
|
|
1397
|
+
/** Generate alternative query terms to increase the recall of a search request. */
|
|
1398
|
+
export declare interface GenerativeQueryRewrites {
|
|
1399
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1400
|
+
rewritesType: "generative";
|
|
1401
|
+
/** The number of query rewrites to generate. Defaults to 10.*/
|
|
1402
|
+
count?: number;
|
|
1403
|
+
}
|
|
1404
|
+
|
|
1318
1405
|
/**
|
|
1319
1406
|
* Represents a geographic point in global coordinates.
|
|
1320
1407
|
*/
|
|
@@ -1741,7 +1828,7 @@ export declare interface IndexingParametersConfiguration {
|
|
|
1741
1828
|
failOnUnsupportedContentType?: boolean;
|
|
1742
1829
|
/** For Azure blobs, set to false if you want to continue indexing if a document fails indexing. */
|
|
1743
1830
|
failOnUnprocessableDocument?: boolean;
|
|
1744
|
-
/** For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://
|
|
1831
|
+
/** For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://learn.microsoft.com/azure/search/search-limits-quotas-capacity. */
|
|
1745
1832
|
indexStorageMetadataOnlyForOversizedDocuments?: boolean;
|
|
1746
1833
|
/** For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source fields to destination fields in an index. */
|
|
1747
1834
|
delimitedTextHeaders?: string;
|
|
@@ -1749,6 +1836,10 @@ export declare interface IndexingParametersConfiguration {
|
|
|
1749
1836
|
delimitedTextDelimiter?: string;
|
|
1750
1837
|
/** For CSV blobs, indicates that the first (non-blank) line of each blob contains headers. */
|
|
1751
1838
|
firstLineContainsHeaders?: boolean;
|
|
1839
|
+
/** Specifies the submode that will determine whether a markdown file will be parsed into exactly one search document or multiple search documents. Default is `oneToMany`. */
|
|
1840
|
+
markdownParsingSubmode?: MarkdownParsingSubmode;
|
|
1841
|
+
/** Specifies the max header depth that will be considered while grouping markdown content. Default is `h6`. */
|
|
1842
|
+
markdownHeaderDepth?: MarkdownHeaderDepth;
|
|
1752
1843
|
/** For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property. */
|
|
1753
1844
|
documentRoot?: string;
|
|
1754
1845
|
/** Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when "imageAction" is set to a value other than "none". This applies to embedded image content in a .PDF or other application, or image files such as .jpg and .png, in Azure blobs. */
|
|
@@ -2338,7 +2429,9 @@ export declare enum KnownBlobIndexerParsingMode {
|
|
|
2338
2429
|
/** Set to jsonArray to extract individual elements of a JSON array as separate documents. */
|
|
2339
2430
|
JsonArray = "jsonArray",
|
|
2340
2431
|
/** Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents. */
|
|
2341
|
-
JsonLines = "jsonLines"
|
|
2432
|
+
JsonLines = "jsonLines",
|
|
2433
|
+
/** Set to markdown to extract content from markdown files. */
|
|
2434
|
+
Markdown = "markdown"
|
|
2342
2435
|
}
|
|
2343
2436
|
|
|
2344
2437
|
/** Known values of {@link BlobIndexerPDFTextRotationAlgorithm} that the service accepts. */
|
|
@@ -2383,6 +2476,28 @@ export declare enum KnownCustomEntityLookupSkillLanguage {
|
|
|
2383
2476
|
Pt = "pt"
|
|
2384
2477
|
}
|
|
2385
2478
|
|
|
2479
|
+
/** Known values of {@link DocumentIntelligenceLayoutSkillMarkdownHeaderDepth} that the service accepts. */
|
|
2480
|
+
export declare enum KnownDocumentIntelligenceLayoutSkillMarkdownHeaderDepth {
|
|
2481
|
+
/** Header level 1. */
|
|
2482
|
+
H1 = "h1",
|
|
2483
|
+
/** Header level 2. */
|
|
2484
|
+
H2 = "h2",
|
|
2485
|
+
/** Header level 3. */
|
|
2486
|
+
H3 = "h3",
|
|
2487
|
+
/** Header level 4. */
|
|
2488
|
+
H4 = "h4",
|
|
2489
|
+
/** Header level 5. */
|
|
2490
|
+
H5 = "h5",
|
|
2491
|
+
/** Header level 6. */
|
|
2492
|
+
H6 = "h6"
|
|
2493
|
+
}
|
|
2494
|
+
|
|
2495
|
+
/** Known values of {@link DocumentIntelligenceLayoutSkillOutputMode} that the service accepts. */
|
|
2496
|
+
export declare enum KnownDocumentIntelligenceLayoutSkillOutputMode {
|
|
2497
|
+
/** Specify the deepest markdown header section to parse. */
|
|
2498
|
+
OneToMany = "oneToMany"
|
|
2499
|
+
}
|
|
2500
|
+
|
|
2386
2501
|
/** Known values of {@link EntityCategory} that the service accepts. */
|
|
2387
2502
|
export declare enum KnownEntityCategory {
|
|
2388
2503
|
/** Entities describing a physical location. */
|
|
@@ -2847,6 +2962,30 @@ declare enum KnownLexicalNormalizerName {
|
|
|
2847
2962
|
export { KnownLexicalNormalizerName }
|
|
2848
2963
|
export { KnownLexicalNormalizerName as KnownNormalizerNames }
|
|
2849
2964
|
|
|
2965
|
+
/** Known values of {@link MarkdownHeaderDepth} that the service accepts. */
|
|
2966
|
+
export declare enum KnownMarkdownHeaderDepth {
|
|
2967
|
+
/** Indicates that headers up to a level of h1 will be considered while grouping markdown content. */
|
|
2968
|
+
H1 = "h1",
|
|
2969
|
+
/** Indicates that headers up to a level of h2 will be considered while grouping markdown content. */
|
|
2970
|
+
H2 = "h2",
|
|
2971
|
+
/** Indicates that headers up to a level of h3 will be considered while grouping markdown content. */
|
|
2972
|
+
H3 = "h3",
|
|
2973
|
+
/** Indicates that headers up to a level of h4 will be considered while grouping markdown content. */
|
|
2974
|
+
H4 = "h4",
|
|
2975
|
+
/** Indicates that headers up to a level of h5 will be considered while grouping markdown content. */
|
|
2976
|
+
H5 = "h5",
|
|
2977
|
+
/** Indicates that headers up to a level of h6 will be considered while grouping markdown content. This is the default. */
|
|
2978
|
+
H6 = "h6"
|
|
2979
|
+
}
|
|
2980
|
+
|
|
2981
|
+
/** Known values of {@link MarkdownParsingSubmode} that the service accepts. */
|
|
2982
|
+
export declare enum KnownMarkdownParsingSubmode {
|
|
2983
|
+
/** Indicates that each section of the markdown file (up to a specified depth) will be parsed into individual search documents. This can result in a single markdown file producing multiple search documents. This is the default sub-mode. */
|
|
2984
|
+
OneToMany = "oneToMany",
|
|
2985
|
+
/** Indicates that each markdown file will be parsed into a single search document. */
|
|
2986
|
+
OneToOne = "oneToOne"
|
|
2987
|
+
}
|
|
2988
|
+
|
|
2850
2989
|
/** Known values of {@link OcrLineEnding} that the service accepts. */
|
|
2851
2990
|
export declare enum KnownOcrLineEnding {
|
|
2852
2991
|
/** Lines are separated by a single space character. */
|
|
@@ -3216,7 +3355,13 @@ export declare enum KnownQueryDebugMode {
|
|
|
3216
3355
|
/** No query debugging information will be returned. */
|
|
3217
3356
|
Disabled = "disabled",
|
|
3218
3357
|
/** Allows the user to further explore their reranked results. */
|
|
3219
|
-
Semantic = "semantic"
|
|
3358
|
+
Semantic = "semantic",
|
|
3359
|
+
/** Allows the user to further explore their hybrid and vector query results. */
|
|
3360
|
+
Vector = "vector",
|
|
3361
|
+
/** Allows the user to explore the list of query rewrites generated for their search request. */
|
|
3362
|
+
QueryRewrites = "queryRewrites",
|
|
3363
|
+
/** Turn on all debug options. */
|
|
3364
|
+
All = "all"
|
|
3220
3365
|
}
|
|
3221
3366
|
|
|
3222
3367
|
/** Known values of {@link QueryLanguage} that the service accepts. */
|
|
@@ -3368,7 +3513,7 @@ export declare enum KnownQueryLanguage {
|
|
|
3368
3513
|
}
|
|
3369
3514
|
|
|
3370
3515
|
/** Known values of {@link QuerySpellerType} that the service accepts. */
|
|
3371
|
-
export declare enum
|
|
3516
|
+
export declare enum KnownQuerySpeller {
|
|
3372
3517
|
/** Speller not enabled. */
|
|
3373
3518
|
None = "none",
|
|
3374
3519
|
/** Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. */
|
|
@@ -3489,6 +3634,12 @@ export declare enum KnownSemanticFieldState {
|
|
|
3489
3634
|
Partial = "partial"
|
|
3490
3635
|
}
|
|
3491
3636
|
|
|
3637
|
+
/** Known values of {@link SemanticQueryRewritesResultType} that the service accepts. */
|
|
3638
|
+
export declare enum KnownSemanticQueryRewritesResultType {
|
|
3639
|
+
/** Query rewrites were not successfully generated for this request. Only the original query was used to retrieve the results. */
|
|
3640
|
+
OriginalQueryOnly = "originalQueryOnly"
|
|
3641
|
+
}
|
|
3642
|
+
|
|
3492
3643
|
/** Known values of {@link SemanticSearchResultsType} that the service accepts. */
|
|
3493
3644
|
export declare enum KnownSemanticSearchResultsType {
|
|
3494
3645
|
/** Results without any semantic enrichment or reranking. */
|
|
@@ -3531,14 +3682,6 @@ export declare enum KnownSentimentSkillLanguage {
|
|
|
3531
3682
|
Tr = "tr"
|
|
3532
3683
|
}
|
|
3533
3684
|
|
|
3534
|
-
/** Known values of {@link Speller} that the service accepts. */
|
|
3535
|
-
export declare enum KnownSpeller {
|
|
3536
|
-
/** Speller not enabled. */
|
|
3537
|
-
None = "none",
|
|
3538
|
-
/** Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. */
|
|
3539
|
-
Lexicon = "lexicon"
|
|
3540
|
-
}
|
|
3541
|
-
|
|
3542
3685
|
/** Known values of {@link SplitSkillEncoderModelName} that the service accepts. */
|
|
3543
3686
|
export declare enum KnownSplitSkillEncoderModelName {
|
|
3544
3687
|
/** Refers to a base model trained with a 50,000 token vocabulary, often used in general natural language processing tasks. */
|
|
@@ -4093,6 +4236,14 @@ export declare enum KnownVectorSearchCompressionKind {
|
|
|
4093
4236
|
BinaryQuantization = "binaryQuantization"
|
|
4094
4237
|
}
|
|
4095
4238
|
|
|
4239
|
+
/** Known values of {@link VectorSearchCompressionRescoreStorageMethod} that the service accepts. */
|
|
4240
|
+
export declare enum KnownVectorSearchCompressionRescoreStorageMethod {
|
|
4241
|
+
/** This option preserves the original full-precision vectors. Choose this option for maximum flexibility and highest quality of compressed search results. This consumes more storage but allows for rescoring and oversampling. */
|
|
4242
|
+
PreserveOriginals = "preserveOriginals",
|
|
4243
|
+
/** This option discards the original full-precision vectors. Choose this option for maximum storage savings. Since this option does not allow for rescoring and oversampling, it will often cause slight to moderate reductions in quality. */
|
|
4244
|
+
DiscardOriginals = "discardOriginals"
|
|
4245
|
+
}
|
|
4246
|
+
|
|
4096
4247
|
/** Known values of {@link VectorSearchCompressionTarget} that the service accepts. */
|
|
4097
4248
|
export declare enum KnownVectorSearchCompressionTarget {
|
|
4098
4249
|
/** Int8 */
|
|
@@ -4416,6 +4567,30 @@ export declare interface MappingCharFilter extends BaseCharFilter {
|
|
|
4416
4567
|
mappings: string[];
|
|
4417
4568
|
}
|
|
4418
4569
|
|
|
4570
|
+
/**
|
|
4571
|
+
* Defines values for MarkdownHeaderDepth. \
|
|
4572
|
+
* {@link KnownMarkdownHeaderDepth} can be used interchangeably with MarkdownHeaderDepth,
|
|
4573
|
+
* this enum contains the known values that the service supports.
|
|
4574
|
+
* ### Known values supported by the service
|
|
4575
|
+
* **h1**: Indicates that headers up to a level of h1 will be considered while grouping markdown content. \
|
|
4576
|
+
* **h2**: Indicates that headers up to a level of h2 will be considered while grouping markdown content. \
|
|
4577
|
+
* **h3**: Indicates that headers up to a level of h3 will be considered while grouping markdown content. \
|
|
4578
|
+
* **h4**: Indicates that headers up to a level of h4 will be considered while grouping markdown content. \
|
|
4579
|
+
* **h5**: Indicates that headers up to a level of h5 will be considered while grouping markdown content. \
|
|
4580
|
+
* **h6**: Indicates that headers up to a level of h6 will be considered while grouping markdown content. This is the default.
|
|
4581
|
+
*/
|
|
4582
|
+
export declare type MarkdownHeaderDepth = string;
|
|
4583
|
+
|
|
4584
|
+
/**
|
|
4585
|
+
* Defines values for MarkdownParsingSubmode. \
|
|
4586
|
+
* {@link KnownMarkdownParsingSubmode} can be used interchangeably with MarkdownParsingSubmode,
|
|
4587
|
+
* this enum contains the known values that the service supports.
|
|
4588
|
+
* ### Known values supported by the service
|
|
4589
|
+
* **oneToMany**: Indicates that each section of the markdown file (up to a specified depth) will be parsed into individual search documents. This can result in a single markdown file producing multiple search documents. This is the default sub-mode. \
|
|
4590
|
+
* **oneToOne**: Indicates that each markdown file will be parsed into a single search document.
|
|
4591
|
+
*/
|
|
4592
|
+
export declare type MarkdownParsingSubmode = string;
|
|
4593
|
+
|
|
4419
4594
|
/**
|
|
4420
4595
|
* Options for the merge documents operation.
|
|
4421
4596
|
*/
|
|
@@ -4783,7 +4958,10 @@ export declare interface QueryCaptionResult {
|
|
|
4783
4958
|
* this enum contains the known values that the service supports.
|
|
4784
4959
|
* ### Known values supported by the service
|
|
4785
4960
|
* **disabled**: No query debugging information will be returned. \
|
|
4786
|
-
* **semantic**: Allows the user to further explore their reranked results.
|
|
4961
|
+
* **semantic**: Allows the user to further explore their reranked results. \
|
|
4962
|
+
* **vector**: Allows the user to further explore their hybrid and vector query results. \
|
|
4963
|
+
* **queryRewrites**: Allows the user to explore the list of query rewrites generated for their search request. \
|
|
4964
|
+
* **all**: Turn on all debug options.
|
|
4787
4965
|
*/
|
|
4788
4966
|
export declare type QueryDebugMode = string;
|
|
4789
4967
|
|
|
@@ -4921,6 +5099,37 @@ export declare interface QueryResultDocumentSubscores {
|
|
|
4921
5099
|
readonly documentBoost?: number;
|
|
4922
5100
|
}
|
|
4923
5101
|
|
|
5102
|
+
/** Defines options for query rewrites. */
|
|
5103
|
+
export declare type QueryRewrites = GenerativeQueryRewrites;
|
|
5104
|
+
|
|
5105
|
+
/** Contains debugging information specific to query rewrites. */
|
|
5106
|
+
export declare interface QueryRewritesDebugInfo {
|
|
5107
|
+
/**
|
|
5108
|
+
* List of query rewrites generated for the text query.
|
|
5109
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
5110
|
+
*/
|
|
5111
|
+
readonly text?: QueryRewritesValuesDebugInfo;
|
|
5112
|
+
/**
|
|
5113
|
+
* List of query rewrites generated for the vectorizable text queries.
|
|
5114
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
5115
|
+
*/
|
|
5116
|
+
readonly vectors?: QueryRewritesValuesDebugInfo[];
|
|
5117
|
+
}
|
|
5118
|
+
|
|
5119
|
+
/** Contains debugging information specific to query rewrites. */
|
|
5120
|
+
export declare interface QueryRewritesValuesDebugInfo {
|
|
5121
|
+
/**
|
|
5122
|
+
* The input text to the generative query rewriting model. There may be cases where the user query and the input to the generative model are not identical.
|
|
5123
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
5124
|
+
*/
|
|
5125
|
+
readonly inputQuery?: string;
|
|
5126
|
+
/**
|
|
5127
|
+
* List of query rewrites.
|
|
5128
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
5129
|
+
*/
|
|
5130
|
+
readonly rewrites?: string[];
|
|
5131
|
+
}
|
|
5132
|
+
|
|
4924
5133
|
/**
|
|
4925
5134
|
* Defines values for QuerySpellerType. \
|
|
4926
5135
|
* {@link KnownQuerySpellerType} can be used interchangeably with QuerySpellerType,
|
|
@@ -4929,13 +5138,23 @@ export declare interface QueryResultDocumentSubscores {
|
|
|
4929
5138
|
* **none**: Speller not enabled. \
|
|
4930
5139
|
* **lexicon**: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter.
|
|
4931
5140
|
*/
|
|
4932
|
-
export declare type
|
|
5141
|
+
export declare type QuerySpeller = string;
|
|
4933
5142
|
|
|
4934
5143
|
/** Defines values for QueryType. */
|
|
4935
5144
|
export declare type QueryType = "simple" | "full" | "semantic";
|
|
4936
5145
|
|
|
4937
5146
|
export declare type RegexFlags = `${KnownRegexFlags}`;
|
|
4938
5147
|
|
|
5148
|
+
/** Contains the options for rescoring. */
|
|
5149
|
+
export declare interface RescoringOptions {
|
|
5150
|
+
/** If set to true, after the initial search on the compressed vectors, the similarity scores are recalculated using the full-precision vectors. This will improve recall at the expense of latency. */
|
|
5151
|
+
enableRescoring?: boolean;
|
|
5152
|
+
/** Default oversampling factor. Oversampling retrieves a greater set of potential documents to offset the resolution loss due to quantization. This increases the set of results that will be rescored on full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when 'enableRescoring' is true. Higher values improve recall at the expense of latency. */
|
|
5153
|
+
defaultOversampling?: number;
|
|
5154
|
+
/** Controls the storage method for original vectors. This setting is immutable. */
|
|
5155
|
+
rescoreStorageMethod?: VectorSearchCompressionRescoreStorageMethod;
|
|
5156
|
+
}
|
|
5157
|
+
|
|
4939
5158
|
/**
|
|
4940
5159
|
* Options for reset docs operation.
|
|
4941
5160
|
*/
|
|
@@ -5279,6 +5498,7 @@ export declare class SearchClient<TModel extends object> implements IndexDocumen
|
|
|
5279
5498
|
private convertQueryAnswers;
|
|
5280
5499
|
private convertQueryCaptions;
|
|
5281
5500
|
private convertVectorQuery;
|
|
5501
|
+
private convertQueryRewrites;
|
|
5282
5502
|
}
|
|
5283
5503
|
|
|
5284
5504
|
/**
|
|
@@ -5361,6 +5581,11 @@ export declare interface SearchDocumentsResultBase {
|
|
|
5361
5581
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
5362
5582
|
*/
|
|
5363
5583
|
readonly answers?: QueryAnswerResult[];
|
|
5584
|
+
/**
|
|
5585
|
+
* Debug information that applies to the search results as a whole.
|
|
5586
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
5587
|
+
*/
|
|
5588
|
+
readonly debugInfo?: DebugInfo;
|
|
5364
5589
|
/**
|
|
5365
5590
|
* Reason that a partial response was returned for a semantic search request.
|
|
5366
5591
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
@@ -5371,6 +5596,11 @@ export declare interface SearchDocumentsResultBase {
|
|
|
5371
5596
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
5372
5597
|
*/
|
|
5373
5598
|
readonly semanticSearchResultsType?: SemanticSearchResultsType;
|
|
5599
|
+
/**
|
|
5600
|
+
* Type of query rewrite that was used to retrieve documents.
|
|
5601
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
5602
|
+
*/
|
|
5603
|
+
readonly semanticQueryRewritesResultType?: SemanticQueryRewritesResultType;
|
|
5374
5604
|
}
|
|
5375
5605
|
|
|
5376
5606
|
/**
|
|
@@ -6252,7 +6482,7 @@ export declare interface SearchIndexerLimits {
|
|
|
6252
6482
|
/**
|
|
6253
6483
|
* Contains the possible cases for Skill.
|
|
6254
6484
|
*/
|
|
6255
|
-
export declare type SearchIndexerSkill = AzureMachineLearningSkill | AzureOpenAIEmbeddingSkill | ConditionalSkill | CustomEntityLookupSkill | DocumentExtractionSkill | EntityLinkingSkill | EntityRecognitionSkill | EntityRecognitionSkillV3 | ImageAnalysisSkill | KeyPhraseExtractionSkill | LanguageDetectionSkill | MergeSkill | OcrSkill | PIIDetectionSkill | SentimentSkill | SentimentSkillV3 | ShaperSkill | SplitSkill | TextTranslationSkill | VisionVectorizeSkill | WebApiSkill;
|
|
6485
|
+
export declare type SearchIndexerSkill = AzureMachineLearningSkill | AzureOpenAIEmbeddingSkill | ConditionalSkill | CustomEntityLookupSkill | DocumentExtractionSkill | DocumentIntelligenceLayoutSkill | EntityLinkingSkill | EntityRecognitionSkill | EntityRecognitionSkillV3 | ImageAnalysisSkill | KeyPhraseExtractionSkill | LanguageDetectionSkill | MergeSkill | OcrSkill | PIIDetectionSkill | SentimentSkill | SentimentSkillV3 | ShaperSkill | SplitSkill | TextTranslationSkill | VisionVectorizeSkill | WebApiSkill;
|
|
6256
6486
|
|
|
6257
6487
|
/**
|
|
6258
6488
|
* A list of skills.
|
|
@@ -6711,7 +6941,7 @@ export declare type SearchResult<TModel extends object, TFields extends SelectFi
|
|
|
6711
6941
|
* Contains debugging information that can be used to further explore your search results.
|
|
6712
6942
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
6713
6943
|
*/
|
|
6714
|
-
readonly documentDebugInfo?: DocumentDebugInfo
|
|
6944
|
+
readonly documentDebugInfo?: DocumentDebugInfo;
|
|
6715
6945
|
};
|
|
6716
6946
|
|
|
6717
6947
|
/** The results of the vector query will filter based on the '\@search.score' value. Note this is the \@search.score returned as part of the search response. The threshold direction will be chosen for higher \@search.score. */
|
|
@@ -6825,6 +7055,15 @@ export declare interface SemanticPrioritizedFields {
|
|
|
6825
7055
|
keywordsFields?: SemanticField[];
|
|
6826
7056
|
}
|
|
6827
7057
|
|
|
7058
|
+
/**
|
|
7059
|
+
* Defines values for SemanticQueryRewritesResultType. \
|
|
7060
|
+
* {@link KnownSemanticQueryRewritesResultType} can be used interchangeably with SemanticQueryRewritesResultType,
|
|
7061
|
+
* this enum contains the known values that the service supports.
|
|
7062
|
+
* ### Known values supported by the service
|
|
7063
|
+
* **originalQueryOnly**: Query rewrites were not successfully generated for this request. Only the original query was used to retrieve the results.
|
|
7064
|
+
*/
|
|
7065
|
+
export declare type SemanticQueryRewritesResultType = string;
|
|
7066
|
+
|
|
6828
7067
|
/** Defines parameters for a search index that influence semantic capabilities. */
|
|
6829
7068
|
export declare interface SemanticSearch {
|
|
6830
7069
|
/** Allows you to set the name of a default semantic configuration in your index, making it optional to pass it on as a query parameter every time. */
|
|
@@ -6862,6 +7101,11 @@ export declare interface SemanticSearchOptions {
|
|
|
6862
7101
|
* to 'None'.
|
|
6863
7102
|
*/
|
|
6864
7103
|
captions?: QueryCaption;
|
|
7104
|
+
/**
|
|
7105
|
+
* When QueryRewrites is set to `generative`, the query terms are sent to a generate model which will
|
|
7106
|
+
* produce 10 (default) rewrites to help increase the recall of the request. Defaults to `none`.
|
|
7107
|
+
*/
|
|
7108
|
+
queryRewrites?: QueryRewrites;
|
|
6865
7109
|
/**
|
|
6866
7110
|
* Allows setting a separate search query that will be solely used for semantic reranking,
|
|
6867
7111
|
* semantic captions and semantic answers. Is useful for scenarios where there is a need to use
|
|
@@ -7140,16 +7384,6 @@ export declare interface SoftDeleteColumnDeletionDetectionPolicy extends BaseDat
|
|
|
7140
7384
|
softDeleteMarkerValue?: string;
|
|
7141
7385
|
}
|
|
7142
7386
|
|
|
7143
|
-
/**
|
|
7144
|
-
* Defines values for Speller. \
|
|
7145
|
-
* {@link KnownSpeller} can be used interchangeably with Speller,
|
|
7146
|
-
* this enum contains the known values that the service supports.
|
|
7147
|
-
* ### Known values supported by the service
|
|
7148
|
-
* **none**: Speller not enabled. \
|
|
7149
|
-
* **lexicon**: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter.
|
|
7150
|
-
*/
|
|
7151
|
-
export declare type Speller = string;
|
|
7152
|
-
|
|
7153
7387
|
/** A skill to split a string into chunks of text. */
|
|
7154
7388
|
export declare interface SplitSkill extends BaseSearchIndexerSkill {
|
|
7155
7389
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -7554,6 +7788,11 @@ export declare interface VectorizableTextQuery<TModel extends object> extends Ba
|
|
|
7554
7788
|
kind: "text";
|
|
7555
7789
|
/** The text to be vectorized to perform a vector search query. */
|
|
7556
7790
|
text: string;
|
|
7791
|
+
/**
|
|
7792
|
+
* Can be configured to let a generative model rewrite the query before sending it to be
|
|
7793
|
+
* vectorized.
|
|
7794
|
+
*/
|
|
7795
|
+
queryRewrites?: QueryRewrites;
|
|
7557
7796
|
}
|
|
7558
7797
|
|
|
7559
7798
|
/** The query parameters to use for vector search when a raw vector value is provided. */
|
|
@@ -7612,6 +7851,16 @@ export declare type VectorSearchCompression = BinaryQuantizationCompression | Sc
|
|
|
7612
7851
|
*/
|
|
7613
7852
|
export declare type VectorSearchCompressionKind = string;
|
|
7614
7853
|
|
|
7854
|
+
/**
|
|
7855
|
+
* Defines values for VectorSearchCompressionRescoreStorageMethod. \
|
|
7856
|
+
* {@link KnownVectorSearchCompressionRescoreStorageMethod} can be used interchangeably with VectorSearchCompressionRescoreStorageMethod,
|
|
7857
|
+
* this enum contains the known values that the service supports.
|
|
7858
|
+
* ### Known values supported by the service
|
|
7859
|
+
* **preserveOriginals**: This option preserves the original full-precision vectors. Choose this option for maximum flexibility and highest quality of compressed search results. This consumes more storage but allows for rescoring and oversampling. \
|
|
7860
|
+
* **discardOriginals**: This option discards the original full-precision vectors. Choose this option for maximum storage savings. Since this option does not allow for rescoring and oversampling, it will often cause slight to moderate reductions in quality.
|
|
7861
|
+
*/
|
|
7862
|
+
export declare type VectorSearchCompressionRescoreStorageMethod = string;
|
|
7863
|
+
|
|
7615
7864
|
/**
|
|
7616
7865
|
* Defines values for VectorSearchCompressionTarget. \
|
|
7617
7866
|
* {@link KnownVectorSearchCompressionTarget} can be used interchangeably with VectorSearchCompressionTarget,
|