Image Retrieval - Vectorize Image

  • Reference
Service:
Azure AI Services
API Version:
2023-04-01-preview

Return vector from an image.

POST /retrieval:vectorizeImage?api-version=2023-04-01-preview
With optional parameters: 
POST /retrieval:vectorizeImage?model-version={model-version}&api-version=2023-04-01-preview

URI Parameters

Name In Required Type Description
api-version
 query True

string

Requested API version.
model-version
 query

string

Model version.

Request Body

Name Required Type Description
url True

string

Publicly reachable URL of an image.

Responses

Name Type Description
200 OK

SingleVectorResultApiModel

Success
Other Status Codes

ErrorResponse

Error

Headers

x-ms-error-code: string

Examples

ImageRetrieval_VectorizeImage

Sample request

POST /retrieval:vectorizeImage?model-version=2023-04-01-preview&api-version=2023-04-01-preview

{
  "url": "https://example.com/image.jpg"
}

Sample response

Status code:
200 
{
  "vector": [
    0,
    1.1,
    2.2
  ],
  "modelVersion": "2023-04-01-preview"
}

Definitions

Name Description
ErrorResponse

Response returned when an error occurs.
ErrorResponseDetails

Error info.
ErrorResponseInnerError

Detailed error.
ImageUrl

A JSON document with a URL pointing to the image that is to be analyzed.
SingleVectorResultApiModel

Results of image vectorization.

ErrorResponse

Response returned when an error occurs.

Name Type Description
error

ErrorResponseDetails

Error info.

ErrorResponseDetails

Error info.

Name Type Description
code

string

Error code.
details

ErrorResponseDetails[]

List of detailed errors.
innererror

ErrorResponseInnerError

Detailed error.
message

string

Error message.
target

string

Target of the error.

ErrorResponseInnerError

Detailed error.

Name Type Description
code

string

Error code.
innererror

ErrorResponseInnerError

Detailed error.
message

string

Error message.

ImageUrl

A JSON document with a URL pointing to the image that is to be analyzed.

Name Type Description
url

string

Publicly reachable URL of an image.

SingleVectorResultApiModel

Results of image vectorization.

Name Type Description
modelVersion

string

Model version.
vector

number[]

Vector of the image.