@azure/search-documents 12.2.0-beta.3 → 12.2.0

package/dist/esm/generated/service/models/index.js

@@ -5,68 +5,30 @@
  * Code generated by Microsoft (R) AutoRest Code Generator.
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
-/** Known values of {@link ApiVersion20250801Preview} that the service accepts. */
-export var KnownApiVersion20250801Preview;
-(function (KnownApiVersion20250801Preview) {
-    /** Api Version '2025-08-01-preview' */
-    KnownApiVersion20250801Preview["TwoThousandTwentyFive0801Preview"] = "2025-08-01-preview";
-})(KnownApiVersion20250801Preview || (KnownApiVersion20250801Preview = {}));
-/** Known values of {@link KnowledgeAgentModelKind} that the service accepts. */
-export var KnownKnowledgeAgentModelKind;
-(function (KnownKnowledgeAgentModelKind) {
-    /** Use Azure Open AI models for query planning. */
-    KnownKnowledgeAgentModelKind["AzureOpenAI"] = "azureOpenAI";
-})(KnownKnowledgeAgentModelKind || (KnownKnowledgeAgentModelKind = {}));
-/** Known values of {@link KnowledgeAgentOutputConfigurationModality} that the service accepts. */
-export var KnownKnowledgeAgentOutputConfigurationModality;
-(function (KnownKnowledgeAgentOutputConfigurationModality) {
-    /** Synthesize an answer for the response payload. */
-    KnownKnowledgeAgentOutputConfigurationModality["AnswerSynthesis"] = "answerSynthesis";
-    /** Return data from the knowledge sources directly without generative alteration. */
-    KnownKnowledgeAgentOutputConfigurationModality["ExtractiveData"] = "extractiveData";
-})(KnownKnowledgeAgentOutputConfigurationModality || (KnownKnowledgeAgentOutputConfigurationModality = {}));
-/** Known values of {@link KnowledgeSourceKind} that the service accepts. */
-export var KnownKnowledgeSourceKind;
-(function (KnownKnowledgeSourceKind) {
-    /** A knowledge source that reads data from a Search Index. */
-    KnownKnowledgeSourceKind["SearchIndex"] = "searchIndex";
-    /** A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. */
-    KnownKnowledgeSourceKind["AzureBlob"] = "azureBlob";
-})(KnownKnowledgeSourceKind || (KnownKnowledgeSourceKind = {}));
+/** Known values of {@link ApiVersion20250901} that the service accepts. */
+export var KnownApiVersion20250901;
+(function (KnownApiVersion20250901) {
+    /** Api Version '2025-09-01' */
+    KnownApiVersion20250901["TwoThousandTwentyFive0901"] = "2025-09-01";
+})(KnownApiVersion20250901 || (KnownApiVersion20250901 = {}));
 /** Known values of {@link SearchIndexerDataSourceType} that the service accepts. */
 export var KnownSearchIndexerDataSourceType;
 (function (KnownSearchIndexerDataSourceType) {
-    /** Indicates an Azure SQL datasource. */
+    /** Definition of an Azure SQL datasource whose credentials can either be a standard SQL connection string or the ResourceId of the SQL resource. The container property refers to the table or view to be indexed. Query parameter is not supported for this datasource. */
     KnownSearchIndexerDataSourceType["AzureSql"] = "azuresql";
-    /** Indicates a CosmosDB datasource. */
+    /** Definition of an CosmosDB datasource whose credentials can either be a formatted connection string containing details for AccountEndpoint, AccountKey, and Database for a key based connection or details for ResourceID and ApiKind for keyless connection. The container property refers to cosmosdb collection to be indexed and the optional query property refers to a SQL query on the collection. */
     KnownSearchIndexerDataSourceType["CosmosDb"] = "cosmosdb";
-    /** Indicates an Azure Blob datasource. */
+    /** Definition of an Azure Blob datasource whose credentials can either be a storage connection string or the ResourceId of the storage account. The container property refers to the blob container to be indexed and the optional query property refers to a specific sub-folder in the container. */
     KnownSearchIndexerDataSourceType["AzureBlob"] = "azureblob";
-    /** Indicates an Azure Table datasource. */
+    /** Definition of an Azure Table datasource whose credentials can either be a table connection string or the ResourceId of the storage account. The container property refers to the blob container to be indexed and the optional query property can be used to filter rows. */
     KnownSearchIndexerDataSourceType["AzureTable"] = "azuretable";
-    /** Indicates a MySql datasource. */
+    /** Definition of an Azure SQL datasource whose credentials can either be a standard ADO.NET formatted SQL connection string or the ResourceId of the SQL resource. The container property refers to the table or view to be indexed. Query parameter is not supported for this datasource. */
     KnownSearchIndexerDataSourceType["MySql"] = "mysql";
-    /** Indicates an ADLS Gen2 datasource. */
+    /** Definition of an Azure ADLS Gen 2 datasource whose credentials can either be a storage connection string or the ResourceId of the storage account. The container property refers to the blob container to be indexed and the optional query property refers to a specific sub-folder in the container. */
     KnownSearchIndexerDataSourceType["AdlsGen2"] = "adlsgen2";
-    /** Indicates a Microsoft Fabric OneLake datasource. */
+    /** Definition of an Microsoft Fabric Onelake datasource whose credentials can either be the Fabric workspace GUID or a workspace FQDN. The container property refers to the lakehouse GUID and the optional query property refers to folders or shortcuts in the lakehouse. */
     KnownSearchIndexerDataSourceType["OneLake"] = "onelake";
 })(KnownSearchIndexerDataSourceType || (KnownSearchIndexerDataSourceType = {}));
