Minor Fixes of TypeSpec for AOAI On Your Data 2023-12-01-preview /ext…

…ensions/chat/completions (#27271) * auth * restore * vector db * fix examples * fix * matrix * fix cosmosdb * fix pinecone description * generated --------- Co-authored-by: Yuantao Wang <[email protected]>
Azure · Feb 26, 2024 · 7276d96 · 7276d96
1 parent d269787
commit 7276d96
Show file tree

Hide file tree

Showing 27 changed files with 273 additions and 131 deletions.
diff --git a/...iveservices/OpenAI.Inference/examples/2023-08-01-preview/extensions_chat_completions.json b/...iveservices/OpenAI.Inference/examples/2023-08-01-preview/extensions_chat_completions.json
@@ -7,10 +7,6 @@
     "deploymentId": "<deployment-id>",
     "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/...iveservices/OpenAI.Inference/examples/2023-09-01-preview/extensions_chat_completions.json b/...iveservices/OpenAI.Inference/examples/2023-09-01-preview/extensions_chat_completions.json
@@ -7,10 +7,6 @@
     "deploymentId": "<deployment-id>",
     "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/...s/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_aml_index.json b/...s/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_aml_index.json
@@ -7,10 +7,6 @@
     "deploymentId": "<deployment-id>",
     "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/...erence/examples/2023-12-01-preview/extensions_chat_completions_azure_search_advanced.json b/...erence/examples/2023-12-01-preview/extensions_chat_completions_azure_search_advanced.json
@@ -7,10 +7,6 @@
     "deploymentId": "<deployment-id>",
     "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/...ce/examples/2023-12-01-preview/extensions_chat_completions_azure_search_image_vector.json b/...ce/examples/2023-12-01-preview/extensions_chat_completions_azure_search_image_vector.json
@@ -7,10 +7,6 @@
     "deploymentId": "<deployment-id>",
     "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/...ference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_minimum.json b/...ference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_minimum.json
@@ -7,10 +7,6 @@
     "deploymentId": "<deployment-id>",
     "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/...s/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_cosmos_db.json b/...s/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_cosmos_db.json
@@ -7,10 +7,6 @@
     "deploymentId": "<deployment-id>",
     "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/...enAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_elasticsearch.json b/...enAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_elasticsearch.json
@@ -7,10 +7,6 @@
     "deploymentId": "<deployment-id>",
     "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/...es/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_pinecone.json b/...es/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_pinecone.json
@@ -7,10 +7,6 @@
     "deploymentId": "<deployment-id>",
     "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/...n/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/authentication.tsp b/...n/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/...ces/OpenAI.Inference/models/completions/extensions/oyd/azure_cognitive_search_options.tsp b/...ces/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/...iveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cosmosdb_options.tsp b/...iveservices/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/...penAI.Inference/models/completions/extensions/oyd/azure_machinelearning_index_options.tsp b/...penAI.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/...tiveservices/OpenAI.Inference/models/completions/extensions/oyd/elasticsearch_options.tsp b/...tiveservices/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/...cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/pinecone_options.tsp b/...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/...zureOpenAI/inference/preview/2023-08-01-preview/examples/extensions_chat_completions.json b/...zureOpenAI/inference/preview/2023-08-01-preview/examples/extensions_chat_completions.json
@@ -7,10 +7,6 @@
     "deploymentId": "<deployment-id>",
     "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}"
           }