diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-08-01-preview/extensions_chat_completions.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-08-01-preview/extensions_chat_completions.json index 5265df25b2e6..5aa5aebb5803 100644 --- a/specification/cognitiveservices/OpenAI.Inference/examples/2023-08-01-preview/extensions_chat_completions.json +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-08-01-preview/extensions_chat_completions.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "key": "{search admin key}", "indexName": "{index name}" } diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-09-01-preview/extensions_chat_completions.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-09-01-preview/extensions_chat_completions.json index dbaca3214431..7df840fc4769 100644 --- a/specification/cognitiveservices/OpenAI.Inference/examples/2023-09-01-preview/extensions_chat_completions.json +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-09-01-preview/extensions_chat_completions.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "key": "{search admin key}", "indexName": "{index name}" } diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_aml_index.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_aml_index.json index 24d661ad76fd..effee4f8f5a7 100644 --- a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_aml_index.json +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_aml_index.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_advanced.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_advanced.json index 0968a3dbea37..269dde63613b 100644 --- a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_advanced.json +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_advanced.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "authentication": { "type": "UserAssignedManagedIdentity", "managedIdentityResourceId": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}" diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_image_vector.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_image_vector.json index 860e6e9e4b22..5c04637a4eb4 100644 --- a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_image_vector.json +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_image_vector.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "indexName": "{index name}", "queryType": "vector", "fieldsMapping": { diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_minimum.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_minimum.json index 6979c66744f7..378e5e33c51e 100644 --- a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_minimum.json +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_minimum.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "indexName": "{index name}" } } diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_cosmos_db.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_cosmos_db.json index d2d8295cefa8..6d34d089490b 100644 --- a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_cosmos_db.json +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_cosmos_db.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -32,6 +28,9 @@ "deploymentName": "{embedding deployment name}" }, "fieldsMapping": { + "contentFields": [ + "content" + ], "vectorFields": [ "contentvector" ] diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_elasticsearch.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_elasticsearch.json index 01680301b679..db3ea789f8d5 100644 --- a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_elasticsearch.json +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_elasticsearch.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "Elasticsearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io", "indexName": "{index name}", "authentication": { "type": "KeyAndKeyId", diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_pinecone.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_pinecone.json index 2cbd35ec2ab5..3cac930b509b 100644 --- a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_pinecone.json +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_pinecone.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -22,7 +18,7 @@ "parameters": { "authentication": { "type": "APIKey", - "apiKey": "{api key}" + "key": "{api key}" }, "environment": "{environment name}", "indexName": "{index name}", diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/authentication.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/authentication.tsp index 657a61bba75d..46bd8786c3c5 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/authentication.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/authentication.tsp @@ -18,6 +18,12 @@ enum OnYourDataAuthenticationType { @doc("Authentication via key and key ID pair.") keyAndKeyId: "KeyAndKeyId", + @doc("Authentication via encoded API key.") + encodedApiKey: "EncodedAPIKey", + + @doc("Authentication via access token.") + accessToken: "AccessToken", + @doc("Authentication via system-assigned managed identity.") systemAssignedManagedIdentity: "SystemAssignedManagedIdentity", @@ -75,6 +81,32 @@ model OnYourDataKeyAndKeyIdAuthenticationOptions keyId: string; } +@doc(""" +The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key. +""") +@added(ServiceApiVersions.v2023_08_01_Preview) +model OnYourDataEncodedApiKeyAuthenticationOptions + extends OnYourDataAuthenticationOptions { + @doc("The authentication type of Elasticsearch encoded API Key.") + type: OnYourDataAuthenticationType.encodedApiKey; + + @doc("The encoded API key to use for authentication.") + encodedApiKey: string; +} + +@doc(""" +The authentication options for Azure OpenAI On Your Data when using access token. +""") +@added(ServiceApiVersions.v2023_08_01_Preview) +model OnYourDataAccessTokenAuthenticationOptions + extends OnYourDataAuthenticationOptions { + @doc("The authentication type of access token.") + type: OnYourDataAuthenticationType.accessToken; + + @doc("The access token to use for authentication.") + accessToken: string; +} + @doc(""" The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity. """) diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cognitive_search_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cognitive_search_options.tsp index 8ef494030b21..83ff77ac430d 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cognitive_search_options.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cognitive_search_options.tsp @@ -26,7 +26,7 @@ model AzureCognitiveSearchChatExtensionConfiguration } @added(ServiceApiVersions.v2023_08_01_Preview) -@doc("Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension.") +@doc("Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension. The supported authentication types are APIKey, SystemAssignedManagedIdentity and UserAssignedManagedIdentity.") model AzureCognitiveSearchChatExtensionParameters { ...OnYourDataCommonChatExtensionConfiguration; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cosmosdb_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cosmosdb_options.tsp index e169fc9dbfde..b940c3082784 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cosmosdb_options.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cosmosdb_options.tsp @@ -10,7 +10,7 @@ using TypeSpec.Versioning; #suppress "@azure-tools/typespec-azure-core/casing-style" "this represents the case-sensitive wire format" @added(ServiceApiVersions.v2023_12_01_Preview) @doc(""" -A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat +A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat extension. """) model AzureCosmosDBChatExtensionConfiguration @@ -29,7 +29,7 @@ model AzureCosmosDBChatExtensionConfiguration @added(ServiceApiVersions.v2023_12_01_Preview) @doc(""" Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for -MongoDB vCore. +MongoDB vCore. The supported authentication type is ConnectionString. """) model AzureCosmosDBChatExtensionParameters { ...OnYourDataCommonChatExtensionConfiguration; @@ -51,13 +51,33 @@ model AzureCosmosDBChatExtensionParameters { fieldsMapping: AzureCosmosDBFieldMappingOptions; @doc("The embedding dependency for vector search.") - embeddingDependency?: OnYourDataVectorizationSource; + embeddingDependency: OnYourDataVectorizationSource; } #suppress "@azure-tools/typespec-azure-core/casing-style" "this represents the case-sensitive wire format" @doc("Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource.") @added(ServiceApiVersions.v2023_12_01_Preview) model AzureCosmosDBFieldMappingOptions { + @doc("The name of the index field to use as a title.") + @projectedName("csharp", "TitleFieldName") + titleField?: string; + + @doc("The name of the index field to use as a URL.") + @projectedName("csharp", "UrlFieldName") + urlField?: string; + + @doc("The name of the index field to use as a filepath.") + @projectedName("csharp", "FilepathFieldName") + filepathField?: string; + + @doc("The names of index fields that should be treated as content.") + @projectedName("csharp", "ContentFieldNames") + contentFields: string[]; + + @doc("The separator pattern that content fields should use.") + @projectedName("csharp", "ContentFieldSeparator") + contentFieldsSeparator?: string; + @doc("The names of fields that represent vector data.") @projectedName("csharp", "VectorFieldNames") vectorFields: string[]; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_machinelearning_index_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_machinelearning_index_options.tsp index ae37887aac41..368adc73c1ef 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_machinelearning_index_options.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_machinelearning_index_options.tsp @@ -24,7 +24,7 @@ model AzureMachineLearningIndexChatExtensionConfiguration } @added(ServiceApiVersions.v2023_12_01_Preview) -@doc("Parameters for the Azure Machine Learning vector index chat extension.") +@doc("Parameters for the Azure Machine Learning vector index chat extension. The supported authentication types are AccessToken, SystemAssignedManagedIdentity and UserAssignedManagedIdentity.") model AzureMachineLearningIndexChatExtensionParameters { ...OnYourDataCommonChatExtensionConfiguration; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/elasticsearch_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/elasticsearch_options.tsp index fe691977fb69..4d433e91cb5d 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/elasticsearch_options.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/elasticsearch_options.tsp @@ -24,7 +24,7 @@ model ElasticsearchChatExtensionConfiguration } @added(ServiceApiVersions.v2023_12_01_Preview) -@doc("Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension.") +@doc("Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension. The supported authentication types are KeyAndKeyId and EncodedAPIKey.") model ElasticsearchChatExtensionParameters { ...OnYourDataCommonChatExtensionConfiguration; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/pinecone_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/pinecone_options.tsp index dc1096b96fda..6ebb9f2069d1 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/pinecone_options.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/pinecone_options.tsp @@ -10,7 +10,7 @@ using TypeSpec.Versioning; #suppress "@azure-tools/typespec-azure-core/casing-style" "this represents the case-sensitive wire format" @added(ServiceApiVersions.v2023_12_01_Preview) @doc(""" -A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat +A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat extension. """) model PineconeChatExtensionConfiguration @@ -26,7 +26,7 @@ model PineconeChatExtensionConfiguration } @added(ServiceApiVersions.v2023_12_01_Preview) -@doc("Parameters for configuring Azure OpenAI Pinecone chat extensions.") +@doc("Parameters for configuring Azure OpenAI Pinecone chat extensions. The supported authentication type is APIKey.") model PineconeChatExtensionParameters { ...OnYourDataCommonChatExtensionConfiguration; @@ -42,7 +42,7 @@ model PineconeChatExtensionParameters { fieldsMapping: PineconeFieldMappingOptions; @doc("The embedding dependency for vector search.") - embeddingDependency?: OnYourDataVectorizationSource; + embeddingDependency: OnYourDataVectorizationSource; } @doc("Optional settings to control how fields are processed when using a configured Pinecone resource.") @@ -62,18 +62,9 @@ model PineconeFieldMappingOptions { @doc("The names of index fields that should be treated as content.") @projectedName("csharp", "ContentFieldNames") - contentFields?: string[]; + contentFields: string[]; @doc("The separator pattern that content fields should use.") @projectedName("csharp", "ContentFieldSeparator") contentFieldsSeparator?: string; - - @doc("The names of fields that represent vector data.") - @projectedName("csharp", "VectorFieldNames") - vectorFields?: string[]; - - @added(ServiceApiVersions.v2023_12_01_Preview) - @doc("The names of fields that represent image vector data.") - @projectedName("csharp", "ImageVectorFieldNames") - imageVectorFields?: string[]; } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/examples/extensions_chat_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/examples/extensions_chat_completions.json index 5265df25b2e6..5aa5aebb5803 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/examples/extensions_chat_completions.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/examples/extensions_chat_completions.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "key": "{search admin key}", "indexName": "{index name}" } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/generated.json index 808d4193b987..c0f9d5fcecec 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/generated.json @@ -488,7 +488,7 @@ }, "AzureCognitiveSearchChatExtensionParameters": { "type": "object", - "description": "Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension.", + "description": "Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension. The supported authentication types are APIKey, SystemAssignedManagedIdentity and UserAssignedManagedIdentity.", "properties": { "authentication": { "$ref": "#/definitions/OnYourDataAuthenticationOptions", @@ -1750,6 +1750,25 @@ ] } }, + "OnYourDataAccessTokenAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using access token.", + "properties": { + "accessToken": { + "type": "string", + "description": "The access token to use for authentication." + } + }, + "required": [ + "accessToken" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "AccessToken" + }, "OnYourDataApiKeyAuthenticationOptions": { "type": "object", "description": "The authentication options for Azure OpenAI On Your Data when using an API key.", @@ -1790,6 +1809,8 @@ "APIKey", "ConnectionString", "KeyAndKeyId", + "EncodedAPIKey", + "AccessToken", "SystemAssignedManagedIdentity", "UserAssignedManagedIdentity" ], @@ -1812,6 +1833,16 @@ "value": "KeyAndKeyId", "description": "Authentication via key and key ID pair." }, + { + "name": "encodedApiKey", + "value": "EncodedAPIKey", + "description": "Authentication via encoded API key." + }, + { + "name": "accessToken", + "value": "AccessToken", + "description": "Authentication via access token." + }, { "name": "systemAssignedManagedIdentity", "value": "SystemAssignedManagedIdentity", @@ -1844,6 +1875,25 @@ ], "x-ms-discriminator-value": "ConnectionString" }, + "OnYourDataEncodedApiKeyAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.", + "properties": { + "encodedApiKey": { + "type": "string", + "description": "The encoded API key to use for authentication." + } + }, + "required": [ + "encodedApiKey" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "EncodedAPIKey" + }, "OnYourDataKeyAndKeyIdAuthenticationOptions": { "type": "object", "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.", diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/examples/extensions_chat_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/examples/extensions_chat_completions.json index dbaca3214431..7df840fc4769 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/examples/extensions_chat_completions.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/examples/extensions_chat_completions.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "key": "{search admin key}", "indexName": "{index name}" } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/generated.json index 3a090370b6ec..388e334b38ba 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/generated.json @@ -1119,7 +1119,7 @@ }, "AzureCognitiveSearchChatExtensionParameters": { "type": "object", - "description": "Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension.", + "description": "Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension. The supported authentication types are APIKey, SystemAssignedManagedIdentity and UserAssignedManagedIdentity.", "properties": { "authentication": { "$ref": "#/definitions/OnYourDataAuthenticationOptions", @@ -2381,6 +2381,25 @@ ] } }, + "OnYourDataAccessTokenAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using access token.", + "properties": { + "accessToken": { + "type": "string", + "description": "The access token to use for authentication." + } + }, + "required": [ + "accessToken" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "AccessToken" + }, "OnYourDataApiKeyAuthenticationOptions": { "type": "object", "description": "The authentication options for Azure OpenAI On Your Data when using an API key.", @@ -2421,6 +2440,8 @@ "APIKey", "ConnectionString", "KeyAndKeyId", + "EncodedAPIKey", + "AccessToken", "SystemAssignedManagedIdentity", "UserAssignedManagedIdentity" ], @@ -2443,6 +2464,16 @@ "value": "KeyAndKeyId", "description": "Authentication via key and key ID pair." }, + { + "name": "encodedApiKey", + "value": "EncodedAPIKey", + "description": "Authentication via encoded API key." + }, + { + "name": "accessToken", + "value": "AccessToken", + "description": "Authentication via access token." + }, { "name": "systemAssignedManagedIdentity", "value": "SystemAssignedManagedIdentity", @@ -2475,6 +2506,25 @@ ], "x-ms-discriminator-value": "ConnectionString" }, + "OnYourDataEncodedApiKeyAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.", + "properties": { + "encodedApiKey": { + "type": "string", + "description": "The encoded API key to use for authentication." + } + }, + "required": [ + "encodedApiKey" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "EncodedAPIKey" + }, "OnYourDataKeyAndKeyIdAuthenticationOptions": { "type": "object", "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.", diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_aml_index.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_aml_index.json index 24d661ad76fd..effee4f8f5a7 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_aml_index.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_aml_index.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_advanced.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_advanced.json index 0968a3dbea37..269dde63613b 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_advanced.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_advanced.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "authentication": { "type": "UserAssignedManagedIdentity", "managedIdentityResourceId": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}" diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_image_vector.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_image_vector.json index 860e6e9e4b22..5c04637a4eb4 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_image_vector.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_image_vector.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "indexName": "{index name}", "queryType": "vector", "fieldsMapping": { diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_minimum.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_minimum.json index 6979c66744f7..378e5e33c51e 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_minimum.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_minimum.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "indexName": "{index name}" } } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_cosmos_db.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_cosmos_db.json index d2d8295cefa8..6d34d089490b 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_cosmos_db.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_cosmos_db.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -32,6 +28,9 @@ "deploymentName": "{embedding deployment name}" }, "fieldsMapping": { + "contentFields": [ + "content" + ], "vectorFields": [ "contentvector" ] diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_elasticsearch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_elasticsearch.json index 01680301b679..db3ea789f8d5 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_elasticsearch.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_elasticsearch.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "Elasticsearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io", "indexName": "{index name}", "authentication": { "type": "KeyAndKeyId", diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_pinecone.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_pinecone.json index 2cbd35ec2ab5..3cac930b509b 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_pinecone.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_pinecone.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -22,7 +18,7 @@ "parameters": { "authentication": { "type": "APIKey", - "apiKey": "{api key}" + "key": "{api key}" }, "environment": "{environment name}", "indexName": "{index name}", diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/generated.json index 786ed8ecd433..e217f2baeaa7 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/generated.json @@ -1167,7 +1167,7 @@ }, "AzureCognitiveSearchChatExtensionParameters": { "type": "object", - "description": "Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension.", + "description": "Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension. The supported authentication types are APIKey, SystemAssignedManagedIdentity and UserAssignedManagedIdentity.", "properties": { "authentication": { "$ref": "#/definitions/OnYourDataAuthenticationOptions", @@ -1315,7 +1315,7 @@ }, "AzureCosmosDBChatExtensionConfiguration": { "type": "object", - "description": "A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat\nextension.", + "description": "A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat\nextension.", "properties": { "parameters": { "$ref": "#/definitions/AzureCosmosDBChatExtensionParameters", @@ -1334,7 +1334,7 @@ }, "AzureCosmosDBChatExtensionParameters": { "type": "object", - "description": "Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for\nMongoDB vCore.", + "description": "Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for\nMongoDB vCore. The supported authentication type is ConnectionString.", "properties": { "authentication": { "$ref": "#/definitions/OnYourDataAuthenticationOptions", @@ -1385,13 +1385,37 @@ "databaseName", "containerName", "indexName", - "fieldsMapping" + "fieldsMapping", + "embeddingDependency" ] }, "AzureCosmosDBFieldMappingOptions": { "type": "object", "description": "Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource.", "properties": { + "titleField": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "urlField": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepathField": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "contentFields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "contentFieldsSeparator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, "vectorFields": { "type": "array", "description": "The names of fields that represent vector data.", @@ -1401,6 +1425,7 @@ } }, "required": [ + "contentFields", "vectorFields" ] }, @@ -1518,7 +1543,7 @@ }, "AzureMachineLearningIndexChatExtensionParameters": { "type": "object", - "description": "Parameters for the Azure Machine Learning vector index chat extension.", + "description": "Parameters for the Azure Machine Learning vector index chat extension. The supported authentication types are AccessToken, SystemAssignedManagedIdentity and UserAssignedManagedIdentity.", "properties": { "authentication": { "$ref": "#/definitions/OnYourDataAuthenticationOptions", @@ -2637,7 +2662,7 @@ }, "ElasticsearchChatExtensionParameters": { "type": "object", - "description": "Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension.", + "description": "Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension. The supported authentication types are KeyAndKeyId and EncodedAPIKey.", "properties": { "authentication": { "$ref": "#/definitions/OnYourDataAuthenticationOptions", @@ -3095,6 +3120,25 @@ ], "x-ms-discriminator-value": "max_tokens" }, + "OnYourDataAccessTokenAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using access token.", + "properties": { + "accessToken": { + "type": "string", + "description": "The access token to use for authentication." + } + }, + "required": [ + "accessToken" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "AccessToken" + }, "OnYourDataApiKeyAuthenticationOptions": { "type": "object", "description": "The authentication options for Azure OpenAI On Your Data when using an API key.", @@ -3135,6 +3179,8 @@ "APIKey", "ConnectionString", "KeyAndKeyId", + "EncodedAPIKey", + "AccessToken", "SystemAssignedManagedIdentity", "UserAssignedManagedIdentity" ], @@ -3157,6 +3203,16 @@ "value": "KeyAndKeyId", "description": "Authentication via key and key ID pair." }, + { + "name": "encodedApiKey", + "value": "EncodedAPIKey", + "description": "Authentication via encoded API key." + }, + { + "name": "accessToken", + "value": "AccessToken", + "description": "Authentication via access token." + }, { "name": "systemAssignedManagedIdentity", "value": "SystemAssignedManagedIdentity", @@ -3208,6 +3264,25 @@ ], "x-ms-discriminator-value": "DeploymentName" }, + "OnYourDataEncodedApiKeyAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.", + "properties": { + "encodedApiKey": { + "type": "string", + "description": "The encoded API key to use for authentication." + } + }, + "required": [ + "encodedApiKey" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "EncodedAPIKey" + }, "OnYourDataEndpointVectorizationSource": { "type": "object", "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non a public Azure OpenAI endpoint call for embeddings.", @@ -3351,7 +3426,7 @@ }, "PineconeChatExtensionConfiguration": { "type": "object", - "description": "A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat\nextension.", + "description": "A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat\nextension.", "properties": { "parameters": { "$ref": "#/definitions/PineconeChatExtensionParameters", @@ -3370,7 +3445,7 @@ }, "PineconeChatExtensionParameters": { "type": "object", - "description": "Parameters for configuring Azure OpenAI Pinecone chat extensions.", + "description": "Parameters for configuring Azure OpenAI Pinecone chat extensions. The supported authentication type is APIKey.", "properties": { "authentication": { "$ref": "#/definitions/OnYourDataAuthenticationOptions", @@ -3416,7 +3491,8 @@ "required": [ "environment", "indexName", - "fieldsMapping" + "fieldsMapping", + "embeddingDependency" ] }, "PineconeFieldMappingOptions": { @@ -3445,22 +3521,11 @@ "contentFieldsSeparator": { "type": "string", "description": "The separator pattern that content fields should use." - }, - "vectorFields": { - "type": "array", - "description": "The names of fields that represent vector data.", - "items": { - "type": "string" - } - }, - "imageVectorFields": { - "type": "array", - "description": "The names of fields that represent image vector data.", - "items": { - "type": "string" - } } - } + }, + "required": [ + "contentFields" + ] }, "StopFinishDetails": { "type": "object",