-/** Known values of {@link IndexerPermissionOption} that the service accepts. */
-export var KnownIndexerPermissionOption;
-(function (KnownIndexerPermissionOption) {
-    /** Indexer to ingest ACL userIds from data source to index. */
-    KnownIndexerPermissionOption["UserIds"] = "userIds";
-    /** Indexer to ingest ACL groupIds from data source to index. */
-    KnownIndexerPermissionOption["GroupIds"] = "groupIds";
-    /** Indexer to ingest Azure RBAC scope from data source to index. */
-    KnownIndexerPermissionOption["RbacScope"] = "rbacScope";
-})(KnownIndexerPermissionOption || (KnownIndexerPermissionOption = {}));
-/** Known values of {@link IndexerResyncOption} that the service accepts. */
-export var KnownIndexerResyncOption;
-(function (KnownIndexerResyncOption) {
-    /** Indexer to re-ingest pre-selected permissions data from data source to index. */
-    KnownIndexerResyncOption["Permissions"] = "permissions";
-})(KnownIndexerResyncOption || (KnownIndexerResyncOption = {}));
 /** Known values of {@link BlobIndexerParsingMode} that the service accepts. */
 export var KnownBlobIndexerParsingMode;
 (function (KnownBlobIndexerParsingMode) {
@@ -82,33 +44,7 @@ export var KnownBlobIndexerParsingMode;
     KnownBlobIndexerParsingMode["JsonArray"] = "jsonArray";
     /** Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents. */
     KnownBlobIndexerParsingMode["JsonLines"] = "jsonLines";
-    /** Set to markdown to extract content from markdown files. */
-    KnownBlobIndexerParsingMode["Markdown"] = "markdown";
 })(KnownBlobIndexerParsingMode || (KnownBlobIndexerParsingMode = {}));
