@azure/search-documents 12.1.0-alpha.20240513.1 → 12.1.0-beta.2

package/types/search-documents.d.ts

@@ -9,6 +9,40 @@ import { Pipeline } from '@azure/core-rest-pipeline';
 import { RestError } from '@azure/core-rest-pipeline';
 import { TokenCredential } from '@azure/core-auth';
 
+/** Specifies the AI Services Vision parameters for vectorizing a query image or text. */
+export declare interface AIServicesVisionParameters {
+    /** The version of the model to use when calling the AI Services Vision service. It will default to the latest available when not specified. */
+    modelVersion?: string;
+    /** The resource URI of the AI Services resource. */
+    resourceUri: string;
+    /** API key of the designated AI Services resource. */
+    apiKey?: string;
+    /** 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 index, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. */
+    authIdentity?: SearchIndexerDataIdentity;
+}
+
+/** Specifies the AI Services Vision parameters for vectorizing a query image or text. */
+export declare interface AIServicesVisionVectorizer extends BaseVectorSearchVectorizer {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    kind: "aiServicesVision";
+    /** Contains the parameters specific to AI Services Vision embedding vectorization. */
+    aIServicesVisionParameters?: AIServicesVisionParameters;
+}
+
+/**
+ * Defines values for AIStudioModelCatalogName. \
+ * {@link KnownAIStudioModelCatalogName} can be used interchangeably with AIStudioModelCatalogName,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32** \
+ * **OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336** \
+ * **Facebook-DinoV2-Image-Embeddings-ViT-Base** \
+ * **Facebook-DinoV2-Image-Embeddings-ViT-Giant** \
+ * **Cohere-embed-v3-english** \
+ * **Cohere-embed-v3-multilingual**
+ */
+export declare type AIStudioModelCatalogName = string;
+
 /**
  * An iterator for listing the aliases that exist in the Search service. Will make requests
  * as needed during iteration. Use .byPage() to make one request to the server
@@ -214,20 +248,37 @@ export declare interface AzureMachineLearningSkill extends BaseSearchIndexerSkil
     degreeOfParallelism?: number;
 }
 
-/** Allows you to generate a vector embedding for a given text input using the Azure Open AI service. */
-export declare interface AzureOpenAIEmbeddingSkill extends BaseSearchIndexerSkill {
+/** Specifies an Azure Machine Learning endpoint deployed via the Azure AI Studio Model Catalog for generating the vector embedding of a query string. */
+export declare interface AzureMachineLearningVectorizer extends BaseVectorSearchVectorizer {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    kind: "aml";
+    /** Specifies the properties of the AML vectorizer. */
+    amlParameters?: AzureMachineLearningVectorizerParameters;
+}
+
+/** Specifies the properties for connecting to an AML vectorizer. */
+export declare type AzureMachineLearningVectorizerParameters = NoAuthAzureMachineLearningVectorizerParameters | KeyAuthAzureMachineLearningVectorizerParameters | TokenAuthAzureMachineLearningVectorizerParameters;
+
+/** Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource. */
+export declare interface AzureOpenAIEmbeddingSkill extends BaseSearchIndexerSkill, AzureOpenAIParameters {
     /** Polymorphic discriminator, which specifies the different types this object can be */
     odatatype: "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill";
-    /** The resource uri for your Azure Open AI resource. */
-    resourceUri?: string;
-    /** ID of your Azure Open AI model deployment on the designated resource. */
-    deploymentId?: string;
-    /** API key for the designated Azure Open AI resource. */
-    apiKey?: string;
-    /** The user-assigned managed identity used for outbound connections. */
-    authIdentity?: SearchIndexerDataIdentity;
+    /** The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models. */
+    dimensions?: number;
 }
 
+/**
+ * Defines values for AzureOpenAIModelName. \
+ * {@link KnownAzureOpenAIModelName} can be used interchangeably with AzureOpenAIModelName,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **text-embedding-ada-002** \
+ * **text-embedding-3-large** \
+ * **text-embedding-3-small** \
+ * **experimental**
+ */
+export declare type AzureOpenAIModelName = string;
+
 /** Contains the parameters specific to using an Azure Open AI service for vectorization at query time. */
 export declare interface AzureOpenAIParameters {
     /** The resource uri for your Azure Open AI resource. */
@@ -238,15 +289,25 @@ export declare interface AzureOpenAIParameters {
     apiKey?: string;
     /** The user-assigned managed identity used for outbound connections. */
     authIdentity?: SearchIndexerDataIdentity;
+    /** The name of the embedding model that is deployed at the provided deploymentId path. */
+    modelName?: AzureOpenAIModelName;
 }
 
 /** Contains the parameters specific to using an Azure Open AI service for vectorization at query time. */
-export declare type AzureOpenAIVectorizer = BaseVectorSearchVectorizer & {
+export declare interface AzureOpenAIVectorizer extends BaseVectorSearchVectorizer {
     /** Polymorphic discriminator, which specifies the different types this object can be */
     kind: "azureOpenAI";
     /** Contains the parameters specific to Azure Open AI embedding vectorization. */
     azureOpenAIParameters?: AzureOpenAIParameters;
-};
+}
+
+/** Specifies the properties common between all AML vectorizer auth types. */
+export declare interface BaseAzureMachineLearningVectorizerParameters {
+    /** When specified, indicates the timeout for the http client making the API call. */
+    timeout?: string;
+    /** The name of the embedding model from the Azure AI Studio Catalog that is deployed at the provided endpoint. */
+    modelName?: AIStudioModelCatalogName;
+}
 
 /** Base type for character filters. */
 export declare interface BaseCharFilter {
@@ -321,7 +382,7 @@ export declare interface BaseSearchIndexerDataIdentity {
 /** Base type for skills. */
 export declare interface BaseSearchIndexerSkill {
     /** Polymorphic discriminator, which specifies the different types this object can be */
-    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";
+    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";
     /** 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 '#'. */
     name?: string;
     /** The description of the skill which describes the inputs, outputs, and usage of the skill. */
@@ -455,6 +516,8 @@ export declare interface BaseSearchRequestOptions<TModel extends object, TFields
      * Defines options for vector search queries
      */
     vectorSearchOptions?: VectorSearchOptions<TModel>;
+    /** The query parameters to configure hybrid search behaviors. */
+    hybridSearch?: HybridSearchOptions;
 }
 
 /** Base type for token filters. */
@@ -467,7 +530,13 @@ export declare interface BaseTokenFilter {
 
 /** The query parameters for vector and hybrid search queries. */
 export declare interface BaseVectorQuery<TModel extends object> {
-    /** Polymorphic discriminator, which specifies the different types this object can be */
+    /**
+     * ### Known values supported by the service
+     * **vector**: Vector query where a raw vector value is provided.
+     * **text**: Vector query where a text value that needs to be vectorized is provided.
+     * **imageUrl**: Vector query where an url that represents an image value that needs to be vectorized is provided.
+     * **imageBinary**: Vector query where a base 64 encoded binary of an image that needs to be vectorized is provided.
+     */
     kind: VectorQueryKind;
     /** Number of nearest neighbors to return as top hits. */
     kNearestNeighborsCount?: number;
@@ -486,6 +555,10 @@ export declare interface BaseVectorQuery<TModel extends object> {
      * vector field.
      */
     oversampling?: number;
+    /** Relative weight of the vector query when compared to other vector query and/or the text query within the same search request. This value is used when combining the results of multiple ranking lists produced by the different vector queries and/or the results retrieved through the text query. The higher the weight, the higher the documents that matched that query will be in the final ranking. Default is 1.0 and the value needs to be a positive number larger than zero. */
+    weight?: number;
+    /** The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric. */
+    threshold?: VectorThreshold;
 }
 
 /** Contains configuration options specific to the algorithm used during indexing and/or querying. */
@@ -516,6 +589,12 @@ export declare interface BaseVectorSearchVectorizer {
     name: string;
 }
 
+/** The threshold used for vector queries. */
+export declare interface BaseVectorThreshold {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    kind: "vectorSimilarity" | "searchScore";
+}
+
 export declare type BlobIndexerDataToExtract = "storageMetadata" | "allMetadata" | "contentAndMetadata";
 
 export declare type BlobIndexerImageAction = "none" | "generateNormalizedImages" | "generateNormalizedImagePerPage";
@@ -875,12 +954,12 @@ export declare interface CustomNormalizer extends BaseLexicalNormalizer {
 }
 
 /** Contains the parameters specific to generating vector embeddings via a custom endpoint. */
-export declare type CustomVectorizer = BaseVectorSearchVectorizer & {
+export declare interface CustomVectorizer extends BaseVectorSearchVectorizer {
     /** Polymorphic discriminator, which specifies the different types this object can be */
     kind: "customWebApi";
     /** Contains the parameters specific to generating vector embeddings via a custom endpoint. */
     customVectorizerParameters?: CustomVectorizerParameters;
-};
+}
 
 /** Contains the parameters specific to generating vector embeddings via a custom endpoint. */
 export declare interface CustomVectorizerParameters {
@@ -1374,6 +1453,24 @@ export declare interface HnswParameters {
     metric?: VectorSearchAlgorithmMetric;
 }
 
+/**
+ * Defines values for HybridCountAndFacetMode. \
+ * {@link KnownHybridCountAndFacetMode} can be used interchangeably with HybridCountAndFacetMode,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **countRetrievableResults**: Only include documents that were matched within the 'maxTextRecallSize' retrieval window when computing 'count' and 'facets'. \
+ * **countAllResults**: Include all documents that were matched by the search query when computing 'count' and 'facets', regardless of whether or not those documents are within the 'maxTextRecallSize' retrieval window.
+ */
+export declare type HybridCountAndFacetMode = string;
+
+/** TThe query parameters to configure hybrid search behaviors. */
+export declare interface HybridSearchOptions {
+    /** Determines the maximum number of documents to be retrieved by the text query portion of a hybrid search request. Those documents will be combined with the documents matching the vector queries to produce a single final list of results. Choosing a larger maxTextRecallSize value will allow retrieving and paging through more documents (using the top and skip parameters), at the cost of higher resource utilization and higher latency. The value needs to be between 1 and 10,000. Default is 1000. */
+    maxTextRecallSize?: number;
+    /** Determines whether the count and facets should includes all documents that matched the search query, or only the documents that are retrieved within the 'maxTextRecallSize' window. */
+    countAndFacetMode?: HybridCountAndFacetMode;
+}
+
 /** A skill that analyzes image files. It extracts a rich set of visual features based on the image content. */
 export declare interface ImageAnalysisSkill extends BaseSearchIndexerSkill {
     /** Polymorphic discriminator, which specifies the different types this object can be */
@@ -1748,6 +1845,18 @@ export declare interface KeepTokenFilter extends BaseTokenFilter {
     lowerCaseKeepWords?: boolean;
 }
 
+/**
+ * Specifies the properties for connecting to an AML vectorizer with an authentication key.
+ */
+export declare interface KeyAuthAzureMachineLearningVectorizerParameters extends BaseAzureMachineLearningVectorizerParameters {
+    /** Indicates how the service should attempt to identify itself to the AML instance */
+    authKind: "key";
+    /** The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed. */
+    scoringUri: string;
+    /** The key for the AML service. */
+    authenticationKey: string;
+}
+
 /** A skill that uses text analytics for key phrase extraction. */
 export declare interface KeyPhraseExtractionSkill extends BaseSearchIndexerSkill {
     /** Polymorphic discriminator, which specifies the different types this object can be */
@@ -1793,6 +1902,22 @@ export declare interface KeywordTokenizer {
     maxTokenLength?: number;
 }
 
+/** Known values of {@link AIStudioModelCatalogName} that the service accepts. */
+export declare enum KnownAIStudioModelCatalogName {
+    /** OpenAIClipImageTextEmbeddingsVitBasePatch32 */
+    OpenAIClipImageTextEmbeddingsVitBasePatch32 = "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32",
+    /** OpenAIClipImageTextEmbeddingsViTLargePatch14336 */
+    OpenAIClipImageTextEmbeddingsViTLargePatch14336 = "OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336",
+    /** FacebookDinoV2ImageEmbeddingsViTBase */
+    FacebookDinoV2ImageEmbeddingsViTBase = "Facebook-DinoV2-Image-Embeddings-ViT-Base",
+    /** FacebookDinoV2ImageEmbeddingsViTGiant */
+    FacebookDinoV2ImageEmbeddingsViTGiant = "Facebook-DinoV2-Image-Embeddings-ViT-Giant",
+    /** CohereEmbedV3English */
+    CohereEmbedV3English = "Cohere-embed-v3-english",
+    /** CohereEmbedV3Multilingual */
+    CohereEmbedV3Multilingual = "Cohere-embed-v3-multilingual"
+}
+
 /**
  * Defines values for AnalyzerName.
  * See https://docs.microsoft.com/rest/api/searchservice/Language-support
@@ -2172,6 +2297,18 @@ export declare enum KnownAnalyzerNames {
     Whitespace = "whitespace"
 }
 
+/** Known values of {@link AzureOpenAIModelName} that the service accepts. */
+export declare enum KnownAzureOpenAIModelName {
+    /** TextEmbeddingAda002 */
+    TextEmbeddingAda002 = "text-embedding-ada-002",
+    /** TextEmbedding3Large */
+    TextEmbedding3Large = "text-embedding-3-large",
+    /** TextEmbedding3Small */
+    TextEmbedding3Small = "text-embedding-3-small",
+    /** Experimental */
+    Experimental = "experimental"
+}
+
 /** Known values of {@link BlobIndexerDataToExtract} that the service accepts. */
 export declare enum KnownBlobIndexerDataToExtract {
     /** Indexes just the standard blob properties and user-specified metadata. */
@@ -2324,6 +2461,14 @@ export declare enum KnownEntityRecognitionSkillLanguage {
     Tr = "tr"
 }
 
+/** Known values of {@link HybridCountAndFacetMode} that the service accepts. */
+export declare enum KnownHybridCountAndFacetMode {
+    /** Only include documents that were matched within the 'maxTextRecallSize' retrieval window when computing 'count' and 'facets'. */
+    CountRetrievableResults = "countRetrievableResults",
+    /** Include all documents that were matched by the search query when computing 'count' and 'facets', regardless of whether or not those documents are within the 'maxTextRecallSize' retrieval window. */
+    CountAllResults = "countAllResults"
+}
+
 /** Known values of {@link ImageAnalysisSkillLanguage} that the service accepts. */
 export declare enum KnownImageAnalysisSkillLanguage {
     /** Arabic */
@@ -3321,7 +3466,9 @@ export declare enum KnownSearchIndexerDataSourceType {
     /** Indicates a MySql datasource. */
     MySql = "mysql",
     /** Indicates an ADLS Gen2 datasource. */
-    AdlsGen2 = "adlsgen2"
+    AdlsGen2 = "adlsgen2",
+    /** Indicates a Microsoft Fabric OneLake datasource. */
+    OneLake = "onelake"
 }
 
 /** Known values of {@link SemanticErrorMode} that the service accepts. */
@@ -3954,12 +4101,22 @@ export declare enum KnownTokenizerNames {
     Whitespace = "whitespace"
 }
 
+/** Known values of {@link VectorEncodingFormat} that the service accepts. */
+export declare enum KnownVectorEncodingFormat {
+    /** Encoding format representing bits packed into a wider data type. */
+    PackedBit = "packedBit"
+}
+
 /** Known values of {@link VectorQueryKind} that the service accepts. */
 export declare enum KnownVectorQueryKind {
     /** Vector query where a raw vector value is provided. */
     Vector = "vector",
     /** Vector query where a text value that needs to be vectorized is provided. */
-    Text = "text"
+    Text = "text",
+    /** Vector query where an url that represents an image value that needs to be vectorized is provided. */
+    ImageUrl = "imageUrl",
+    /** Vector query where a base 64 encoded binary of an image that needs to be vectorized is provided. */
+    ImageBinary = "imageBinary"
 }
 
 /** Known values of {@link VectorSearchCompressionKind} that the service accepts. */
@@ -3979,7 +4136,19 @@ export declare enum KnownVectorSearchVectorizerKind {
     /** Generate embeddings using an Azure OpenAI resource at query time. */
     AzureOpenAI = "azureOpenAI",
     /** Generate embeddings using a custom web endpoint at query time. */
-    CustomWebApi = "customWebApi"
+    CustomWebApi = "customWebApi",
+    /** Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API. */
+    AIServicesVision = "aiServicesVision",
+    /** Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Studio Model Catalog at query time. */
+    AML = "aml"
+}
+
+/** Known values of {@link VectorThresholdKind} that the service accepts. */
+export declare enum KnownVectorThresholdKind {
+    /** The results of the vector query will be filtered based on the vector similarity metric. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field. */
+    VectorSimilarity = "vectorSimilarity",
+    /** 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. */
+    SearchScore = "searchScore"
 }
 
 /** Known values of {@link VisualFeature} that the service accepts. */
@@ -4389,6 +4558,16 @@ export declare interface NGramTokenizer extends BaseLexicalTokenizer {
     tokenChars?: TokenCharacterKind[];
 }
 
+/**
+ * Specifies the properties for connecting to an AML vectorizer with no authentication.
+ */
+export declare interface NoAuthAzureMachineLearningVectorizerParameters extends BaseAzureMachineLearningVectorizerParameters {
+    /** Indicates how the service should attempt to identify itself to the AML instance */
+    authKind: "none";
+    /** The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed. */
+    scoringUri: string;
+}
+
 /** A skill that extracts text from image files. */
 export declare interface OcrSkill extends BaseSearchIndexerSkill {
     /** Polymorphic discriminator, which specifies the different types this object can be */
@@ -5226,7 +5405,7 @@ export declare type SearchFieldArray<TModel extends object = object> = (<T>() =>
  * NB: `Edm.Single` alone is not a valid data type. It must be used as part of a collection type.
  * @readonly
  */
-export declare type SearchFieldDataType = "Edm.String" | "Edm.Int32" | "Edm.Int64" | "Edm.Double" | "Edm.Boolean" | "Edm.DateTimeOffset" | "Edm.GeographyPoint" | "Collection(Edm.String)" | "Collection(Edm.Int32)" | "Collection(Edm.Int64)" | "Collection(Edm.Double)" | "Collection(Edm.Boolean)" | "Collection(Edm.DateTimeOffset)" | "Collection(Edm.GeographyPoint)" | "Collection(Edm.Single)" | "Collection(Edm.Half)" | "Collection(Edm.Int16)" | "Collection(Edm.SByte)";
+export declare type SearchFieldDataType = "Edm.String" | "Edm.Int32" | "Edm.Int64" | "Edm.Double" | "Edm.Boolean" | "Edm.DateTimeOffset" | "Edm.GeographyPoint" | "Collection(Edm.String)" | "Collection(Edm.Int32)" | "Collection(Edm.Int64)" | "Collection(Edm.Double)" | "Collection(Edm.Boolean)" | "Collection(Edm.DateTimeOffset)" | "Collection(Edm.GeographyPoint)" | "Collection(Edm.Single)" | "Collection(Edm.Half)" | "Collection(Edm.Int16)" | "Collection(Edm.SByte)" | "Collection(Edm.Byte)";
 
 /**
  * Represents a search index definition, which describes the fields and search behavior of an
@@ -5887,7 +6066,7 @@ export declare interface SearchIndexerDataSourceConnection {
     encryptionKey?: SearchResourceEncryptionKey;
 }
 
-export declare type SearchIndexerDataSourceType = "azuresql" | "cosmosdb" | "azureblob" | "azuretable" | "mysql" | "adlsgen2";
+export declare type SearchIndexerDataSourceType = "azuresql" | "cosmosdb" | "azureblob" | "azuretable" | "mysql" | "adlsgen2" | "onelake";
 
 /** Specifies the identity for a datasource to use. */
 export declare interface SearchIndexerDataUserAssignedIdentity extends BaseSearchIndexerDataIdentity {
@@ -6054,7 +6233,7 @@ export declare interface SearchIndexerLimits {
 /**
  * Contains the possible cases for Skill.
  */
-export declare type SearchIndexerSkill = AzureMachineLearningSkill | AzureOpenAIEmbeddingSkill | ConditionalSkill | CustomEntityLookupSkill | DocumentExtractionSkill | EntityLinkingSkill | EntityRecognitionSkill | EntityRecognitionSkillV3 | ImageAnalysisSkill | KeyPhraseExtractionSkill | LanguageDetectionSkill | MergeSkill | OcrSkill | PIIDetectionSkill | SentimentSkill | SentimentSkillV3 | ShaperSkill | SplitSkill | TextTranslationSkill | WebApiSkill;
+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;
 
 /**
  * A list of skills.
@@ -6516,6 +6695,14 @@ export declare type SearchResult<TModel extends object, TFields extends SelectFi
     readonly documentDebugInfo?: DocumentDebugInfo[];
 };
 
+/** 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. */
+export declare interface SearchScoreThreshold extends BaseVectorThreshold {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    kind: "searchScore";
+    /** The threshold 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. */
+    value: number;
+}
+
 /**
  * Response from a get service statistics request. If successful, it includes service level
  * counters and limits.
@@ -6732,6 +6919,8 @@ export declare interface ServiceLimits {
     maxComplexCollectionFieldsPerIndex?: number;
     /** The maximum number of objects in complex collections allowed per document. */
     maxComplexObjectsInCollectionsPerDocument?: number;
+    /** The maximum amount of storage in bytes allowed per index. */
+    maxStoragePerIndex?: number;
 }
 
 /** A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields). */
@@ -6894,6 +7083,8 @@ export declare interface SimpleField {
      * optional parameters for searching the vector field.
      */
     vectorSearchProfileName?: string;
+    /** The encoding format to interpret the field contents. */
+    vectorSearchEncodingFormat?: VectorEncodingFormat;
 }
 
 /** A filter that stems words using a Snowball-generated stemmer. This token filter is implemented using Apache Lucene. */
@@ -7166,6 +7357,18 @@ export declare interface TextWeights {
     };
 }
 
+/**
+ * Specifies the properties for connecting to an AML vectorizer with a managed identity.
+ */
+export declare interface TokenAuthAzureMachineLearningVectorizerParameters extends BaseAzureMachineLearningVectorizerParameters {
+    /** Indicates how the service should attempt to identify itself to the AML instance */
+    authKind: "token";
+    /** The Azure Resource Manager resource ID of the AML service. It should be in the format subscriptions/\{guid\}/resourceGroups/\{resource-group-name\}/Microsoft.MachineLearningServices/workspaces/\{workspace-name\}/services/\{service_name\}. */
+    resourceId: string;
+    /** The region the AML service is deployed in. */
+    region?: string;
+}
+
 /** Defines values for TokenCharacterKind. */
 export declare type TokenCharacterKind = "letter" | "digit" | "whitespace" | "punctuation" | "symbol";
 
@@ -7247,14 +7450,39 @@ export declare interface UniqueTokenFilter extends BaseTokenFilter {
  */
 export declare type UploadDocumentsOptions = IndexDocumentsOptions;
 
+/**
+ * Defines values for VectorEncodingFormat. \
+ * {@link KnownVectorEncodingFormat} can be used interchangeably with VectorEncodingFormat,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **packedBit**: Encoding format representing bits packed into a wider data type.
+ */
+export declare type VectorEncodingFormat = string;
+
 export declare type VectorFilterMode = "postFilter" | "preFilter";
 
+/** The query parameters to use for vector search when a base 64 encoded binary of an image that needs to be vectorized is provided. */
+export declare interface VectorizableImageBinaryQuery<TModel extends object> extends BaseVectorQuery<TModel> {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    kind: "imageBinary";
+    /** The base64 encoded binary of an image to be vectorized to perform a vector search query. */
+    binaryImage: string;
+}
+
+/** The query parameters to use for vector search when an url that represents an image value that needs to be vectorized is provided. */
+export declare interface VectorizableImageUrlQuery<TModel extends object> extends BaseVectorQuery<TModel> {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    kind: "imageUrl";
+    /** The URL of an image to be vectorized to perform a vector search query. */
+    url: string;
+}
+
 /** The query parameters to use for vector search when a text value that needs to be vectorized is provided. */
 export declare interface VectorizableTextQuery<TModel extends object> extends BaseVectorQuery<TModel> {
     /** Polymorphic discriminator, which specifies the different types this object can be */
     kind: "text";
     /** The text to be vectorized to perform a vector search query. */
-    text?: string;
+    text: string;
 }
 
 /** The query parameters to use for vector search when a raw vector value is provided. */
@@ -7266,9 +7494,9 @@ export declare interface VectorizedQuery<TModel extends object> extends BaseVect
 }
 
 /** The query parameters for vector and hybrid search queries. */
-export declare type VectorQuery<TModel extends object> = VectorizedQuery<TModel> | VectorizableTextQuery<TModel>;
+export declare type VectorQuery<TModel extends object> = VectorizedQuery<TModel> | VectorizableTextQuery<TModel> | VectorizableImageUrlQuery<TModel> | VectorizableImageBinaryQuery<TModel>;
 
-export declare type VectorQueryKind = "vector" | "text";
+export declare type VectorQueryKind = "vector" | "text" | "imageUrl" | "imageBinary";
 
 /** Contains configuration options related to vector search. */
 export declare interface VectorSearch {
@@ -7290,7 +7518,7 @@ export declare type VectorSearchAlgorithmConfiguration = HnswAlgorithmConfigurat
 
 export declare type VectorSearchAlgorithmKind = "hnsw" | "exhaustiveKnn";
 
-export declare type VectorSearchAlgorithmMetric = "cosine" | "euclidean" | "dotProduct";
+export declare type VectorSearchAlgorithmMetric = "cosine" | "euclidean" | "dotProduct" | "hamming";
 
 /**
  * Contains configuration options specific to the compression method used during indexing or
@@ -7344,9 +7572,28 @@ export declare interface VectorSearchProfile {
 }
 
 /** Contains configuration options on how to vectorize text vector queries. */
-export declare type VectorSearchVectorizer = AzureOpenAIVectorizer | CustomVectorizer;
+export declare type VectorSearchVectorizer = AzureOpenAIVectorizer | CustomVectorizer | AIServicesVisionVectorizer | AzureMachineLearningVectorizer;
+
+export declare type VectorSearchVectorizerKind = "azureOpenAI" | "customWebApi" | "aiServicesVision" | "aml";
+
+/** The results of the vector query will be filtered based on the vector similarity metric. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field. */
+export declare interface VectorSimilarityThreshold extends BaseVectorThreshold {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    kind: "vectorSimilarity";
+    /** The threshold will filter based on the similarity metric value. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field. */
+    value: number;
+}
+
+/** The threshold used for vector queries. */
+export declare type VectorThreshold = VectorSimilarityThreshold | SearchScoreThreshold;
 
-export declare type VectorSearchVectorizerKind = "azureOpenAI" | "customWebApi";
+/** Allows you to generate a vector embedding for a given image or text input using the Azure AI Services Vision Vectorize API. */
+export declare interface VisionVectorizeSkill extends BaseSearchIndexerSkill {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    odatatype: "#Microsoft.Skills.Vision.VectorizeSkill";
+    /** The version of the model to use when calling the AI Services Vision service. It will default to the latest available when not specified. */
+    modelVersion?: string;
+}
 
 export declare type VisualFeature = "adult" | "brands" | "categories" | "description" | "faces" | "objects" | "tags";
 

package/dist-esm/src/constants.js

@@ -1,5 +0,0 @@
-"use strict";
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-const SDK_VERSION = "12.1.0-beta.2";
-//# sourceMappingURL=constants.js.map

package/dist-esm/src/constants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,WAAW,GAAW,eAAe,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nconst SDK_VERSION: string = \"12.1.0-beta.2\";\n"]}