swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Images API
schemes:
- https
tags:
- name: Images
paths:
  /chat/threads/{chatThreadId}/images:
    post:
      tags:
      - Images
      summary: Microsoft Azure Upload An Image In A Thread, On Behalf Of A User
      operationId: microsoftAzureChatthreadUploadchatimage
      consumes:
      - application/octet-stream
      produces:
      - application/json
      parameters:
      - in: header
        name: image-filename
        description: The file name of the image.
        required: false
        type: string
      - in: path
        name: chatThreadId
        description: Thread id where the uploaded image belongs to. (Teams meeting only)
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - in: body
        name: chatImageFile
        description: 'Image binary data, allowed image formats: jpeg, png, gif, heic, webp'
        required: true
        schema:
          $ref: '#/definitions/ChatImageFile'
      responses:
        '201':
          description: Uploaded successfully, the `Location` header contains the URL for the newly uploaded image.
          schema:
            $ref: '#/definitions/UploadChatImageResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Upload Image:
          $ref: ./examples/Images_UploadChatImage.json
      description: Needs a more full description created.
  /chat/threads/{chatThreadId}/images/{imageId}/view/{imageViewType}:
    get:
      tags:
      - Images
      summary: Microsoft Azure Get An Image By View Type
      operationId: microsoftAzureChatthreadGetchatimage
      produces:
      - application/json
      - image/gif
      - image/jpeg
      - image/png
      - image/bmp
      - image/tiff
      parameters:
      - in: path
        name: chatThreadId
        description: The thread id to which the message was sent.
        required: true
        type: string
      - in: path
        name: imageId
        description: The image id.
        required: true
        type: string
      - in: path
        name: imageViewType
        description: The view type of image.
        required: true
        enum:
        - original
        - small
        type: string
        x-ms-enum:
          name: ImageViewType
          modelAsString: true
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Image binary data
          schema:
            $ref: '#/definitions/ChatImageFile'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Delete message:
          $ref: ./examples/Images_GetChatImage.json
      description: Needs a more full description created.
  /chat/threads/{chatThreadId}/images/{imageId}:
    delete:
      tags:
      - Images
      summary: Microsoft Azure Deletes A Image
      operationId: microsoftAzureChatthreadDeletechatimage
      produces:
      - application/json
      parameters:
      - in: path
        name: chatThreadId
        description: The thread id to which the message was sent.
        required: true
        type: string
      - in: path
        name: imageId
        description: The image id.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '204':
          description: Request successful.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Delete message:
          $ref: ./examples/Images_DeleteChatImage.json
      description: Needs a more full description created.
  /images/generations:submit:
    post:
      summary: Microsoft Azure Generates A Batch Of Images From A Text Caption
      operationId: microsoftAzureImagesGenerate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/apiVersionQueryParameter'
      - in: header
        name: Operation-Id
        description: ID of the status monitor for the operation. If the Operation-Id header matches an existing operation and the request is not identical to the prior request, it will fail with a 400 Bad Request.
        type: string
        format: uuid
      - in: body
        name: body
        description: The specification of the images that should be generated.
        required: true
        schema:
          $ref: '#/definitions/GenerateImagesCreation'
      responses:
        '202':
          description: Accepted
          headers:
            operation-location:
              type: string
              format: url
              description: URL to poll for the operation result.
            x-ms-request-id:
              type: string
              format: uuid
              description: Service generated correlation id identifying the request, in the form of a GUID.
          schema:
            $ref: '#/definitions/GenerateImagesResponse'
        default:
          description: An error occurred.
          headers:
            x-ms-error-code:
              type: string
              description: The error code indicating what went wrong.
            x-ms-request-id:
              type: string
              format: uuid
              description: Service generated correlation id identifying the request, in the form of a GUID.
          schema:
            $ref: '#/definitions/ErrorResponse_2'
      x-ms-long-running-operation: true
      x-ms-examples:
        Creating an image generation operation.:
          $ref: ./examples/post_images_generate.json
      description: Needs a more full description created.
      tags:
      - Images
  /operations/images/{operation-id}:
    get:
      summary: Microsoft Azure Returns The Status Of The Images Operation
      operationId: microsoftAzureOperationsimagesGet
      tags:
      - Images
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/apiVersionQueryParameter_4'
      - in: path
        name: operation-id
        required: true
        type: string
        format: uuid
        description: The id of the operation
      responses:
        '200':
          description: OK
          headers:
            retry-after:
              type: integer
              format: int32
              description: Indicates the number of seconds that the client should wait before executing another GET request if the operation did not terminate yet.
            x-ms-request-id:
              type: string
              format: uuid
              description: Service generated correlation id identifying the request, in the form of a GUID.
          schema:
            $ref: '#/definitions/OperationResponse'
        default:
          description: An error occurred.
          headers:
            x-ms-error-code:
              type: string
              description: The error code indicating what went wrong.
            x-ms-request-id:
              type: string
              format: uuid
              description: Service generated correlation id identifying the request, in the form of a GUID.
          schema:
            $ref: '#/definitions/ErrorResponse_5'
      x-ms-examples:
        Getting the result of a specific operation.:
          $ref: ./examples/get_images_operation.json
      description: Needs a more full description created.
    delete:
      summary: Microsoft Azure Deletes An Operation If In Terminal State And All Generated And User Provided Images Associated With The Operation
      operationId: microsoftAzureOperationsimagesDelete
      tags:
      - Images
      parameters:
      - $ref: '#/parameters/apiVersionQueryParameter_4'
      - in: path
        name: operation-id
        required: true
        type: string
        format: uuid
        description: The id of the operation
      responses:
        '204':
          description: NoContent
          headers:
            x-ms-request-id:
              type: string
              format: uuid
              description: Service generated correlation id identifying the request, in the form of a GUID.
        default:
          description: An error occurred.
          headers:
            x-ms-error-code:
              type: string
              description: The error code indicating what went wrong.
            x-ms-request-id:
              type: string
              format: uuid
              description: Service generated correlation id identifying the request, in the form of a GUID.
          schema:
            $ref: '#/definitions/ErrorResponse_5'
      x-ms-examples:
        Deleting a specific operation.:
          $ref: ./examples/delete_images_operation.json
      description: Needs a more full description created.
  /deployments/{deployment-id}/images/generations:
    post:
      operationId: ImageGenerations_Create
      summary: Microsoft Azure Create Image Generations
      description: Creates an image given a prompt using DALL-E models.
      tags:
      - Images
      parameters:
      - $ref: '#/components/parameters/DeploymentIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateImageRequest'
            examples:
              ImagegenerationsCreateRequestExample:
                summary: Default ImageGenerations_Create request
                x-microcks-default: true
                value:
                  prompt: example_value
                  n: 10
                  size: 256x256
                  quality: standard
                  style: natural
                  response_format: url
                  user: example_value
      responses:
        '200':
          description: Successfully created image generations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageGenerationsResponse'
              examples:
                ImagegenerationsCreate200Example:
                  summary: Default ImageGenerations_Create 200 response
                  x-microcks-default: true
                  value:
                    created: 10
                    data:
                    - url: https://www.example.com
                      b64_json: example_value
                      revised_prompt: example_value
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ImagegenerationsCreatedefaultExample:
                  summary: Default ImageGenerations_Create default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      param: example_value
                      type: example_value
                      inner_error:
                        code: example_value
                        content_filter_result: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/images
  : get:
      operationId: microsoftAzureImagesListbycatalog
      tags:
      - Images
      description: List Image resources by Catalog
      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}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/ImageListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Images_ListByCatalog:
          $ref: ./examples/GetImages.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Images
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/images/{imageName}
  : get:
      operationId: microsoftAzureImagesGet
      tags:
      - Images
      description: Get a Image
      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: imageName
        in: path
        description: Image name. Use an image GUID for GA versions of the API.
        required: true
        type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/Image'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Images_Get:
          $ref: ./examples/GetImage.json
      summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Images Imagename
    put:
      operationId: microsoftAzureImagesCreateorupdate
      tags:
      - Images
      description: Create a Image
      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: imageName
        in: path
        description: Image name. Use an image GUID for GA versions of the API.
        required: true
        type: string
      - name: resource
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/Image'
      responses:
        '200':
          description: Resource 'Image' update operation succeeded
          schema:
            $ref: '#/definitions/Image'
        '201':
          description: Resource 'Image' create operation succeeded
          schema:
            $ref: '#/definitions/Image'
          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:
        Image_CreateOrUpdate:
          $ref: ./examples/PutImage.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 Images Imagename
    delete:
      operationId: microsoftAzureImagesDelete
      tags:
      - Images
      description: Delete a Image
      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: imageName
        in: path
        description: Image name. Use an image GUID for GA versions of the API.
        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:
        Images_Delete:
          $ref: ./examples/DeleteImage.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 Images Imagename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/images/getEntityTypeImageUploadUrl
  : post:
      tags:
      - Images
      operationId: microsoftAzureImagesGetuploadurlforentitytype
      x-ms-examples:
        Images_GetUploadUrlForEntityType:
          $ref: ./examples/ImagesGetUploadUrlForEntityType.json
      description: Gets entity type (profile or interaction) image upload URL.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: hubName
        in: path
        required: true
        type: string
        description: The name of the hub.
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/GetImageUploadUrlInput'
        description: Parameters supplied to the GetUploadUrlForEntityType operation.
      - $ref: '#/parameters/ApiVersionParameter_2'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. Successfully get the image upload URL for entity type.
          schema:
            $ref: '#/definitions/ImageDefinition'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Images Getentitytypeimageuploadurl
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/images/getDataImageUploadUrl
  : post:
      tags:
      - Images
      operationId: microsoftAzureImagesGetuploadurlfordata
      x-ms-examples:
        Images_GetUploadUrlForData:
          $ref: ./examples/ImagesGetUploadUrlForData.json
      description: Gets data image upload URL.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: hubName
        in: path
        required: true
        type: string
        description: The name of the hub.
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/GetImageUploadUrlInput'
        description: Parameters supplied to the GetUploadUrlForData operation.
      - $ref: '#/parameters/ApiVersionParameter_2'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. Successfully get the image upload URL for data.
          schema:
            $ref: '#/definitions/ImageDefinition'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Images Getdataimageuploadurl