-/** Known values of {@link MarkdownParsingSubmode} that the service accepts. */
-export var KnownMarkdownParsingSubmode;
-(function (KnownMarkdownParsingSubmode) {
-    /** 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. */
-    KnownMarkdownParsingSubmode["OneToMany"] = "oneToMany";
-    /** Indicates that each markdown file will be parsed into a single search document. */
-    KnownMarkdownParsingSubmode["OneToOne"] = "oneToOne";
-})(KnownMarkdownParsingSubmode || (KnownMarkdownParsingSubmode = {}));
-/** Known values of {@link MarkdownHeaderDepth} that the service accepts. */
-export var KnownMarkdownHeaderDepth;
-(function (KnownMarkdownHeaderDepth) {
-    /** Indicates that headers up to a level of h1 will be considered while grouping markdown content. */
-    KnownMarkdownHeaderDepth["H1"] = "h1";
-    /** Indicates that headers up to a level of h2 will be considered while grouping markdown content. */
-    KnownMarkdownHeaderDepth["H2"] = "h2";
-    /** Indicates that headers up to a level of h3 will be considered while grouping markdown content. */
-    KnownMarkdownHeaderDepth["H3"] = "h3";
-    /** Indicates that headers up to a level of h4 will be considered while grouping markdown content. */
-    KnownMarkdownHeaderDepth["H4"] = "h4";
-    /** Indicates that headers up to a level of h5 will be considered while grouping markdown content. */
-    KnownMarkdownHeaderDepth["H5"] = "h5";
-    /** Indicates that headers up to a level of h6 will be considered while grouping markdown content. This is the default. */
-    KnownMarkdownHeaderDepth["H6"] = "h6";
-})(KnownMarkdownHeaderDepth || (KnownMarkdownHeaderDepth = {}));
 /** Known values of {@link BlobIndexerDataToExtract} that the service accepts. */
 export var KnownBlobIndexerDataToExtract;
 (function (KnownBlobIndexerDataToExtract) {
@@ -145,24 +81,6 @@ export var KnownIndexerExecutionEnvironment;
     /** Indicates that the indexer should run with the environment provisioned specifically for the search service. This should only be specified as the execution environment if the indexer needs to access resources securely over shared private link resources. */
     KnownIndexerExecutionEnvironment["Private"] = "private";
 })(KnownIndexerExecutionEnvironment || (KnownIndexerExecutionEnvironment = {}));
-/** Known values of {@link IndexerExecutionStatusDetail} that the service accepts. */
-export var KnownIndexerExecutionStatusDetail;
-(function (KnownIndexerExecutionStatusDetail) {
-    /** Indicates that the reset that occurred was for a call to ResetDocs. */
-    KnownIndexerExecutionStatusDetail["ResetDocs"] = "resetDocs";
-    /** Indicates to selectively resync based on option(s) from data source. */
-    KnownIndexerExecutionStatusDetail["Resync"] = "resync";
-})(KnownIndexerExecutionStatusDetail || (KnownIndexerExecutionStatusDetail = {}));
-/** Known values of {@link IndexingMode} that the service accepts. */
-export var KnownIndexingMode;
-(function (KnownIndexingMode) {
-    /** The indexer is indexing all documents in the datasource. */
-    KnownIndexingMode["IndexingAllDocs"] = "indexingAllDocs";
-    /** The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status. */
-    KnownIndexingMode["IndexingResetDocs"] = "indexingResetDocs";
-    /** The indexer is resyncing and indexing selective option(s) from the datasource. */
-    KnownIndexingMode["IndexingResync"] = "indexingResync";
-})(KnownIndexingMode || (KnownIndexingMode = {}));
 /** Known values of {@link IndexProjectionMode} that the service accepts. */
 export var KnownIndexProjectionMode;
 (function (KnownIndexProjectionMode) {
@@ -201,16 +119,6 @@ export var KnownSearchFieldDataType;
     /** Indicates that a field contains a 8-bit unsigned integer. This is only valid when used with Collection(Edm.Byte). */
     KnownSearchFieldDataType["Byte"] = "Edm.Byte";
 })(KnownSearchFieldDataType || (KnownSearchFieldDataType = {}));
