Skip to content

Commit d748b99

Browse files
HeidiSteenHeidiSteen
authored
azure search data plane string changes requested by PM (Azure#26327)
* String changes requested by PM feature owner * String changes requested by PM feature owner * Updated SplitSkillLanguage languages * Finnish was in the wrong spot * restored SplitSKillLanguage list to avoid breaking change
1 parent 7c906b1 commit d748b99

2 files changed

Lines changed: 31 additions & 31 deletions

File tree

‎specification/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchservice.json‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6143,7 +6143,7 @@
61436143
"items": {
61446144
"$ref": "#/definitions/VectorSearchAlgorithmConfiguration"
61456145
},
6146-
"description": "Contains configuration options specific to the algorithm used during indexing and/or querying."
6146+
"description": "Contains configuration options specific to the algorithm used during indexing or querying."
61476147
},
61486148
"vectorizers": {
61496149
"type": "array",
@@ -6205,7 +6205,7 @@
62056205
"name",
62066206
"kind"
62076207
],
6208-
"description": "Contains configuration options specific to the algorithm used during indexing and/or querying."
6208+
"description": "Contains configuration options specific to the algorithm used during indexing or querying."
62096209
},
62106210
"HnswVectorSearchAlgorithmConfiguration": {
62116211
"type": "object",
@@ -6219,10 +6219,10 @@
62196219
"hnswParameters": {
62206220
"x-ms-client-name": "Parameters",
62216221
"$ref": "#/definitions/HnswParameters",
6222-
"description": "Contains the parameters specific to hnsw algorithm."
6222+
"description": "Contains the parameters specific to HNSW algorithm."
62236223
}
62246224
},
6225-
"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."
6225+
"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."
62266226
},
62276227
"HnswParameters": {
62286228
"type": "object",
@@ -6260,7 +6260,7 @@
62606260
"description": "The similarity metric to use for vector comparisons."
62616261
}
62626262
},
6263-
"description": "Contains the parameters specific to hnsw algorithm."
6263+
"description": "Contains the parameters specific to the HNSW algorithm."
62646264
},
62656265
"ExhaustiveKnnVectorSearchAlgorithmConfiguration": {
62666266
"type": "object",
@@ -6330,7 +6330,7 @@
63306330
{
63316331
"value": "hnsw",
63326332
"name": "Hnsw",
6333-
"description": "Hnsw (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm."
6333+
"description": "HNSW (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm."
63346334
},
63356335
{
63366336
"value": "exhaustiveKnn",
@@ -6363,7 +6363,7 @@
63636363
"name",
63646364
"kind"
63656365
],
6366-
"description": "Contains specific details for a vectorization method to be used during query time."
6366+
"description": "Specifies the vectorization method to be used during query time."
63676367
},
63686368
"AzureOpenAIVectorizer": {
63696369
"type": "object",
@@ -6377,34 +6377,34 @@
63776377
"azureOpenAIParameters": {
63786378
"x-ms-client-name": "AzureOpenAIParameters",
63796379
"$ref": "#/definitions/AzureOpenAIParameters",
6380-
"description": "Contains the parameters specific to Azure Open AI embedding vectorization."
6380+
"description": "Contains the parameters specific to Azure OpenAI embedding vectorization."
63816381
}
63826382
},
6383-
"description": "Contains the parameters specific to using an Azure Open AI service for vectorization at query time."
6383+
"description": "Specifies the Azure OpenAI resource used to vectorize a query string."
63846384
},
63856385
"AzureOpenAIParameters": {
63866386
"type": "object",
63876387
"properties": {
63886388
"resourceUri": {
63896389
"type": "string",
63906390
"format": "uri",
6391-
"description": "The resource uri for your Azure Open AI resource."
6391+
"description": "The resource URI of the Azure OpenAI resource."
63926392
},
63936393
"deploymentId": {
63946394
"type": "string",
6395-
"description": "ID of your Azure Open AI model deployment on the designated resource."
6395+
"description": "ID of the Azure OpenAI model deployment on the designated resource."
63966396
},
63976397
"apiKey": {
63986398
"type": "string",
6399-
"description": "API key for the designated Azure Open AI resource."
6399+
"description": "API key of the designated Azure OpenAI resource."
64006400
},
64016401
"authIdentity": {
64026402
"$ref": "#/definitions/SearchIndexerDataIdentity",
64036403
"x-nullable": true,
64046404
"description": "The user-assigned managed identity used for outbound connections."
64056405
}
64066406
},
6407-
"description": "Contains the parameters specific to using an Azure Open AI service for vectorization at query time."
6407+
"description": "Specifies the parameters for connecting to the Azure OpenAI resource."
64086408
},
64096409
"CustomVectorizer": {
64106410
"type": "object",
@@ -6418,26 +6418,26 @@
64186418
"customVectorizerParameters": {
64196419
"x-ms-client-name": "CustomVectorizerParameters",
64206420
"$ref": "#/definitions/CustomVectorizerParameters",
6421-
"description": "Contains the parameters specific to generating vector embeddings via a custom endpoint."
6421+
"description": "Specifies the properties of the user-defined vectorizer."
64226422
}
64236423
},
6424-
"description": "Contains the parameters specific to generating vector embeddings via a custom endpoint."
6424+
"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."
64256425
},
64266426
"CustomVectorizerParameters": {
64276427
"type": "object",
64286428
"properties": {
64296429
"uri": {
64306430
"type": "string",
64316431
"format": "uri",
6432-
"description": "The uri for the Web API."
6432+
"description": "The URI of the Web API providing the vectorizer."
64336433
},
64346434
"httpHeaders": {
64356435
"$ref": "#/definitions/WebApiHttpHeaders",
6436-
"description": "The headers required to make the http request."
6436+
"description": "The headers required to make the HTTP request."
64376437
},
64386438
"httpMethod": {
64396439
"type": "string",
6440-
"description": "The method for the http request."
6440+
"description": "The method for the HTTP request."
64416441
},
64426442
"timeout": {
64436443
"type": "string",
@@ -6455,7 +6455,7 @@
64556455
"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."
64566456
}
64576457
},
6458-
"description": "Contains the parameters specific to generating vector embeddings via a custom endpoint."
6458+
"description": "Specifies the properties for connecting to a user-defined vectorizer."
64596459
},
64606460
"VectorSearchVectorizerKind": {
64616461
"type": "string",
@@ -6470,7 +6470,7 @@
64706470
{
64716471
"value": "azureOpenAI",
64726472
"name": "AzureOpenAI",
6473-
"description": "Generate embeddings using an Azure Open AI service at query time."
6473+
"description": "Generate embeddings using an Azure OpenAI resource at query time."
64746474
},
64756475
{
64766476
"value": "customWebApi",
@@ -8604,7 +8604,7 @@
86048604
]
86058605
},
86068606
"CognitiveServicesAccountKey": {
8607-
"description": "An Azure AI service resource provisioned with a key that is attached to a skillset.",
8607+
"description": "The multi-region account key of an Azure AI service resource that's attached to a skillset.",
86088608
"x-ms-discriminator-value": "#Microsoft.Azure.Search.CognitiveServicesByKey",
86098609
"allOf": [
86108610
{
@@ -9462,23 +9462,23 @@
94629462
"resourceUri": {
94639463
"type": "string",
94649464
"format": "uri",
9465-
"description": "The resource uri for your Azure Open AI resource."
9465+
"description": "The resource URI for your Azure OpenAI resource."
94669466
},
94679467
"deploymentId": {
94689468
"type": "string",
9469-
"description": "ID of your Azure Open AI model deployment on the designated resource."
9469+
"description": "ID of your Azure OpenAI model deployment on the designated resource."
94709470
},
94719471
"apiKey": {
94729472
"type": "string",
9473-
"description": "API key for the designated Azure Open AI resource."
9473+
"description": "API key for the designated Azure OpenAI resource."
94749474
},
94759475
"authIdentity": {
94769476
"$ref": "#/definitions/SearchIndexerDataIdentity",
94779477
"x-nullable": true,
94789478
"description": "The user-assigned managed identity used for outbound connections."
94799479
}
94809480
},
9481-
"description": "Allows you to generate a vector embedding for a given text input using the Azure Open AI service."
9481+
"description": "Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource."
94829482
},
94839483
"ListSkillsetsResult": {
94849484
"properties": {

‎specification/search/data-plane/Azure.Search/stable/2023-11-01/searchservice.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5545,7 +5545,7 @@
55455545
"items": {
55465546
"$ref": "#/definitions/VectorSearchAlgorithmConfiguration"
55475547
},
5548-
"description": "Contains configuration options specific to the algorithm used during indexing and/or querying."
5548+
"description": "Contains configuration options specific to the algorithm used during indexing or querying."
55495549
}
55505550
},
55515551
"description": "Contains configuration options related to vector search."
@@ -5595,7 +5595,7 @@
55955595
"name",
55965596
"kind"
55975597
],
5598-
"description": "Contains configuration options specific to the algorithm used during indexing and/or querying."
5598+
"description": "Contains configuration options specific to the algorithm used during indexing or querying."
55995599
},
56005600
"HnswVectorSearchAlgorithmConfiguration": {
56015601
"type": "object",
@@ -5609,10 +5609,10 @@
56095609
"hnswParameters": {
56105610
"x-ms-client-name": "Parameters",
56115611
"$ref": "#/definitions/HnswParameters",
5612-
"description": "Contains the parameters specific to hnsw algorithm."
5612+
"description": "Contains the parameters specific to HNSW algorithm."
56135613
}
56145614
},
5615-
"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."
5615+
"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."
56165616
},
56175617
"HnswParameters": {
56185618
"type": "object",
@@ -5650,7 +5650,7 @@
56505650
"description": "The similarity metric to use for vector comparisons."
56515651
}
56525652
},
5653-
"description": "Contains the parameters specific to hnsw algorithm."
5653+
"description": "Contains the parameters specific to the HNSW algorithm."
56545654
},
56555655
"ExhaustiveKnnVectorSearchAlgorithmConfiguration": {
56565656
"type": "object",
@@ -5720,7 +5720,7 @@
57205720
{
57215721
"value": "hnsw",
57225722
"name": "Hnsw",
5723-
"description": "Hnsw (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm."
5723+
"description": "HNSW (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm."
57245724
},
57255725
{
57265726
"value": "exhaustiveKnn",

0 commit comments

Comments
 (0)
⚡