components:
  parameters:
    DeploymentIdParameter:
      name: deployment-id
      in: path
      required: true
      description: The deployment ID of the model to use for this request.
      schema:
        type: string
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: The API version to use for this operation.
      schema:
        type: string
        default: '2024-06-01'
  schemas:
    ImageGenerationsResponse:
      type: object
      description: Response from the image generations API.
      properties:
        created:
          type: integer
          description: The Unix timestamp of when the images were created.
          example: 10
        data:
          type: array
          description: The list of generated images.
          items:
            type: object
            properties:
              url:
                type: string
                format: uri
                description: The URL of the generated image.
              b64_json:
                type: string
                description: The base64-encoded JSON of the generated image.
              revised_prompt:
                type: string
                description: The revised prompt that was used to generate the image.
          example: []
      required:
      - created
      - data
    CreateImageRequest:
      type: object
      description: Request body for creating image generations.
      properties:
        prompt:
          type: string
          description: A text description of the desired image(s).
          maxLength: 4000
          example: example_value
        n:
          type: integer
          minimum: 1
          maximum: 10
          default: 1
          description: The number of images to generate.
          example: 10
        size:
          type: string
          enum:
          - 256x256
          - 512x512
          - 1024x1024
          - 1792x1024
          - 1024x1792
          default: 1024x1024
          description: The size of the generated images.
          example: 256x256
        quality:
          type: string
          enum:
          - standard
          - hd
          default: standard
          description: The quality of the image that will be generated.
          example: standard
        style:
          type: string
          enum:
          - natural
          - vivid
          default: vivid
          description: The style of the generated images.
          example: natural
        response_format:
          type: string
          enum:
          - url
          - b64_json
          default: url
          description: The format in which the generated images are returned.
          example: url
        user:
          type: string
          description: A unique identifier representing your end-user.
          example: example_value
      required:
      - prompt
    ErrorResponse:
      type: object
      description: Error response.
      properties:
        error:
          type: object
          description: The error object.
          properties:
            code:
              type: string
              description: The error code.
            message:
              type: string
              description: The error message.
            param:
              type: string
              description: The parameter that caused the error.
            type:
              type: string
              description: The error type.
            inner_error:
              type: object
              description: Inner error details.
              properties:
                code:
                  type: string
                  description: The inner error code.
                content_filter_result:
                  type: object
                  description: Content filter results, if applicable.
          required:
          - code
          - message
          example: example_value