-/** Known values of {@link PermissionFilter} that the service accepts. */
-export var KnownPermissionFilter;
-(function (KnownPermissionFilter) {
-    /** Field represents user IDs that should be used to filter document access on queries. */
-    KnownPermissionFilter["UserIds"] = "userIds";
-    /** Field represents group IDs that should be used to filter document access on queries. */
-    KnownPermissionFilter["GroupIds"] = "groupIds";
-    /** Field represents an RBAC scope that should be used to filter document access on queries. */
-    KnownPermissionFilter["RbacScope"] = "rbacScope";
-})(KnownPermissionFilter || (KnownPermissionFilter = {}));
 /** Known values of {@link LexicalAnalyzerName} that the service accepts. */
 export var KnownLexicalAnalyzerName;
 (function (KnownLexicalAnalyzerName) {
@@ -427,7 +335,7 @@ export var KnownRankingOrder;
     /** Sets sort order as BoostedRerankerScore */
     KnownRankingOrder["BoostedRerankerScore"] = "BoostedRerankerScore";
     /** Sets sort order as ReRankerScore */
-    KnownRankingOrder["ReRankerScore"] = "RerankerScore";
+    KnownRankingOrder["RerankerScore"] = "RerankerScore";
 })(KnownRankingOrder || (KnownRankingOrder = {}));
 /** Known values of {@link VectorSearchAlgorithmKind} that the service accepts. */
 export var KnownVectorSearchAlgorithmKind;
@@ -444,10 +352,6 @@ export var KnownVectorSearchVectorizerKind;
     KnownVectorSearchVectorizerKind["AzureOpenAI"] = "azureOpenAI";
     /** Generate embeddings using a custom web endpoint at query time. */
     KnownVectorSearchVectorizerKind["CustomWebApi"] = "customWebApi";
-    /** Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API. */
-    KnownVectorSearchVectorizerKind["AIServicesVision"] = "aiServicesVision";
-    /** Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog at query time. */
-    KnownVectorSearchVectorizerKind["AML"] = "aml";
 })(KnownVectorSearchVectorizerKind || (KnownVectorSearchVectorizerKind = {}));
 /** Known values of {@link VectorSearchCompressionKind} that the service accepts. */
 export var KnownVectorSearchCompressionKind;
@@ -465,34 +369,6 @@ export var KnownVectorSearchCompressionRescoreStorageMethod;
     /** 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. */
     KnownVectorSearchCompressionRescoreStorageMethod["DiscardOriginals"] = "discardOriginals";
 })(KnownVectorSearchCompressionRescoreStorageMethod || (KnownVectorSearchCompressionRescoreStorageMethod = {}));
-/** Known values of {@link SearchIndexPermissionFilterOption} that the service accepts. */
-export var KnownSearchIndexPermissionFilterOption;
-(function (KnownSearchIndexPermissionFilterOption) {
-    /** Enabled */
-    KnownSearchIndexPermissionFilterOption["Enabled"] = "enabled";
-    /** Disabled */
-    KnownSearchIndexPermissionFilterOption["Disabled"] = "disabled";
-})(KnownSearchIndexPermissionFilterOption || (KnownSearchIndexPermissionFilterOption = {}));
-/** Known values of {@link AzureOpenAIModelName} that the service accepts. */
-export var KnownAzureOpenAIModelName;
-(function (KnownAzureOpenAIModelName) {
-    /** TextEmbeddingAda002 */
-    KnownAzureOpenAIModelName["TextEmbeddingAda002"] = "text-embedding-ada-002";
-    /** TextEmbedding3Large */
-    KnownAzureOpenAIModelName["TextEmbedding3Large"] = "text-embedding-3-large";
-    /** TextEmbedding3Small */
-    KnownAzureOpenAIModelName["TextEmbedding3Small"] = "text-embedding-3-small";
-    /** Gpt4O */
-    KnownAzureOpenAIModelName["Gpt4O"] = "gpt-4o";
-    /** Gpt4OMini */
-    KnownAzureOpenAIModelName["Gpt4OMini"] = "gpt-4o-mini";
-    /** Gpt41 */
-    KnownAzureOpenAIModelName["Gpt41"] = "gpt-4.1";
-    /** Gpt41Mini */
-    KnownAzureOpenAIModelName["Gpt41Mini"] = "gpt-4.1-mini";
-    /** Gpt41Nano */
-    KnownAzureOpenAIModelName["Gpt41Nano"] = "gpt-4.1-nano";
-})(KnownAzureOpenAIModelName || (KnownAzureOpenAIModelName = {}));
 /** Known values of {@link TokenFilterName} that the service accepts. */
 export var KnownTokenFilterName;
 (function (KnownTokenFilterName) {
@@ -589,24 +465,16 @@ export var KnownVectorSearchCompressionTarget;
     /** Int8 */
     KnownVectorSearchCompressionTarget["Int8"] = "int8";
 })(KnownVectorSearchCompressionTarget || (KnownVectorSearchCompressionTarget = {}));
