Skip to content

[OpenAI] Removing LROs from the client surface #26898

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
trrwilson merged 1 commit into from
Nov 30, 2023
Merged

[OpenAI] Removing LROs from the client surface #26898

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 0 additions & 8 deletions specification/cognitiveservices/OpenAI.Inference/client.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,7 @@ interface OpenAIClient {
getChatCompletions is Azure.OpenAI.getChatCompletions;
getChatCompletionsWithAzureExtensions is Azure.OpenAI.getChatCompletionsWithAzureExtensions;

#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "non-model response value needed"
beginImageGenerations is Azure.OpenAI.beginAzureBatchImageGeneration;
#suppress "@azure-tools/typespec-azure-core/rpc-operation-request-body" "MUST fix in next update"
#suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "Allowed because this is a non-standard status polling operation."
getAzureBatchImageGenerationOperationStatus is Azure.OpenAI.getAzureBatchImageGenerationOperationStatus;
getImageGenerations is Azure.OpenAI.getImageGenerations;

getEmbeddings is Azure.OpenAI.getEmbeddings;
}

@@access(OpenAIClient.beginImageGenerations, Access.internal);
@@access(OpenAIClient.getAzureBatchImageGenerationOperationStatus, Access.internal);
5 changes: 0 additions & 5 deletions specification/cognitiveservices/OpenAI.Inference/client/custom_visibility.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ import "../main.tsp";

using Azure.ClientGenerator.Core;

// Azure-specific long-running operations should be treated as implementation details that are wrapped into
// appropriately merged public surface.
@@access(Azure.OpenAI.beginAzureBatchImageGeneration, Access.internal);
@@access(Azure.OpenAI.getAzureBatchImageGenerationOperationStatus, Access.internal);

