Skip to content

azure search data plane string changes requested by PM #26327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jhendrixMSFT merged 5 commits into from
Oct 23, 2023
Merged

azure search data plane string changes requested by PM #26327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9204073
String changes requested by PM feature owner
HeidiSteen Oct 20, 2023
586a7e7
String changes requested by PM feature owner
HeidiSteen Oct 20, 2023
9eaed76
Updated SplitSkillLanguage languages
HeidiSteen Oct 20, 2023
0cecc40
Finnish was in the wrong spot
HeidiSteen Oct 20, 2023
0eef627
restored SplitSKillLanguage list to avoid breaking change
HeidiSteen Oct 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 25 additions & 25 deletions specification/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchservice.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand All @@ -6377,34 +6377,34 @@
"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",
"properties": {
"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",
"x-nullable": true,
"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",
Expand All @@ -6418,26 +6418,26 @@
"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",
"properties": {
"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",
Expand All @@ -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",
Expand All @@ -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",
Expand Down Expand Up @@ -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": [
{
Expand Down Expand Up @@ -9462,23 +9462,23 @@
"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",
"x-nullable": true,
"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": {
Expand Down
12 changes: 6 additions & 6 deletions specification/search/data-plane/Azure.Search/stable/2023-11-01/searchservice.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down