-/** Known values of {@link AIFoundryModelCatalogName} that the service accepts. */
-export var KnownAIFoundryModelCatalogName;
-(function (KnownAIFoundryModelCatalogName) {
-    /** OpenAIClipImageTextEmbeddingsVitBasePatch32 */
-    KnownAIFoundryModelCatalogName["OpenAIClipImageTextEmbeddingsVitBasePatch32"] = "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32";
-    /** OpenAIClipImageTextEmbeddingsViTLargePatch14336 */
-    KnownAIFoundryModelCatalogName["OpenAIClipImageTextEmbeddingsViTLargePatch14336"] = "OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336";
-    /** FacebookDinoV2ImageEmbeddingsViTBase */
-    KnownAIFoundryModelCatalogName["FacebookDinoV2ImageEmbeddingsViTBase"] = "Facebook-DinoV2-Image-Embeddings-ViT-Base";
-    /** FacebookDinoV2ImageEmbeddingsViTGiant */
-    KnownAIFoundryModelCatalogName["FacebookDinoV2ImageEmbeddingsViTGiant"] = "Facebook-DinoV2-Image-Embeddings-ViT-Giant";
-    /** CohereEmbedV3English */
-    KnownAIFoundryModelCatalogName["CohereEmbedV3English"] = "Cohere-embed-v3-english";
-    /** CohereEmbedV3Multilingual */
-    KnownAIFoundryModelCatalogName["CohereEmbedV3Multilingual"] = "Cohere-embed-v3-multilingual";
-    /** Cohere embed v4 model for generating embeddings from both text and images. */
-    KnownAIFoundryModelCatalogName["CohereEmbedV4"] = "Cohere-embed-v4";
-})(KnownAIFoundryModelCatalogName || (KnownAIFoundryModelCatalogName = {}));
+/** Known values of {@link AzureOpenAIModelName} that the service accepts. */
+export var KnownAzureOpenAIModelName;
+(function (KnownAzureOpenAIModelName) {
+    /** TextEmbeddingAda002 */
+    KnownAzureOpenAIModelName["TextEmbeddingAda002"] = "text-embedding-ada-002";
+    /** TextEmbedding3Large */
+    KnownAzureOpenAIModelName["TextEmbedding3Large"] = "text-embedding-3-large";
+    /** TextEmbedding3Small */
+    KnownAzureOpenAIModelName["TextEmbedding3Small"] = "text-embedding-3-small";
+})(KnownAzureOpenAIModelName || (KnownAzureOpenAIModelName = {}));
 /** Known values of {@link KeyPhraseExtractionSkillLanguage} that the service accepts. */
 export var KnownKeyPhraseExtractionSkillLanguage;
 (function (KnownKeyPhraseExtractionSkillLanguage) {
@@ -1321,26 +1189,6 @@ export var KnownTextSplitMode;
     /** Split the text into individual sentences. */
     KnownTextSplitMode["Sentences"] = "sentences";
 })(KnownTextSplitMode || (KnownTextSplitMode = {}));