// Azure-specific Chat Completions with extensions should be handled by clients as a conditional selection within the
// shared Chat Completions route, with the selection gated by the presence or non-presence of additional child
// configuration options on the request payload options model.
Expand Down
26 changes: 13 additions & 13 deletions ...nitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/generated.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1751,7 +1751,7 @@
},
"OnYourDataApiKeyAuthenticationOptions": {
"type": "object",
"description": "The authentication option using API key.",
"description": "The authentication options for Azure OpenAI On Your Data when using an API key.",
"properties": {
"key": {
"type": "string",
Expand All @@ -1770,11 +1770,11 @@
},
"OnYourDataAuthenticationOptions": {
"type": "object",
"description": "The authentication options for Azure OpenAI on your data.",
"description": "The authentication options for Azure OpenAI On Your Data.",
"properties": {
"type": {
"$ref": "#/definitions/OnYourDataAuthenticationType",
"description": "The Authentication type."
"description": "The authentication type."
}
},
"discriminator": "type",
Expand All @@ -1784,7 +1784,7 @@
},
"OnYourDataAuthenticationType": {
"type": "string",
"description": " Authentication types supported by with Azure OpenAI on your data.",
"description": "The authentication types supported with Azure OpenAI On Your Data.",
"enum": [
"APIKey",
"ConnectionString",
Expand All @@ -1799,34 +1799,34 @@
{
"name": "apiKey",
"value": "APIKey",
"description": "API key."
"description": "Authentication via API key."
},
{
"name": "connectionString",
"value": "ConnectionString",
"description": "Connection string."
"description": "Authentication via connection string."
},
{
"name": "keyAndKeyId",
"value": "KeyAndKeyId",
"description": "Key and keyId pair."
"description": "Authentication via key and key ID pair."
},
{
"name": "systemAssignedManagedIdentity",
"value": "SystemAssignedManagedIdentity",
"description": "System-assigned managed identity."
"description": "Authentication via system-assigned managed identity."
},
{
"name": "userAssignedManagedIdentity",
"value": "UserAssignedManagedIdentity",
"description": "User-assigned managed identity."
"description": "Authentication via user-assigned managed identity."
}
]
}
},
"OnYourDataConnectionStringAuthenticationOptions": {
"type": "object",
"description": "The authentication option using connection string.",
"description": "The authentication options for Azure OpenAI On Your Data when using a connection string.",
"properties": {
"connectionString": {
"type": "string",
Expand All @@ -1845,7 +1845,7 @@
},
"OnYourDataKeyAndKeyIdAuthenticationOptions": {
"type": "object",
"description": "The authentication option using Elasticsearch key and keyId pair.",
"description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.",
"properties": {
"key": {
"type": "string",
Expand All @@ -1869,7 +1869,7 @@
},
"OnYourDataSystemAssignedManagedIdentityAuthenticationOptions": {
"type": "object",
"description": "The authentication option using system-assigned managed identity.",
"description": "The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.",
"allOf": [
{
"$ref": "#/definitions/OnYourDataAuthenticationOptions"
Expand All @@ -1879,7 +1879,7 @@
},
"OnYourDataUserAssignedManagedIdentityAuthenticationOptions": {
"type": "object",
"description": "The authentication option using user-assigned managed identity.",
"description": "The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.",
"properties": {
"managedIdentityResourceId": {
"type": "string",
Expand Down
26 changes: 13 additions & 13 deletions ...nitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/generated.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2368,7 +2368,7 @@
},
"OnYourDataApiKeyAuthenticationOptions": {
"type": "object",
"description": "The authentication option using API key.",
"description": "The authentication options for Azure OpenAI On Your Data when using an API key.",
"properties": {
"key": {
"type": "string",
Expand All @@ -2387,11 +2387,11 @@
},
"OnYourDataAuthenticationOptions": {
"type": "object",
"description": "The authentication options for Azure OpenAI on your data.",
"description": "The authentication options for Azure OpenAI On Your Data.",
"properties": {
"type": {
"$ref": "#/definitions/OnYourDataAuthenticationType",
"description": "The Authentication type."
"description": "The authentication type."
}
},
"discriminator": "type",
Expand All @@ -2401,7 +2401,7 @@
},
"OnYourDataAuthenticationType": {
"type": "string",
"description": " Authentication types supported by with Azure OpenAI on your data.",
"description": "The authentication types supported with Azure OpenAI On Your Data.",
"enum": [
"APIKey",
"ConnectionString",
Expand All @@ -2416,34 +2416,34 @@
{
"name": "apiKey",
"value": "APIKey",
"description": "API key."
"description": "Authentication via API key."
},
{
"name": "connectionString",
"value": "ConnectionString",
"description": "Connection string."
"description": "Authentication via connection string."
},
{
"name": "keyAndKeyId",
"value": "KeyAndKeyId",
"description": "Key and keyId pair."
"description": "Authentication via key and key ID pair."
},
{
"name": "systemAssignedManagedIdentity",
"value": "SystemAssignedManagedIdentity",
"description": "System-assigned managed identity."
"description": "Authentication via system-assigned managed identity."
},
{
"name": "userAssignedManagedIdentity",
"value": "UserAssignedManagedIdentity",
"description": "User-assigned managed identity."
"description": "Authentication via user-assigned managed identity."
}
]
}
},
"OnYourDataConnectionStringAuthenticationOptions": {
"type": "object",
"description": "The authentication option using connection string.",
"description": "The authentication options for Azure OpenAI On Your Data when using a connection string.",
"properties": {
"connectionString": {
"type": "string",
Expand All @@ -2462,7 +2462,7 @@
},
"OnYourDataKeyAndKeyIdAuthenticationOptions": {
"type": "object",
"description": "The authentication option using Elasticsearch key and keyId pair.",
"description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.",
"properties": {
"key": {
"type": "string",
Expand All @@ -2486,7 +2486,7 @@
},
"OnYourDataSystemAssignedManagedIdentityAuthenticationOptions": {
"type": "object",
"description": "The authentication option using system-assigned managed identity.",
"description": "The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.",
"allOf": [
{
"$ref": "#/definitions/OnYourDataAuthenticationOptions"
Expand All @@ -2496,7 +2496,7 @@
},
"OnYourDataUserAssignedManagedIdentityAuthenticationOptions": {
"type": "object",
"description": "The authentication option using user-assigned managed identity.",
"description": "The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.",
"properties": {
"managedIdentityResourceId": {
"type": "string",
Expand Down
34 changes: 17 additions & 17 deletions ...nitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/generated.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1356,7 +1356,7 @@
},
"indexName": {
"type": "string",
"description": "The index name name of Azure Cosmos DB."
"description": "The index name of Azure Cosmos DB."
},
"fieldsMapping": {
"$ref": "#/definitions/AzureCosmosDBFieldMappingOptions",
Expand Down Expand Up @@ -1532,7 +1532,7 @@
},
"projectResourceId": {
"type": "string",
"description": "The resource id of the Azure Machine Learning project."
"description": "The resource ID of the Azure Machine Learning project."
},
"name": {
"type": "string",
Expand Down Expand Up @@ -3077,7 +3077,7 @@
},
"OnYourDataApiKeyAuthenticationOptions": {
"type": "object",
"description": "The authentication option using API key.",
"description": "The authentication options for Azure OpenAI On Your Data when using an API key.",
"properties": {
"key": {
"type": "string",
Expand All @@ -3096,11 +3096,11 @@
},
"OnYourDataAuthenticationOptions": {
"type": "object",
"description": "The authentication options for Azure OpenAI on your data.",
"description": "The authentication options for Azure OpenAI On Your Data.",
"properties": {
"type": {
"$ref": "#/definitions/OnYourDataAuthenticationType",
"description": "The Authentication type."
"description": "The authentication type."
}
},
"discriminator": "type",
Expand All @@ -3110,7 +3110,7 @@
},
"OnYourDataAuthenticationType": {
"type": "string",
"description": " Authentication types supported by with Azure OpenAI on your data.",
"description": "The authentication types supported with Azure OpenAI On Your Data.",
"enum": [
"APIKey",
"ConnectionString",
Expand All @@ -3125,34 +3125,34 @@
{
"name": "apiKey",
"value": "APIKey",
"description": "API key."
"description": "Authentication via API key."
},
{
"name": "connectionString",
"value": "ConnectionString",
"description": "Connection string."
"description": "Authentication via connection string."
},
{
"name": "keyAndKeyId",
"value": "KeyAndKeyId",
"description": "Key and keyId pair."
"description": "Authentication via key and key ID pair."
},
{
"name": "systemAssignedManagedIdentity",
"value": "SystemAssignedManagedIdentity",
"description": "System-assigned managed identity."
"description": "Authentication via system-assigned managed identity."
},
{
"name": "userAssignedManagedIdentity",
"value": "UserAssignedManagedIdentity",
"description": "User-assigned managed identity."
"description": "Authentication via user-assigned managed identity."
}
]
}
},
"OnYourDataConnectionStringAuthenticationOptions": {
"type": "object",
"description": "The authentication option using connection string.",
"description": "The authentication options for Azure OpenAI On Your Data when using a connection string.",
"properties": {
"connectionString": {
"type": "string",
Expand Down Expand Up @@ -3208,7 +3208,7 @@
{
"name": "modelId",
"value": "ModelId",
"description": "The embedding model id defined in the search service. Currently only supported by Elasticsearch."
"description": "The embedding model ID defined in the search service. Currently only supported by Elasticsearch."
}
]
}
Expand Down Expand Up @@ -3263,7 +3263,7 @@
"properties": {
"modelId": {
"type": "string",
"description": "The embedding model id build inside the search service. Currently only supported by Elasticsearch."
"description": "The embedding model ID build inside the search service. Currently only supported by Elasticsearch."
}
},
"required": [
Expand All @@ -3278,7 +3278,7 @@
},
"OnYourDataKeyAndKeyIdAuthenticationOptions": {
"type": "object",
"description": "The authentication option using Elasticsearch key and keyId pair.",
"description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.",
"properties": {
"key": {
"type": "string",
Expand All @@ -3302,7 +3302,7 @@
},
"OnYourDataSystemAssignedManagedIdentityAuthenticationOptions": {
"type": "object",
"description": "The authentication option using system-assigned managed identity.",
"description": "The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.",
"allOf": [
{
"$ref": "#/definitions/OnYourDataAuthenticationOptions"
Expand All @@ -3312,7 +3312,7 @@
},
"OnYourDataUserAssignedManagedIdentityAuthenticationOptions": {
"type": "object",
"description": "The authentication option using user-assigned managed identity.",
"description": "The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.",
"properties": {
"managedIdentityResourceId": {
"type": "string",
Expand Down
⚡