[Azure OpenAI Service] Adding images.json to 2023-04-15-preview #23104
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,348 @@ | ||
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "title": "Cognitive Services API", | ||
| "description": "Cognitive Services API to support OpenAI Dall-E", | ||
| "version": "2023-04-01-preview" | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| }, | ||
| "host": "eastus.api.cognitive.microsoft.com", | ||
| "basePath": "/dalle", | ||
| "schemes": ["https"], | ||
| "securityDefinitions": { | ||
| "Api-Key": { | ||
| "type": "apiKey", | ||
| "name": "Api-Key", | ||
| "in": "header", | ||
| "description": "Provide your Cognitive Services Azure OpenAI account key here." | ||
| } | ||
| }, | ||
| "security": [ | ||
| { | ||
| "Api-Key": [] | ||
| } | ||
| ], | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "parameters": { | ||
| "apiVersionQueryParameter": { | ||
| "in": "query", | ||
| "name": "api-version", | ||
| "description": "The requested API version.", | ||
| "required": true, | ||
| "type": "string" | ||
| } | ||
| }, | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "definitions": { | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "Status": { | ||
| "description": "The status of the operation.", | ||
| "type": "string", | ||
| "enum": [ | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "NotStarted", | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "Running", | ||
| "Failed", | ||
| "Canceled", | ||
| "Succeeded" | ||
| ] | ||
| }, | ||
| "InnerError": { | ||
| "type": "object", | ||
| "description": "The inner error if a task in a batch failed.", | ||
| "properties": { | ||
| "message": { | ||
| "type": "string", | ||
| "description": "The error message.", | ||
| "example": "Operation failed as a result of our safety system." | ||
| }, | ||
| "code": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "ContentFilter", | ||
|
||
| "Internal", | ||
| "BlockedImages" | ||
| ], | ||
| "description": "The error code." | ||
| } | ||
| } | ||
| }, | ||
| "Error": { | ||
| "type": "object", | ||
| "description": "The error if the request or operation failed.", | ||
| "properties": { | ||
| "message": { | ||
| "type": "string", | ||
| "description": "The error message.", | ||
| "example": "Required query parameter 'api-version' is missing." | ||
| }, | ||
| "code": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "BadRequest", | ||
|
||
| "ContentFilter", | ||
| "Internal", | ||
| "TooManyRequests", | ||
| "Unauthorized", | ||
| "NotFound", | ||
| "OperationNotInTerminalState", | ||
| "BlockedImages", | ||
| "RequestTimout" | ||
| ], | ||
| "description": "The error code." | ||
| }, | ||
| "details": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/InnerError" | ||
| } | ||
| } | ||
| }, | ||
| "required": [ | ||
| "message", | ||
| "code" | ||
| ] | ||
| }, | ||
| "ErrorResponse": { | ||
| "type": "object", | ||
| "properties": { | ||
| "error": { | ||
| "$ref": "#/definitions/Error" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "error" | ||
| ] | ||
| }, | ||
| "ImageResult": { | ||
| "type": "object", | ||
| "description": "The image url if successful, and an error otherwise.", | ||
| "properties": { | ||
| "url": { | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "type": "string", | ||
| "description": "The image url.", | ||
|
||
| "example": "https://www.contoso.com" | ||
| }, | ||
| "error": { | ||
| "$ref": "#/definitions/Error" | ||
| } | ||
| } | ||
| }, | ||
| "OperationResult": { | ||
| "type": "array", | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "The result data of the operation, if successful", | ||
| "items": { | ||
| "$ref": "#/definitions/ImageResult" | ||
| } | ||
| }, | ||
| "OperationResponse": { | ||
| "type": "object", | ||
| "properties": { | ||
| "id": { | ||
| "type": "string", | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "The ID of the operation.", | ||
| "example": "59c7e2ea-7450-4e85-9762-55c78727f4c7" | ||
| }, | ||
| "created": { | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "type": "integer", | ||
| "format": "int64", | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "The unix timestamp when the operation was created.", | ||
| "example": "1676540381" | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| }, | ||
| "last_action": { | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "type": "integer", | ||
| "format": "int64", | ||
| "description": "The unix timestamp for when the current state was entered.", | ||
| "example": "1676540381" | ||
| }, | ||
| "expires_at": { | ||
| "type": "integer", | ||
| "format": "int64", | ||
| "description": "The unix timestamp when the operation expires.", | ||
| "example": "1676540381" | ||
| }, | ||
| "data": { | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "$ref": "#/definitions/OperationResult" | ||
| }, | ||
| "status": { | ||
| "$ref": "#/definitions/Status" | ||
| }, | ||
| "error": { | ||
| "$ref": "#/definitions/Error" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "id", | ||
| "status", | ||
| "created", | ||
| "last_action" | ||
| ] | ||
| }, | ||
| "ImageResolution": { | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "The resolution of the image (256x256, 512x512, or 1024x1024). Smaller images are faster to generate.", | ||
| "type": "string", | ||
| "enum": [ | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "256x256", | ||
| "512x512", | ||
| "1024x1024" | ||
| ], | ||
| "default": "1024x1024" | ||
| }, | ||
| "GenerateImagesPostRequest": { | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "type": "object", | ||
|
||
| "properties": { | ||
| "prompt": { | ||
| "type": "string", | ||
| "description": "The prompt to generate an image from.", | ||
| "minLength": 1, | ||
| "maxLength": 1000 | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| }, | ||
| "n": { | ||
| "type": "integer", | ||
| "description": "The number of images to generate.", | ||
| "minimum": 1, | ||
| "default": 1 | ||
| }, | ||
| "size": { | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "$ref": "#/definitions/ImageResolution" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "prompt" | ||
| ] | ||
| }, | ||
| "GenerateImagesPostResponse": { | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "type": "object", | ||
| "properties": { | ||
| "status": { | ||
| "$ref": "#/definitions/Status" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "id" | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ] | ||
| } | ||
| }, | ||
| "paths": { | ||
| "/images/generate": { | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "post": { | ||
| "summary": "Generates a batch of images from a text caption", | ||
| "operationId": "Images_Generate", | ||
| "consumes": [ | ||
| "application/json" | ||
| ], | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/parameters/apiVersionQueryParameter" | ||
| }, | ||
| { | ||
| "in": "body", | ||
| "name": "body", | ||
| "required": true, | ||
| "schema": { | ||
| "$ref": "#/definitions/GenerateImagesPostRequest" | ||
| } | ||
| } | ||
| ], | ||
| "responses": { | ||
| "202": { | ||
| "description": "Created", | ||
| "headers": { | ||
| "Operation-Location": { | ||
| "type": "string", | ||
| "description": "URL to poll for the operation result." | ||
| } | ||
| }, | ||
| "schema": { | ||
| "$ref": "#/definitions/GenerateImagesPostResponse" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "An error occurred.", | ||
| "schema": { | ||
| "$ref": "#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/operations/{operationId}": { | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "get": { | ||
| "summary": "Returns the status of the operation", | ||
| "operationId": "Operations_Get", | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/parameters/apiVersionQueryParameter" | ||
| }, | ||
| { | ||
| "in": "path", | ||
| "name": "operationId", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The id of the operation" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "OK", | ||
| "headers": { | ||
| "Operation-Location": { | ||
| "schema": { | ||
| "type": "string" | ||
| }, | ||
| "description": "The location of the operation." | ||
| }, | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "Retry-After": { | ||
| "schema": { | ||
| "type": "integer" | ||
| }, | ||
| "description": "Indicates the number of seconds that the client should wait before trying to get the result from the URL identified by the Operation-Location header if the operation did not terminate yet." | ||
| } | ||
| }, | ||
| "schema": { | ||
| "$ref": "#/definitions/OperationResponse" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "An error occurred.", | ||
| "schema": { | ||
| "$ref": "#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "delete": { | ||
| "summary": "Deletes an operation (if in terminal state)", | ||
| "operationId": "Operations_Delete", | ||
| "parameters": [ | ||
| { | ||
| "in": "query", | ||
| "name": "api-version", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "API version." | ||
| }, | ||
hstellmach-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| { | ||
| "in": "path", | ||
| "name": "operationId", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The id of the operation" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "204": { | ||
| "description": "NoContent" | ||
| }, | ||
| "default": { | ||
| "description": "An error occurred.", | ||
| "schema": { | ||
| "$ref": "#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.