diff --git a/specification/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchservice.json index c2f7dd72000c..9bf30c32cc63 100644 --- a/specification/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchservice.json @@ -6143,7 +6143,7 @@ "items": { "$ref": "#/definitions/VectorSearchAlgorithmConfiguration" }, - "description": "Contains configuration options specific to the algorithm used during indexing and/or querying." + "description": "Contains configuration options specific to the algorithm used during indexing or querying." }, "vectorizers": { "type": "array", @@ -6205,7 +6205,7 @@ "name", "kind" ], - "description": "Contains configuration options specific to the algorithm used during indexing and/or querying." + "description": "Contains configuration options specific to the algorithm used during indexing or querying." }, "HnswVectorSearchAlgorithmConfiguration": { "type": "object", @@ -6219,10 +6219,10 @@ "hnswParameters": { "x-ms-client-name": "Parameters", "$ref": "#/definitions/HnswParameters", - "description": "Contains the parameters specific to hnsw algorithm." + "description": "Contains the parameters specific to HNSW algorithm." } }, - "description": "Contains configuration options specific to the hnsw approximate nearest neighbors algorithm used during indexing and querying. The hnsw algorithm offers a tunable trade-off between search speed and accuracy." + "description": "Contains configuration options specific to the HNSW approximate nearest neighbors algorithm used during indexing and querying. The HNSW algorithm offers a tunable trade-off between search speed and accuracy." }, "HnswParameters": { "type": "object", @@ -6260,7 +6260,7 @@ "description": "The similarity metric to use for vector comparisons." } }, - "description": "Contains the parameters specific to hnsw algorithm." + "description": "Contains the parameters specific to the HNSW algorithm." }, "ExhaustiveKnnVectorSearchAlgorithmConfiguration": { "type": "object", @@ -6330,7 +6330,7 @@ { "value": "hnsw", "name": "Hnsw", - "description": "Hnsw (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm." + "description": "HNSW (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm." }, { "value": "exhaustiveKnn", @@ -6363,7 +6363,7 @@ "name", "kind" ], - "description": "Contains specific details for a vectorization method to be used during query time." + "description": "Specifies the vectorization method to be used during query time." }, "AzureOpenAIVectorizer": { "type": "object", @@ -6377,10 +6377,10 @@ "azureOpenAIParameters": { "x-ms-client-name": "AzureOpenAIParameters", "$ref": "#/definitions/AzureOpenAIParameters", - "description": "Contains the parameters specific to Azure Open AI embedding vectorization." + "description": "Contains the parameters specific to Azure OpenAI embedding vectorization." } }, - "description": "Contains the parameters specific to using an Azure Open AI service for vectorization at query time." + "description": "Specifies the Azure OpenAI resource used to vectorize a query string." }, "AzureOpenAIParameters": { "type": "object", @@ -6388,15 +6388,15 @@ "resourceUri": { "type": "string", "format": "uri", - "description": "The resource uri for your Azure Open AI resource." + "description": "The resource URI of the Azure OpenAI resource." }, "deploymentId": { "type": "string", - "description": "ID of your Azure Open AI model deployment on the designated resource." + "description": "ID of the Azure OpenAI model deployment on the designated resource." }, "apiKey": { "type": "string", - "description": "API key for the designated Azure Open AI resource." + "description": "API key of the designated Azure OpenAI resource." }, "authIdentity": { "$ref": "#/definitions/SearchIndexerDataIdentity", @@ -6404,7 +6404,7 @@ "description": "The user-assigned managed identity used for outbound connections." } }, - "description": "Contains the parameters specific to using an Azure Open AI service for vectorization at query time." + "description": "Specifies the parameters for connecting to the Azure OpenAI resource." }, "CustomVectorizer": { "type": "object", @@ -6418,10 +6418,10 @@ "customVectorizerParameters": { "x-ms-client-name": "CustomVectorizerParameters", "$ref": "#/definitions/CustomVectorizerParameters", - "description": "Contains the parameters specific to generating vector embeddings via a custom endpoint." + "description": "Specifies the properties of the user-defined vectorizer." } }, - "description": "Contains the parameters specific to generating vector embeddings via a custom endpoint." + "description": "Specifies a user-defined vectorizer for generating the vector embedding of a query string. Integration of an external vectorizer is achieved using the custom Web API interface of a skillset." }, "CustomVectorizerParameters": { "type": "object", @@ -6429,15 +6429,15 @@ "uri": { "type": "string", "format": "uri", - "description": "The uri for the Web API." + "description": "The URI of the Web API providing the vectorizer." }, "httpHeaders": { "$ref": "#/definitions/WebApiHttpHeaders", - "description": "The headers required to make the http request." + "description": "The headers required to make the HTTP request." }, "httpMethod": { "type": "string", - "description": "The method for the http request." + "description": "The method for the HTTP request." }, "timeout": { "type": "string", @@ -6455,7 +6455,7 @@ "description": "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." } }, - "description": "Contains the parameters specific to generating vector embeddings via a custom endpoint." + "description": "Specifies the properties for connecting to a user-defined vectorizer." }, "VectorSearchVectorizerKind": { "type": "string", @@ -6470,7 +6470,7 @@ { "value": "azureOpenAI", "name": "AzureOpenAI", - "description": "Generate embeddings using an Azure Open AI service at query time." + "description": "Generate embeddings using an Azure OpenAI resource at query time." }, { "value": "customWebApi", @@ -8604,7 +8604,7 @@ ] }, "CognitiveServicesAccountKey": { - "description": "An Azure AI service resource provisioned with a key that is attached to a skillset.", + "description": "The multi-region account key of an Azure AI service resource that's attached to a skillset.", "x-ms-discriminator-value": "#Microsoft.Azure.Search.CognitiveServicesByKey", "allOf": [ { @@ -9462,15 +9462,15 @@ "resourceUri": { "type": "string", "format": "uri", - "description": "The resource uri for your Azure Open AI resource." + "description": "The resource URI for your Azure OpenAI resource." }, "deploymentId": { "type": "string", - "description": "ID of your Azure Open AI model deployment on the designated resource." + "description": "ID of your Azure OpenAI model deployment on the designated resource." }, "apiKey": { "type": "string", - "description": "API key for the designated Azure Open AI resource." + "description": "API key for the designated Azure OpenAI resource." }, "authIdentity": { "$ref": "#/definitions/SearchIndexerDataIdentity", @@ -9478,7 +9478,7 @@ "description": "The user-assigned managed identity used for outbound connections." } }, - "description": "Allows you to generate a vector embedding for a given text input using the Azure Open AI service." + "description": "Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource." }, "ListSkillsetsResult": { "properties": { diff --git a/specification/search/data-plane/Azure.Search/stable/2023-11-01/searchservice.json b/specification/search/data-plane/Azure.Search/stable/2023-11-01/searchservice.json index 4b3b0a895169..098c93bc3dd0 100644 --- a/specification/search/data-plane/Azure.Search/stable/2023-11-01/searchservice.json +++ b/specification/search/data-plane/Azure.Search/stable/2023-11-01/searchservice.json @@ -5545,7 +5545,7 @@ "items": { "$ref": "#/definitions/VectorSearchAlgorithmConfiguration" }, - "description": "Contains configuration options specific to the algorithm used during indexing and/or querying." + "description": "Contains configuration options specific to the algorithm used during indexing or querying." } }, "description": "Contains configuration options related to vector search." @@ -5595,7 +5595,7 @@ "name", "kind" ], - "description": "Contains configuration options specific to the algorithm used during indexing and/or querying." + "description": "Contains configuration options specific to the algorithm used during indexing or querying." }, "HnswVectorSearchAlgorithmConfiguration": { "type": "object", @@ -5609,10 +5609,10 @@ "hnswParameters": { "x-ms-client-name": "Parameters", "$ref": "#/definitions/HnswParameters", - "description": "Contains the parameters specific to hnsw algorithm." + "description": "Contains the parameters specific to HNSW algorithm." } }, - "description": "Contains configuration options specific to the hnsw approximate nearest neighbors algorithm used during indexing and querying. The hnsw algorithm offers a tunable trade-off between search speed and accuracy." + "description": "Contains configuration options specific to the HNSW approximate nearest neighbors algorithm used during indexing and querying. The HNSW algorithm offers a tunable trade-off between search speed and accuracy." }, "HnswParameters": { "type": "object", @@ -5650,7 +5650,7 @@ "description": "The similarity metric to use for vector comparisons." } }, - "description": "Contains the parameters specific to hnsw algorithm." + "description": "Contains the parameters specific to the HNSW algorithm." }, "ExhaustiveKnnVectorSearchAlgorithmConfiguration": { "type": "object", @@ -5720,7 +5720,7 @@ { "value": "hnsw", "name": "Hnsw", - "description": "Hnsw (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm." + "description": "HNSW (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm." }, { "value": "exhaustiveKnn",