-/** Known values of {@link SplitSkillUnit} that the service accepts. */
-export var KnownSplitSkillUnit;
-(function (KnownSplitSkillUnit) {
-    /** The length will be measured by character. */
-    KnownSplitSkillUnit["Characters"] = "characters";
-    /** The length will be measured by an AzureOpenAI tokenizer from the tiktoken library. */
-    KnownSplitSkillUnit["AzureOpenAITokens"] = "azureOpenAITokens";
-})(KnownSplitSkillUnit || (KnownSplitSkillUnit = {}));
-/** Known values of {@link SplitSkillEncoderModelName} that the service accepts. */
-export var KnownSplitSkillEncoderModelName;
-(function (KnownSplitSkillEncoderModelName) {
-    /** Refers to a base model trained with a 50,000 token vocabulary, often used in general natural language processing tasks. */
-    KnownSplitSkillEncoderModelName["R50KBase"] = "r50k_base";
-    /** A base model with a 50,000 token vocabulary, optimized for prompt-based tasks. */
-    KnownSplitSkillEncoderModelName["P50KBase"] = "p50k_base";
-    /** Similar to p50k_base but fine-tuned for editing or rephrasing tasks with a 50,000 token vocabulary. */
-    KnownSplitSkillEncoderModelName["P50KEdit"] = "p50k_edit";
-    /** A base model with a 100,000 token vocabulary. */
-    KnownSplitSkillEncoderModelName["CL100KBase"] = "cl100k_base";
-})(KnownSplitSkillEncoderModelName || (KnownSplitSkillEncoderModelName = {}));
 /** Known values of {@link CustomEntityLookupSkillLanguage} that the service accepts. */
 export var KnownCustomEntityLookupSkillLanguage;
 (function (KnownCustomEntityLookupSkillLanguage) {
@@ -1555,26 +1403,6 @@ export var KnownDocumentIntelligenceLayoutSkillChunkingUnit;
     /** Specifies chunk by characters. */
     KnownDocumentIntelligenceLayoutSkillChunkingUnit["Characters"] = "characters";
 })(KnownDocumentIntelligenceLayoutSkillChunkingUnit || (KnownDocumentIntelligenceLayoutSkillChunkingUnit = {}));
-/** Known values of {@link ChatCompletionExtraParametersBehavior} that the service accepts. */
-export var KnownChatCompletionExtraParametersBehavior;
-(function (KnownChatCompletionExtraParametersBehavior) {
-    /** Passes any extra parameters directly to the model. */
-    KnownChatCompletionExtraParametersBehavior["PassThrough"] = "passThrough";
-    /** Drops all extra parameters. */
-    KnownChatCompletionExtraParametersBehavior["Drop"] = "drop";
-    /** Raises an error if any extra parameter is present. */
-    KnownChatCompletionExtraParametersBehavior["Error"] = "error";
-})(KnownChatCompletionExtraParametersBehavior || (KnownChatCompletionExtraParametersBehavior = {}));
-/** Known values of {@link ChatCompletionResponseFormatType} that the service accepts. */
-export var KnownChatCompletionResponseFormatType;
-(function (KnownChatCompletionResponseFormatType) {
-    /** Text */
-    KnownChatCompletionResponseFormatType["Text"] = "text";
-    /** JsonObject */
-    KnownChatCompletionResponseFormatType["JsonObject"] = "jsonObject";
-    /** JsonSchema */
-    KnownChatCompletionResponseFormatType["JsonSchema"] = "jsonSchema";
-})(KnownChatCompletionResponseFormatType || (KnownChatCompletionResponseFormatType = {}));
 /** Known values of {@link LexicalTokenizerName} that the service accepts. */
 export var KnownLexicalTokenizerName;
 (function (KnownLexicalTokenizerName) {