Vectorize - Image

Service:

Azure AI Services

API Version:

2024-02-01

Return vector from an image.

POST /retrieval:vectorizeImage?model-version={model-version}&api-version=2024-02-01

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	Requested API version.
model-version	query	True	string	Model version. Please refer https://aka.ms/image-retrieval for supported model versions.

Request Body

Name	Required	Type	Description
url	True	string (uri)	Publicly reachable URL of an image.

Responses

Name	Type	Description
200 OK	SingleVectorResult	Success
Other Status Codes	ErrorResponse	Error Headers x-ms-error-code: string

Examples

VectorizeImage_MaximumSet_Gen

VectorizeImage_MinimumSet_Gen

VectorizeImage_MaximumSet_Gen

Sample request

HTTP

POST /retrieval:vectorizeImage?model-version=smwtkmvew&api-version=2024-02-01

{
  "url": "https://microsoft.com/a"
}

Sample response

Status code:

200

{
  "vector": [
    14
  ],
  "modelVersion": "dpcfdmwpqyrzmkrwdauywmdcoduss"
}

VectorizeImage_MinimumSet_Gen

Sample request

HTTP

POST /retrieval:vectorizeImage?model-version=ghajr&api-version=2024-02-01

{
  "url": "https://microsoft.com/a"
}

Sample response

Status code:

200

{}

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 publicly accessible image to be analyzed.
SingleVectorResult	Results of image vectorization.

ErrorResponse

Object

Response returned when an error occurs.

Name	Type	Description
error	ErrorResponseDetails	Error info.

ErrorResponseDetails

Object

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

Object

Detailed error.

Name	Type	Description
code	string	Error code.
innererror	ErrorResponseInnerError	Detailed error.
message	string	Error message.

ImageUrl

Object

A JSON document with a URL pointing to the publicly accessible image to be analyzed.

Name	Type	Description
url	string (uri)	Publicly reachable URL of an image.

SingleVectorResult

Object

Results of image vectorization.

Name	Type	Description
modelVersion	string	Model version.
vector	number[] (float)	Vector of the image.