swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ImageRetrieval API
schemes:
- https
tags:
- name: ImageRetrieval
paths:
  /retrieval:vectorizeText:
    post:
      tags:
      - ImageRetrieval
      summary: Microsoft Azure Return Vector From A Text
      operationId: microsoftAzureImageretrievalVectorizetext
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: query
        name: model-version
        description: Model version.
        type: string
      - $ref: '#/parameters/ApiVersion'
      - in: body
        name: body
        description: Request of VectorizeText.
        schema:
          $ref: '#/definitions/VectorizeTextRequestApiModel'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SingleVectorResultApiModel'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        ImageRetrieval_VectorizeText:
          $ref: ./examples/ImageRetrieval_VectorizeText.json
      description: Needs a more full description created.
  /retrieval:vectorizeImage:
    post:
      tags:
      - ImageRetrieval
      summary: Microsoft Azure Return Vector From An Image
      operationId: microsoftAzureImageretrievalVectorizeimage
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: query
        name: model-version
        description: Model version.
        type: string
      - $ref: '#/parameters/ApiVersion'
      - in: body
        name: body
        description: A JSON document with a URL pointing to the image that is to be analyzed.
        required: true
        schema:
          $ref: '#/definitions/ImageUrl'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SingleVectorResultApiModel'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
      x-ms-examples:
        ImageRetrieval_VectorizeImage:
          $ref: ./examples/ImageRetrieval_VectorizeImage.json
      description: Needs a more full description created.
definitions:
  ErrorResponse:
    description: Response returned when an error occurs.
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/ErrorResponseDetails'
  SingleVectorResultApiModel:
    description: Results of image vectorization.
    type: object
    properties:
      vector:
        description: Vector of the image.
        type: array
        items:
          format: float
          type: number
      modelVersion:
        description: Model version.
        type: string
  ErrorResponseDetails:
    description: Error info.
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: Error code.
        type: string
      message:
        description: Error message.
        type: string
      target:
        description: Target of the error.
        type: string
      details:
        description: List of detailed errors.
        type: array
        items:
          $ref: '#/definitions/ErrorResponseDetails'
      innererror:
        $ref: '#/definitions/ErrorResponseInnerError'
  ErrorResponseInnerError:
    description: Detailed error.
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: Error code.
        type: string
      message:
        description: Error message.
        type: string
      innererror:
        $ref: '#/definitions/ErrorResponseInnerError'
  VectorizeTextRequestApiModel:
    description: Model for VectorizeText request.
    required:
    - text
    type: object
    properties:
      text:
        description: Text for vectorization.
        minLength: 1
        type: string
  ImageUrl:
    description: A JSON document with a URL pointing to the image that is to be analyzed.
    required:
    - url
    type: object
    properties:
      url:
        description: Publicly reachable URL of an image.
        type: string
parameters:
  ApiVersion:
    in: query
    name: api-version
    description: Requested API version.
    required: true
    type: string
    x-ms-parameter-location: client
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'