-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[OpenAI] Added missing GA service versions, 2024-02-01 and 2024-06-01 (…
…#29424) * added a missing GA service version * add the generated.json 2024-02-01 but looks different to inference.json * add the 2024-06-01 service API version * remove self introudced new generated.json from 2024-02-01 * added operation id * Update specification/ai/Face/tspconfig.yaml * Ran npx tsv command * copied from previous examples * added generated swagger version into readme * fixed "Missing required property: deployment-id" * run tsp compile * generated.json with generated_ prefix json file. * revert the data-plane changes for inference.json * add generated.json updates * suppress spellcheck failures --------- Co-authored-by: Jose Alvarez <jp.alvarezl@gmail.com>
- Loading branch information
1 parent
e60f9d4
commit 46de0ae
Showing
61 changed files
with
14,883 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
16 changes: 16 additions & 0 deletions
16
...on/cognitiveservices/OpenAI.Inference/examples/2024-02-01/audio_transcription_object.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| { | ||
| "operationId": "GetAudioTranscriptionAsResponseObject", | ||
| "title": "Gets transcribed text and associated metadata from provided spoken audio data.", | ||
| "parameters": { | ||
| "endpoint": "{endpoint}", | ||
| "api-version": "2024-02-01", | ||
| "deploymentId": "<deployment-id>" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "text": "A structured object when requesting json or verbose_json" | ||
| } | ||
| } | ||
| } | ||
| } |
16 changes: 16 additions & 0 deletions
16
...tion/cognitiveservices/OpenAI.Inference/examples/2024-02-01/audio_transcription_text.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| { | ||
| "operationId": "GetAudioTranscriptionAsPlainText", | ||
| "title": "Gets transcribed text and associated metadata from provided spoken audio data.", | ||
| "parameters": { | ||
| "endpoint": "{endpoint}", | ||
| "api-version": "2024-02-01", | ||
| "deploymentId": "<deployment-id>", | ||
| "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "type": "string", | ||
| "example": "plain text when requesting text, srt, or vtt" | ||
| } | ||
| } | ||
| } |
17 changes: 17 additions & 0 deletions
17
...tion/cognitiveservices/OpenAI.Inference/examples/2024-02-01/audio_translation_object.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| { | ||
| "operationId": "GetAudioTranslationAsResponseObject", | ||
| "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", | ||
| "parameters": { | ||
| "endpoint": "{endpoint}", | ||
| "api-version": "2024-02-01", | ||
| "deploymentId": "<deployment-id>", | ||
| "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "text": "A structured object when requesting json or verbose_json" | ||
| } | ||
| } | ||
| } | ||
| } |
16 changes: 16 additions & 0 deletions
16
...cation/cognitiveservices/OpenAI.Inference/examples/2024-02-01/audio_translation_text.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| { | ||
| "operationId": "GetAudioTranslationAsPlainText", | ||
| "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", | ||
| "parameters": { | ||
| "endpoint": "{endpoint}", | ||
| "api-version": "2024-02-01", | ||
| "deploymentId": "<deployment-id>", | ||
| "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "type": "string", | ||
| "example": "plain text when requesting text, srt, or vtt" | ||
| } | ||
| } | ||
| } |
58 changes: 58 additions & 0 deletions
58
...eservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_aml_index.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| { | ||
| "operationId": "GetChatCompletionsWithAzureExtensions", | ||
| "title": "Creates a completion for the provided AML index. Uses Azure OpenAI chat extensions.", | ||
| "parameters": { | ||
| "endpoint": "{endpoint}", | ||
| "api-version": "2024-02-01", | ||
| "deploymentId": "<deployment-id>", | ||
| "body": { | ||
| "messages": [ | ||
| { | ||
| "role": "user", | ||
| "content": "can you tell me how to care for a parrot?" | ||
| } | ||
| ], | ||
| "dataSources": [ | ||
| { | ||
| "type": "AzureMLIndex", | ||
| "parameters": { | ||
| "projectResourceId": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.MachineLearningServices/workspaces/{workspace-id}", | ||
| "name": "gm-cars", | ||
| "version": "5" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", | ||
| "created": 1686676106, | ||
| "choices": [ | ||
| { | ||
| "index": 0, | ||
| "finish_reason": "stop", | ||
| "message": { | ||
| "role": "assistant", | ||
| "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", | ||
| "context": { | ||
| "messages": [ | ||
| { | ||
| "role": "tool", | ||
| "content": "extension specific payload here" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "usage": { | ||
| "completion_tokens": 557, | ||
| "prompt_tokens": 33, | ||
| "total_tokens": 590 | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
82 changes: 82 additions & 0 deletions
82
...enAI.Inference/examples/2024-02-01/extensions_chat_completions_azure_search_advanced.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| { | ||
| "operationId": "GetChatCompletionsWithAzureExtensions", | ||
| "title": "Creates a completion based on Azure Cognitive Services vector data and user-assigned managed identity. Uses Azure OpenAI chat extensions.", | ||
| "parameters": { | ||
| "endpoint": "{endpoint}", | ||
| "api-version": "2024-02-01", | ||
| "deploymentId": "<deployment-id>", | ||
| "body": { | ||
| "messages": [ | ||
| { | ||
| "role": "user", | ||
| "content": "can you tell me how to care for a parrot?" | ||
| } | ||
| ], | ||
| "dataSources": [ | ||
| { | ||
| "type": "AzureCognitiveSearch", | ||
| "parameters": { | ||
| "endpoint": "https://your-search-endpoint.search.windows.net/", | ||
| "authentication": { | ||
| "type": "UserAssignedManagedIdentity", | ||
| "managedIdentityResourceId": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}" | ||
| }, | ||
| "indexName": "{index name}", | ||
| "queryType": "vector", | ||
| "embeddingDependency": { | ||
| "type": "DeploymentName", | ||
| "deploymentName": "{embedding deployment name}" | ||
| }, | ||
| "inScope": true, | ||
| "topNDocuments": 5, | ||
| "strictness": 3, | ||
| "roleInformation": "You are an AI assistant that helps people find information.", | ||
| "fieldsMapping": { | ||
| "contentFieldsSeparator": "\\n", | ||
| "contentFields": [ | ||
| "content" | ||
| ], | ||
| "filepathField": "filepath", | ||
| "titleField": "title", | ||
| "urlField": "url", | ||
| "vectorFields": [ | ||
| "contentvector" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", | ||
| "created": 1686676106, | ||
| "choices": [ | ||
| { | ||
| "index": 0, | ||
| "finish_reason": "stop", | ||
| "message": { | ||
| "role": "assistant", | ||
| "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", | ||
| "context": { | ||
| "messages": [ | ||
| { | ||
| "role": "tool", | ||
| "content": "extension specific payload here" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "usage": { | ||
| "completion_tokens": 557, | ||
| "prompt_tokens": 33, | ||
| "total_tokens": 590 | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
63 changes: 63 additions & 0 deletions
63
....Inference/examples/2024-02-01/extensions_chat_completions_azure_search_image_vector.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| { | ||
| "operationId": "GetChatCompletionsWithAzureExtensions", | ||
| "title": "Creates a completion based on Azure Cognitive Services image vector data. Uses Azure OpenAI chat extensions.", | ||
| "parameters": { | ||
| "endpoint": "{endpoint}", | ||
| "api-version": "2024-02-01", | ||
| "deploymentId": "<deployment-id>", | ||
| "body": { | ||
| "messages": [ | ||
| { | ||
| "role": "user", | ||
| "content": "can you tell me how to care for a parrot?" | ||
| } | ||
| ], | ||
| "dataSources": [ | ||
| { | ||
| "type": "AzureCognitiveSearch", | ||
| "parameters": { | ||
| "endpoint": "https://your-search-endpoint.search.windows.net/", | ||
| "indexName": "{index name}", | ||
| "queryType": "vector", | ||
| "fieldsMapping": { | ||
| "imageVectorFields": [ | ||
| "image_vector" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", | ||
| "created": 1686676106, | ||
| "choices": [ | ||
| { | ||
| "index": 0, | ||
| "finish_reason": "stop", | ||
| "message": { | ||
| "role": "assistant", | ||
| "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", | ||
| "context": { | ||
| "messages": [ | ||
| { | ||
| "role": "tool", | ||
| "content": "extension specific payload here" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "usage": { | ||
| "completion_tokens": 557, | ||
| "prompt_tokens": 33, | ||
| "total_tokens": 590 | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
57 changes: 57 additions & 0 deletions
57
...penAI.Inference/examples/2024-02-01/extensions_chat_completions_azure_search_minimum.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| { | ||
| "operationId": "GetChatCompletionsWithAzureExtensions", | ||
| "title": "Creates a completion based on Azure Cognitive Services data and system-assigned managed identity. Uses Azure OpenAI chat extensions.", | ||
| "parameters": { | ||
| "endpoint": "{endpoint}", | ||
| "api-version": "2024-02-01", | ||
| "deploymentId": "<deployment-id>", | ||
| "body": { | ||
| "messages": [ | ||
| { | ||
| "role": "user", | ||
| "content": "can you tell me how to care for a parrot?" | ||
| } | ||
| ], | ||
| "dataSources": [ | ||
| { | ||
| "type": "AzureCognitiveSearch", | ||
| "parameters": { | ||
| "endpoint": "https://your-search-endpoint.search.windows.net/", | ||
| "indexName": "{index name}" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", | ||
| "created": 1686676106, | ||
| "choices": [ | ||
| { | ||
| "index": 0, | ||
| "finish_reason": "stop", | ||
| "message": { | ||
| "role": "assistant", | ||
| "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", | ||
| "context": { | ||
| "messages": [ | ||
| { | ||
| "role": "tool", | ||
| "content": "extension specific payload here" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "usage": { | ||
| "completion_tokens": 557, | ||
| "prompt_tokens": 33, | ||
| "total_tokens": 590 | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.