@azure/search-documents 12.0.0-beta.2 → 12.0.0-beta.4
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/README.md +4 -4
- package/dist/index.js +779 -210
- 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/models/index.js +22 -6
- package/dist-esm/src/generated/data/models/index.js.map +1 -1
- package/dist-esm/src/generated/data/models/mappers.js +78 -14
- 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 +30 -6
- package/dist-esm/src/generated/service/models/index.js.map +1 -1
- package/dist-esm/src/generated/service/models/mappers.js +402 -5
- 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.map +1 -1
- package/dist-esm/src/indexModels.js.map +1 -1
- package/dist-esm/src/searchClient.js +7 -7
- package/dist-esm/src/searchClient.js.map +1 -1
- package/dist-esm/src/serviceModels.js.map +1 -1
- package/dist-esm/src/serviceUtils.js +44 -6
- package/dist-esm/src/serviceUtils.js.map +1 -1
- package/package.json +12 -10
- package/types/search-documents.d.ts +236 -31
|
@@ -275,6 +275,40 @@ export declare type AzureMachineLearningSkill = BaseSearchIndexerSkill & {
|
|
|
275
275
|
degreeOfParallelism?: number;
|
|
276
276
|
};
|
|
277
277
|
|
|
278
|
+
/** Allows you to generate a vector embedding for a given text input using the Azure Open AI service. */
|
|
279
|
+
export declare interface AzureOpenAIEmbeddingSkill extends BaseSearchIndexerSkill {
|
|
280
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
281
|
+
odatatype: "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill";
|
|
282
|
+
/** The resource uri for your Azure Open AI resource. */
|
|
283
|
+
resourceUri?: string;
|
|
284
|
+
/** ID of your Azure Open AI model deployment on the designated resource. */
|
|
285
|
+
deploymentId?: string;
|
|
286
|
+
/** API key for the designated Azure Open AI resource. */
|
|
287
|
+
apiKey?: string;
|
|
288
|
+
/** The user-assigned managed identity used for outbound connections. */
|
|
289
|
+
authIdentity?: SearchIndexerDataIdentity;
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
/** Contains the parameters specific to using an Azure Open AI service for vectorization at query time. */
|
|
293
|
+
export declare interface AzureOpenAIParameters {
|
|
294
|
+
/** The resource uri for your Azure Open AI resource. */
|
|
295
|
+
resourceUri?: string;
|
|
296
|
+
/** ID of your Azure Open AI model deployment on the designated resource. */
|
|
297
|
+
deploymentId?: string;
|
|
298
|
+
/** API key for the designated Azure Open AI resource. */
|
|
299
|
+
apiKey?: string;
|
|
300
|
+
/** The user-assigned managed identity used for outbound connections. */
|
|
301
|
+
authIdentity?: SearchIndexerDataIdentity;
|
|
302
|
+
}
|
|
303
|
+
|
|
304
|
+
/** Contains the parameters specific to using an Azure Open AI service for vectorization at query time. */
|
|
305
|
+
export declare type AzureOpenAIVectorizer = BaseVectorSearchVectorizer & {
|
|
306
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
307
|
+
kind: "azureOpenAI";
|
|
308
|
+
/** Contains the parameters specific to Azure Open AI embedding vectorization. */
|
|
309
|
+
azureOpenAIParameters?: AzureOpenAIParameters;
|
|
310
|
+
};
|
|
311
|
+
|
|
278
312
|
/** Base type for character filters. */
|
|
279
313
|
export declare interface BaseCharFilter {
|
|
280
314
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -300,7 +334,7 @@ export declare interface BaseDataChangeDetectionPolicy {
|
|
|
300
334
|
/** Base type for data deletion detection policies. */
|
|
301
335
|
export declare interface BaseDataDeletionDetectionPolicy {
|
|
302
336
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
303
|
-
odatatype: "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy";
|
|
337
|
+
odatatype: "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy" | "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy";
|
|
304
338
|
}
|
|
305
339
|
|
|
306
340
|
/** Base type for analyzers. */
|
|
@@ -348,7 +382,7 @@ export declare interface BaseSearchIndexerDataIdentity {
|
|
|
348
382
|
/** Base type for skills. */
|
|
349
383
|
export declare interface BaseSearchIndexerSkill {
|
|
350
384
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
351
|
-
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";
|
|
385
|
+
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";
|
|
352
386
|
/** 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 '#'. */
|
|
353
387
|
name?: string;
|
|
354
388
|
/** The description of the skill which describes the inputs, outputs, and usage of the skill. */
|
|
@@ -369,14 +403,34 @@ export declare interface BaseTokenFilter {
|
|
|
369
403
|
name: string;
|
|
370
404
|
}
|
|
371
405
|
|
|
372
|
-
/**
|
|
406
|
+
/** The query parameters for vector and hybrid search queries. */
|
|
407
|
+
export declare interface BaseVectorQuery<TModel extends object> {
|
|
408
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
409
|
+
kind: VectorQueryKind;
|
|
410
|
+
/** Number of nearest neighbors to return as top hits. */
|
|
411
|
+
kNearestNeighborsCount?: number;
|
|
412
|
+
/** Vector Fields of type Collection(Edm.Single) to be included in the vector searched. */
|
|
413
|
+
fields?: SearchFieldArray<TModel>;
|
|
414
|
+
/** When true, triggers an exhaustive k-nearest neighbor search across all vectors within the vector index. Useful for scenarios where exact matches are critical, such as determining ground truth values. */
|
|
415
|
+
exhaustive?: boolean;
|
|
416
|
+
}
|
|
417
|
+
|
|
418
|
+
/** Contains configuration options specific to the algorithm used during indexing and/or querying. */
|
|
373
419
|
export declare interface BaseVectorSearchAlgorithmConfiguration {
|
|
374
420
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
375
|
-
kind:
|
|
421
|
+
kind: VectorSearchAlgorithmKind;
|
|
376
422
|
/** The name to associate with this particular configuration. */
|
|
377
423
|
name: string;
|
|
378
424
|
}
|
|
379
425
|
|
|
426
|
+
/** Contains specific details for a vectorization method to be used during query time. */
|
|
427
|
+
export declare interface BaseVectorSearchVectorizer {
|
|
428
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
429
|
+
kind: VectorSearchVectorizerKind;
|
|
430
|
+
/** The name to associate with this particular vectorization method. */
|
|
431
|
+
name: string;
|
|
432
|
+
}
|
|
433
|
+
|
|
380
434
|
/**
|
|
381
435
|
* Defines values for BlobIndexerDataToExtract. \
|
|
382
436
|
* {@link KnownBlobIndexerDataToExtract} can be used interchangeably with BlobIndexerDataToExtract,
|
|
@@ -814,6 +868,30 @@ export declare type CustomNormalizer = BaseLexicalNormalizer & {
|
|
|
814
868
|
charFilters?: CharFilterName[];
|
|
815
869
|
};
|
|
816
870
|
|
|
871
|
+
/** Contains the parameters specific to generating vector embeddings via a custom endpoint. */
|
|
872
|
+
export declare type CustomVectorizer = BaseVectorSearchVectorizer & {
|
|
873
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
874
|
+
kind: "customWebApi";
|
|
875
|
+
/** Contains the parameters specific to generating vector embeddings via a custom endpoint. */
|
|
876
|
+
customVectorizerParameters?: CustomVectorizerParameters;
|
|
877
|
+
};
|
|
878
|
+
|
|
879
|
+
/** Contains the parameters specific to generating vector embeddings via a custom endpoint. */
|
|
880
|
+
export declare interface CustomVectorizerParameters {
|
|
881
|
+
/** The uri for the Web API. */
|
|
882
|
+
uri?: string;
|
|
883
|
+
/** The headers required to make the http request. */
|
|
884
|
+
httpHeaders?: Record<string, string>;
|
|
885
|
+
/** The method for the http request. */
|
|
886
|
+
httpMethod?: string;
|
|
887
|
+
/** The desired timeout for the request. Default is 30 seconds. */
|
|
888
|
+
timeout?: string;
|
|
889
|
+
/** Applies to custom endpoints that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the vectorization connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token. */
|
|
890
|
+
authResourceId?: string;
|
|
891
|
+
/** The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. */
|
|
892
|
+
authIdentity?: SearchIndexerDataIdentity;
|
|
893
|
+
}
|
|
894
|
+
|
|
817
895
|
/**
|
|
818
896
|
* Contains the possible cases for DataChangeDetectionPolicy.
|
|
819
897
|
*/
|
|
@@ -822,7 +900,7 @@ export declare type DataChangeDetectionPolicy = HighWaterMarkChangeDetectionPoli
|
|
|
822
900
|
/**
|
|
823
901
|
* Contains the possible cases for DataDeletionDetectionPolicy.
|
|
824
902
|
*/
|
|
825
|
-
export declare type DataDeletionDetectionPolicy = SoftDeleteColumnDeletionDetectionPolicy;
|
|
903
|
+
export declare type DataDeletionDetectionPolicy = SoftDeleteColumnDeletionDetectionPolicy | NativeBlobSoftDeleteDeletionDetectionPolicy;
|
|
826
904
|
|
|
827
905
|
/**
|
|
828
906
|
* Default Batch Size
|
|
@@ -1111,6 +1189,20 @@ export declare type EntityRecognitionSkillV3 = BaseSearchIndexerSkill & {
|
|
|
1111
1189
|
|
|
1112
1190
|
export declare type ExcludedODataTypes = Date | GeographyPoint;
|
|
1113
1191
|
|
|
1192
|
+
/** Contains the parameters specific to exhaustive KNN algorithm. */
|
|
1193
|
+
export declare interface ExhaustiveKnnParameters {
|
|
1194
|
+
/** The similarity metric to use for vector comparisons. */
|
|
1195
|
+
metric?: VectorSearchAlgorithmMetric;
|
|
1196
|
+
}
|
|
1197
|
+
|
|
1198
|
+
/** Contains configuration options specific to the exhaustive KNN algorithm used during querying, which will perform brute-force search across the entire vector index. */
|
|
1199
|
+
export declare type ExhaustiveKnnVectorSearchAlgorithmConfiguration = BaseVectorSearchAlgorithmConfiguration & {
|
|
1200
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1201
|
+
kind: "exhaustiveKnn";
|
|
1202
|
+
/** Contains the parameters specific to exhaustive KNN algorithm. */
|
|
1203
|
+
parameters?: ExhaustiveKnnParameters;
|
|
1204
|
+
};
|
|
1205
|
+
|
|
1114
1206
|
export declare type ExtractDocumentKey<TModel> = {
|
|
1115
1207
|
[K in keyof TModel as TModel[K] extends string | undefined ? K : never]: TModel[K];
|
|
1116
1208
|
};
|
|
@@ -1700,6 +1792,11 @@ export declare type IndexIterator = PagedAsyncIterableIterator<SearchIndex, Sear
|
|
|
1700
1792
|
*/
|
|
1701
1793
|
export declare type IndexNameIterator = PagedAsyncIterableIterator<string, string[], {}>;
|
|
1702
1794
|
|
|
1795
|
+
/**
|
|
1796
|
+
* Defines behavior of the index projections in relation to the rest of the indexer.
|
|
1797
|
+
*/
|
|
1798
|
+
export declare type IndexProjectionMode = "skipIndexingParentDocuments" | "includeIndexingParentDocuments";
|
|
1799
|
+
|
|
1703
1800
|
/** Input field mapping for a skill. */
|
|
1704
1801
|
export declare interface InputFieldMappingEntry {
|
|
1705
1802
|
/** The name of the input. */
|
|
@@ -4177,6 +4274,12 @@ export declare type MicrosoftTokenizerLanguage = "bangla" | "bulgarian" | "catal
|
|
|
4177
4274
|
*/
|
|
4178
4275
|
export declare type NarrowedModel<TModel extends object, TFields extends SelectFields<TModel> = SelectFields<TModel>> = (<T>() => T extends TModel ? true : false) extends <T>() => T extends never ? true : false ? TModel : (<T>() => T extends TModel ? true : false) extends <T>() => T extends object ? true : false ? TModel : (<T>() => T extends TModel ? true : false) extends <T>() => T extends any ? true : false ? TModel : (<T>() => T extends TModel ? true : false) extends <T>() => T extends unknown ? true : false ? TModel : (<T>() => T extends TFields ? true : false) extends <T>() => T extends never ? true : false ? never : (<T>() => T extends TFields ? true : false) extends <T>() => T extends SelectFields<TModel> ? true : false ? TModel : SearchPick<TModel, TFields>;
|
|
4179
4276
|
|
|
4277
|
+
/** Defines a data deletion detection policy utilizing Azure Blob Storage's native soft delete feature for deletion detection. */
|
|
4278
|
+
export declare type NativeBlobSoftDeleteDeletionDetectionPolicy = BaseDataDeletionDetectionPolicy & {
|
|
4279
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
4280
|
+
odatatype: "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy";
|
|
4281
|
+
};
|
|
4282
|
+
|
|
4180
4283
|
/**
|
|
4181
4284
|
* Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.
|
|
4182
4285
|
*/
|
|
@@ -4745,6 +4848,14 @@ export declare type QuerySpellerType = string;
|
|
|
4745
4848
|
/** Defines values for QueryType. */
|
|
4746
4849
|
export declare type QueryType = "simple" | "full" | "semantic";
|
|
4747
4850
|
|
|
4851
|
+
/** The query parameters to use for vector search when a raw vector value is provided. */
|
|
4852
|
+
export declare interface RawVectorQuery<TModel extends object> extends BaseVectorQuery<TModel> {
|
|
4853
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
4854
|
+
kind: "vector";
|
|
4855
|
+
/** The vector representation of a search query. */
|
|
4856
|
+
vector?: number[];
|
|
4857
|
+
}
|
|
4858
|
+
|
|
4748
4859
|
/**
|
|
4749
4860
|
* Defines values for RegexFlags. \
|
|
4750
4861
|
* {@link KnownRegexFlags} can be used interchangeably with RegexFlags,
|
|
@@ -5075,12 +5186,12 @@ export declare class SearchClient<TModel extends object> implements IndexDocumen
|
|
|
5075
5186
|
private encodeContinuationToken;
|
|
5076
5187
|
private decodeContinuationToken;
|
|
5077
5188
|
private convertSelect;
|
|
5078
|
-
private
|
|
5189
|
+
private convertVectorQueryFields;
|
|
5079
5190
|
private convertSearchFields;
|
|
5080
5191
|
private convertSemanticFields;
|
|
5081
5192
|
private convertOrderBy;
|
|
5082
5193
|
private convertAnswers;
|
|
5083
|
-
private
|
|
5194
|
+
private convertVectorQuery;
|
|
5084
5195
|
}
|
|
5085
5196
|
|
|
5086
5197
|
/**
|
|
@@ -5898,6 +6009,34 @@ export declare interface SearchIndexerError {
|
|
|
5898
6009
|
readonly documentationLink?: string;
|
|
5899
6010
|
}
|
|
5900
6011
|
|
|
6012
|
+
/** Definition of additional projections to secondary search indexes. */
|
|
6013
|
+
export declare interface SearchIndexerIndexProjections {
|
|
6014
|
+
/** A list of projections to be performed to secondary search indexes. */
|
|
6015
|
+
selectors: SearchIndexerIndexProjectionSelector[];
|
|
6016
|
+
/** A dictionary of index projection-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. */
|
|
6017
|
+
parameters?: SearchIndexerIndexProjectionsParameters;
|
|
6018
|
+
}
|
|
6019
|
+
|
|
6020
|
+
/** Description for what data to store in the designated search index. */
|
|
6021
|
+
export declare interface SearchIndexerIndexProjectionSelector {
|
|
6022
|
+
/** Name of the search index to project to. Must have a key field with the 'keyword' analyzer set. */
|
|
6023
|
+
targetIndexName: string;
|
|
6024
|
+
/** Name of the field in the search index to map the parent document's key value to. Must be a string field that is filterable and not the key field. */
|
|
6025
|
+
parentKeyFieldName: string;
|
|
6026
|
+
/** Source context for the projections. Represents the cardinality at which the document will be split into multiple sub documents. */
|
|
6027
|
+
sourceContext: string;
|
|
6028
|
+
/** Mappings for the projection, or which source should be mapped to which field in the target index. */
|
|
6029
|
+
mappings: InputFieldMappingEntry[];
|
|
6030
|
+
}
|
|
6031
|
+
|
|
6032
|
+
/** A dictionary of index projection-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. */
|
|
6033
|
+
export declare interface SearchIndexerIndexProjectionsParameters {
|
|
6034
|
+
/** Describes unknown properties.*/
|
|
6035
|
+
[property: string]: unknown;
|
|
6036
|
+
/** Defines behavior of the index projections in relation to the rest of the indexer. */
|
|
6037
|
+
projectionMode?: IndexProjectionMode;
|
|
6038
|
+
}
|
|
6039
|
+
|
|
5901
6040
|
/**
|
|
5902
6041
|
* Definition of additional projections to azure blob, table, or files, of enriched data.
|
|
5903
6042
|
*/
|
|
@@ -5932,6 +6071,14 @@ export declare type SearchIndexerKnowledgeStoreFileProjectionSelector = SearchIn
|
|
|
5932
6071
|
/** Projection definition for what data to store in Azure Blob. */
|
|
5933
6072
|
export declare type SearchIndexerKnowledgeStoreObjectProjectionSelector = SearchIndexerKnowledgeStoreBlobProjectionSelector & {};
|
|
5934
6073
|
|
|
6074
|
+
/** A dictionary of knowledge store-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. */
|
|
6075
|
+
export declare interface SearchIndexerKnowledgeStoreParameters {
|
|
6076
|
+
/** Describes unknown properties. The value of an unknown property can be of "any" type. */
|
|
6077
|
+
[property: string]: unknown;
|
|
6078
|
+
/** Whether or not projections should synthesize a generated key name if one isn't already present. */
|
|
6079
|
+
synthesizeGeneratedKeyName?: boolean;
|
|
6080
|
+
}
|
|
6081
|
+
|
|
5935
6082
|
/** Container object for various projection selectors. */
|
|
5936
6083
|
export declare interface SearchIndexerKnowledgeStoreProjection {
|
|
5937
6084
|
/** Projections to Azure Table storage. */
|
|
@@ -5983,7 +6130,7 @@ export declare interface SearchIndexerLimits {
|
|
|
5983
6130
|
/**
|
|
5984
6131
|
* Contains the possible cases for Skill.
|
|
5985
6132
|
*/
|
|
5986
|
-
export declare type SearchIndexerSkill = ConditionalSkill | KeyPhraseExtractionSkill | OcrSkill | ImageAnalysisSkill | LanguageDetectionSkill | ShaperSkill | MergeSkill | EntityRecognitionSkill | SentimentSkill | SplitSkill | PIIDetectionSkill | EntityRecognitionSkillV3 | EntityLinkingSkill | SentimentSkillV3 | CustomEntityLookupSkill | TextTranslationSkill | DocumentExtractionSkill | WebApiSkill | AzureMachineLearningSkill;
|
|
6133
|
+
export declare type SearchIndexerSkill = ConditionalSkill | KeyPhraseExtractionSkill | OcrSkill | ImageAnalysisSkill | LanguageDetectionSkill | ShaperSkill | MergeSkill | EntityRecognitionSkill | SentimentSkill | SplitSkill | PIIDetectionSkill | EntityRecognitionSkillV3 | EntityLinkingSkill | SentimentSkillV3 | CustomEntityLookupSkill | TextTranslationSkill | DocumentExtractionSkill | WebApiSkill | AzureMachineLearningSkill | AzureOpenAIEmbeddingSkill;
|
|
5987
6134
|
|
|
5988
6135
|
/**
|
|
5989
6136
|
* A list of skills.
|
|
@@ -6009,6 +6156,10 @@ export declare interface SearchIndexerSkillset {
|
|
|
6009
6156
|
* Definition of additional projections to azure blob, table, or files, of enriched data.
|
|
6010
6157
|
*/
|
|
6011
6158
|
knowledgeStore?: SearchIndexerKnowledgeStore;
|
|
6159
|
+
/**
|
|
6160
|
+
* Definition of additional projections to secondary search index(es).
|
|
6161
|
+
*/
|
|
6162
|
+
indexProjections?: SearchIndexerIndexProjections;
|
|
6012
6163
|
/**
|
|
6013
6164
|
* The ETag of the skillset.
|
|
6014
6165
|
*/
|
|
@@ -6434,14 +6585,20 @@ export declare interface SearchRequest<TModel extends object = never> {
|
|
|
6434
6585
|
* the results.
|
|
6435
6586
|
*/
|
|
6436
6587
|
scoringProfile?: string;
|
|
6588
|
+
/**
|
|
6589
|
+
* Allows setting a separate search query that will be solely used for semantic reranking,
|
|
6590
|
+
* semantic captions and semantic answers. Is useful for scenarios where there is a need to use
|
|
6591
|
+
* different queries between the base retrieval and ranking phase, and the L2 semantic phase.
|
|
6592
|
+
*/
|
|
6593
|
+
semanticQuery?: string;
|
|
6437
6594
|
/**
|
|
6438
6595
|
* The name of a semantic configuration that will be used when processing documents for queries of
|
|
6439
6596
|
* type semantic.
|
|
6440
6597
|
*/
|
|
6441
6598
|
semanticConfiguration?: string;
|
|
6442
6599
|
/**
|
|
6443
|
-
* Allows the user to choose whether a semantic call should fail completely
|
|
6444
|
-
*
|
|
6600
|
+
* Allows the user to choose whether a semantic call should fail completely, or to return partial
|
|
6601
|
+
* results (default).
|
|
6445
6602
|
*/
|
|
6446
6603
|
semanticErrorHandlingMode?: SemanticErrorHandlingMode;
|
|
6447
6604
|
/**
|
|
@@ -6508,9 +6665,14 @@ export declare interface SearchRequest<TModel extends object = never> {
|
|
|
6508
6665
|
*/
|
|
6509
6666
|
semanticFields?: string;
|
|
6510
6667
|
/**
|
|
6511
|
-
* The query parameters for vector and
|
|
6668
|
+
* The query parameters for vector, hybrid, and multi-vector search queries.
|
|
6512
6669
|
*/
|
|
6513
|
-
|
|
6670
|
+
vectorQueries?: VectorQuery<TModel>[];
|
|
6671
|
+
/**
|
|
6672
|
+
* Determines whether or not filters are applied before or after the vector search is performed.
|
|
6673
|
+
* Default is 'preFilter'.
|
|
6674
|
+
*/
|
|
6675
|
+
vectorFilterMode?: VectorFilterMode;
|
|
6514
6676
|
}
|
|
6515
6677
|
|
|
6516
6678
|
/**
|
|
@@ -6579,13 +6741,20 @@ export declare interface SearchRequestOptions<TModel extends object, TFields ext
|
|
|
6579
6741
|
* the results.
|
|
6580
6742
|
*/
|
|
6581
6743
|
scoringProfile?: string;
|
|
6744
|
+
/**
|
|
6745
|
+
* Allows setting a separate search query that will be solely used for semantic reranking,
|
|
6746
|
+
* semantic captions and semantic answers. Is useful for scenarios where there is a need to use
|
|
6747
|
+
* different queries between the base retrieval and ranking phase, and the L2 semantic phase.
|
|
6748
|
+
*/
|
|
6749
|
+
semanticQuery?: string;
|
|
6582
6750
|
/**
|
|
6583
6751
|
* The name of a semantic configuration that will be used when processing documents for queries of
|
|
6584
6752
|
* type semantic.
|
|
6585
6753
|
*/
|
|
6586
6754
|
semanticConfiguration?: string;
|
|
6587
6755
|
/**
|
|
6588
|
-
*
|
|
6756
|
+
* Allows the user to choose whether a semantic call should fail completely, or to return
|
|
6757
|
+
* partial results (default).
|
|
6589
6758
|
*/
|
|
6590
6759
|
semanticErrorHandlingMode?: SemanticErrorHandlingMode;
|
|
6591
6760
|
/**
|
|
@@ -6667,7 +6836,12 @@ export declare interface SearchRequestOptions<TModel extends object, TFields ext
|
|
|
6667
6836
|
/**
|
|
6668
6837
|
* The query parameters for vector and hybrid search queries.
|
|
6669
6838
|
*/
|
|
6670
|
-
|
|
6839
|
+
vectorQueries?: VectorQuery<TModel>[];
|
|
6840
|
+
/**
|
|
6841
|
+
* Determines whether or not filters are applied before or after the vector search is performed.
|
|
6842
|
+
* Default is 'preFilter'.
|
|
6843
|
+
*/
|
|
6844
|
+
vectorFilterMode?: VectorFilterMode;
|
|
6671
6845
|
}
|
|
6672
6846
|
|
|
6673
6847
|
/**
|
|
@@ -7095,7 +7269,7 @@ export declare interface SimpleField {
|
|
|
7095
7269
|
* The name of the vector search algorithm configuration that specifies the algorithm and
|
|
7096
7270
|
* optional parameters for searching the vector field.
|
|
7097
7271
|
*/
|
|
7098
|
-
|
|
7272
|
+
vectorSearchProfile?: string;
|
|
7099
7273
|
}
|
|
7100
7274
|
|
|
7101
7275
|
/** A filter that stems words using a Snowball-generated stemmer. This token filter is implemented using Apache Lucene. */
|
|
@@ -7139,6 +7313,10 @@ export declare type SplitSkill = BaseSearchIndexerSkill & {
|
|
|
7139
7313
|
textSplitMode?: TextSplitMode;
|
|
7140
7314
|
/** The desired maximum page length. Default is 10000. */
|
|
7141
7315
|
maxPageLength?: number;
|
|
7316
|
+
/** Only applicable when textSplitMode is set to 'pages'. If specified, n+1th chunk will start with this number of characters/tokens from the end of the nth chunk. */
|
|
7317
|
+
pageOverlapLength?: number;
|
|
7318
|
+
/** Only applicable when textSplitMode is set to 'pages'. If specified, the SplitSkill will discontinue splitting after processing the first 'maximumPagesToTake' pages, in order to improve performance when only a few initial pages are needed from each document. */
|
|
7319
|
+
maximumPagesToTake?: number;
|
|
7142
7320
|
};
|
|
7143
7321
|
|
|
7144
7322
|
/**
|
|
@@ -7550,30 +7728,57 @@ export declare type UniqueTokenFilter = BaseTokenFilter & {
|
|
|
7550
7728
|
*/
|
|
7551
7729
|
export declare type UploadDocumentsOptions = IndexDocumentsOptions;
|
|
7552
7730
|
|
|
7553
|
-
/** The query parameters for vector and hybrid search queries. */
|
|
7554
|
-
export declare interface Vector<T extends object> {
|
|
7555
|
-
/** The vector representation of a search query. */
|
|
7556
|
-
value?: number[];
|
|
7557
|
-
/** Number of nearest neighbors to return as top hits. */
|
|
7558
|
-
kNearestNeighborsCount?: number;
|
|
7559
|
-
/** Vector Fields of type Collection(Edm.Single) to be included in the vector searched. */
|
|
7560
|
-
fields?: SearchFieldArray<T>;
|
|
7561
|
-
}
|
|
7562
|
-
|
|
7563
7731
|
/**
|
|
7564
|
-
*
|
|
7732
|
+
* Determines whether or not filters are applied before or after the vector search is performed.
|
|
7565
7733
|
*/
|
|
7734
|
+
export declare type VectorFilterMode = "postFilter" | "preFilter";
|
|
7735
|
+
|
|
7736
|
+
/** The query parameters to use for vector search when a text value that needs to be vectorized is provided. */
|
|
7737
|
+
export declare interface VectorizableTextQuery<TModel extends object> extends BaseVectorQuery<TModel> {
|
|
7738
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
7739
|
+
kind: "text";
|
|
7740
|
+
/** The text to be vectorized to perform a vector search query. */
|
|
7741
|
+
text?: string;
|
|
7742
|
+
}
|
|
7743
|
+
|
|
7744
|
+
/** The query parameters for vector and hybrid search queries. */
|
|
7745
|
+
export declare type VectorQuery<TModel extends object> = RawVectorQuery<TModel> | VectorizableTextQuery<TModel>;
|
|
7746
|
+
|
|
7747
|
+
export declare type VectorQueryKind = "vector" | "text";
|
|
7748
|
+
|
|
7749
|
+
/** Contains configuration options related to vector search. */
|
|
7566
7750
|
export declare interface VectorSearch {
|
|
7567
|
-
/**
|
|
7568
|
-
|
|
7569
|
-
|
|
7570
|
-
|
|
7751
|
+
/** Defines combinations of configurations to use with vector search. */
|
|
7752
|
+
profiles?: VectorSearchProfile[];
|
|
7753
|
+
/** Contains configuration options specific to the algorithm used during indexing and/or querying. */
|
|
7754
|
+
algorithms?: VectorSearchAlgorithmConfiguration[];
|
|
7755
|
+
/** Contains configuration options on how to vectorize text vector queries. */
|
|
7756
|
+
vectorizers?: VectorSearchVectorizer[];
|
|
7571
7757
|
}
|
|
7572
7758
|
|
|
7573
|
-
|
|
7759
|
+
/** Contains configuration options specific to the algorithm used during indexing and/or querying. */
|
|
7760
|
+
export declare type VectorSearchAlgorithmConfiguration = HnswVectorSearchAlgorithmConfiguration | ExhaustiveKnnVectorSearchAlgorithmConfiguration;
|
|
7761
|
+
|
|
7762
|
+
export declare type VectorSearchAlgorithmKind = "hnsw" | "exhaustiveKnn";
|
|
7574
7763
|
|
|
7764
|
+
/** The similarity metric to use for vector comparisons. */
|
|
7575
7765
|
export declare type VectorSearchAlgorithmMetric = "cosine" | "euclidean" | "dotProduct";
|
|
7576
7766
|
|
|
7767
|
+
/** Defines a combination of configurations to use with vector search. */
|
|
7768
|
+
export declare interface VectorSearchProfile {
|
|
7769
|
+
/** The name to associate with this particular vector search profile. */
|
|
7770
|
+
name: string;
|
|
7771
|
+
/** The name of the vector search algorithm configuration that specifies the algorithm and optional parameters. */
|
|
7772
|
+
algorithm: string;
|
|
7773
|
+
/** The name of the kind of vectorization method being configured for use with vector search. */
|
|
7774
|
+
vectorizer?: string;
|
|
7775
|
+
}
|
|
7776
|
+
|
|
7777
|
+
/** Contains configuration options on how to vectorize text vector queries. */
|
|
7778
|
+
export declare type VectorSearchVectorizer = AzureOpenAIVectorizer | CustomVectorizer;
|
|
7779
|
+
|
|
7780
|
+
export declare type VectorSearchVectorizerKind = "azureOpenAI" | "customWebApi";
|
|
7781
|
+
|
|
7577
7782
|
/**
|
|
7578
7783
|
* Defines values for VisualFeature. \
|
|
7579
7784
|
* {@link KnownVisualFeature} can be used interchangeably with VisualFeature,
|