Share via

Image Retrieval - Vectorize Stream

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

Return vector from an image.

POST /retrieval:vectorizeImage?overload=stream&api-version=2023-04-01-preview
With optional parameters: 
POST /retrieval:vectorizeImage?overload=stream&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

Media Types: "application/octet-stream", "image/jpeg", "image/gif", "image/tiff", "image/bmp", "image/png"

Name Type Description
body

string (byte)

An image stream.

Responses

Name Type Description
200 OK

SingleVectorResultApiModel

Success
Other Status Codes

ErrorResponse

Error

Headers

x-ms-error-code: string

Examples

ImageRetrieval_VectorizeImageFromImageStream

Sample request

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

"Ynl0ZXM="

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.
SingleVectorResultApiModel

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.

SingleVectorResultApiModel

Object

Results of image vectorization.

Name Type Description
modelVersion

string

Model version.
vector

number[] (float)

Vector of the image.