swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Deployments API description: Operations for managing model deployments schemes: - https tags: - name: Deployments description: Operations for managing model deployments paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments : get: operationId: Deployments_List summary: Microsoft Azure List Model Deployments description: Gets the deployments associated with the Cognitive Services account. tags: - Deployments parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/AccountNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: Successfully returned the deployments. content: application/json: schema: $ref: '#/components/schemas/DeploymentListResult' examples: DeploymentsList200Example: summary: Default Deployments_List 200 response x-microcks-default: true value: value: - id: abc123 name: Example Title type: example_value etag: example_value nextLink: example_value default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: DeploymentsListdefaultExample: summary: Default Deployments_List default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value additionalInfo: - type: example_value info: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName} : get: operationId: Deployments_Get summary: Microsoft Azure Get a Model Deployment description: Gets the specified deployments associated with the Cognitive Services account. tags: - Deployments parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/AccountNameParameter' - name: deploymentName in: path required: true description: The name of the deployment. schema: type: string example: example_value - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: Successfully returned the deployment. content: application/json: schema: $ref: '#/components/schemas/Deployment' examples: DeploymentsGet200Example: summary: Default Deployments_Get 200 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value etag: example_value sku: name: Example Title tier: Free properties: provisioningState: Accepted scaleSettings: scaleType: Standard capacity: 10 activeCapacity: 10 rateLimits: - {} capabilities: example_value versionUpgradeOption: OnceNewDefaultVersionAvailable default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: DeploymentsGetdefaultExample: summary: Default Deployments_Get default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value additionalInfo: - type: example_value info: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: Deployments_CreateOrUpdate summary: Microsoft Azure Create or Update a Model Deployment description: Update the state of specified deployments associated with the Cognitive Services account. tags: - Deployments parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/AccountNameParameter' - name: deploymentName in: path required: true description: The name of the deployment. schema: type: string example: example_value - $ref: '#/components/parameters/ApiVersionParameter' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Deployment' examples: DeploymentsCreateorupdateRequestExample: summary: Default Deployments_CreateOrUpdate request x-microcks-default: true value: id: abc123 name: Example Title type: example_value etag: example_value sku: name: Example Title tier: Free properties: provisioningState: Accepted scaleSettings: scaleType: Standard capacity: 10 activeCapacity: 10 rateLimits: - {} capabilities: example_value versionUpgradeOption: OnceNewDefaultVersionAvailable responses: '200': description: Successfully updated the deployment. content: application/json: schema: $ref: '#/components/schemas/Deployment' examples: DeploymentsCreateorupdate200Example: summary: Default Deployments_CreateOrUpdate 200 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value etag: example_value sku: name: Example Title tier: Free properties: provisioningState: Accepted scaleSettings: scaleType: Standard capacity: 10 activeCapacity: 10 rateLimits: - {} capabilities: example_value versionUpgradeOption: OnceNewDefaultVersionAvailable '201': description: Successfully created the deployment. content: application/json: schema: $ref: '#/components/schemas/Deployment' examples: DeploymentsCreateorupdate201Example: summary: Default Deployments_CreateOrUpdate 201 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value etag: example_value sku: name: Example Title tier: Free properties: provisioningState: Accepted scaleSettings: scaleType: Standard capacity: 10 activeCapacity: 10 rateLimits: - {} capabilities: example_value versionUpgradeOption: OnceNewDefaultVersionAvailable default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: DeploymentsCreateorupdatedefaultExample: summary: Default Deployments_CreateOrUpdate default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value additionalInfo: - type: example_value info: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: Deployments_Delete summary: Microsoft Azure Delete a Model Deployment description: Deletes the specified deployment associated with the Cognitive Services account. tags: - Deployments parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/AccountNameParameter' - name: deploymentName in: path required: true description: The name of the deployment. schema: type: string example: example_value - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: Successfully deleted the deployment. '202': description: Accepted. The deployment deletion is in progress. '204': description: The deployment does not exist. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: DeploymentsDeletedefaultExample: summary: Default Deployments_Delete default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value additionalInfo: - type: example_value info: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /deployments/{deploymentId}/audio/speech: post: operationId: microsoftAzureGeneratespeechfromtext description: Generates text-to-speech audio from the input text. produces: - application/octet-stream - application/json parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: deploymentId in: path description: Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request. required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/SpeechGenerationOptions' responses: '200': description: The request has succeeded. schema: type: file default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Generates text-to-speech audio from the input text.: $ref: ./examples/generated_audio_speech.json summary: Microsoft Azure Post Deployments Deploymentid Audio Speech tags: - Deployments /deployments/{deploymentId}/audio/transcriptions: post: operationId: microsoftAzureGetaudiotranscriptionasplaintext description: Gets transcribed text and associated metadata from provided spoken audio data. Audio will be transcribed in the
written language corresponding to the language it was spoken in. produces: - text/plain - application/json consumes: - multipart/form-data parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: deploymentId in: path description: Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request. required: true type: string - $ref: '#/parameters/AudioTranscriptionOptions.file' - $ref: '#/parameters/AudioTranscriptionOptions.filename' - $ref: '#/parameters/AudioTranscriptionOptions.responseFormat' - $ref: '#/parameters/AudioTranscriptionOptions.language' - $ref: '#/parameters/AudioTranscriptionOptions.prompt' - $ref: '#/parameters/AudioTranscriptionOptions.temperature' - $ref: '#/parameters/AudioTranscriptionOptions.model' responses: '200': description: The request has succeeded. schema: type: string default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Gets transcribed text and associated metadata from provided spoken audio data.: $ref: ./examples/generated_audio_transcription_text.json summary: Microsoft Azure Post Deployments Deploymentid Audio Transcriptions tags: - Deployments /deployments/{deploymentId}/audio/translations: post: operationId: microsoftAzureGetaudiotranslationasplaintext description: Gets English language transcribed text and associated metadata from provided spoken audio data. produces: - text/plain - application/json consumes: - multipart/form-data parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: deploymentId in: path description: Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request. required: true type: string - $ref: '#/parameters/AudioTranslationOptions.file' - $ref: '#/parameters/AudioTranslationOptions.filename' - $ref: '#/parameters/AudioTranslationOptions.responseFormat' - $ref: '#/parameters/AudioTranslationOptions.prompt' - $ref: '#/parameters/AudioTranslationOptions.temperature' - $ref: '#/parameters/AudioTranslationOptions.model' responses: '200': description: The request has succeeded. schema: type: string default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Gets English language transcribed text and associated metadata from provided spoken audio data.: $ref: ./examples/generated_audio_translation_text.json summary: Microsoft Azure Post Deployments Deploymentid Audio Translations tags: - Deployments /deployments/{deploymentId}/chat/completions: post: operationId: microsoftAzureGetchatcompletions description: Gets chat completions for the provided chat messages.
Completions support a wide variety of tasks and generate text that continues from or "completes"
provided prompt data. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: deploymentId in: path description: Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request. required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/ChatCompletionsOptions' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/ChatCompletions' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: ? Creates a completion based on Azure Cognitive Services data and system-assigned managed identity. Uses Azure OpenAI chat extensions. : $ref: ./examples/generated_extensions_chat_completions_azure_search_minimum.json Creates a completion based on Azure Cognitive Services image vector data. Uses Azure OpenAI chat extensions.: $ref: ./examples/generated_extensions_chat_completions_azure_search_image_vector.json ? Creates a completion based on Azure Cognitive Services vector data and user-assigned managed identity. Uses Azure OpenAI chat extensions. : $ref: ./examples/generated_extensions_chat_completions_azure_search_advanced.json Creates a completion for the provided AML index. Uses Azure OpenAI chat extensions.: $ref: ./examples/generated_extensions_chat_completions_aml_index.json Creates a completion for the provided Azure Cosmos DB. Uses Azure OpenAI chat extensions.: $ref: ./examples/generated_extensions_chat_completions_cosmos_db.json Creates a completion for the provided Elasticsearch. Uses Azure OpenAI chat extensions.: $ref: ./examples/generated_extensions_chat_completions_elasticsearch.json Creates a completion for the provided Pinecone resource. Uses Azure OpenAI chat extensions.: $ref: ./examples/generated_extensions_chat_completions_pinecone.json Creates a completion for the provided prompt, parameters and chosen model.: $ref: ./examples/generated_chat_completions.json summary: Microsoft Azure Post Deployments Deploymentid Chat Completions tags: - Deployments /deployments/{deploymentId}/completions: post: operationId: microsoftAzureGetcompletions description: Gets completions for the provided input prompts.
Completions support a wide variety of tasks and generate text that continues from or "completes"
provided prompt data. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: deploymentId in: path description: Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request. required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/CompletionsOptions' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/Completions' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Creates a completion for the provided prompt, parameters and chosen model.: $ref: ./examples/generated_completions.json summary: Microsoft Azure Post Deployments Deploymentid Completions tags: - Deployments /deployments/{deploymentId}/embeddings: post: operationId: microsoftAzureGetembeddings description: Return the embeddings for a given prompt. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: deploymentId in: path description: Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request. required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/EmbeddingsOptions' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/Embeddings' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Return the embeddings for a given prompt.: $ref: ./examples/generated_embeddings.json summary: Microsoft Azure Post Deployments Deploymentid Embeddings tags: - Deployments /deployments/{deploymentId}/images/generations: post: operationId: microsoftAzureGetimagegenerations description: Creates an image given a prompt. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: deploymentId in: path description: Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request. required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/ImageGenerationOptions' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/ImageGenerations' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Creates images given a prompt.: $ref: ./examples/generated_image_generation.json summary: Microsoft Azure Post Deployments Deploymentid Images Generations tags: - Deployments /deployments: get: tags: - Deployments summary: Microsoft Azure Gets The List Of Deployments Owned By The Azure Openai Resource operationId: microsoftAzureDeploymentsList produces: - application/json parameters: - $ref: '#/parameters/apiVersionQueryParameter' responses: '200': description: Success schema: $ref: '#/definitions/DeploymentList' default: description: An error occurred. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Getting all deployments owned by account.: $ref: ./examples/get_deployments.json description: Needs a more full description created. post: tags: - Deployments summary: Microsoft Azure Creates A New Deployment For The Azure Openai Resource According To The Given Specification operationId: microsoftAzureDeploymentsCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/apiVersionQueryParameter' - in: body name: body description: The specification of the deployment including the model to deploy and the scale settings. schema: $ref: '#/definitions/Deployment' responses: '201': description: The deployment has been successfully created. schema: $ref: '#/definitions/Deployment' headers: Location: description: The location of the newly created item. type: string format: uri default: description: An error occurred. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Creating a deployment.: $ref: ./examples/post_deployment.json description: Needs a more full description created. /deployments/{deployment_id}: get: tags: - Deployments summary: Microsoft Azure Gets Details For A Single Deployment Specified By The Given Deployment Id operationId: microsoftAzureDeploymentsGet produces: - application/json parameters: - in: path name: deployment_id description: The identifier of the deployment. required: true type: string - $ref: '#/parameters/apiVersionQueryParameter' responses: '200': description: Success schema: $ref: '#/definitions/Deployment' default: description: An error occurred. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Getting a specific deployment.: $ref: ./examples/get_deployment.json description: Needs a more full description created. patch: tags: - Deployments summary: Microsoft Azure Updates The Mutable Details Of The Deployment With The Given Deployment Id operationId: microsoftAzureDeploymentsUpdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: deployment_id description: The identifier of the deployment. required: true type: string - $ref: '#/parameters/apiVersionQueryParameter' - in: body name: body description: The updated values for the deployment. schema: $ref: '#/definitions/DeploymentUpdate' responses: '200': description: The update process was successfully started. schema: $ref: '#/definitions/Deployment' '409': description: The specified deployment does not exist or is in a non-terminal state. schema: $ref: '#/definitions/ErrorResponse' x-ms-error-response: true default: description: An error occurred. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Updating an existing deployment with less capacity: $ref: ./examples/patch_deployment_less_capacity.json description: Needs a more full description created. delete: tags: - Deployments summary: Microsoft Azure Deletes The Deployment Specified By The Given Deployment Id operationId: microsoftAzureDeploymentsDelete produces: - application/json parameters: - in: path name: deployment_id description: The identifier of the deployment. required: true type: string - $ref: '#/parameters/apiVersionQueryParameter' responses: '204': description: The deployment was successfully deleted. default: description: An error occurred. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Deleting a deployment.: $ref: ./examples/delete_deployment.json description: Needs a more full description created. /deployments/{deployment-id}: get: tags: - Deployments summary: Microsoft Azure Gets Details For A Single Deployment Specified By The Given Deployment Id operationId: microsoftAzureDeploymentsGet produces: - application/json parameters: - in: path name: deployment-id description: The identifier of the deployment. required: true type: string - $ref: '#/parameters/apiVersionQueryParameter_3' responses: '200': description: Success schema: $ref: '#/definitions/Deployment_2' default: description: An error occurred. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-examples: Getting a specific deployment.: $ref: ./examples/get_deployment.json description: Needs a more full description created. patch: tags: - Deployments summary: Microsoft Azure Updates The Mutable Details Of The Deployment With The Given Deployment Id operationId: microsoftAzureDeploymentsUpdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: deployment-id description: The identifier of the deployment. required: true type: string - $ref: '#/parameters/apiVersionQueryParameter_3' - in: body name: deployment description: The updated values for the deployment. required: true schema: $ref: '#/definitions/DeploymentUpdate_2' responses: '200': description: The update process was successfully started. schema: $ref: '#/definitions/Deployment_2' '409': description: The specified deployment does not exist or is in a non-terminal state. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-error-response: true default: description: An error occurred. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-examples: Updating an existing deployment with less capacity: $ref: ./examples/patch_deployment_less_capacity.json description: Needs a more full description created. delete: tags: - Deployments summary: Microsoft Azure Deletes The Deployment Specified By The Given Deployment Id operationId: microsoftAzureDeploymentsDelete produces: - application/json parameters: - in: path name: deployment-id description: The identifier of the deployment. required: true type: string - $ref: '#/parameters/apiVersionQueryParameter_3' responses: '204': description: The deployment was successfully deleted. default: description: An error occurred. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-examples: Deleting a deployment.: $ref: ./examples/delete_deployment.json description: Needs a more full description created. /deployments/{deployment-id}/completions: post: summary: Microsoft Azure Creates A Completion For The Provided Prompt, Parameters And Chosen Model operationId: microsoftAzureCompletionsCreate parameters: - in: path name: deployment-id required: true schema: type: string example: davinci description: Deployment id of the model which was deployed. - in: query name: api-version required: true schema: type: string example: 2023-12-01-preview description: api version requestBody: required: true content: application/json: schema: type: object properties: prompt: description: 'The prompt(s) to generate completions for, encoded as a string or array of strings. Note that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document. Maximum allowed size of string list is 2048.' oneOf: - type: string default: '' example: This is a test. nullable: true - type: array items: type: string default: '' example: This is a test. nullable: false description: Array size minimum of 1 and maximum of 2048 max_tokens: description: The token count of your prompt plus max_tokens cannot exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096). Has minimum of 0. type: integer default: 16 example: 16 nullable: true temperature: description: 'What sampling temperature to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer. We generally recommend altering this or top_p but not both.' type: number default: 1 example: 1 nullable: true top_p: description: 'An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.' type: number default: 1 example: 1 nullable: true logit_bias: description: Defaults to null. Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this tokenizer tool (which works for both GPT-2 and GPT-3) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. As an example, you can pass {"50256" : -100} to prevent the <|endoftext|> token from being generated. type: object nullable: false user: description: A unique identifier representing your end-user, which can help monitoring and detecting abuse type: string nullable: false n: description: 'How many completions to generate for each prompt. Minimum of 1 and maximum of 128 allowed. Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop.' type: integer default: 1 example: 1 nullable: true stream: description: 'Whether to stream back partial progress. If set, tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message.' type: boolean nullable: true default: false logprobs: description: 'Include the log probabilities on the logprobs most likely tokens, as well the chosen tokens. For example, if logprobs is 5, the API will return a list of the 5 most likely tokens. The API will always return the logprob of the sampled token, so there may be up to logprobs+1 elements in the response. Minimum of 0 and maximum of 5 allowed.' type: integer default: null nullable: true suffix: type: string nullable: true description: The suffix that comes after a completion of inserted text. echo: description: Echo back the prompt in addition to the completion type: boolean default: false nullable: true stop: description: Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence. oneOf: - type: string default: <|endoftext|> example: ' ' nullable: true - type: array items: type: string example: ' ' nullable: false description: Array minimum size of 1 and maximum of 4 completion_config: type: string nullable: true presence_penalty: description: Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. type: number default: 0 frequency_penalty: description: Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. type: number default: 0 best_of: description: 'Generates best_of completions server-side and returns the "best" (the one with the highest log probability per token). Results cannot be streamed. When used with n, best_of controls the number of candidate completions and n specifies how many to return - best_of must be greater than n. Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop. Has maximum value of 128.' type: integer example: prompt: "Negate the following sentence.The price for bubblegum increased on thursday.\n\n Negated Sentence:" max_tokens: 50 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string object: type: string created: type: integer model: type: string prompt_filter_results: $ref: '#/components/schemas/promptFilterResults' choices: type: array items: type: object properties: text: type: string index: type: integer logprobs: type: object properties: tokens: type: array items: type: string token_logprobs: type: array items: type: number top_logprobs: type: array items: type: object additionalProperties: type: number text_offset: type: array items: type: integer nullable: true finish_reason: type: string content_filter_results: $ref: '#/components/schemas/contentFilterChoiceResults' usage: type: object properties: completion_tokens: type: number format: int32 prompt_tokens: type: number format: int32 total_tokens: type: number format: int32 required: - prompt_tokens - total_tokens - completion_tokens required: - id - object - created - model - choices example: model: davinci object: text_completion id: cmpl-4509KAos68kxOqpE2uYGw81j6m7uo created: 1637097562 choices: - index: 0 text: The price for bubblegum decreased on thursday. logprobs: null finish_reason: stop headers: apim-request-id: description: Request ID for troubleshooting purposes schema: type: string default: description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' headers: apim-request-id: description: Request ID for troubleshooting purposes schema: type: string description: Needs a more full description created. tags: - Deployments /deployments/{deployment-id}/embeddings: post: summary: Microsoft Azure Get A Vector Representation Of A Given Input That Can Be Easily Consumed By Machine Learning Models And Algorithms operationId: microsoftAzureEmbeddingsCreate parameters: - in: path name: deployment-id required: true schema: type: string example: ada-search-index-v1 description: The deployment id of the model which was deployed. - in: query name: api-version required: true schema: type: string example: 2024-03-01-preview description: api version requestBody: required: true content: application/json: schema: type: object additionalProperties: true properties: input: description: 'Input text to get embeddings for, encoded as a string. To get embeddings for multiple inputs in a single request, pass an array of strings. Each input must not exceed 2048 tokens in length. Unless you are embedding code, we suggest replacing newlines (\n) in your input with a single space, as we have observed inferior results when newlines are present.' oneOf: - type: string default: '' example: This is a test. nullable: true - type: array minItems: 1 maxItems: 2048 items: type: string minLength: 1 example: This is a test. nullable: false user: description: A unique identifier representing your end-user, which can help monitoring and detecting abuse. type: string nullable: false input_type: description: input type of embedding search to use type: string example: query encoding_format: description: The format to return the embeddings in. Can be either `float` or `base64`. Defaults to `float`. type: string example: base64 nullable: true dimensions: description: The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models. type: integer example: 1 nullable: true required: - input responses: '200': description: OK content: application/json: schema: type: object properties: object: type: string model: type: string data: type: array items: type: object properties: index: type: integer object: type: string embedding: type: array items: type: number required: - index - object - embedding usage: type: object properties: prompt_tokens: type: integer total_tokens: type: integer required: - prompt_tokens - total_tokens required: - object - model - data - usage x-ms-examples: Create a embeddings.: $ref: ./examples/embeddings.yaml description: Needs a more full description created. tags: - Deployments /deployments/{deployment-id}/chat/completions: post: summary: Microsoft Azure Creates A Completion For The Chat Message operationId: microsoftAzureChatcompletionsCreate parameters: - in: path name: deployment-id required: true schema: type: string description: Deployment id of the model which was deployed. - in: query name: api-version required: true schema: type: string example: 2024-03-01-preview description: api version requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/createChatCompletionRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/createChatCompletionResponse' headers: apim-request-id: description: Request ID for troubleshooting purposes schema: type: string default: description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' headers: apim-request-id: description: Request ID for troubleshooting purposes schema: type: string x-ms-examples: Create a chat completion.: $ref: ./examples/chat_completions.yaml Creates a completion based on Azure Search data and system-assigned managed identity.: $ref: ./examples/chat_completions_azure_search_minimum.yaml Creates a completion based on Azure Search image vector data.: $ref: ./examples/chat_completions_azure_search_image_vector.yaml Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.: $ref: ./examples/chat_completions_azure_search_advanced.yaml Creates a completion for the provided AML index.: $ref: ./examples/chat_completions_aml_index.yaml Creates a completion for the provided Azure Cosmos DB.: $ref: ./examples/chat_completions_cosmos_db.yaml Creates a completion for the provided Elasticsearch.: $ref: ./examples/chat_completions_elasticsearch.yaml Creates a completion for the provided Pinecone resource.: $ref: ./examples/chat_completions_pinecone.yaml description: Needs a more full description created. tags: - Deployments /deployments/{deployment-id}/audio/transcriptions: post: summary: Microsoft Azure Transcribes Audio Into The Input Language operationId: microsoftAzureTranscriptionsCreate parameters: - in: path name: deployment-id required: true schema: type: string example: whisper description: Deployment id of the whisper model. - in: query name: api-version required: true schema: type: string example: 2024-03-01-preview description: api version requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/createTranscriptionRequest' responses: '200': description: OK content: application/json: schema: oneOf: - $ref: '#/components/schemas/audioResponse' - $ref: '#/components/schemas/audioVerboseResponse' text/plain: schema: type: string description: Transcribed text in the output format (when response_format was one of text, vtt or srt). x-ms-examples: Create an audio transcription with json response format.: $ref: ./examples/audio_transcription_object.yaml Create an audio transcription with text response format.: $ref: ./examples/audio_transcription_text.yaml description: Needs a more full description created. tags: - Deployments /deployments/{deployment-id}/audio/translations: post: summary: Microsoft Azure Transcribes And Translates Input Audio Into English Text operationId: microsoftAzureTranslationsCreate parameters: - in: path name: deployment-id required: true schema: type: string example: whisper description: Deployment id of the whisper model which was deployed. - in: query name: api-version required: true schema: type: string example: 2024-03-01-preview description: api version requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/createTranslationRequest' responses: '200': description: OK content: application/json: schema: oneOf: - $ref: '#/components/schemas/audioResponse' - $ref: '#/components/schemas/audioVerboseResponse' text/plain: schema: type: string description: Transcribed text in the output format (when response_format was one of text, vtt or srt). x-ms-examples: Create an audio translation with json response format.: $ref: ./examples/audio_translation_object.yaml Create an audio translation with text response format.: $ref: ./examples/audio_translation_text.yaml description: Needs a more full description created. tags: - Deployments /deployments/{deployment-id}/audio/speech: post: summary: Microsoft Azure Generates Audio From The Input Text operationId: microsoftAzureSpeechCreate parameters: - in: path name: deployment-id required: true schema: type: string example: tts-1 description: Deployment id of the tts model which was deployed. - in: query name: api-version required: true schema: type: string example: 2024-03-01-preview description: api version requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/createSpeechRequest' responses: '200': description: OK content: application/octet-stream: schema: type: string format: binary x-ms-examples: Create an audio from text with response format mp3.: $ref: ./examples/audio_speech.yaml description: Needs a more full description created. tags: - Deployments /deployments/{deployment-id}/images/generations: post: summary: Microsoft Azure Generates A Batch Of Images From A Text Caption On A Given Dalle Model Deployment operationId: microsoftAzureImagegenerationsCreate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/imageGenerationsRequest' parameters: - in: path name: deployment-id required: true schema: type: string example: dalle-deployment description: Deployment id of the dalle model which was deployed. - in: query name: api-version required: true schema: type: string example: 2024-03-01-preview description: api version responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/generateImagesResponse' default: description: An error occurred. content: application/json: schema: $ref: '#/components/schemas/dalleErrorResponse' x-ms-examples: Create an image.: $ref: ./examples/image_generation.yaml description: Needs a more full description created. tags: - Deployments /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}: put: operationId: Deployments_CreateOrUpdate summary: Microsoft Azure Create or Update a Deployment description: Deploys resources at resource group scope. You can provide the template and parameters directly in the request or link to JSON files. tags: - Deployments parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter_2' - name: deploymentName in: path required: true description: The name of the deployment. schema: type: string minLength: 1 maxLength: 64 pattern: ^[-\w\._\(\)]+$ example: example_value - $ref: '#/components/parameters/ApiVersionParameter_3' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Deployment_3' examples: DeploymentsCreateorupdateRequestExample: summary: Default Deployments_CreateOrUpdate request x-microcks-default: true value: location: example_value properties: template: example_value parameters: example_value mode: Incremental tags: example_value responses: '200': description: Successfully updated the deployment. content: application/json: schema: $ref: '#/components/schemas/DeploymentExtended' examples: DeploymentsCreateorupdate200Example: summary: Default Deployments_CreateOrUpdate 200 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value location: example_value properties: provisioningState: NotSpecified correlationId: '500123' timestamp: '2026-01-15T10:30:00Z' duration: example_value outputs: example_value mode: Incremental tags: example_value '201': description: Successfully created the deployment. content: application/json: schema: $ref: '#/components/schemas/DeploymentExtended' examples: DeploymentsCreateorupdate201Example: summary: Default Deployments_CreateOrUpdate 201 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value location: example_value properties: provisioningState: NotSpecified correlationId: '500123' timestamp: '2026-01-15T10:30:00Z' duration: example_value outputs: example_value mode: Incremental tags: example_value default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: DeploymentsCreateorupdatedefaultExample: summary: Default Deployments_CreateOrUpdate default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - {} additionalInfo: - {} x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: Deployments_Get summary: Microsoft Azure Get a Deployment description: Gets a deployment by name. tags: - Deployments parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter_2' - name: deploymentName in: path required: true description: The name of the deployment. schema: type: string example: example_value - $ref: '#/components/parameters/ApiVersionParameter_3' responses: '200': description: Successfully returned the deployment. content: application/json: schema: $ref: '#/components/schemas/DeploymentExtended' examples: DeploymentsGet200Example: summary: Default Deployments_Get 200 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value location: example_value properties: provisioningState: NotSpecified correlationId: '500123' timestamp: '2026-01-15T10:30:00Z' duration: example_value outputs: example_value mode: Incremental tags: example_value default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: DeploymentsGetdefaultExample: summary: Default Deployments_Get default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - {} additionalInfo: - {} x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments : get: operationId: microsoftAzureDeploymentsListbydevicegroup tags: - Deployments description: List Deployment resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. parameters: - $ref: '#/parameters/CustomFilterQueryParameter' - $ref: '#/parameters/CustomTopQueryParameter' - $ref: '#/parameters/CustomSkipQueryParameter' - $ref: '#/parameters/CustomMaxPageSizeQueryParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: catalogName in: path description: Name of catalog required: true type: string pattern: ^[A-Za-z0-9_-]{1,50}$ - name: productName in: path description: Name of product. required: true type: string pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$ - name: deviceGroupName in: path description: Name of device group. required: true type: string pattern: ^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\s]{1,48}[A-Za-z0-9]$|^\.default$|^\.unassigned$ responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/DeploymentListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Deployments_ListByDeviceGroup: $ref: ./examples/GetDeployments.json x-ms-pageable: nextLinkName: nextLink summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Deployments ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments/{deploymentName} : get: operationId: microsoftAzureDeploymentsGet tags: - Deployments description: Get a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: catalogName in: path description: Name of catalog required: true type: string pattern: ^[A-Za-z0-9_-]{1,50}$ - name: productName in: path description: Name of product. required: true type: string pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$ - name: deviceGroupName in: path description: Name of device group. required: true type: string pattern: ^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\s]{1,48}[A-Za-z0-9]$|^\.default$|^\.unassigned$ - name: deploymentName in: path description: Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/Deployment_4' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Deployments_Get: $ref: ./examples/GetDeployment.json summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Deployments Deploymentname put: operationId: microsoftAzureDeploymentsCreateorupdate tags: - Deployments description: Create a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: catalogName in: path description: Name of catalog required: true type: string pattern: ^[A-Za-z0-9_-]{1,50}$ - name: productName in: path description: Name of product. required: true type: string pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$ - name: deviceGroupName in: path description: Name of device group. required: true type: string pattern: ^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\s]{1,48}[A-Za-z0-9]$|^\.default$|^\.unassigned$ - name: deploymentName in: path description: Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group. required: true type: string - name: resource in: body description: Resource create parameters. required: true schema: $ref: '#/definitions/Deployment_4' responses: '200': description: Resource 'Deployment' update operation succeeded schema: $ref: '#/definitions/Deployment_4' '201': description: Resource 'Deployment' create operation succeeded schema: $ref: '#/definitions/Deployment_4' headers: Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Deployments_CreateOrUpdate: $ref: ./examples/PutDeployment.json x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-long-running-operation: true summary: Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Deployments Deploymentname delete: operationId: microsoftAzureDeploymentsDelete tags: - Deployments description: Delete a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: catalogName in: path description: Name of catalog required: true type: string pattern: ^[A-Za-z0-9_-]{1,50}$ - name: productName in: path description: Name of product. required: true type: string pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$ - name: deviceGroupName in: path description: Name of device group. required: true type: string pattern: ^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\s]{1,48}[A-Za-z0-9]$|^\.default$|^\.unassigned$ - name: deploymentName in: path description: Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group. required: true type: string responses: '200': description: Resource deleted successfully. '202': description: Resource deletion accepted. headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. '204': description: Resource does not exist. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Deployments_Delete: $ref: ./examples/DeleteDeployment.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true summary: Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Deployments Deploymentname /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}: delete: tags: - Deployments operationId: microsoftAzureDeploymentsDeleteatscope summary: Microsoft Azure Deletes A Deployment From The Deployment History description: A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code. parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '202': description: Accepted - Returns this status until the asynchronous operation has completed. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true head: tags: - Deployments operationId: microsoftAzureDeploymentsCheckexistenceatscope description: Checks whether the deployment exists. parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '204': description: No Content '404': description: Not Found default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Head Scope Providers Microsoft Resources Deployments Deploymentname put: tags: - Deployments operationId: microsoftAzureDeploymentsCreateorupdateatscope summary: Microsoft Azure Deploys Resources At A Given Scope description: You can provide the template and parameters directly in the request or link to JSON files. parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/Deployment_5' description: Additional parameters supplied to the operation. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' '201': description: Created - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: Create deployment at a given scope.: $ref: ./examples/PutDeploymentAtScope.json get: tags: - Deployments operationId: microsoftAzureDeploymentsGetatscope description: Gets a deployment. parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Get Scope Providers Microsoft Resources Deployments Deploymentname /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel: post: tags: - Deployments operationId: microsoftAzureDeploymentsCancelatscope summary: Microsoft Azure Cancels A Currently Running Template Deployment description: You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed. parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/validate: post: tags: - Deployments operationId: microsoftAzureDeploymentsValidateatscope x-ms-long-running-operation: true description: Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/Deployment_5' description: Parameters to validate. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' '202': description: Accepted - The request has been accepted for processing and the operation will complete asynchronously. '400': description: Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Post Scope Providers Microsoft Resources Deployments Deploymentname Validate /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate: post: tags: - Deployments operationId: microsoftAzureDeploymentsExporttemplateatscope description: Exports the template used for specified deployment. parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns the template. schema: $ref: '#/definitions/DeploymentExportResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Post Scope Providers Microsoft Resources Deployments Deploymentname Exporttemplate /{scope}/providers/Microsoft.Resources/deployments/: get: tags: - Deployments operationId: microsoftAzureDeploymentsListatscope description: Get all the deployments at the given scope. parameters: - $ref: '#/parameters/ScopeParameter' - name: $filter in: query required: false type: string description: The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. - name: $top in: query required: false type: integer format: int32 description: The number of results to get. If null is passed, returns all deployments. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns an array of deployments. schema: $ref: '#/definitions/DeploymentListResult_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/DeploymentExtendedFilter' summary: Microsoft Azure Get Scope Providers Microsoft Resources Deployments /providers/Microsoft.Resources/deployments/{deploymentName}: delete: tags: - Deployments operationId: microsoftAzureDeploymentsDeleteattenantscope summary: Microsoft Azure Deletes A Deployment From The Deployment History description: A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '202': description: Accepted - Returns this status until the asynchronous operation has completed. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true head: tags: - Deployments operationId: microsoftAzureDeploymentsCheckexistenceattenantscope description: Checks whether the deployment exists. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '204': description: No Content '404': description: Not Found default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Head Providers Microsoft Resources Deployments Deploymentname put: tags: - Deployments operationId: microsoftAzureDeploymentsCreateorupdateattenantscope summary: Microsoft Azure Deploys Resources At Tenant Scope description: You can provide the template and parameters directly in the request or link to JSON files. parameters: - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/ScopedDeployment' description: Additional parameters supplied to the operation. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' '201': description: Created - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: Create deployment at tenant scope.: $ref: ./examples/PutDeploymentAtTenant.json get: tags: - Deployments operationId: microsoftAzureDeploymentsGetattenantscope description: Gets a deployment. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Get Providers Microsoft Resources Deployments Deploymentname /providers/Microsoft.Resources/deployments/{deploymentName}/cancel: post: tags: - Deployments operationId: microsoftAzureDeploymentsCancelattenantscope summary: Microsoft Azure Cancels A Currently Running Template Deployment description: You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' /providers/Microsoft.Resources/deployments/{deploymentName}/validate: post: tags: - Deployments operationId: microsoftAzureDeploymentsValidateattenantscope x-ms-long-running-operation: true description: Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. parameters: - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/ScopedDeployment' description: Parameters to validate. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' '202': description: Accepted - The request has been accepted for processing and the operation will complete asynchronously. '400': description: Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Post Providers Microsoft Resources Deployments Deploymentname Validate /providers/Microsoft.Resources/deployments/{deploymentName}/whatIf: post: tags: - Deployments operationId: microsoftAzureDeploymentsWhatifattenantscope description: Returns changes that will be made by the deployment if executed at the scope of the tenant group. parameters: - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/ScopedDeploymentWhatIf' description: Parameters to validate. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns What-If operation status schema: $ref: '#/definitions/WhatIfOperationResult' '202': description: Accepted - Returns URL in Location header to query for long-running operation status. headers: Location: type: string description: URL to get status of this long-running operation. Retry-After: type: string description: Number of seconds to wait before polling for status. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Predict template changes at management group scope: $ref: ./examples/PostDeploymentWhatIfOnTenant.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Providers Microsoft Resources Deployments Deploymentname Whatif /providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate: post: tags: - Deployments operationId: microsoftAzureDeploymentsExporttemplateattenantscope description: Exports the template used for specified deployment. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns the template. schema: $ref: '#/definitions/DeploymentExportResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Post Providers Microsoft Resources Deployments Deploymentname Exporttemplate /providers/Microsoft.Resources/deployments/: get: tags: - Deployments operationId: microsoftAzureDeploymentsListattenantscope description: Get all the deployments at the tenant scope. parameters: - name: $filter in: query required: false type: string description: The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. - name: $top in: query required: false type: integer format: int32 description: The number of results to get. If null is passed, returns all deployments. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns an array of deployments. schema: $ref: '#/definitions/DeploymentListResult_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/DeploymentExtendedFilter' summary: Microsoft Azure Get Providers Microsoft Resources Deployments /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}: delete: tags: - Deployments operationId: microsoftAzureDeploymentsDeleteatmanagementgroupscope summary: Microsoft Azure Deletes A Deployment From The Deployment History description: A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code. parameters: - $ref: '#/parameters/GroupIdParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '202': description: Accepted - Returns this status until the asynchronous operation has completed. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true head: tags: - Deployments operationId: microsoftAzureDeploymentsCheckexistenceatmanagementgroupscope description: Checks whether the deployment exists. parameters: - $ref: '#/parameters/GroupIdParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '204': description: No Content '404': description: Not Found default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Head Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments Deploymentname put: tags: - Deployments operationId: microsoftAzureDeploymentsCreateorupdateatmanagementgroupscope summary: Microsoft Azure Deploys Resources At Management Group Scope description: You can provide the template and parameters directly in the request or link to JSON files. parameters: - $ref: '#/parameters/GroupIdParameter' - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/ScopedDeployment' description: Additional parameters supplied to the operation. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' '201': description: Created - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: Create deployment at management group scope.: $ref: ./examples/PutDeploymentAtManagementGroup.json get: tags: - Deployments operationId: microsoftAzureDeploymentsGetatmanagementgroupscope description: Gets a deployment. parameters: - $ref: '#/parameters/GroupIdParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Get Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments Deploymentname ? /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel : post: tags: - Deployments operationId: microsoftAzureDeploymentsCancelatmanagementgroupscope summary: Microsoft Azure Cancels A Currently Running Template Deployment description: You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed. parameters: - $ref: '#/parameters/GroupIdParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' ? /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate : post: tags: - Deployments operationId: microsoftAzureDeploymentsValidateatmanagementgroupscope x-ms-long-running-operation: true description: Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. parameters: - $ref: '#/parameters/GroupIdParameter' - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/ScopedDeployment' description: Parameters to validate. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' '202': description: Accepted - The request has been accepted for processing and the operation will complete asynchronously. '400': description: Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Post Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments Deploymentname Validate ? /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf : post: tags: - Deployments operationId: microsoftAzureDeploymentsWhatifatmanagementgroupscope description: Returns changes that will be made by the deployment if executed at the scope of the management group. parameters: - $ref: '#/parameters/GroupIdParameter' - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/ScopedDeploymentWhatIf' description: Parameters to validate. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns What-If operation status schema: $ref: '#/definitions/WhatIfOperationResult' '202': description: Accepted - Returns URL in Location header to query for long-running operation status. headers: Location: type: string description: URL to get status of this long-running operation. Retry-After: type: string description: Number of seconds to wait before polling for status. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Predict template changes at management group scope: $ref: ./examples/PostDeploymentWhatIfOnManagementGroup.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments Deploymentname Whatif ? /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate : post: tags: - Deployments operationId: microsoftAzureDeploymentsExporttemplateatmanagementgroupscope description: Exports the template used for specified deployment. parameters: - $ref: '#/parameters/GroupIdParameter' - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns the template. schema: $ref: '#/definitions/DeploymentExportResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Post Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments Deploymentname Exporttemplate /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/: get: tags: - Deployments operationId: microsoftAzureDeploymentsListatmanagementgroupscope description: Get all the deployments for a management group. parameters: - $ref: '#/parameters/GroupIdParameter' - name: $filter in: query required: false type: string description: The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. - name: $top in: query required: false type: integer format: int32 description: The number of results to get. If null is passed, returns all deployments. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK - Returns an array of deployments. schema: $ref: '#/definitions/DeploymentListResult_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/DeploymentExtendedFilter' summary: Microsoft Azure Get Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}: delete: tags: - Deployments operationId: microsoftAzureDeploymentsDeleteatsubscriptionscope summary: Microsoft Azure Deletes A Deployment From The Deployment History description: A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '202': description: Accepted - Returns this status until the asynchronous operation has completed. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true head: tags: - Deployments operationId: microsoftAzureDeploymentsCheckexistenceatsubscriptionscope description: Checks whether the deployment exists. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '204': description: No Content '404': description: Not Found default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Head Subscriptions Subscriptionid Providers Microsoft Resources Deployments Deploymentname put: tags: - Deployments operationId: microsoftAzureDeploymentsCreateorupdateatsubscriptionscope summary: Microsoft Azure Deploys Resources At Subscription Scope description: You can provide the template and parameters directly in the request or link to JSON files. parameters: - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/Deployment_5' description: Additional parameters supplied to the operation. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' '201': description: Created - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Create a deployment that will deploy a templateSpec with the given resourceId: $ref: ./examples/PutDeploymentSubscriptionTemplateSpecsWithId.json x-ms-long-running-operation: true get: tags: - Deployments operationId: microsoftAzureDeploymentsGetatsubscriptionscope description: Gets a deployment. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Resources Deployments Deploymentname /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel: post: tags: - Deployments operationId: microsoftAzureDeploymentsCancelatsubscriptionscope summary: Microsoft Azure Cancels A Currently Running Template Deployment description: You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate: post: tags: - Deployments operationId: microsoftAzureDeploymentsValidateatsubscriptionscope x-ms-long-running-operation: true description: Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. parameters: - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/Deployment_5' description: Parameters to validate. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' '202': description: Accepted - The request has been accepted for processing and the operation will complete asynchronously. '400': description: Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Resources Deployments Deploymentname Validate /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf: post: tags: - Deployments operationId: microsoftAzureDeploymentsWhatifatsubscriptionscope description: Returns changes that will be made by the deployment if executed at the scope of the subscription. parameters: - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/DeploymentWhatIf' description: Parameters to What If. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns What-If operation status schema: $ref: '#/definitions/WhatIfOperationResult' '202': description: Accepted - Returns URL in Location header to query for long-running operation status. headers: Location: type: string description: URL to get status of this long-running operation. Retry-After: type: string description: Number of seconds to wait before polling for status. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Predict template changes at subscription scope: $ref: ./examples/PostDeploymentWhatIfOnSubscription.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Resources Deployments Deploymentname Whatif /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate: post: tags: - Deployments operationId: microsoftAzureDeploymentsExporttemplateatsubscriptionscope description: Exports the template used for specified deployment. parameters: - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns the template. schema: $ref: '#/definitions/DeploymentExportResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Resources Deployments Deploymentname Exporttemplate /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/: get: tags: - Deployments operationId: microsoftAzureDeploymentsListatsubscriptionscope description: Get all the deployments for a subscription. parameters: - name: $filter in: query required: false type: string description: The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. - name: $top in: query required: false type: integer format: int32 description: The number of results to get. If null is passed, returns all deployments. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns an array of deployments. schema: $ref: '#/definitions/DeploymentListResult_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/DeploymentExtendedFilter' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Resources Deployments ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName} : delete: tags: - Deployments operationId: microsoftAzureDeploymentsDelete summary: Microsoft Azure Deletes A Deployment From The Deployment History description: A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group with the deployment to delete. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '202': description: Accepted - Returns this status until the asynchronous operation has completed. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true head: tags: - Deployments operationId: microsoftAzureDeploymentsCheckexistence description: Checks whether the deployment exists. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group with the deployment to check. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '204': description: No Content '404': description: Not Found default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Head Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deployments Deploymentname put: tags: - Deployments operationId: microsoftAzureDeploymentsCreateorupdate summary: Microsoft Azure Deploys Resources To A Resource Group description: You can provide the template and parameters directly in the request or link to JSON files. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/Deployment_5' description: Additional parameters supplied to the operation. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' '201': description: Created - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Create a deployment that will redeploy the last successful deployment on failure: $ref: ./examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json Create a deployment that will redeploy another deployment on failure: $ref: ./examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json Create a deployment that will deploy a templateSpec with the given resourceId: $ref: ./examples/PutDeploymentResourceGroupTemplateSpecsWithId.json Create a deployment that will deploy a template with a uri and queryString: $ref: ./examples/PutDeploymentResourceGroup.json x-ms-long-running-operation: true get: tags: - Deployments operationId: microsoftAzureDeploymentsGet description: Gets a deployment. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns information about the deployment, including provisioning status. schema: $ref: '#/definitions/DeploymentExtended' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deployments Deploymentname ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel : post: tags: - Deployments operationId: microsoftAzureDeploymentsCancel summary: Microsoft Azure Cancels A Currently Running Template Deployment description: You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate : post: tags: - Deployments operationId: microsoftAzureDeploymentsValidate x-ms-long-running-operation: true description: Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group the template will be deployed to. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/Deployment_5' description: Parameters to validate. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' '202': description: Accepted - The request has been accepted for processing and the operation will complete asynchronously. '400': description: Returns the validation result. schema: $ref: '#/definitions/DeploymentValidateResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deployments Deploymentname Validate ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf : post: tags: - Deployments operationId: microsoftAzureDeploymentsWhatif description: Returns changes that will be made by the deployment if executed at the scope of the resource group. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group the template will be deployed to. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/DeploymentNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/DeploymentWhatIf' description: Parameters to validate. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns What-If operation status schema: $ref: '#/definitions/WhatIfOperationResult' '202': description: Accepted - Returns URL in Location header to query for long-running operation status. headers: Location: type: string description: URL to get status of this long-running operation. Retry-After: type: string description: Number of seconds to wait before polling for status. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Predict template changes at resource group scope: $ref: ./examples/PostDeploymentWhatIfOnResourceGroup.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deployments Deploymentname Whatif ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate : post: tags: - Deployments operationId: microsoftAzureDeploymentsExporttemplate description: Exports the template used for specified deployment. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - $ref: '#/parameters/DeploymentNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns the template. schema: $ref: '#/definitions/DeploymentExportResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deployments Deploymentname Exporttemplate /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/: get: tags: - Deployments operationId: microsoftAzureDeploymentsListbyresourcegroup description: Get all the deployments for a resource group. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group with the deployments to get. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 - name: $filter in: query required: false type: string description: The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. - name: $top in: query required: false type: integer format: int32 description: The number of results to get. If null is passed, returns all deployments. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns an array of deployments. schema: $ref: '#/definitions/DeploymentListResult_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/DeploymentExtendedFilter' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deployments /providers/Microsoft.Resources/calculateTemplateHash: post: tags: - Deployments operationId: microsoftAzureDeploymentsCalculatetemplatehash description: Calculate the hash of the given template. parameters: - $ref: '#/parameters/ApiVersionParameter' - name: template in: body required: true schema: type: object description: The template provided to calculate hash. x-ms-examples: Calculate template hash: $ref: ./examples/CalculateTemplateHash.json responses: '200': description: OK - Returns the hash. schema: $ref: '#/definitions/TemplateHashResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Post Providers Microsoft Resources Calculatetemplatehash components: schemas: Sku: type: object description: The resource model definition representing SKU. properties: name: type: string description: The name of the SKU. Examples include F0 (free), S0, S1, S2, etc. example: Example Title tier: type: string readOnly: true enum: - Free - Basic - Standard - Premium - Enterprise description: The pricing tier of the SKU. example: Free required: - name line: type: object description: A content line object consisting of an adjacent sequence of content elements, such as words and selection marks. properties: text: type: string spans: type: array description: An array of spans that represent detected objects and its bounding box information. items: $ref: '#/components/schemas/span' required: - text - spans chatCompletionResponseMessageRole: type: string enum: - assistant description: The role of the author of the response message. contentFilterIdResult: type: object allOf: - $ref: '#/components/schemas/contentFilterResultBase' - properties: id: type: string required: - id - filtered createChatCompletionResponse: type: object allOf: - $ref: '#/components/schemas/chatCompletionsResponseCommon' - properties: prompt_filter_results: $ref: '#/components/schemas/promptFilterResults' choices: type: array items: type: object allOf: - $ref: '#/components/schemas/chatCompletionChoiceCommon' - properties: message: $ref: '#/components/schemas/chatCompletionResponseMessage' content_filter_results: $ref: '#/components/schemas/contentFilterChoiceResults' logprobs: $ref: '#/components/schemas/chatCompletionChoiceLogProbs' enhancements: $ref: '#/components/schemas/enhancement' description: The enhancement results returned by the service. required: - id - object - created - model - choices imageResult: type: object description: The image url or encoded image if successful, and an error otherwise. properties: url: type: string description: The image url. example: https://www.contoso.com b64_json: type: string description: The base64 encoded image content_filter_results: $ref: '#/components/schemas/dalleContentFilterResults' revised_prompt: type: string description: The prompt that was used to generate the image, if there was any revision to the prompt. prompt_filter_results: $ref: '#/components/schemas/dalleFilterResults' createChatCompletionRequest: type: object allOf: - $ref: '#/components/schemas/chatCompletionsRequestCommon' - properties: messages: description: A list of messages comprising the conversation so far. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb). type: array minItems: 1 items: $ref: '#/components/schemas/chatCompletionRequestMessage' data_sources: type: array description: " The configuration entries for Azure OpenAI chat extensions that use them.\n This additional specification is only compatible with Azure OpenAI." items: $ref: '#/components/schemas/azureChatExtensionConfiguration' enhancements: type: object description: The type of enhancements needed. properties: grounding: type: object description: Request object to specify if grounding enhancement is needed. properties: enabled: type: boolean default: false ocr: type: object description: Request object to specify if ocr enhancement is needed. properties: enabled: type: boolean default: false n: type: integer minimum: 1 maximum: 128 default: 1 example: 1 nullable: true description: How many chat completion choices to generate for each input message. seed: type: integer minimum: -9223372036854776000 maximum: 9223372036854776000 default: 0 example: 1 nullable: true description: If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. logprobs: description: Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. This option is currently not available on the `gpt-4-vision-preview` model. type: boolean default: false nullable: true top_logprobs: description: An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used. type: integer minimum: 0 maximum: 5 nullable: true response_format: type: object description: An object specifying the format that the model must output. Used to enable JSON mode. properties: type: $ref: '#/components/schemas/chatCompletionResponseFormat' tools: description: A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. type: array minItems: 1 items: $ref: '#/components/schemas/chatCompletionTool' tool_choice: $ref: '#/components/schemas/chatCompletionToolChoiceOption' functions: description: Deprecated in favor of `tools`. A list of functions the model may generate JSON inputs for. type: array minItems: 1 maxItems: 128 items: $ref: '#/components/schemas/chatCompletionFunction' function_call: description: Deprecated in favor of `tool_choice`. Controls how the model responds to function calls. "none" means the model does not call a function, and responds to the end-user. "auto" means the model can pick between an end-user or calling a function. Specifying a particular function via `{"name":\ "my_function"}` forces the model to call that function. "none" is the default when no functions are present. "auto" is the default if functions are present. oneOf: - type: string enum: - none - auto description: '`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.' - type: object description: 'Specifying a particular function via `{"name": "my_function"}` forces the model to call that function.' properties: name: type: string description: The name of the function to call. required: - name required: - messages citation: required: - content type: object properties: content: type: string description: The content of the citation. title: type: string description: The title of the citation. url: type: string description: The URL of the citation. filepath: type: string description: The file path of the citation. chunk_id: type: string description: The chunk ID of the citation. description: citation information for a chat completions response message. contentFilterDetectedWithCitationResult: type: object allOf: - $ref: '#/components/schemas/contentFilterDetectedResult' - properties: citation: type: object properties: URL: type: string license: type: string required: - detected - filtered errorBase: type: object properties: code: type: string message: type: string chatCompletionTokenLogprob: type: object properties: token: description: The token. type: string logprob: description: The log probability of this token. type: number bytes: description: A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. type: array items: type: integer nullable: true top_logprobs: description: List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned. type: array items: type: object properties: token: description: The token. type: string logprob: description: The log probability of this token. type: number bytes: description: A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. type: array items: type: integer nullable: true required: - token - logprob - bytes required: - token - logprob - bytes - top_logprobs contentFilterResultBase: type: object properties: filtered: type: boolean required: - filtered dalleErrorResponse: type: object properties: error: $ref: '#/components/schemas/dalleError' contentFilterPromptResults: type: object description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. allOf: - $ref: '#/components/schemas/contentFilterResultsBase' - properties: jailbreak: $ref: '#/components/schemas/contentFilterDetectedResult' imageQuality: description: The quality of the image that will be generated. type: string enum: - standard - hd default: standard x-ms-enum: name: Quality modelAsString: true values: - value: standard description: Standard quality creates images with standard quality. name: Standard - value: hd description: HD quality creates images with finer details and greater consistency across the image. name: HD chatCompletionMessageToolCall: type: object properties: id: type: string description: The ID of the tool call. type: $ref: '#/components/schemas/toolCallType' function: type: object description: The function that the model called. properties: name: type: string description: The name of the function to call. arguments: type: string description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. required: - name - arguments required: - id - type - function imagesResponseFormat: description: The format in which the generated images are returned. type: string enum: - url - b64_json default: url x-ms-enum: name: ImagesResponseFormat modelAsString: true values: - value: url description: The URL that provides temporary access to download the generated images. name: Url - value: b64_json description: The generated images are returned as base64 encoded string. name: Base64Json contentFilterDetectedResult: type: object allOf: - $ref: '#/components/schemas/contentFilterResultBase' - properties: detected: type: boolean required: - detected - filtered azureChatExtensionConfiguration: required: - type type: object properties: type: $ref: '#/components/schemas/azureChatExtensionType' description: " A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat\n completions request that should use Azure OpenAI chat extensions to augment the response behavior.\n The use of this configuration is compatible only with Azure OpenAI." discriminator: propertyName: type mapping: azure_search: '#/components/schemas/azureSearchChatExtensionConfiguration' azure_ml_index: '#/components/schemas/azureMachineLearningIndexChatExtensionConfiguration' azure_cosmos_db: '#/components/schemas/azureCosmosDBChatExtensionConfiguration' elasticsearch: '#/components/schemas/elasticsearchChatExtensionConfiguration' pinecone: '#/components/schemas/pineconeChatExtensionConfiguration' DeploymentProperties_2: type: object description: Deployment properties. properties: template: type: object description: The template content. Use this element when you want to pass the template syntax directly in the request rather than link to an existing template. example: example_value templateLink: $ref: '#/components/schemas/TemplateLink' parameters: type: object description: Name and value pairs that define the deployment parameters. example: example_value parametersLink: $ref: '#/components/schemas/ParametersLink' mode: type: string description: The mode that is used to deploy resources. enum: - Incremental - Complete example: Incremental debugSetting: $ref: '#/components/schemas/DebugSetting' required: - mode DebugSetting: type: object description: The debug setting. properties: detailLevel: type: string description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both. example: example_value imageStyle: description: The style of the generated images. type: string enum: - vivid - natural default: vivid x-ms-enum: name: Style modelAsString: true values: - value: vivid description: Vivid creates images that are hyper-realistic and dramatic. name: Vivid - value: natural description: Natural creates images that are more natural and less hyper-realistic. name: Natural chatCompletionRequestMessage: type: object properties: role: $ref: '#/components/schemas/chatCompletionRequestMessageRole' discriminator: propertyName: role mapping: system: '#/components/schemas/chatCompletionRequestMessageSystem' user: '#/components/schemas/chatCompletionRequestMessageUser' assistant: '#/components/schemas/chatCompletionRequestMessageAssistant' tool: '#/components/schemas/chatCompletionRequestMessageTool' function: '#/components/schemas/chatCompletionRequestMessageFunction' required: - role promptFilterResults: type: array description: Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders. items: $ref: '#/components/schemas/promptFilterResult' dalleError: type: object allOf: - $ref: '#/components/schemas/errorBase' properties: param: type: string type: type: string inner_error: $ref: '#/components/schemas/dalleInnerError' innerError: description: Inner error with additional details. type: object properties: code: $ref: '#/components/schemas/innerErrorCode' content_filter_results: $ref: '#/components/schemas/contentFilterPromptResults' errorResponse: type: object properties: error: $ref: '#/components/schemas/error' audioVerboseResponse: description: Translation or transcription response when response_format was verbose_json type: object allOf: - $ref: '#/components/schemas/audioResponse' - properties: task: type: string description: Type of audio task. enum: - transcribe - translate x-ms-enum: modelAsString: true language: type: string description: Language. duration: type: number description: Duration. segments: type: array items: $ref: '#/components/schemas/audioSegment' required: - text chatCompletionNamedToolChoice: type: object description: Specifies a tool the model should use. Use to force the model to call a specific function. properties: type: type: string enum: - function description: The type of the tool. Currently, only `function` is supported. function: type: object properties: name: type: string description: The name of the function to call. required: - name chatCompletionsRequestCommon: type: object properties: temperature: description: 'What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both.' type: number minimum: 0 maximum: 2 default: 1 example: 1 nullable: true top_p: description: 'An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both.' type: number minimum: 0 maximum: 1 default: 1 example: 1 nullable: true stream: description: 'If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a `data: [DONE]` message.' type: boolean nullable: true default: false stop: description: Up to 4 sequences where the API will stop generating further tokens. oneOf: - type: string nullable: true - type: array items: type: string nullable: false minItems: 1 maxItems: 4 description: Array minimum size of 1 and maximum of 4 default: null max_tokens: description: The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens). type: integer default: 4096 presence_penalty: description: Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. type: number default: 0 minimum: -2 maximum: 2 frequency_penalty: description: Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. type: number default: 0 minimum: -2 maximum: 2 logit_bias: description: Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. type: object nullable: true user: description: A unique identifier representing your end-user, which can help Azure OpenAI to monitor and detect abuse. type: string example: user-1234 nullable: false ErrorAdditionalInfo: type: object description: The resource management error additional info. properties: type: type: string readOnly: true description: The additional info type. example: example_value info: type: object readOnly: true description: The additional info. example: example_value DeploymentListResult: type: object description: The list of cognitive services account deployments. properties: value: type: array items: $ref: '#/components/schemas/Deployment' description: An array of deployments. example: [] nextLink: type: string description: The link used to get the next page of deployments. example: example_value DeploymentProperties: type: object description: Properties of Cognitive Services account deployment. properties: provisioningState: type: string readOnly: true enum: - Accepted - Creating - Deleting - Moving - Failed - Succeeded - Disabled - Canceled description: The provisioning state of the deployment. example: Accepted model: $ref: '#/components/schemas/DeploymentModel' scaleSettings: type: object description: The deployment scale settings. properties: scaleType: type: string enum: - Standard - Manual description: Deployment scale type. capacity: type: integer description: Deployment capacity. activeCapacity: type: integer readOnly: true description: Deployment active capacity. example: example_value rateLimits: type: array readOnly: true items: type: object properties: key: type: string renewalPeriod: type: number count: type: number description: The rate limits for the deployment. example: [] capabilities: type: object readOnly: true additionalProperties: type: string description: The capabilities of the deployment. example: example_value versionUpgradeOption: type: string enum: - OnceNewDefaultVersionAvailable - OnceCurrentVersionExpired - NoAutoUpgrade description: Deployment model version upgrade option. example: OnceNewDefaultVersionAvailable chatCompletionResponseFormat: type: string enum: - text - json_object default: text example: json_object nullable: true description: Setting to `json_object` enables JSON mode. This guarantees that the message the model generates is valid JSON. x-ms-enum: name: ChatCompletionResponseFormat modelAsString: true values: - value: text description: Response format is a plain text string. - value: json_object description: Response format is a JSON object. audioResponseFormat: title: AudioResponseFormat description: Defines the format of the output. enum: - json - text - srt - verbose_json - vtt type: string x-ms-enum: modelAsString: true chatCompletionFunction: type: object properties: name: type: string description: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. description: type: string description: The description of what the function does. parameters: $ref: '#/components/schemas/chatCompletionFunctionParameters' required: - name chatCompletionTool: type: object properties: type: $ref: '#/components/schemas/chatCompletionToolType' function: type: object properties: description: type: string description: A description of what the function does, used by the model to choose when and how to call the function. name: type: string description: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. parameters: $ref: '#/components/schemas/chatCompletionFunctionParameters' required: - name - parameters required: - type - function chatCompletionToolChoiceOption: description: 'Controls which (if any) function is called by the model. `none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function. Specifying a particular function via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that function.' oneOf: - type: string description: '`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.' enum: - none - auto - $ref: '#/components/schemas/chatCompletionNamedToolChoice' chatCompletionChoiceCommon: type: object properties: index: type: integer finish_reason: type: string chatCompletionResponseMessage: type: object description: A chat completion message generated by the model. properties: role: $ref: '#/components/schemas/chatCompletionResponseMessageRole' content: type: string description: The contents of the message. nullable: true tool_calls: type: array description: The tool calls generated by the model, such as function calls. items: $ref: '#/components/schemas/chatCompletionMessageToolCall' function_call: $ref: '#/components/schemas/chatCompletionFunctionCall' context: $ref: '#/components/schemas/azureChatExtensionsMessageContext' imageSize: description: The size of the generated images. type: string enum: - 1792x1024 - 1024x1792 - 1024x1024 default: 1024x1024 x-ms-enum: name: Size modelAsString: true values: - value: 1792x1024 description: The desired size of the generated image is 1792x1024 pixels. name: Size1792x1024 - value: 1024x1792 description: The desired size of the generated image is 1024x1792 pixels. name: Size1024x1792 - value: 1024x1024 description: The desired size of the generated image is 1024x1024 pixels. name: Size1024x1024 Deployment_3: type: object description: Deployment operation parameters. properties: location: type: string description: The location to store the deployment data. example: example_value properties: $ref: '#/components/schemas/DeploymentProperties_2' tags: type: object additionalProperties: type: string description: Deployment tags. example: example_value required: - properties DeploymentExtended: type: object description: Deployment information. properties: id: type: string readOnly: true description: The ID of the deployment. example: abc123 name: type: string readOnly: true description: The name of the deployment. example: Example Title type: type: string readOnly: true description: The type of the deployment. example: example_value location: type: string description: The location of the deployment. example: example_value properties: $ref: '#/components/schemas/DeploymentPropertiesExtended' tags: type: object additionalProperties: type: string description: Deployment tags. example: example_value chatCompletionFunctionCall: type: object description: Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model. properties: name: type: string description: The name of the function to call. arguments: type: string description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. required: - name - arguments ErrorResponse: type: object description: Error response. properties: error: type: object description: The error object. properties: code: type: string message: type: string target: type: string details: type: array items: type: object properties: code: type: string message: type: string target: type: string additionalInfo: type: array items: type: object properties: type: type: string info: type: object example: example_value chatCompletionToolType: type: string enum: - function description: The type of the tool. Currently, only `function` is supported. x-ms-enum: name: ChatCompletionToolType modelAsString: true values: - value: function description: The tool type is function. enhancement: type: object properties: grounding: type: object description: The grounding enhancement that returns the bounding box of the objects detected in the image. properties: lines: type: array items: $ref: '#/components/schemas/line' required: - lines Deployment: type: object description: Cognitive Services account deployment. properties: id: type: string readOnly: true example: abc123 name: type: string readOnly: true example: Example Title type: type: string readOnly: true example: example_value etag: type: string readOnly: true example: example_value sku: $ref: '#/components/schemas/Sku' properties: $ref: '#/components/schemas/DeploymentProperties' contentFilterSeverityResult: type: object allOf: - $ref: '#/components/schemas/contentFilterResultBase' - properties: severity: type: string enum: - safe - low - medium - high x-ms-enum: name: ContentFilterSeverity modelAsString: true values: - value: safe description: General content or related content in generic or non-harmful contexts. - value: low description: Harmful content at a low intensity and risk level. - value: medium description: Harmful content at a medium intensity and risk level. - value: high description: Harmful content at a high intensity and risk level. required: - severity - filtered promptFilterResult: type: object description: Content filtering results for a single prompt in the request. properties: prompt_index: type: integer content_filter_results: $ref: '#/components/schemas/contentFilterPromptResults' chatCompletionResponseObject: type: string description: The object type. enum: - chat.completion x-ms-enum: name: ChatCompletionResponseObject modelAsString: true values: - value: chat.completion description: The object type is chat completion. chatCompletionRequestMessageRole: type: string enum: - system - user - assistant - tool - function description: The role of the messages author. x-ms-enum: name: ChatCompletionRequestMessageRole modelAsString: true values: - value: system description: The message author role is system. - value: user description: The message author role is user. - value: assistant description: The message author role is assistant. - value: tool description: The message author role is tool. - value: function description: Deprecated. The message author role is function. toolCallType: type: string enum: - function description: The type of the tool call, in this case `function`. x-ms-enum: name: ToolCallType modelAsString: true values: - value: function description: The tool call type is function. chatCompletionFunctionParameters: type: object description: The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/gpt/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. additionalProperties: true generateImagesResponse: type: object properties: created: type: integer format: unixtime description: The unix timestamp when the operation was created. example: '1676540381' data: type: array description: The result data of the operation, if successful items: $ref: '#/components/schemas/imageResult' required: - created - data DeploymentModel: type: object description: Properties of the deployment model. properties: format: type: string description: Deployment model format. example: example_value name: type: string description: Deployment model name. example: Example Title version: type: string description: Deployment model version. example: example_value source: type: string description: Optional. Deployment model source ARM resource ID. example: example_value required: - format - name - version dalleInnerError: description: Inner error with additional details. type: object properties: code: $ref: '#/components/schemas/innerErrorCode' content_filter_results: $ref: '#/components/schemas/dalleFilterResults' revised_prompt: type: string description: The prompt that was used to generate the image, if there was any revision to the prompt. dalleContentFilterResults: type: object description: Information about the content filtering results. properties: sexual: $ref: '#/components/schemas/contentFilterSeverityResult' violence: $ref: '#/components/schemas/contentFilterSeverityResult' hate: $ref: '#/components/schemas/contentFilterSeverityResult' self_harm: $ref: '#/components/schemas/contentFilterSeverityResult' audioResponse: description: Translation or transcription response when response_format was json type: object properties: text: type: string description: Translated or transcribed text. required: - text azureChatExtensionsMessageContext: type: object properties: citations: type: array description: The data source retrieval result, used to generate the assistant message in the response. items: $ref: '#/components/schemas/citation' x-ms-identifiers: [] intent: type: string description: The detected intent from the chat history, used to pass to the next turn to carry over the context. description: " A representation of the additional context information available when Azure OpenAI chat extensions are involved\n in the generation of a corresponding chat completions response. This context information is only populated when\n using an Azure OpenAI request configured to use a matching extension." chatCompletionsResponseCommon: type: object properties: id: type: string description: A unique identifier for the chat completion. object: $ref: '#/components/schemas/chatCompletionResponseObject' created: type: integer format: unixtime description: The Unix timestamp (in seconds) of when the chat completion was created. model: type: string description: The model used for the chat completion. usage: $ref: '#/components/schemas/completionUsage' system_fingerprint: type: string description: Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. required: - id - object - created - model dalleFilterResults: type: object description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. allOf: - $ref: '#/components/schemas/dalleContentFilterResults' - properties: profanity: $ref: '#/components/schemas/contentFilterDetectedResult' jailbreak: $ref: '#/components/schemas/contentFilterDetectedResult' contentFilterChoiceResults: type: object description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about third party text and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. allOf: - $ref: '#/components/schemas/contentFilterResultsBase' - properties: protected_material_text: $ref: '#/components/schemas/contentFilterDetectedResult' - properties: protected_material_code: $ref: '#/components/schemas/contentFilterDetectedWithCitationResult' TemplateLink: type: object description: Entity representing the reference to the template. properties: uri: type: string description: The URI of the template. example: example_value contentVersion: type: string description: The content version of the template. example: example_value required: - uri CloudError: type: object description: An error response for a resource management request. properties: error: $ref: '#/components/schemas/ErrorResponse_3' azureChatExtensionType: type: string description: " A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat\n completions request that should use Azure OpenAI chat extensions to augment the response behavior.\n The use of this configuration is compatible only with Azure OpenAI." enum: - azure_search - azure_ml_index - azure_cosmos_db - elasticsearch - pinecone x-ms-enum: name: AzureChatExtensionType modelAsString: true values: - name: azureSearch value: azure_search description: Represents the use of Azure Search as an Azure OpenAI chat extension. - name: azureMachineLearningIndex value: azure_ml_index description: Represents the use of Azure Machine Learning index as an Azure OpenAI chat extension. - name: azureCosmosDB value: azure_cosmos_db description: Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension. - name: elasticsearch value: elasticsearch description: Represents the use of Elasticsearch® index as an Azure OpenAI chat extension. - name: pinecone value: pinecone description: Represents the use of Pinecone index as an Azure OpenAI chat extension. ErrorResponse_3: type: object description: Common error response for all Azure Resource Manager APIs. properties: code: type: string readOnly: true description: The error code. example: example_value message: type: string readOnly: true description: The error message. example: example_value target: type: string readOnly: true description: The error target. example: example_value details: type: array readOnly: true items: $ref: '#/components/schemas/ErrorResponse_3' description: The error details. example: [] additionalInfo: type: array readOnly: true items: $ref: '#/components/schemas/ErrorAdditionalInfo' description: The error additional info. example: [] ParametersLink: type: object description: Entity representing the reference to the deployment parameters. properties: uri: type: string description: The URI of the parameters file. example: example_value contentVersion: type: string description: The content version of the parameters. example: example_value required: - uri completionUsage: type: object description: Usage statistics for the completion request. properties: prompt_tokens: type: integer description: Number of tokens in the prompt. completion_tokens: type: integer description: Number of tokens in the generated completion. total_tokens: type: integer description: Total number of tokens used in the request (prompt + completion). required: - prompt_tokens - completion_tokens - total_tokens chatCompletionChoiceLogProbs: description: Log probability information for the choice. type: object nullable: true properties: content: description: A list of message content tokens with log probability information. type: array items: $ref: '#/components/schemas/chatCompletionTokenLogprob' nullable: true required: - content DeploymentPropertiesExtended: type: object description: Deployment properties with additional details. properties: provisioningState: type: string readOnly: true description: Denotes the state of provisioning. enum: - NotSpecified - Accepted - Running - Ready - Creating - Created - Deleting - Deleted - Canceled - Failed - Succeeded - Updating example: NotSpecified correlationId: type: string readOnly: true description: The correlation ID of the deployment. example: '500123' timestamp: type: string format: date-time readOnly: true description: The timestamp of the template deployment. example: '2026-01-15T10:30:00Z' duration: type: string readOnly: true description: The duration of the template deployment. example: example_value outputs: type: object readOnly: true description: Key/value pairs that represent deployment output. example: example_value mode: type: string readOnly: true description: The deployment mode. enum: - Incremental - Complete example: Incremental createSpeechRequest: type: object description: Speech request. properties: input: type: string description: The text to synthesize audio for. The maximum length is 4096 characters. maxLength: 4096 voice: type: string description: The voice to use for speech synthesis. enum: - alloy - echo - fable - onyx - nova - shimmer response_format: type: string description: The format to synthesize the audio in. enum: - mp3 - opus - aac - flac speed: description: The speed of the synthesize audio. Select a value from `0.25` to `4.0`. `1.0` is the default. type: number default: 1 minimum: 0.25 maximum: 4 required: - input - voice span: type: object description: A span object that represents a detected object and its bounding box information. properties: text: type: string description: The text content of the span that represents the detected object. offset: type: integer description: The character offset within the text where the span begins. This offset is defined as the position of the first character of the span, counting from the start of the text as Unicode codepoints. length: type: integer description: The length of the span in characters, measured in Unicode codepoints. polygon: type: array description: An array of objects representing points in the polygon that encloses the detected object. items: type: object properties: x: type: number description: The x-coordinate of the point. y: type: number description: The y-coordinate of the point. required: - text - offset - length - polygon contentFilterResultsBase: type: object description: Information about the content filtering results. properties: sexual: $ref: '#/components/schemas/contentFilterSeverityResult' violence: $ref: '#/components/schemas/contentFilterSeverityResult' hate: $ref: '#/components/schemas/contentFilterSeverityResult' self_harm: $ref: '#/components/schemas/contentFilterSeverityResult' profanity: $ref: '#/components/schemas/contentFilterDetectedResult' custom_blocklists: items: $ref: '#/components/schemas/contentFilterIdResult' type: array error: $ref: '#/components/schemas/errorBase' error: type: object allOf: - $ref: '#/components/schemas/errorBase' properties: param: type: string type: type: string inner_error: $ref: '#/components/schemas/innerError' innerErrorCode: description: Error codes for the inner error object. enum: - ResponsibleAIPolicyViolation type: string x-ms-enum: name: InnerErrorCode modelAsString: true values: - value: ResponsibleAIPolicyViolation description: The prompt violated one of more content filter rules. createTranslationRequest: type: object description: Translation request. properties: file: type: string description: The audio file to translate. format: binary prompt: type: string description: An optional text to guide the model's style or continue a previous audio segment. The prompt should be in English. response_format: $ref: '#/components/schemas/audioResponseFormat' temperature: type: number default: 0 description: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. required: - file createTranscriptionRequest: type: object description: Transcription request. properties: file: type: string description: The audio file object to transcribe. format: binary prompt: type: string description: An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language. response_format: $ref: '#/components/schemas/audioResponseFormat' temperature: type: number default: 0 description: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. language: type: string description: The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency. required: - file imageGenerationsRequest: type: object properties: prompt: description: A text description of the desired image(s). The maximum length is 4000 characters. type: string format: string example: a corgi in a field minLength: 1 n: description: The number of images to generate. type: integer minimum: 1 maximum: 1 default: 1 size: $ref: '#/components/schemas/imageSize' response_format: $ref: '#/components/schemas/imagesResponseFormat' user: description: A unique identifier representing your end-user, which can help to monitor and detect abuse. type: string format: string example: user123456 quality: $ref: '#/components/schemas/imageQuality' style: $ref: '#/components/schemas/imageStyle' required: - prompt audioSegment: type: object description: Transcription or translation segment. properties: id: type: integer description: Segment identifier. seek: type: number description: Offset of the segment. start: type: number description: Segment start offset. end: type: number description: Segment end offset. text: type: string description: Segment text. tokens: type: array items: type: number nullable: false description: Tokens of the text. temperature: type: number description: Temperature. avg_logprob: type: number description: Average log probability. compression_ratio: type: number description: Compression ratio. no_speech_prob: type: number description: Probability of 'no speech'. parameters: AccountNameParameter: name: accountName in: path required: true description: The name of the Cognitive Services account. schema: type: string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ SubscriptionIdParameter: name: subscriptionId in: path required: true description: The ID of the target subscription. schema: type: string format: uuid ResourceGroupNameParameter: name: resourceGroupName in: path required: true description: The name of the resource group. schema: type: string minLength: 1 maxLength: 90 ApiVersionParameter_3: name: api-version in: query required: true description: The API version to use for this operation. schema: type: string default: '2024-03-01' ResourceGroupNameParameter_2: name: resourceGroupName in: path required: true description: The name of the resource group. The name is case insensitive. schema: type: string minLength: 1 maxLength: 90 ApiVersionParameter: name: api-version in: query required: true description: The API version to use for this operation. schema: type: string default: 2024-04-01-preview definitions: AzureChatExtensionsMessageContext: type: object description: " A representation of the additional context information available when Azure OpenAI chat extensions are involved\n in the generation of a corresponding chat completions response. This context information is only populated when\n using an Azure OpenAI request configured to use a matching extension." properties: citations: type: array description: " The contextual information associated with the Azure chat extensions used for a chat completions request.\n These messages describe the data source retrievals, plugin invocations, and other intermediate steps taken in the\n course of generating a chat completions response that was augmented by capabilities from Azure OpenAI chat\n extensions." items: $ref: '#/definitions/AzureChatExtensionDataSourceResponseCitation' x-ms-identifiers: [] intent: type: string description: The detected intent from the chat history, used to pass to the next turn to carry over the context. WhatIfPropertyChange: required: - path - propertyChangeType properties: path: type: string description: The path of the property. propertyChangeType: type: string description: The type of property change. enum: - Create - Delete - Modify - Array - NoEffect x-ms-enum: name: PropertyChangeType modelAsString: false values: - value: Create description: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. - value: Delete description: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. - value: Modify description: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. - value: Array description: The property is an array and contains nested changes. - value: NoEffect description: The property will not be set or updated. before: type: object description: The value of the property before the deployment is executed. after: type: object description: The value of the property after the deployment is executed. children: type: array items: $ref: '#/definitions/WhatIfPropertyChange' x-ms-identifiers: - path description: Nested property changes. description: The predicted change to the resource property. ImageGenerationContentFilterResults: type: object description: Describes the content filtering result for the image generation request. properties: sexual: $ref: '#/definitions/ContentFilterResult' description: "Describes language related to anatomical organs and genitals, romantic relationships,\n acts portrayed in erotic or affectionate terms, physical sexual acts, including\n those portrayed as an assault or a forced sexual violent act against one’s will,\n prostitution, pornography, and abuse." violence: $ref: '#/definitions/ContentFilterResult' description: 'Describes language related to physical actions intended to hurt, injure, damage, or kill someone or something; describes weapons, etc.' hate: $ref: '#/definitions/ContentFilterResult' description: 'Describes language attacks or uses that include pejorative or discriminatory language with reference to a person or identity group on the basis of certain differentiating attributes of these groups including but not limited to race, ethnicity, nationality, gender identity and expression, sexual orientation, religion, immigration status, ability status, personal appearance, and body size.' self_harm: $ref: '#/definitions/ContentFilterResult' description: 'Describes language related to physical actions intended to purposely hurt, injure, or damage one’s body, or kill oneself.' x-ms-client-name: selfHarm EmbeddingsUsage: type: object description: Measurement of the amount of tokens used in this request and response. properties: prompt_tokens: type: integer format: int32 description: Number of tokens sent in the original request. x-ms-client-name: promptTokens total_tokens: type: integer format: int32 description: Total number of tokens transacted in this request/response. x-ms-client-name: totalTokens required: - prompt_tokens - total_tokens Dependency: properties: dependsOn: type: array items: $ref: '#/definitions/BasicDependency' description: The list of dependencies. id: type: string description: The ID of the dependency. resourceType: type: string description: The dependency resource type. resourceName: type: string description: The dependency resource name. description: Deployment dependency information. ImageType: type: string description: Image type values. enum: - InvalidImageType - OneBl - PlutonRuntime - WifiFirmware - SecurityMonitor - NormalWorldLoader - NormalWorldDtb - NormalWorldKernel - RootFs - Services - Applications - FwConfig - BootManifest - Nwfs - TrustedKeystore - Policy - CustomerBoardConfig - UpdateCertStore - BaseSystemUpdateManifest - FirmwareUpdateManifest - CustomerUpdateManifest - RecoveryManifest - ManifestSet - Other x-ms-enum: name: ImageType modelAsString: true values: - name: InvalidImageType value: InvalidImageType description: Invalid image. - name: OneBl value: OneBl description: One Bl image type - name: PlutonRuntime value: PlutonRuntime description: Pluton image type - name: WifiFirmware value: WifiFirmware description: Wifi firmware image type - name: SecurityMonitor value: SecurityMonitor description: Security monitor image type - name: NormalWorldLoader value: NormalWorldLoader description: Normal world loader image type - name: NormalWorldDtb value: NormalWorldDtb description: Normal world dtb image type - name: NormalWorldKernel value: NormalWorldKernel description: Normal world kernel image type - name: RootFs value: RootFs description: Root FS image type - name: Services value: Services description: Services image type - name: Applications value: Applications description: Applications image type - name: FwConfig value: FwConfig description: FW config image type - name: BootManifest value: BootManifest description: Boot manifest image type - name: Nwfs value: Nwfs description: Nwfs image type - name: TrustedKeystore value: TrustedKeystore description: Trusted key store image type - name: Policy value: Policy description: Policy image type - name: CustomerBoardConfig value: CustomerBoardConfig description: Customer board config image type - name: UpdateCertStore value: UpdateCertStore description: Update certificate store image type - name: BaseSystemUpdateManifest value: BaseSystemUpdateManifest description: Base system update manifest image type - name: FirmwareUpdateManifest value: FirmwareUpdateManifest description: Firmware update manifest image type - name: CustomerUpdateManifest value: CustomerUpdateManifest description: Customer update manifest image type - name: RecoveryManifest value: RecoveryManifest description: Recovery manifest image type - name: ManifestSet value: ManifestSet description: manifest set image type - name: Other value: Other description: Other image type ChatResponseMessage: type: object description: A representation of a chat message as received in a response. properties: role: $ref: '#/definitions/ChatRole' description: The chat role associated with the message. content: type: string description: The content of the message. x-nullable: true tool_calls: type: array description: 'The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat completions request to resolve as configured.' items: $ref: '#/definitions/ChatCompletionsToolCall' x-ms-client-name: toolCalls function_call: $ref: '#/definitions/FunctionCall' description: 'The function call that must be resolved and have its output appended to subsequent input messages for the chat completions request to resolve as configured.' x-ms-client-name: functionCall context: $ref: '#/definitions/AzureChatExtensionsMessageContext' description: 'If Azure OpenAI chat extensions are configured, this array represents the incremental steps performed by those extensions while processing the chat completions request.' required: - role - content Azure.Core.Foundations.Error: type: object description: The error object. properties: code: type: string description: One of a server-defined set of error codes. message: type: string description: A human-readable representation of the error. target: type: string description: The target of the error. details: type: array description: An array of details about specific errors that led to this reported error. items: $ref: '#/definitions/Azure.Core.Foundations.Error' x-ms-identifiers: [] innererror: $ref: '#/definitions/Azure.Core.Foundations.InnerError' description: An object containing more specific information than the current object about the error. required: - code - message ChatCompletionsResponseFormat: type: object description: 'An abstract representation of a response format configuration usable by Chat Completions. Can be used to enable JSON mode.' properties: type: type: string description: The discriminated type for the response format. discriminator: type required: - type DeploymentPropertiesExtended: properties: provisioningState: type: string readOnly: true description: Denotes the state of provisioning. enum: - NotSpecified - Accepted - Running - Ready - Creating - Created - Deleting - Deleted - Canceled - Failed - Succeeded - Updating x-ms-enum: name: ProvisioningState modelAsString: true correlationId: readOnly: true type: string description: The correlation ID of the deployment. timestamp: readOnly: true type: string format: date-time description: The timestamp of the template deployment. duration: readOnly: true type: string description: The duration of the template deployment. outputs: readOnly: true type: object description: Key/value pairs that represent deployment output. providers: readOnly: true type: array items: $ref: '#/definitions/Provider' description: The list of resource providers needed for the deployment. dependencies: readOnly: true type: array items: $ref: '#/definitions/Dependency' description: The list of deployment dependencies. templateLink: readOnly: true $ref: '#/definitions/TemplateLink' description: The URI referencing the template. parameters: readOnly: true type: object description: 'Deployment parameters. ' parametersLink: readOnly: true $ref: '#/definitions/ParametersLink' description: 'The URI referencing the parameters. ' mode: readOnly: true type: string description: The deployment mode. Possible values are Incremental and Complete. enum: - Incremental - Complete x-ms-enum: name: DeploymentMode modelAsString: false debugSetting: readOnly: true $ref: '#/definitions/DebugSetting' description: The debug setting of the deployment. onErrorDeployment: readOnly: true $ref: '#/definitions/OnErrorDeploymentExtended' description: The deployment on error behavior. templateHash: readOnly: true type: string description: The hash produced for the template. outputResources: readOnly: true type: array description: Array of provisioned resources. items: $ref: '#/definitions/ResourceReference' description: Details of provisioned resources. validatedResources: readOnly: true type: array description: Array of validated resources. items: $ref: '#/definitions/ResourceReference' description: Details of validated resources. error: readOnly: true $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse description: The deployment error. description: Deployment properties with additional details. ContentFilterResult: type: object description: Information about filtered content severity level and if it has been filtered or not. properties: severity: $ref: '#/definitions/ContentFilterSeverity' description: Ratings for the intensity and risk level of filtered content. filtered: type: boolean description: A value indicating whether or not the content has been filtered. required: - severity - filtered Deployment_2: title: Deployment description: Deployments manage the reserved quota for Azure OpenAI models and make them available for inference requests. required: - model - scale_settings type: object properties: object: $ref: '#/definitions/TypeDiscriminator' status: $ref: '#/definitions/State_2' created_at: format: unixtime description: A timestamp when this job or item was created (in unix epochs). type: integer readOnly: true updated_at: format: unixtime description: A timestamp when this job or item was modified last (in unix epochs). type: integer readOnly: true id: description: The identity of this item. type: string readOnly: true model: description: The OpenAI model identifier (model-id) to deploy. Can be a base model or a fine tune. minLength: 1 type: string owner: description: The owner of this deployment. For Azure OpenAI only "organization-owner" is supported. type: string readOnly: true scale_settings: $ref: '#/definitions/ScaleSettings' error: $ref: '#/definitions/Error' State: title: State description: The state of a job or item. enum: - notRunning - running - succeeded - canceled - failed - deleted type: string readOnly: true x-ms-enum: name: State modelAsString: false values: - value: notRunning description: The operation was created and is not queued to be processed in the future. - value: running description: The operation has started to be processed. - value: succeeded description: The operation has successfully be processed and is ready for consumption. - value: canceled description: The operation has been canceled and is incomplete. - value: failed description: The operation has completed processing with a failure and cannot be further consumed. - value: deleted description: The entity has been deleted but may still be referenced by other entities predating the deletion. Azure.Core.Foundations.ErrorResponse: type: object description: A response containing error details. properties: error: $ref: '#/definitions/Azure.Core.Foundations.Error' description: The error object. required: - error KeyVaultParameterReference: type: object properties: keyVault: $ref: '#/definitions/KeyVaultReference' description: Azure Key Vault reference. secretName: type: string description: Azure Key Vault secret name. secretVersion: type: string description: Azure Key Vault secret version. required: - keyVault - secretName description: Azure Key Vault parameter reference. KeyVaultReference: type: object properties: id: type: string description: Azure Key Vault resource id. required: - id description: Azure Key Vault reference. ProviderResourceType: properties: resourceType: type: string description: The resource type. locations: type: array items: type: string description: The collection of locations where this resource type can be created. locationMappings: type: array items: $ref: '#/definitions/ProviderExtendedLocation' x-ms-identifiers: - location - type description: The location mappings that are supported by this resource type. aliases: type: array items: $ref: '#/definitions/Alias' x-ms-identifiers: - name description: The aliases that are supported by this resource type. apiVersions: type: array items: type: string description: The API version. defaultApiVersion: type: string readOnly: true description: The default API version. zoneMappings: type: array items: $ref: '#/definitions/ZoneMapping' x-ms-identifiers: - location apiProfiles: type: array readOnly: true items: $ref: '#/definitions/ApiProfile' x-ms-identifiers: - apiVersion - profileVersion description: The API profiles for the resource provider. capabilities: type: string description: The additional capabilities offered by this resource type. properties: type: object additionalProperties: type: string description: 'The additional properties. ' description: The properties. description: Resource type managed by the resource provider. ScopedDeploymentWhatIf: properties: location: type: string description: The location to store the deployment data. properties: $ref: '#/definitions/DeploymentWhatIfProperties' description: The deployment properties. required: - location - properties description: Deployment What-if operation parameters. DeploymentListResult_2: properties: value: type: array items: $ref: '#/definitions/DeploymentExtended' description: An array of deployments. nextLink: readOnly: true type: string description: The URL to use for getting the next set of results. description: List of deployments. ChatCompletions: type: object description: 'Representation of the response data from a chat completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.' properties: id: type: string description: A unique identifier associated with this chat completions response. created: type: integer format: unixtime description: 'The first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970.' choices: type: array description: 'The collection of completions choices associated with this completions response. Generally, `n` choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated.' items: $ref: '#/definitions/ChatChoice' x-ms-identifiers: [] model: type: string description: The model name used for this completions request. prompt_filter_results: type: array description: 'Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders.' items: $ref: '#/definitions/ContentFilterResultsForPrompt' x-ms-client-name: promptFilterResults x-ms-identifiers: [] system_fingerprint: type: string description: 'Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.' x-ms-client-name: systemFingerprint usage: $ref: '#/definitions/CompletionsUsage' description: Usage information for tokens processed and generated as part of this completions operation. required: - id - created - choices - usage DeploymentWhatIfSettings: properties: resultFormat: type: string description: The format of the What-If results enum: - ResourceIdOnly - FullResourcePayloads x-ms-enum: name: WhatIfResultFormat modelAsString: false description: Deployment What-If operation settings. ChatCompletionsToolCall: type: object description: 'An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested chat completion.' properties: type: type: string description: The object type. id: type: string description: The ID of the tool call. discriminator: type required: - type - id Choice: type: object description: 'The representation of a single prompt completion as part of an overall completions request. Generally, `n` choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated.' properties: text: type: string description: The generated text for a given completions prompt. index: type: integer format: int32 description: The ordered index associated with this completions choice. content_filter_results: $ref: '#/definitions/ContentFilterResultsForChoice' description: 'Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not.' x-ms-client-name: contentFilterResults logprobs: type: object description: The log probabilities model for tokens associated with this completions choice. x-nullable: true allOf: - $ref: '#/definitions/CompletionsLogProbabilityModel' finish_reason: $ref: '#/definitions/CompletionsFinishReason' description: Reason for finishing x-nullable: true x-ms-client-name: finishReason required: - text - index - logprobs - finish_reason ContentFilterResultDetailsForPrompt: type: object description: Information about content filtering evaluated against input data to Azure OpenAI. properties: sexual: $ref: '#/definitions/ContentFilterResult' description: "Describes language related to anatomical organs and genitals, romantic relationships,\n acts portrayed in erotic or affectionate terms, physical sexual acts, including\n those portrayed as an assault or a forced sexual violent act against one’s will,\n prostitution, pornography, and abuse." violence: $ref: '#/definitions/ContentFilterResult' description: 'Describes language related to physical actions intended to hurt, injure, damage, or kill someone or something; describes weapons, etc.' hate: $ref: '#/definitions/ContentFilterResult' description: 'Describes language attacks or uses that include pejorative or discriminatory language with reference to a person or identity group on the basis of certain differentiating attributes of these groups including but not limited to race, ethnicity, nationality, gender identity and expression, sexual orientation, religion, immigration status, ability status, personal appearance, and body size.' self_harm: $ref: '#/definitions/ContentFilterResult' description: 'Describes language related to physical actions intended to purposely hurt, injure, or damage one’s body, or kill oneself.' x-ms-client-name: selfHarm profanity: $ref: '#/definitions/ContentFilterDetectionResult' description: Describes whether profanity was detected. custom_blocklists: type: array description: Describes detection results against configured custom blocklists. items: $ref: '#/definitions/ContentFilterBlocklistIdResult' x-ms-client-name: customBlocklists error: $ref: '#/definitions/Azure.Core.Foundations.Error' description: 'Describes an error returned if the content filtering system is down or otherwise unable to complete the operation in time.' jailbreak: $ref: '#/definitions/ContentFilterDetectionResult' description: Whether a jailbreak attempt was detected in the prompt. Error: title: Error description: "Error content as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." required: - code - message type: object properties: code: $ref: '#/definitions/ErrorCode' message: description: The message of this error. minLength: 1 type: string target: description: The location where the error happened if available. type: string details: description: The error details if available. type: array items: $ref: '#/definitions/Error' innererror: $ref: '#/definitions/InnerError' ScaleSettings: title: ScaleSettings description: The scale settings of a deployment. It defines the modes for scaling and the reserved capacity. required: - scale_type type: object properties: scale_type: $ref: '#/definitions/ScaleType' discriminator: scale_type InnerErrorCode: title: InnerErrorCode description: "Inner error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." enum: - invalidPayload type: string x-ms-enum: name: InnerErrorCode modelAsString: true values: - value: invalidPayload description: The request data is invalid for this operation. ScopedDeployment: properties: location: type: string description: The location to store the deployment data. properties: $ref: '#/definitions/DeploymentProperties_2' description: The deployment properties. tags: type: object additionalProperties: type: string description: Deployment tags required: - location - properties description: Deployment operation parameters. ApiProfile: properties: profileVersion: type: string readOnly: true description: The profile version. apiVersion: type: string readOnly: true description: The API version. Completions: type: object description: 'Representation of the response data from a completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.' properties: id: type: string description: A unique identifier associated with this completions response. created: type: integer format: unixtime description: 'The first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970.' prompt_filter_results: type: array description: 'Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders.' items: $ref: '#/definitions/ContentFilterResultsForPrompt' x-ms-client-name: promptFilterResults x-ms-identifiers: [] choices: type: array description: 'The collection of completions choices associated with this completions response. Generally, `n` choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated.' items: $ref: '#/definitions/Choice' x-ms-identifiers: [] usage: $ref: '#/definitions/CompletionsUsage' description: Usage information for tokens processed and generated as part of this completions operation. required: - id - created - choices - usage ContentFilterCitedDetectionResult: type: object description: Represents the outcome of a detection operation against protected resources as performed by content filtering. properties: filtered: type: boolean description: A value indicating whether or not the content has been filtered. detected: type: boolean description: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered. URL: type: string format: uri description: The internet location associated with the detection. x-ms-client-name: url license: type: string description: The license description associated with the detection. required: - filtered - detected - license AliasPathMetadata: properties: type: type: string readOnly: true enum: - NotSpecified - Any - String - Object - Array - Integer - Number - Boolean x-ms-enum: name: AliasPathTokenType modelAsString: true values: - value: NotSpecified description: The token type is not specified. - value: Any description: The token type can be anything. - value: String description: The token type is string. - value: Object description: The token type is object. - value: Array description: The token type is array. - value: Integer description: The token type is integer. - value: Number description: The token type is number. - value: Boolean description: The token type is boolean. description: The type of the token that the alias path is referring to. attributes: type: string readOnly: true enum: - None - Modifiable x-ms-enum: name: AliasPathAttributes modelAsString: true values: - value: None description: The token that the alias path is referring to has no attributes. - value: Modifiable description: The token that the alias path is referring to is modifiable by policies with 'modify' effect. description: The attributes of the token that the alias path is referring to. AzureGroundingEnhancement: type: object description: The grounding enhancement that returns the bounding box of the objects detected in the image. properties: lines: type: array description: The lines of text detected by the grounding enhancement. items: $ref: '#/definitions/AzureGroundingEnhancementLine' x-ms-identifiers: [] required: - lines FunctionDefinition: type: object description: The definition of a caller-specified function that chat completions may invoke in response to matching user input. properties: name: type: string description: The name of the function to be called. description: type: string description: 'A description of what the function does. The model will use this description when selecting the function and interpreting its parameters.' parameters: description: The parameters the function accepts, described as a JSON Schema object. required: - name ProviderExtendedLocation: properties: location: type: string description: The azure location. type: type: string description: The extended location type. extendedLocations: type: array items: type: string description: The extended locations for the azure location. description: 'The provider extended location. ' ChatChoice: type: object description: 'The representation of a single prompt completion as part of an overall chat completions request. Generally, `n` choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated.' properties: message: $ref: '#/definitions/ChatResponseMessage' description: The chat message for a given chat completions prompt. logprobs: type: object description: The log probability information for this choice, as enabled via the 'logprobs' request option. x-nullable: true allOf: - $ref: '#/definitions/ChatChoiceLogProbabilityInfo' index: type: integer format: int32 description: The ordered index associated with this chat completions choice. finish_reason: $ref: '#/definitions/CompletionsFinishReason' description: The reason that this chat completions choice completed its generated. x-nullable: true x-ms-client-name: finishReason finish_details: $ref: '#/definitions/ChatFinishDetails' description: 'The reason the model stopped generating tokens, together with any applicable details. This structured representation replaces ''finish_reason'' for some models.' x-ms-client-name: finishDetails delta: $ref: '#/definitions/ChatResponseMessage' description: The delta message content for a streaming response. content_filter_results: $ref: '#/definitions/ContentFilterResultsForChoice' description: 'Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not.' x-ms-client-name: contentFilterResults enhancements: $ref: '#/definitions/AzureChatEnhancements' description: 'Represents the output results of Azure OpenAI enhancements to chat completions, as configured via the matching input provided in the request. This supplementary information is only available when using Azure OpenAI and only when the request is configured to use enhancements.' required: - logprobs - index - finish_reason DeploymentParameter: type: object properties: value: description: Input value to the parameter . reference: $ref: '#/definitions/KeyVaultParameterReference' description: Azure Key Vault parameter reference. description: Deployment parameter for the template. CompletionsUsage: type: object description: 'Representation of the token counts processed for a completions request. Counts consider all tokens across prompts, choices, choice alternates, best_of generations, and other consumers.' properties: completion_tokens: type: integer format: int32 description: The number of tokens generated across all completions emissions. x-ms-client-name: completionTokens prompt_tokens: type: integer format: int32 description: The number of tokens in the provided prompts for the completions request. x-ms-client-name: promptTokens total_tokens: type: integer format: int32 description: The total number of tokens processed for the completions request and response. x-ms-client-name: totalTokens required: - completion_tokens - prompt_tokens - total_tokens ContentFilterSeverity: type: string description: Ratings for the intensity and risk level of harmful content. enum: - safe - low - medium - high x-ms-enum: name: ContentFilterSeverity modelAsString: true values: - name: safe value: safe description: 'Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences.' - name: low value: low description: 'Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity.' - name: medium value: medium description: 'Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity.' - name: high value: high description: 'Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse.' DeploymentUpdate_2: title: DeploymentUpdate description: Defines changes to the deployment. type: object properties: model: description: The new OpenAI model identifier (model-id) to be used for this deployment. Can be a base model or a fine tune. type: string scale_settings: $ref: '#/definitions/ScaleSettingsUpdate' AzureChatExtensionConfiguration: type: object description: " A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat\n completions request that should use Azure OpenAI chat extensions to augment the response behavior.\n The use of this configuration is compatible only with Azure OpenAI." properties: type: $ref: '#/definitions/AzureChatExtensionType' description: " The label for the type of an Azure chat extension. This typically corresponds to a matching Azure resource.\n Azure chat extensions are only compatible with Azure OpenAI." discriminator: type required: - type TypeDiscriminator: title: TypeDiscriminator description: Defines the type of an object. enum: - list - fine-tune - file - fine-tune-event - model - deployment type: string readOnly: true x-ms-enum: name: TypeDiscriminator modelAsString: true values: - value: list description: This object represents a list of other objects. - value: fine-tune description: This object represents a fine tune job. - value: file description: This object represents a file. - value: fine-tune-event description: This object represents an event of a fine tune job. - value: model description: This object represents a model (can be a base models or fine tune job result). - value: deployment description: This object represents a deployment. ImageProperties: type: object description: The properties of image properties: image: type: string description: Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads. x-ms-mutability: - read - create imageId: type: string description: Image ID x-ms-mutability: - read - create imageName: type: string description: Image name readOnly: true regionalDataBoundary: $ref: '#/definitions/RegionalDataBoundary' description: Regional data boundary for an image x-ms-mutability: - read - create uri: type: string description: Location the image readOnly: true description: type: string description: The image description. readOnly: true componentId: type: string description: The image component id. readOnly: true imageType: $ref: '#/definitions/ImageType' description: The image type. readOnly: true provisioningState: $ref: '#/definitions/ProvisioningState' description: The status of the last operation. readOnly: true Deployment_5: properties: location: type: string description: The location to store the deployment data. properties: $ref: '#/definitions/DeploymentProperties_2' description: The deployment properties. tags: type: object additionalProperties: type: string description: Deployment tags required: - properties description: Deployment operation parameters. DeploymentExtended: properties: id: readOnly: true type: string description: The ID of the deployment. name: readOnly: true type: string description: The name of the deployment. type: readOnly: true type: string description: The type of the deployment. location: type: string description: the location of the deployment. properties: $ref: '#/definitions/DeploymentPropertiesExtended' description: Deployment properties. tags: type: object additionalProperties: type: string description: Deployment tags x-ms-azure-resource: true description: Deployment information. SpeechVoice: type: string description: The available voices for text-to-speech. enum: - alloy - echo - fable - onyx - nova - shimmer x-ms-enum: name: SpeechVoice modelAsString: true values: - name: alloy value: alloy description: The Alloy voice. - name: echo value: echo description: The Echo voice. - name: fable value: fable description: The Fable voice. - name: onyx value: onyx description: The Onyx voice. - name: nova value: nova description: The Nova voice. - name: shimmer value: shimmer description: The Shimmer voice. EmbeddingItem: type: object description: Representation of a single embeddings relatedness comparison. properties: embedding: type: array description: 'List of embeddings value for the input prompt. These represent a measurement of the vector-based relatedness of the provided input.' items: type: number format: float index: type: integer format: int32 description: Index of the prompt to which the EmbeddingItem corresponds. required: - embedding - index ContentFilterBlocklistIdResult: type: object description: Represents the outcome of an evaluation against a custom blocklist as performed by content filtering. properties: id: type: string description: The ID of the custom blocklist evaluated. filtered: type: boolean description: A value indicating whether or not the content has been filtered. required: - id - filtered ChatTokenLogProbabilityResult: type: object description: A representation of the log probability information for a single content token, including a list of most likely tokens if 'top_logprobs' were requested. properties: token: type: string description: The message content token. logprob: type: number format: float description: The log probability of the message content token. bytes: type: array description: A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token. x-nullable: true items: type: integer format: int32 top_logprobs: type: array description: The list of most likely tokens and their log probability information, as requested via 'top_logprobs'. x-nullable: true items: $ref: '#/definitions/ChatTokenLogProbabilityInfo' x-ms-identifiers: [] required: - token - logprob - bytes - top_logprobs ChatRequestMessage: type: object description: An abstract representation of a chat message as provided in a request. properties: role: $ref: '#/definitions/ChatRole' description: The chat role associated with this message. discriminator: role required: - role WhatIfOperationProperties: description: Deployment operation properties. properties: changes: type: array items: $ref: '#/definitions/WhatIfChange' x-ms-identifiers: - resourceId - changeType description: List of resource changes predicted by What-If operation. ErrorCode: title: ErrorCode description: "Error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." enum: - conflict - invalidPayload - forbidden - notFound - unexpectedEntityState - itemDoesAlreadyExist - serviceUnavailable - internalFailure - quotaExceeded type: string x-ms-enum: name: ErrorCode modelAsString: true values: - value: conflict description: The requested operation conflicts with the current resource state. - value: invalidPayload description: The request data is invalid for this operation. - value: forbidden description: The operation is forbidden for the current user/api key. - value: notFound description: The resource is not found. - value: unexpectedEntityState description: The operation cannot be executed in the current resource's state. - value: itemDoesAlreadyExist description: The item does already exist. - value: serviceUnavailable description: The service is currently not available. - value: internalFailure description: Internal error. Please retry. - value: quotaExceeded description: Quota exceeded. ErrorResponse: title: ErrorResponse description: "Error response as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." type: object properties: error: $ref: '#/definitions/Error' DeploymentProperties_2: properties: template: type: object description: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. templateLink: $ref: '#/definitions/TemplateLink' description: The URI of the template. Use either the templateLink property or the template property, but not both. parameters: type: object additionalProperties: $ref: '#/definitions/DeploymentParameter' description: Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. parametersLink: $ref: '#/definitions/ParametersLink' description: The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. mode: type: string description: The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. enum: - Incremental - Complete x-ms-enum: name: DeploymentMode modelAsString: false debugSetting: $ref: '#/definitions/DebugSetting' description: The debug setting of the deployment. onErrorDeployment: $ref: '#/definitions/OnErrorDeployment' description: The deployment on error behavior. expressionEvaluationOptions: $ref: '#/definitions/ExpressionEvaluationOptions' description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. required: - mode description: Deployment properties. DeploymentUpdate: title: DeploymentUpdate description: Defines changes to the deployment. type: object properties: model: description: The new OpenAI model to be used for this deployment. Can be a base model or a fine tune. type: string scale_settings: $ref: '#/definitions/ScaleSettingsUpdate' ZoneMapping: type: object properties: location: type: string description: The location of the zone mapping. zones: type: array items: type: string AzureChatExtensionDataSourceResponseCitation: type: object description: 'A single instance of additional context information available when Azure OpenAI chat extensions are involved in the generation of a corresponding chat completions response. This context information is only populated when using an Azure OpenAI request configured to use a matching extension.' properties: content: type: string description: The content of the citation. title: type: string description: The title of the citation. url: type: string description: The URL of the citation. filepath: type: string description: The file path of the citation. chunk_id: type: string description: The chunk ID of the citation. required: - content Alias: properties: name: type: string description: The alias name. paths: type: array items: $ref: '#/definitions/AliasPath' x-ms-identifiers: [] description: The paths for an alias. type: type: string description: The type of the alias. enum: - NotSpecified - PlainText - Mask x-ms-enum: name: AliasType modelAsString: false values: - value: NotSpecified description: Alias type is unknown (same as not providing alias type). - value: PlainText description: Alias value is not secret. - value: Mask description: Alias value is secret. defaultPath: type: string description: The default path for an alias. defaultPattern: $ref: '#/definitions/AliasPattern' description: The default pattern for an alias. defaultMetadata: readOnly: true $ref: '#/definitions/AliasPathMetadata' description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata description: 'The alias type. ' BasicDependency: properties: id: type: string description: The ID of the dependency. resourceType: type: string description: The dependency resource type. resourceName: type: string description: The dependency resource name. description: Deployment dependency information. OnErrorDeploymentExtended: properties: provisioningState: readOnly: true type: string description: The state of the provisioning for the on error deployment. type: type: string description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. enum: - LastSuccessful - SpecificDeployment x-ms-enum: name: OnErrorDeploymentType modelAsString: false deploymentName: type: string description: The deployment to be used on error case. description: Deployment on error behavior with additional details. DebugSetting: properties: detailLevel: type: string description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. description: The debug setting. CompletionsLogProbabilityModel: type: object description: Representation of a log probabilities model for a completions generation. properties: tokens: type: array description: The textual forms of tokens evaluated in this probability model. items: type: string token_logprobs: type: array description: A collection of log probability values for the tokens in this completions data. items: type: number format: float x-nullable: true x-ms-client-name: tokenLogprobs top_logprobs: type: array description: A mapping of tokens to maximum log probability values in this completions data. items: type: object additionalProperties: format: float type: number x-nullable: true x-ms-client-name: topLogprobs x-ms-identifiers: [] text_offset: type: array description: The text offsets associated with tokens in this completions data. items: type: integer format: int32 x-ms-client-name: textOffset required: - tokens - token_logprobs - top_logprobs - text_offset ChatFinishDetails: type: object description: An abstract representation of structured information about why a chat completions response terminated. properties: type: type: string description: The object type. discriminator: type required: - type TemplateHashResult: description: Result of the request to calculate template hash. It contains a string of minified template and its hash. properties: minifiedTemplate: type: string description: The minified template string. templateHash: type: string description: The template hash. TemplateLink: properties: uri: type: string description: The URI of the template to deploy. Use either the uri or id property, but not both. id: type: string description: The resource id of a Template Spec. Use either the id or uri property, but not both. relativePath: type: string description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs contentVersion: type: string description: If included, must match the ContentVersion in the template. queryString: type: string description: The query string (for example, a SAS token) to be used with the templateLink URI. description: Entity representing the reference to the template. ParametersLink: properties: uri: type: string description: The URI of the parameters file. contentVersion: type: string description: If included, must match the ContentVersion in the template. required: - uri description: Entity representing the reference to the deployment parameters. ImageGenerationPromptFilterResults: type: object description: Describes the content filtering results for the prompt of a image generation request. properties: sexual: $ref: '#/definitions/ContentFilterResult' description: "Describes language related to anatomical organs and genitals, romantic relationships,\n acts portrayed in erotic or affectionate terms, physical sexual acts, including\n those portrayed as an assault or a forced sexual violent act against one’s will,\n prostitution, pornography, and abuse." violence: $ref: '#/definitions/ContentFilterResult' description: 'Describes language related to physical actions intended to hurt, injure, damage, or kill someone or something; describes weapons, etc.' hate: $ref: '#/definitions/ContentFilterResult' description: 'Describes language attacks or uses that include pejorative or discriminatory language with reference to a person or identity group on the basis of certain differentiating attributes of these groups including but not limited to race, ethnicity, nationality, gender identity and expression, sexual orientation, religion, immigration status, ability status, personal appearance, and body size.' self_harm: $ref: '#/definitions/ContentFilterResult' description: 'Describes language related to physical actions intended to purposely hurt, injure, or damage one’s body, or kill oneself.' x-ms-client-name: selfHarm profanity: $ref: '#/definitions/ContentFilterDetectionResult' description: Describes whether profanity was detected. jailbreak: $ref: '#/definitions/ContentFilterDetectionResult' description: Whether a jailbreak attempt was detected in the prompt. ScaleType: title: ScaleType description: Defines how scaling operations will be executed. enum: - manual type: string x-ms-enum: name: ScaleType modelAsString: true values: - value: manual description: Scaling of a deployment will happen by manually specifying the capacity of a model. ChatRole: type: string description: A description of the intended purpose of a message within a chat completions interaction. enum: - system - assistant - user - function - tool x-ms-enum: name: ChatRole modelAsString: true values: - name: system value: system description: The role that instructs or sets the behavior of the assistant. - name: assistant value: assistant description: The role that provides responses to system-instructed, user-prompted input. - name: user value: user description: The role that provides input for chat completions. - name: function value: function description: The role that provides function results for chat completions. - name: tool value: tool description: The role that represents extension tool activity within a chat completions operation. Provider: properties: id: readOnly: true type: string description: The provider ID. namespace: type: string description: The namespace of the resource provider. registrationState: readOnly: true type: string description: The registration state of the resource provider. registrationPolicy: readOnly: true type: string description: The registration policy of the resource provider. resourceTypes: readOnly: true type: array items: $ref: '#/definitions/ProviderResourceType' x-ms-identifiers: - resourceType description: The collection of provider resource types. providerAuthorizationConsentState: type: string enum: - NotSpecified - Required - NotRequired - Consented description: The provider authorization consent state. x-ms-enum: name: ProviderAuthorizationConsentState modelAsString: true description: Resource provider information. AzureChatEnhancementConfiguration: type: object description: A representation of the available Azure OpenAI enhancement configurations. properties: grounding: $ref: '#/definitions/AzureChatGroundingEnhancementConfiguration' description: A representation of the available options for the Azure OpenAI grounding enhancement. ocr: $ref: '#/definitions/AzureChatOCREnhancementConfiguration' description: A representation of the available options for the Azure OpenAI optical character recognition (OCR) enhancement. Deployment_4: type: object description: An deployment resource belonging to a device group resource. properties: properties: $ref: '#/definitions/DeploymentProperties' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource Image: type: object description: An image resource belonging to a catalog resource. properties: properties: $ref: '#/definitions/ImageProperties' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource WhatIfOperationResult: description: Result of the What-If operation. Contains a list of predicted changes and a URL link to get to the next set of results. properties: status: type: string description: Status of the What-If operation. properties: x-ms-client-flatten: true $ref: '#/definitions/WhatIfOperationProperties' description: What-If operation properties. error: $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse description: Error when What-If operation fails. ImageGenerations: type: object description: The result of a successful image generation operation. properties: created: type: integer format: unixtime description: 'A timestamp representing when this operation was started. Expressed in seconds since the Unix epoch of 1970-01-01T00:00:00+0000.' data: type: array description: The images generated by the operation. items: $ref: '#/definitions/ImageGenerationData' x-ms-identifiers: [] required: - created - data AzureChatOCREnhancementConfiguration: type: object description: A representation of the available options for the Azure OpenAI optical character recognition (OCR) enhancement. properties: enabled: type: boolean description: Specifies whether the enhancement is enabled. required: - enabled WhatIfChange: description: Information about a single resource change predicted by What-If operation. required: - resourceId - changeType properties: resourceId: type: string description: Resource ID changeType: type: string description: Type of change that will be made to the resource when the deployment is executed. enum: - Create - Delete - Ignore - Deploy - NoChange - Modify - Unsupported x-ms-enum: name: ChangeType modelAsString: false values: - value: Create description: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. - value: Delete description: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. - value: Ignore description: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. - value: Deploy description: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. - value: NoChange description: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. - value: Modify description: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. - value: Unsupported description: The resource is not supported by What-If. unsupportedReason: type: string description: The explanation about why the resource is unsupported by What-If. before: type: object description: The snapshot of the resource before the deployment is executed. after: type: object description: The predicted snapshot of the resource after the deployment is executed. delta: type: array items: $ref: '#/definitions/WhatIfPropertyChange' x-ms-identifiers: - path description: The predicted changes to resource properties. ExpressionEvaluationOptions: properties: scope: type: string description: The scope to be used for evaluation of parameters, variables and functions in a nested template. enum: - NotSpecified - Outer - Inner x-ms-enum: name: ExpressionEvaluationOptionsScopeType modelAsString: true description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. EmbeddingsOptions: type: object description: 'The configuration information for an embeddings request. Embeddings measure the relatedness of text strings and are commonly used for search, clustering, recommendations, and other similar scenarios.' properties: user: type: string description: 'An identifier for the caller or end user of the operation. This may be used for tracking or rate-limiting purposes.' model: type: string description: 'The model name to provide as part of this embeddings request. Not applicable to Azure OpenAI, where deployment information should be included in the Azure resource URI that''s connected to.' input: type: array description: 'Input texts to get embeddings for, encoded as a an array of strings. Each input must not exceed 2048 tokens in length. Unless you are embedding code, we suggest replacing newlines (\n) in your input with a single space, as we have observed inferior results when newlines are present.' items: type: string encoding_format: type: string description: The response encoding format to use for embedding data. default: float enum: - float - base64 x-ms-enum: name: EmbeddingEncodingFormat modelAsString: true values: - name: float value: float description: Specifies that responses should provide arrays of floats for each embedding. - name: base64 value: base64 description: Specifies that responses should provide a base64-encoded string for each embedding. x-ms-client-name: encodingFormat dimensions: type: integer format: int32 description: The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models. input_type: type: string description: When using Azure OpenAI, specifies the input type to use for embedding search. x-ms-client-name: inputType required: - input AzureGroundingEnhancementLine: type: object description: A content line object consisting of an adjacent sequence of content elements, such as words and selection marks. properties: text: type: string description: The text within the line. spans: type: array description: An array of spans that represent detected objects and its bounding box information. items: $ref: '#/definitions/AzureGroundingEnhancementLineSpan' x-ms-identifiers: [] required: - text - spans ImageGenerationOptions: type: object description: Represents the request data used to generate images. properties: model: type: string description: 'The model name or Azure OpenAI model deployment name to use for image generation. If not specified, dall-e-2 will be inferred as a default.' prompt: type: string description: A description of the desired images. n: type: integer format: int32 description: 'The number of images to generate. Dall-e-2 models support values between 1 and 10. Dall-e-3 models only support a value of 1.' default: 1 size: type: string description: 'The desired dimensions for generated images. Dall-e-2 models support 256x256, 512x512, or 1024x1024. Dall-e-3 models support 1024x1024, 1792x1024, or 1024x1792.' default: 1024x1024 enum: - 256x256 - 512x512 - 1024x1024 - 1792x1024 - 1024x1792 x-ms-enum: name: ImageSize modelAsString: true values: - name: size256x256 value: 256x256 description: 'Very small image size of 256x256 pixels. Only supported with dall-e-2 models.' - name: size512x512 value: 512x512 description: 'A smaller image size of 512x512 pixels. Only supported with dall-e-2 models.' - name: size1024x1024 value: 1024x1024 description: 'A standard, square image size of 1024x1024 pixels. Supported by both dall-e-2 and dall-e-3 models.' - name: size1792x1024 value: 1792x1024 description: 'A wider image size of 1024x1792 pixels. Only supported with dall-e-3 models.' - name: size1024x1792 value: 1024x1792 description: 'A taller image size of 1792x1024 pixels. Only supported with dall-e-3 models.' response_format: type: string description: The format in which image generation response items should be presented. default: url enum: - url - b64_json x-ms-enum: name: ImageGenerationResponseFormat modelAsString: true values: - name: url value: url description: Image generation response items should provide a URL from which the image may be retrieved. - name: base64 value: b64_json description: Image generation response items should provide image data as a base64-encoded string. x-ms-client-name: responseFormat quality: type: string description: 'The desired image generation quality level to use. Only configurable with dall-e-3 models.' default: standard enum: - standard - hd x-ms-enum: name: ImageGenerationQuality modelAsString: true values: - name: standard value: standard description: Requests image generation with standard, balanced characteristics of quality, cost, and speed. - name: hd value: hd description: Requests image generation with higher quality, higher cost and lower speed relative to standard. style: type: string description: 'The desired image generation style to use. Only configurable with dall-e-3 models.' default: vivid enum: - natural - vivid x-ms-enum: name: ImageGenerationStyle modelAsString: true values: - name: natural value: natural description: Requests image generation in a natural style with less preference for dramatic and hyper-realistic characteristics. - name: vivid value: vivid description: 'Requests image generation in a vivid style with a higher preference for dramatic and hyper-realistic characteristics.' user: type: string description: A unique identifier representing your end-user, which can help to monitor and detect abuse. required: - prompt Azure.Core.Foundations.InnerError: type: object description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. properties: code: type: string description: One of a server-defined set of error codes. innererror: $ref: '#/definitions/Azure.Core.Foundations.InnerError' description: Inner error. DeploymentList: title: DeploymentList description: Represents a list of deployments. type: object properties: object: $ref: '#/definitions/TypeDiscriminator' data: description: The list of items. type: array items: $ref: '#/definitions/Deployment' readOnly: true ContentFilterDetectionResult: type: object description: Represents the outcome of a detection operation performed by content filtering. properties: filtered: type: boolean description: A value indicating whether or not the content has been filtered. detected: type: boolean description: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered. required: - filtered - detected AzureGroundingEnhancementCoordinatePoint: type: object description: A representation of a single polygon point as used by the Azure grounding enhancement. properties: x: type: number format: float description: The x-coordinate (horizontal axis) of the point. y: type: number format: float description: The y-coordinate (vertical axis) of the point. required: - x - y DeploymentListResult: type: object description: The response of a Deployment list operation. properties: value: type: array description: The Deployment items on this page items: $ref: '#/definitions/Deployment_4' nextLink: type: string format: uri description: The link to the next page of items readOnly: true required: - value FunctionCall: type: object description: The name and arguments of a function that should be called, as generated by the model. properties: name: type: string description: The name of the function to call. arguments: type: string description: 'The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.' required: - name - arguments ChatCompletionsToolDefinition: type: object description: An abstract representation of a tool that can be used by the model to improve a chat completions response. properties: type: type: string description: The object type. discriminator: type required: - type RegionalDataBoundary: type: string description: Regional data boundary values. enum: - None - EU x-ms-enum: name: RegionalDataBoundary modelAsString: true values: - name: None value: None description: No data boundary - name: EU value: EU description: EU data boundary ChatCompletionsOptions: type: object description: 'The configuration information for a chat completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.' properties: messages: type: array description: 'The collection of context messages associated with this chat completions request. Typical usage begins with a chat message for the System role that provides instructions for the behavior of the assistant, followed by alternating messages between the User and Assistant roles.' items: $ref: '#/definitions/ChatRequestMessage' x-ms-identifiers: [] functions: type: array description: A list of functions the model may generate JSON inputs for. items: $ref: '#/definitions/FunctionDefinition' x-ms-identifiers: [] function_call: description: "Controls how the model responds to function calls. \"none\" means the model does not call a function,\nand responds to the end-user. \"auto\" means the model can pick between an end-user or calling a function.\n Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n \"none\" is the default when no functions are present. \"auto\" is the default if functions are present." x-ms-client-name: functionCall max_tokens: type: integer format: int32 description: The maximum number of tokens to generate. x-ms-client-name: maxTokens temperature: type: number format: float description: 'The sampling temperature to use that controls the apparent creativity of generated completions. Higher values will make output more random while lower values will make results more focused and deterministic. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict.' top_p: type: number format: float description: 'An alternative to sampling with temperature called nucleus sampling. This value causes the model to consider the results of tokens with the provided probability mass. As an example, a value of 0.15 will cause only the tokens comprising the top 15% of probability mass to be considered. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict.' x-ms-client-name: topP logit_bias: type: object description: 'A map between GPT token IDs and bias scores that influences the probability of specific tokens appearing in a completions response. Token IDs are computed via external tokenizer tools, while bias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to a full ban or exclusive selection of a token, respectively. The exact behavior of a given bias score varies by model.' additionalProperties: format: int32 type: integer x-ms-client-name: logitBias user: type: string description: 'An identifier for the caller or end user of the operation. This may be used for tracking or rate-limiting purposes.' n: type: integer format: int32 description: 'The number of chat completions choices that should be generated for a chat completions response. Because this setting can generate many completions, it may quickly consume your token quota. Use carefully and ensure reasonable settings for max_tokens and stop.' stop: type: array description: A collection of textual sequences that will end completions generation. items: type: string presence_penalty: type: number format: float description: 'A value that influences the probability of generated tokens appearing based on their existing presence in generated text. Positive values will make tokens less likely to appear when they already exist and increase the model''s likelihood to output new topics.' x-ms-client-name: presencePenalty frequency_penalty: type: number format: float description: 'A value that influences the probability of generated tokens appearing based on their cumulative frequency in generated text. Positive values will make tokens less likely to appear as their frequency increases and decrease the likelihood of the model repeating the same statements verbatim.' x-ms-client-name: frequencyPenalty stream: type: boolean description: A value indicating whether chat completions should be streamed for this request. model: type: string description: 'The model name to provide as part of this completions request. Not applicable to Azure OpenAI, where deployment information should be included in the Azure resource URI that''s connected to.' data_sources: type: array description: " The configuration entries for Azure OpenAI chat extensions that use them.\n This additional specification is only compatible with Azure OpenAI." items: $ref: '#/definitions/AzureChatExtensionConfiguration' x-ms-client-name: dataSources x-ms-identifiers: [] enhancements: $ref: '#/definitions/AzureChatEnhancementConfiguration' description: If provided, the configuration options for available Azure OpenAI chat enhancements. seed: type: integer format: int64 description: 'If specified, the system will make a best effort to sample deterministically such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend."' logprobs: type: boolean description: Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. This option is currently not available on the `gpt-4-vision-preview` model. default: false x-nullable: true top_logprobs: type: integer format: int32 description: An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used. x-nullable: true response_format: $ref: '#/definitions/ChatCompletionsResponseFormat' description: An object specifying the format that the model must output. Used to enable JSON mode. x-ms-client-name: responseFormat tools: type: array description: The available tool definitions that the chat completions request can use, including caller-defined functions. items: $ref: '#/definitions/ChatCompletionsToolDefinition' x-ms-identifiers: [] tool_choice: description: If specified, the model will configure which of the provided tools it can use for the chat completions response. x-ms-client-name: toolChoice required: - messages AliasPattern: properties: phrase: type: string description: The alias pattern phrase. variable: type: string description: The alias pattern variable. type: type: string enum: - NotSpecified - Extract x-ms-enum: name: AliasPatternType modelAsString: false values: - value: NotSpecified description: NotSpecified is not allowed. - value: Extract description: Extract is the only allowed value. description: The type of alias pattern description: The type of the pattern for an alias path. Embeddings: type: object description: 'Representation of the response data from an embeddings request. Embeddings measure the relatedness of text strings and are commonly used for search, clustering, recommendations, and other similar scenarios.' properties: data: type: array description: Embedding values for the prompts submitted in the request. items: $ref: '#/definitions/EmbeddingItem' x-ms-identifiers: [] usage: $ref: '#/definitions/EmbeddingsUsage' description: Usage counts for tokens input using the embeddings API. required: - data - usage CompletionsFinishReason: type: string description: Representation of the manner in which a completions response concluded. enum: - stop - length - content_filter - function_call - tool_calls x-ms-enum: name: CompletionsFinishReason modelAsString: true values: - name: stopped value: stop description: Completions ended normally and reached its end of token generation. - name: tokenLimitReached value: length description: Completions exhausted available token limits before generation could complete. - name: contentFiltered value: content_filter description: 'Completions generated a response that was identified as potentially sensitive per content moderation policies.' - name: functionCall value: function_call description: Completion ended normally, with the model requesting a function to be called. - name: toolCalls value: tool_calls description: Completion ended with the model calling a provided tool for output. Deployment: title: Deployment description: Deployments manage the reserved quota for Azure OpenAI models and make them available for inference requests. required: - model - scale_settings type: object properties: object: $ref: '#/definitions/TypeDiscriminator' status: $ref: '#/definitions/State' created_at: format: int32 description: A timestamp when this job or item was created (in unix epochs). type: integer readOnly: true updated_at: format: int32 description: A timestamp when this job or item was modified last (in unix epochs). type: integer readOnly: true id: description: The identity of this item. type: string readOnly: true model: description: The OpenAI model to deploy. Can be a base model or a fine tune. minLength: 1 type: string owner: description: The owner of this deployment. For Azure OpenAI only "organization-owner" is supported. type: string readOnly: true scale_settings: $ref: '#/definitions/ScaleSettings' DeploymentWhatIfProperties: properties: whatIfSettings: $ref: '#/definitions/DeploymentWhatIfSettings' description: Optional What-If operation settings. allOf: - $ref: '#/definitions/DeploymentProperties_2' description: Deployment What-if properties. AliasPath: properties: path: type: string description: The path of an alias. apiVersions: type: array items: type: string description: The API versions. pattern: $ref: '#/definitions/AliasPattern' description: The pattern for an alias path. metadata: readOnly: true $ref: '#/definitions/AliasPathMetadata' description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. description: The type of the paths for alias. ChatChoiceLogProbabilityInfo: type: object description: Log probability information for a choice, as requested via 'logprobs' and 'top_logprobs'. properties: content: type: array description: The list of log probability information entries for the choice's message content tokens, as requested via the 'logprobs' option. x-nullable: true items: $ref: '#/definitions/ChatTokenLogProbabilityResult' x-ms-identifiers: [] required: - content DeploymentExportResult: properties: template: type: object description: The template content. description: 'The deployment export result. ' DeploymentValidateResult: properties: error: readOnly: true $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse description: The deployment validation error. properties: $ref: '#/definitions/DeploymentPropertiesExtended' description: The template deployment properties. description: Information from validate template deployment response. AzureChatEnhancements: type: object description: 'Represents the output results of Azure enhancements to chat completions, as configured via the matching input provided in the request.' properties: grounding: $ref: '#/definitions/AzureGroundingEnhancement' description: The grounding enhancement that returns the bounding box of the objects detected in the image. ErrorResponse_2: title: ErrorResponse description: "Error response as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." required: - error type: object properties: error: $ref: '#/definitions/Error' AzureChatGroundingEnhancementConfiguration: type: object description: A representation of the available options for the Azure OpenAI grounding enhancement. properties: enabled: type: boolean description: Specifies whether the enhancement is enabled. required: - enabled AzureGroundingEnhancementLineSpan: type: object description: A span object that represents a detected object and its bounding box information. properties: text: type: string description: The text content of the span that represents the detected object. offset: type: integer format: int32 description: 'The character offset within the text where the span begins. This offset is defined as the position of the first character of the span, counting from the start of the text as Unicode codepoints.' length: type: integer format: int32 description: The length of the span in characters, measured in Unicode codepoints. polygon: type: array description: An array of objects representing points in the polygon that encloses the detected object. items: $ref: '#/definitions/AzureGroundingEnhancementCoordinatePoint' x-ms-identifiers: [] required: - text - offset - length - polygon SpeechGenerationOptions: type: object description: A representation of the request options that control the behavior of a text-to-speech operation. properties: input: type: string description: The text to generate audio for. The maximum length is 4096 characters. maxLength: 4096 voice: $ref: '#/definitions/SpeechVoice' description: The voice to use for text-to-speech. response_format: type: string description: The audio output format for the spoken text. By default, the MP3 format will be used. default: mp3 enum: - mp3 - opus - aac - flac x-ms-enum: name: SpeechGenerationResponseFormat modelAsString: true values: - name: mp3 value: mp3 description: Use MP3 as the audio output format. MP3 is the default, general-purpose format. - name: opus value: opus description: Use Opus as the audio output format. Opus is optimized for internet streaming and low latency. - name: aac value: aac description: Use AAC as the audio output format. AAC is optimized for digital audio compression and is preferred by YouTube, Android, and iOS. - name: flac value: flac description: Use FLAC as the audio output format. FLAC is a fully lossless format optimized for maximum quality at the expense of size. x-ms-client-name: responseFormat speed: type: number format: float description: The speed of speech for generated audio. Values are valid in the range from 0.25 to 4.0, with 1.0 the default and higher values corresponding to faster speech. default: 1 minimum: 0.25 maximum: 4 model: type: string description: The model to use for this text-to-speech request. required: - input - voice ContentFilterResultsForPrompt: type: object description: Content filtering results for a single prompt in the request. properties: prompt_index: type: integer format: int32 description: The index of this prompt in the set of prompt results x-ms-client-name: promptIndex content_filter_results: $ref: '#/definitions/ContentFilterResultDetailsForPrompt' description: Content filtering results for this prompt x-ms-client-name: contentFilterResults required: - prompt_index - content_filter_results ChatTokenLogProbabilityInfo: type: object description: A representation of the log probability information for a single message content token. properties: token: type: string description: The message content token. logprob: type: number format: float description: The log probability of the message content token. bytes: type: array description: A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token. x-nullable: true items: type: integer format: int32 required: - token - logprob - bytes DeploymentProperties: type: object description: The properties of deployment properties: deploymentId: type: string description: Deployment ID x-ms-mutability: - read - create deployedImages: type: array description: Images deployed items: $ref: '#/definitions/Image' x-ms-mutability: - read - create deploymentDateUtc: type: string format: date-time description: Deployment date UTC readOnly: true provisioningState: $ref: '#/definitions/ProvisioningState' description: The status of the last operation. readOnly: true ContentFilterResultsForChoice: type: object description: Information about content filtering evaluated against generated model output. properties: sexual: $ref: '#/definitions/ContentFilterResult' description: "Describes language related to anatomical organs and genitals, romantic relationships,\n acts portrayed in erotic or affectionate terms, physical sexual acts, including\n those portrayed as an assault or a forced sexual violent act against one’s will,\n prostitution, pornography, and abuse." violence: $ref: '#/definitions/ContentFilterResult' description: 'Describes language related to physical actions intended to hurt, injure, damage, or kill someone or something; describes weapons, etc.' hate: $ref: '#/definitions/ContentFilterResult' description: 'Describes language attacks or uses that include pejorative or discriminatory language with reference to a person or identity group on the basis of certain differentiating attributes of these groups including but not limited to race, ethnicity, nationality, gender identity and expression, sexual orientation, religion, immigration status, ability status, personal appearance, and body size.' self_harm: $ref: '#/definitions/ContentFilterResult' description: 'Describes language related to physical actions intended to purposely hurt, injure, or damage one’s body, or kill oneself.' x-ms-client-name: selfHarm profanity: $ref: '#/definitions/ContentFilterDetectionResult' description: Describes whether profanity was detected. custom_blocklists: type: array description: Describes detection results against configured custom blocklists. items: $ref: '#/definitions/ContentFilterBlocklistIdResult' x-ms-client-name: customBlocklists error: $ref: '#/definitions/Azure.Core.Foundations.Error' description: 'Describes an error returned if the content filtering system is down or otherwise unable to complete the operation in time.' protected_material_text: $ref: '#/definitions/ContentFilterDetectionResult' description: Information about detection of protected text material. x-ms-client-name: protectedMaterialText protected_material_code: $ref: '#/definitions/ContentFilterCitedDetectionResult' description: Information about detection of protected code material. x-ms-client-name: protectedMaterialCode ScaleSettingsUpdate: title: ScaleSettingsUpdate description: The scale settings of a deployment. It defines the modes for scaling and the reserved capacity. required: - scale_type type: object properties: scale_type: $ref: '#/definitions/ScaleType' discriminator: scale_type State_2: title: State description: The state of a job or item. enum: - notRunning - running - succeeded - canceled - failed - deleted type: string readOnly: true x-ms-enum: name: State modelAsString: true values: - value: notRunning description: The operation was created and is not queued to be processed in the future. - value: running description: The operation has started to be processed. - value: succeeded description: The operation has successfully be processed and is ready for consumption. - value: canceled description: The operation has been canceled and is incomplete. - value: failed description: The operation has completed processing with a failure and cannot be further consumed. - value: deleted description: The entity has been deleted but may still be referenced by other entities predating the deletion. ImageGenerationData: type: object description: 'A representation of a single generated image, provided as either base64-encoded data or as a URL from which the image may be retrieved.' properties: url: type: string format: uri description: The URL that provides temporary access to download the generated image. b64_json: type: string description: The complete data for an image, represented as a base64-encoded string. x-ms-client-name: base64Data content_filter_results: $ref: '#/definitions/ImageGenerationContentFilterResults' description: Information about the content filtering results. x-ms-client-name: contentFilterResults revised_prompt: type: string description: 'The final prompt used by the model to generate the image. Only provided with dall-3-models and only when revisions were made to the prompt.' x-ms-client-name: revisedPrompt prompt_filter_results: $ref: '#/definitions/ImageGenerationPromptFilterResults' description: 'Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.' x-ms-client-name: promptFilterResults OnErrorDeployment: properties: type: type: string description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. enum: - LastSuccessful - SpecificDeployment x-ms-enum: name: OnErrorDeploymentType modelAsString: false deploymentName: type: string description: The deployment to be used on error case. description: Deployment on error behavior. DeploymentWhatIf: properties: location: type: string description: The location to store the deployment data. properties: $ref: '#/definitions/DeploymentWhatIfProperties' description: The deployment properties. required: - properties description: Deployment What-if operation parameters. ResourceReference: description: The resource Id model. properties: id: readOnly: true type: string description: The fully qualified resource Id. CompletionsOptions: type: object description: 'The configuration information for a completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.' properties: prompt: type: array description: The prompts to generate completions from. items: type: string max_tokens: type: integer format: int32 description: The maximum number of tokens to generate. x-ms-client-name: maxTokens temperature: type: number format: float description: 'The sampling temperature to use that controls the apparent creativity of generated completions. Higher values will make output more random while lower values will make results more focused and deterministic. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict.' top_p: type: number format: float description: 'An alternative to sampling with temperature called nucleus sampling. This value causes the model to consider the results of tokens with the provided probability mass. As an example, a value of 0.15 will cause only the tokens comprising the top 15% of probability mass to be considered. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict.' x-ms-client-name: topP logit_bias: type: object description: 'A map between GPT token IDs and bias scores that influences the probability of specific tokens appearing in a completions response. Token IDs are computed via external tokenizer tools, while bias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to a full ban or exclusive selection of a token, respectively. The exact behavior of a given bias score varies by model.' additionalProperties: format: int32 type: integer x-ms-client-name: logitBias user: type: string description: 'An identifier for the caller or end user of the operation. This may be used for tracking or rate-limiting purposes.' n: type: integer format: int32 description: 'The number of completions choices that should be generated per provided prompt as part of an overall completions response. Because this setting can generate many completions, it may quickly consume your token quota. Use carefully and ensure reasonable settings for max_tokens and stop.' logprobs: type: integer format: int32 description: 'A value that controls the emission of log probabilities for the provided number of most likely tokens within a completions response.' suffix: type: string description: The suffix that comes after a completion of inserted text echo: type: boolean description: 'A value specifying whether completions responses should include input prompts as prefixes to their generated output.' stop: type: array description: A collection of textual sequences that will end completions generation. items: type: string presence_penalty: type: number format: float description: 'A value that influences the probability of generated tokens appearing based on their existing presence in generated text. Positive values will make tokens less likely to appear when they already exist and increase the model''s likelihood to output new topics.' x-ms-client-name: presencePenalty frequency_penalty: type: number format: float description: 'A value that influences the probability of generated tokens appearing based on their cumulative frequency in generated text. Positive values will make tokens less likely to appear as their frequency increases and decrease the likelihood of the model repeating the same statements verbatim.' x-ms-client-name: frequencyPenalty best_of: type: integer format: int32 description: 'A value that controls how many completions will be internally generated prior to response formulation. When used together with n, best_of controls the number of candidate completions and must be greater than n. Because this setting can generate many completions, it may quickly consume your token quota. Use carefully and ensure reasonable settings for max_tokens and stop.' x-ms-client-name: bestOf stream: type: boolean description: A value indicating whether chat completions should be streamed for this request. model: type: string description: 'The model name to provide as part of this completions request. Not applicable to Azure OpenAI, where deployment information should be included in the Azure resource URI that''s connected to.' required: - prompt CloudError: x-ms-external: true properties: error: $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse description: An error response for a resource management request. ProvisioningState: type: string description: Provisioning state of resource. enum: - Succeeded - Failed - Canceled - Provisioning - Updating - Deleting - Accepted x-ms-enum: name: ProvisioningState modelAsString: true values: - name: Succeeded value: Succeeded description: Resource has been created. - name: Failed value: Failed description: Resource creation failed. - name: Canceled value: Canceled description: Resource creation was canceled. - name: Provisioning value: Provisioning description: The resource is being provisioned - name: Updating value: Updating description: The resource is being updated - name: Deleting value: Deleting description: The resource is being deleted - name: Accepted value: Accepted description: The resource create request has been accepted AzureChatExtensionType: type: string description: " A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat\n completions request that should use Azure OpenAI chat extensions to augment the response behavior.\n The use of this configuration is compatible only with Azure OpenAI." enum: - azure_search - azure_ml_index - azure_cosmos_db - elasticsearch - pinecone x-ms-enum: name: AzureChatExtensionType modelAsString: true values: - name: azureSearch value: azure_search description: Represents the use of Azure AI Search as an Azure OpenAI chat extension. - name: azureMachineLearningIndex value: azure_ml_index description: Represents the use of Azure Machine Learning index as an Azure OpenAI chat extension. - name: azureCosmosDB value: azure_cosmos_db description: Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension. - name: elasticsearch value: elasticsearch description: Represents the use of Elasticsearch® index as an Azure OpenAI chat extension. - name: pinecone value: pinecone description: Represents the use of Pinecone index as an Azure OpenAI chat extension. InnerError: title: InnerError description: "Inner error as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." type: object properties: code: $ref: '#/definitions/InnerErrorCode' innererror: $ref: '#/definitions/InnerError' parameters: AudioTranscriptionOptions.filename: name: filename in: formData description: The optional filename or descriptive identifier to associate with with the audio data. required: false type: string x-ms-parameter-location: method apiVersionQueryParameter: in: query name: api-version description: The requested API version. required: true type: string default: 2022-03-01-preview x-ms-parameter-location: client AudioTranscriptionOptions.model: name: model in: formData description: The model to use for this transcription request. required: false type: string x-ms-parameter-location: method AudioTranslationOptions.model: name: model in: formData description: The model to use for this translation request. required: false type: string x-ms-parameter-location: method ScopeParameter: name: scope in: path required: true type: string description: The resource scope. x-ms-parameter-location: method x-ms-skip-url-encoding: true CustomTopQueryParameter: name: $top in: query description: The number of result items to return. required: false type: integer format: int32 x-ms-parameter-location: method x-ms-client-name: top CustomMaxPageSizeQueryParameter: name: $maxpagesize in: query description: The maximum number of result items per page. required: false type: integer format: int32 x-ms-parameter-location: method x-ms-client-name: maxpagesize DeploymentNameParameter: name: deploymentName in: path required: true type: string pattern: ^[-\w\._\(\)]+$ x-ms-parameter-location: method minLength: 1 maxLength: 64 description: The name of the deployment. GroupIdParameter: name: groupId in: path required: true type: string description: The management group ID. x-ms-parameter-location: method minLength: 1 maxLength: 90 CustomFilterQueryParameter: name: $filter in: query description: Filter the result list using the given expression required: false type: string x-ms-parameter-location: method x-ms-client-name: filter CustomSkipQueryParameter: name: $skip in: query description: The number of result items to skip. required: false type: integer format: int32 x-ms-parameter-location: method x-ms-client-name: skip AudioTranscriptionOptions.responseFormat: name: response_format in: formData description: The requested format of the transcription response data, which will influence the content and detail of the result. required: false type: string enum: - json - verbose_json - text - srt - vtt x-ms-enum: name: AudioTranscriptionFormat modelAsString: true values: - name: json value: json description: Use a response body that is a JSON object containing a single 'text' field for the transcription. - name: verbose_json value: verbose_json description: 'Use a response body that is a JSON object containing transcription text along with timing, segments, and other metadata.' - name: text value: text description: Use a response body that is plain text containing the raw, unannotated transcription. - name: srt value: srt description: Use a response body that is plain text in SubRip (SRT) format that also includes timing information. - name: vtt value: vtt description: Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information. x-ms-parameter-location: method x-ms-client-name: responseFormat AudioTranscriptionOptions.file: name: file in: formData description: "The audio data to transcribe. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm." required: true type: file x-ms-parameter-location: method AudioTranslationOptions.prompt: name: prompt in: formData description: 'An optional hint to guide the model''s style or continue from a prior audio segment. The written language of the prompt should match the primary spoken language of the audio data.' required: false type: string x-ms-parameter-location: method Azure.Core.Foundations.ApiVersionParameter: name: api-version in: query description: The API version to use for this operation. required: true type: string minLength: 1 x-ms-parameter-location: method x-ms-client-name: apiVersion AudioTranscriptionOptions.language: name: language in: formData description: 'The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code such as ''en'' or ''fr''. Providing this known input language is optional but may improve the accuracy and/or latency of transcription.' required: false type: string x-ms-parameter-location: method AudioTranslationOptions.responseFormat: name: response_format in: formData description: The requested format of the translation response data, which will influence the content and detail of the result. required: false type: string enum: - json - verbose_json - text - srt - vtt x-ms-enum: name: AudioTranslationFormat modelAsString: true values: - name: json value: json description: Use a response body that is a JSON object containing a single 'text' field for the translation. - name: verbose_json value: verbose_json description: 'Use a response body that is a JSON object containing translation text along with timing, segments, and other metadata.' - name: text value: text description: Use a response body that is plain text containing the raw, unannotated translation. - name: srt value: srt description: Use a response body that is plain text in SubRip (SRT) format that also includes timing information. - name: vtt value: vtt description: Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information. x-ms-parameter-location: method x-ms-client-name: responseFormat AudioTranslationOptions.file: name: file in: formData description: "The audio data to translate. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm." required: true type: file x-ms-parameter-location: method AudioTranslationOptions.temperature: name: temperature in: formData description: 'The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.' required: false type: number format: float x-ms-parameter-location: method ApiVersionParameter: name: api-version in: query required: true type: string description: The API version to use for this operation. apiVersionQueryParameter_3: in: query name: api-version description: The requested API version. required: true type: string x-ms-client-default: '2022-12-01' x-ms-parameter-location: client AudioTranscriptionOptions.temperature: name: temperature in: formData description: 'The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.' required: false type: number format: float x-ms-parameter-location: method SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: The Microsoft Azure subscription ID. AudioTranscriptionOptions.prompt: name: prompt in: formData description: 'An optional hint to guide the model''s style or continue from a prior audio segment. The written language of the prompt should match the primary spoken language of the audio data.' required: false type: string x-ms-parameter-location: method AudioTranslationOptions.filename: name: filename in: formData description: The optional filename or descriptive identifier to associate with with the audio data. required: false type: string x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'