definitions:
  ImageDefinition:
    properties:
      imageExists:
        type: boolean
        description: Whether image exists already.
      contentUrl:
        type: string
        description: Content URL for the image blob.
      relativePath:
        type: string
        description: Relative path of the image.
    description: The image definition.
  ErrorDetail:
    type: object
    description: Error detail information.
    properties:
      code:
        type: string
        description: Error code.
      message:
        type: string
        description: Error message.
    required:
    - code
    - message
  UploadChatImageResult:
    description: Result payload for uploading an image.
    required:
    - id
    type: object
    properties:
      id:
        description: A server-generated image id.
        type: string
        example: 0-eus-d2-fb42e272282ebb6ef76a3aedd1974433
      attachmentType:
        $ref: '#/definitions/ChatAttachmentType'
      name:
        description: The name including file extension type of the attachment.
        type: string
        example: SomeImage.png
  Error_2:
    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
    readOnly: true
    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_2'
      innererror:
        $ref: '#/definitions/InnerError'
  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
  ChatAttachmentType:
    description: The type of attachment.
    enum:
    - image
    - file
    type: string
    x-ms-enum:
      name: ChatAttachmentType
      modelAsString: true
  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
  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: true
      values:
      - value: notRunning
        description: The operation was created and is 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.
  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_2'
  GetImageUploadUrlInput:
    properties:
      entityType:
        type: string
        description: Type of entity. Can be Profile or Interaction.
      entityTypeName:
        type: string
        description: Name of the entity type.
      relativePath:
        type: string
        description: Relative path of the image.
    description: Input type for getting image upload url.
  Size:
    title: Size
    description: The desired size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.
    enum:
    - 256x256
    - 512x512
    - 1024x1024
    type: string
    default: 1024x1024
    x-ms-enum:
      name: Size
      modelAsString: true
      values:
      - value: 256x256
        description: The desired size of the generated image is 256x256 pixels.
        name: Size256x256
      - value: 512x512
        description: The desired size of the generated image is 512x512 pixels.
        name: Size512x512
      - value: 1024x1024
        description: The desired size of the generated image is 1024x1024 pixels.
        name: Size1024x1024
  OperationResponse:
    title: OperationResponse
    description: The operation response containing the id and the status of the operation. If successful, it contains data with the generated images and an error otherwise.
    type: object
    properties:
      id:
        format: uuid
        description: The ID of the operation.
        type: string
      created:
        format: unixtime
        description: A timestamp when this job or item was created (in unix epochs).
        type: integer
      expires:
        format: unixtime
        description: A timestamp when this operation and its associated images expire and will be deleted (in unix epochs).
        type: integer
      result:
        type: object
        description: The result of the operation if the operation succeeded.
        properties:
          created:
            format: unixtime
            description: A timestamp when this job or item was created (in unix epochs).
            type: integer
          data:
            $ref: '#/definitions/ImageResults'
        required:
        - created
        - data
      status:
        $ref: '#/definitions/State'
      error:
        $ref: '#/definitions/Error_5'
    required:
    - id
    - status
    - created
  ImageResult:
    title: ImageResult
    type: object
    description: The image url if successful, and an error otherwise.
    properties:
      url:
        type: string
        format: url
        description: The URL that provides temporary access to download the generated image.
      error:
        $ref: '#/definitions/Error_5'
  ChatImageFile:
    description: The image binary data.
    type: string
    format: binary
    x-ms-media-kind: image
  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
  GenerateImagesResponse:
    title: GenerateImagesResponse
    description: Defines response after creating an operation to generate images. It contains the status and the id of the operation.
    type: object
    properties:
      status:
        $ref: '#/definitions/State'
      id:
        type: string
        format: uuid
        description: ' The Id of the asynchronous operation that can be used to query its status later.'
    required:
    - id
    - status
  Error:
    type: object
    description: Error response information.
    properties:
      code:
        type: string
        description: Error code.
      message:
        type: string
        description: Error message.
      details:
        type: array
        description: An array of error detail objects.
        items:
          $ref: '#/definitions/ErrorDetail'
        x-ms-identifiers:
        - code
    required:
    - code
    - message
  Error_5:
    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
    readOnly: true
    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_5'
      innererror:
        $ref: '#/definitions/InnerError'
  ErrorResponse:
    type: object
    description: Wrapper for error response to follow ARM guidelines.
    properties:
      error:
        description: The error response.
        $ref: '#/definitions/Error'
  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
  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
    - jsonlValidationFailed
    - fileImportFailed
    - tooManyRequests
    - unauthorized
    - contentFilter
    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.
      - value: jsonlValidationFailed
        description: Validation of jsonl data failed.
      - value: fileImportFailed
        description: Import of file failed.
      - value: tooManyRequests
        description: Too many requests. Please retry later.
      - value: unauthorized
        description: The current user/api key is not authorized for the operation.
      - value: contentFilter
        description: Image generation failed as a result of our safety system.
  GenerateImagesCreation:
    title: GenerateImagesCreation
    description: Defines the request to create an operation to generate images.
    type: object
    properties:
      prompt:
        description: A text description of the desired image(s).
        type: string
        minLength: 1
      n:
        description: The number of images to generate.
        type: integer
        format: int32
        minimum: 1
        default: 1
      size:
        $ref: '#/definitions/Size'
      user:
        description: A unique identifier representing your end-user, which can help to monitor and detect abuse.
        type: string
    required:
    - prompt
  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
  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.
  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'
  ErrorResponse_5:
    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_5'
  ImageResults:
    title: ImageResults
    description: The result data of the operation, if successful
    type: array
    items:
      $ref: '#/definitions/ImageResult'
  ImageListResult:
    type: object
    description: The response of a Image list operation.
    properties:
      value:
        type: array
        description: The Image items on this page
        items:
          $ref: '#/definitions/Image'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
        readOnly: true
    required:
    - value
parameters:
  ApiVersionParameter:
    in: query
    name: api-version
    description: Version of API to invoke.
    required: true
    type: string
    x-ms-parameter-location: method
  ApiVersionParameter_2:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  apiVersionQueryParameter_4:
    in: query
    name: api-version
    description: The requested API version.
    required: true
    type: string
    x-ms-client-default: 2023-09-01-preview
    x-ms-parameter-location: client
  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
  apiVersionQueryParameter:
    in: query
    name: api-version
    description: The requested API version.
    required: true
    type: string
    x-ms-client-default: 2023-06-01-preview
    x-ms-parameter-location: client
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  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
  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
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'