Skip to content

Commit 1696732

Browse files
jpalvarezljpalvarezl
authored
Hid LROs (#26898)
1 parent 5d3c90d commit 1696732

5 files changed

Lines changed: 43 additions & 56 deletions

File tree

‎specification/cognitiveservices/OpenAI.Inference/client.tsp‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,7 @@ interface OpenAIClient {
3535
getChatCompletions is Azure.OpenAI.getChatCompletions;
3636
getChatCompletionsWithAzureExtensions is Azure.OpenAI.getChatCompletionsWithAzureExtensions;
3737

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

4540
getEmbeddings is Azure.OpenAI.getEmbeddings;
4641
}
47-
48-
@@access(OpenAIClient.beginImageGenerations, Access.internal);
49-
@@access(OpenAIClient.getAzureBatchImageGenerationOperationStatus, Access.internal);

‎specification/cognitiveservices/OpenAI.Inference/client/custom_visibility.tsp‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,6 @@ import "../main.tsp";
33

44
using Azure.ClientGenerator.Core;
55

6-
// Azure-specific long-running operations should be treated as implementation details that are wrapped into
7-
// appropriately merged public surface.
8-
@@access(Azure.OpenAI.beginAzureBatchImageGeneration, Access.internal);
9-
@@access(Azure.OpenAI.getAzureBatchImageGenerationOperationStatus, Access.internal);
10-
116
// Azure-specific Chat Completions with extensions should be handled by clients as a conditional selection within the
127
// shared Chat Completions route, with the selection gated by the presence or non-presence of additional child
138
// configuration options on the request payload options model.

‎specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/generated.json‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1751,7 +1751,7 @@
17511751
},
17521752
"OnYourDataApiKeyAuthenticationOptions": {
17531753
"type": "object",
1754-
"description": "The authentication option using API key.",
1754+
"description": "The authentication options for Azure OpenAI On Your Data when using an API key.",
17551755
"properties": {
17561756
"key": {
17571757
"type": "string",
@@ -1770,11 +1770,11 @@
17701770
},
17711771
"OnYourDataAuthenticationOptions": {
17721772
"type": "object",
1773-
"description": "The authentication options for Azure OpenAI on your data.",
1773+
"description": "The authentication options for Azure OpenAI On Your Data.",
17741774
"properties": {
17751775
"type": {
17761776
"$ref": "#/definitions/OnYourDataAuthenticationType",
1777-
"description": "The Authentication type."
1777+
"description": "The authentication type."
17781778
}
17791779
},
17801780
"discriminator": "type",
@@ -1784,7 +1784,7 @@
17841784
},
17851785
"OnYourDataAuthenticationType": {
17861786
"type": "string",
1787-
"description": " Authentication types supported by with Azure OpenAI on your data.",
1787+
"description": "The authentication types supported with Azure OpenAI On Your Data.",
17881788
"enum": [
17891789
"APIKey",
17901790
"ConnectionString",
@@ -1799,34 +1799,34 @@
17991799
{
18001800
"name": "apiKey",
18011801
"value": "APIKey",
1802-
"description": "API key."
1802+
"description": "Authentication via API key."
18031803
},
18041804
{
18051805
"name": "connectionString",
18061806
"value": "ConnectionString",
1807-
"description": "Connection string."
1807+
"description": "Authentication via connection string."
18081808
},
18091809
{
18101810
"name": "keyAndKeyId",
18111811
"value": "KeyAndKeyId",
1812-
"description": "Key and keyId pair."
1812+
"description": "Authentication via key and key ID pair."
18131813
},
18141814
{
18151815
"name": "systemAssignedManagedIdentity",
18161816
"value": "SystemAssignedManagedIdentity",
1817-
"description": "System-assigned managed identity."
1817+
"description": "Authentication via system-assigned managed identity."
18181818
},
18191819
{
18201820
"name": "userAssignedManagedIdentity",
18211821
"value": "UserAssignedManagedIdentity",
1822-
"description": "User-assigned managed identity."
1822+
"description": "Authentication via user-assigned managed identity."
18231823
}
18241824
]
18251825
}
18261826
},
18271827
"OnYourDataConnectionStringAuthenticationOptions": {
18281828
"type": "object",
1829-
"description": "The authentication option using connection string.",
1829+
"description": "The authentication options for Azure OpenAI On Your Data when using a connection string.",
18301830
"properties": {
18311831
"connectionString": {
18321832
"type": "string",
@@ -1845,7 +1845,7 @@
18451845
},
18461846
"OnYourDataKeyAndKeyIdAuthenticationOptions": {
18471847
"type": "object",
1848-
"description": "The authentication option using Elasticsearch key and keyId pair.",
1848+
"description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.",
18491849
"properties": {
18501850
"key": {
18511851
"type": "string",
@@ -1869,7 +1869,7 @@
18691869
},
18701870
"OnYourDataSystemAssignedManagedIdentityAuthenticationOptions": {
18711871
"type": "object",
1872-
"description": "The authentication option using system-assigned managed identity.",
1872+
"description": "The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.",
18731873
"allOf": [
18741874
{
18751875
"$ref": "#/definitions/OnYourDataAuthenticationOptions"
@@ -1879,7 +1879,7 @@
18791879
},
18801880
"OnYourDataUserAssignedManagedIdentityAuthenticationOptions": {
18811881
"type": "object",
1882-
"description": "The authentication option using user-assigned managed identity.",
1882+
"description": "The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.",
18831883
"properties": {
18841884
"managedIdentityResourceId": {
18851885
"type": "string",

‎specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/generated.json‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2368,7 +2368,7 @@
23682368
},
23692369
"OnYourDataApiKeyAuthenticationOptions": {
23702370
"type": "object",
2371-
"description": "The authentication option using API key.",
2371+
"description": "The authentication options for Azure OpenAI On Your Data when using an API key.",
23722372
"properties": {
23732373
"key": {
23742374
"type": "string",
@@ -2387,11 +2387,11 @@
23872387
},
23882388
"OnYourDataAuthenticationOptions": {
23892389
"type": "object",
2390-
"description": "The authentication options for Azure OpenAI on your data.",
2390+
"description": "The authentication options for Azure OpenAI On Your Data.",
23912391
"properties": {
23922392
"type": {
23932393
"$ref": "#/definitions/OnYourDataAuthenticationType",
2394-
"description": "The Authentication type."
2394+
"description": "The authentication type."
23952395
}
23962396
},
23972397
"discriminator": "type",
@@ -2401,7 +2401,7 @@
24012401
},
24022402
"OnYourDataAuthenticationType": {
24032403
"type": "string",
2404-
"description": " Authentication types supported by with Azure OpenAI on your data.",
2404+
"description": "The authentication types supported with Azure OpenAI On Your Data.",
24052405
"enum": [
24062406
"APIKey",
24072407
"ConnectionString",
@@ -2416,34 +2416,34 @@
24162416
{
24172417
"name": "apiKey",
24182418
"value": "APIKey",
2419-
"description": "API key."
2419+
"description": "Authentication via API key."
24202420
},
24212421
{
24222422
"name": "connectionString",
24232423
"value": "ConnectionString",
2424-
"description": "Connection string."
2424+
"description": "Authentication via connection string."
24252425
},
24262426
{
24272427
"name": "keyAndKeyId",
24282428
"value": "KeyAndKeyId",
2429-
"description": "Key and keyId pair."
2429+
"description": "Authentication via key and key ID pair."
24302430
},
24312431
{
24322432
"name": "systemAssignedManagedIdentity",
24332433
"value": "SystemAssignedManagedIdentity",
2434-
"description": "System-assigned managed identity."
2434+
"description": "Authentication via system-assigned managed identity."
24352435
},
24362436
{
24372437
"name": "userAssignedManagedIdentity",
24382438
"value": "UserAssignedManagedIdentity",
2439-
"description": "User-assigned managed identity."
2439+
"description": "Authentication via user-assigned managed identity."
24402440
}
24412441
]
24422442
}
24432443
},
24442444
"OnYourDataConnectionStringAuthenticationOptions": {
24452445
"type": "object",
2446-
"description": "The authentication option using connection string.",
2446+
"description": "The authentication options for Azure OpenAI On Your Data when using a connection string.",
24472447
"properties": {
24482448
"connectionString": {
24492449
"type": "string",
@@ -2462,7 +2462,7 @@
24622462
},
24632463
"OnYourDataKeyAndKeyIdAuthenticationOptions": {
24642464
"type": "object",
2465-
"description": "The authentication option using Elasticsearch key and keyId pair.",
2465+
"description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.",
24662466
"properties": {
24672467
"key": {
24682468
"type": "string",
@@ -2486,7 +2486,7 @@
24862486
},
24872487
"OnYourDataSystemAssignedManagedIdentityAuthenticationOptions": {
24882488
"type": "object",
2489-
"description": "The authentication option using system-assigned managed identity.",
2489+
"description": "The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.",
24902490
"allOf": [
24912491
{
24922492
"$ref": "#/definitions/OnYourDataAuthenticationOptions"
@@ -2496,7 +2496,7 @@
24962496
},
24972497
"OnYourDataUserAssignedManagedIdentityAuthenticationOptions": {
24982498
"type": "object",
2499-
"description": "The authentication option using user-assigned managed identity.",
2499+
"description": "The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.",
25002500
"properties": {
25012501
"managedIdentityResourceId": {
25022502
"type": "string",

‎specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/generated.json‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1356,7 +1356,7 @@
13561356
},
13571357
"indexName": {
13581358
"type": "string",
1359-
"description": "The index name name of Azure Cosmos DB."
1359+
"description": "The index name of Azure Cosmos DB."
13601360
},
13611361
"fieldsMapping": {
13621362
"$ref": "#/definitions/AzureCosmosDBFieldMappingOptions",
@@ -1532,7 +1532,7 @@
15321532
},
15331533
"projectResourceId": {
15341534
"type": "string",
1535-
"description": "The resource id of the Azure Machine Learning project."
1535+
"description": "The resource ID of the Azure Machine Learning project."
15361536
},
15371537
"name": {
15381538
"type": "string",
@@ -3077,7 +3077,7 @@
30773077
},
30783078
"OnYourDataApiKeyAuthenticationOptions": {
30793079
"type": "object",
3080-
"description": "The authentication option using API key.",
3080+
"description": "The authentication options for Azure OpenAI On Your Data when using an API key.",
30813081
"properties": {
30823082
"key": {
30833083
"type": "string",
@@ -3096,11 +3096,11 @@
30963096
},
30973097
"OnYourDataAuthenticationOptions": {
30983098
"type": "object",
3099-
"description": "The authentication options for Azure OpenAI on your data.",
3099+
"description": "The authentication options for Azure OpenAI On Your Data.",
31003100
"properties": {
31013101
"type": {
31023102
"$ref": "#/definitions/OnYourDataAuthenticationType",
3103-
"description": "The Authentication type."
3103+
"description": "The authentication type."
31043104
}
31053105
},
31063106
"discriminator": "type",
@@ -3110,7 +3110,7 @@
31103110
},
31113111
"OnYourDataAuthenticationType": {
31123112
"type": "string",
3113-
"description": " Authentication types supported by with Azure OpenAI on your data.",
3113+
"description": "The authentication types supported with Azure OpenAI On Your Data.",
31143114
"enum": [
31153115
"APIKey",
31163116
"ConnectionString",
@@ -3125,34 +3125,34 @@
31253125
{
31263126
"name": "apiKey",
31273127
"value": "APIKey",
3128-
"description": "API key."
3128+
"description": "Authentication via API key."
31293129
},
31303130
{
31313131
"name": "connectionString",
31323132
"value": "ConnectionString",
3133-
"description": "Connection string."
3133+
"description": "Authentication via connection string."
31343134
},
31353135
{
31363136
"name": "keyAndKeyId",
31373137
"value": "KeyAndKeyId",
3138-
"description": "Key and keyId pair."
3138+
"description": "Authentication via key and key ID pair."
31393139
},
31403140
{
31413141
"name": "systemAssignedManagedIdentity",
31423142
"value": "SystemAssignedManagedIdentity",
3143-
"description": "System-assigned managed identity."
3143+
"description": "Authentication via system-assigned managed identity."
31443144
},
31453145
{
31463146
"name": "userAssignedManagedIdentity",
31473147
"value": "UserAssignedManagedIdentity",
3148-
"description": "User-assigned managed identity."
3148+
"description": "Authentication via user-assigned managed identity."
31493149
}
31503150
]
31513151
}
31523152
},
31533153
"OnYourDataConnectionStringAuthenticationOptions": {
31543154
"type": "object",
3155-
"description": "The authentication option using connection string.",
3155+
"description": "The authentication options for Azure OpenAI On Your Data when using a connection string.",
31563156
"properties": {
31573157
"connectionString": {
31583158
"type": "string",
@@ -3208,7 +3208,7 @@
32083208
{
32093209
"name": "modelId",
32103210
"value": "ModelId",
3211-
"description": "The embedding model id defined in the search service. Currently only supported by Elasticsearch."
3211+
"description": "The embedding model ID defined in the search service. Currently only supported by Elasticsearch."
32123212
}
32133213
]
32143214
}
@@ -3263,7 +3263,7 @@
32633263
"properties": {
32643264
"modelId": {
32653265
"type": "string",
3266-
"description": "The embedding model id build inside the search service. Currently only supported by Elasticsearch."
3266+
"description": "The embedding model ID build inside the search service. Currently only supported by Elasticsearch."
32673267
}
32683268
},
32693269
"required": [
@@ -3278,7 +3278,7 @@
32783278
},
32793279
"OnYourDataKeyAndKeyIdAuthenticationOptions": {
32803280
"type": "object",
3281-
"description": "The authentication option using Elasticsearch key and keyId pair.",
3281+
"description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.",
32823282
"properties": {
32833283
"key": {
32843284
"type": "string",
@@ -3302,7 +3302,7 @@
33023302
},
33033303
"OnYourDataSystemAssignedManagedIdentityAuthenticationOptions": {
33043304
"type": "object",
3305-
"description": "The authentication option using system-assigned managed identity.",
3305+
"description": "The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.",
33063306
"allOf": [
33073307
{
33083308
"$ref": "#/definitions/OnYourDataAuthenticationOptions"
@@ -3312,7 +3312,7 @@
33123312
},
33133313
"OnYourDataUserAssignedManagedIdentityAuthenticationOptions": {
33143314
"type": "object",
3315-
"description": "The authentication option using user-assigned managed identity.",
3315+
"description": "The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.",
33163316
"properties": {
33173317
"managedIdentityResourceId": {
33183318
"type": "string",

0 commit comments

Comments
 (0)
⚡