Image Retrieval - Vectorize Text

服務:

Cognitive Services - Computer Vision

API 版本:

2023-04-01-preview

從文字傳回向量。

POST /retrieval:vectorizeText?api-version=2023-04-01-preview

含選擇性參數:

POST /retrieval:vectorizeText?model-version={model-version}&api-version=2023-04-01-preview

URI 參數

名稱	位於	必要	類型	Description
api-version	query	True	string	要求的 API 版本。
model-version	query		string	模型版本。

要求本文

名稱	必要	類型	Description
text	True	string	向量化的文字。

回應

名稱	類型	Description
200 OK	SingleVectorResultApiModel	成功
Other Status Codes	ErrorResponse	[錯誤] 標題 x-ms-error-code: string

範例

ImageRetrieval_VectorizeText

範例要求

HTTP

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

{
  "text": "my text"
}

範例回覆

狀態碼:

200

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

定義

名稱	Description
ErrorResponse	發生錯誤時傳回的回應。
ErrorResponseDetails	錯誤資訊。
ErrorResponseInnerError	詳細的錯誤。
SingleVectorResultApiModel	影像向量化的結果。
VectorizeTextRequestApiModel	VectorizeText 要求的模型。

ErrorResponse

發生錯誤時傳回的回應。

名稱	類型	Description
error	ErrorResponseDetails	錯誤資訊。

ErrorResponseDetails

錯誤資訊。

名稱	類型	Description
code	string	錯誤碼。
details	ErrorResponseDetails[]	詳細錯誤清單。
innererror	ErrorResponseInnerError	詳細的錯誤。
message	string	錯誤訊息。
target	string	錯誤的目標。

ErrorResponseInnerError

詳細的錯誤。

名稱	類型	Description
code	string	錯誤碼。
innererror	ErrorResponseInnerError	詳細的錯誤。
message	string	錯誤訊息。

SingleVectorResultApiModel

影像向量化的結果。

名稱	類型	Description
modelVersion	string	模型版本。
vector	number[]	影像的向量。

VectorizeTextRequestApiModel

VectorizeText 要求的模型。

名稱	類型	Description
text	string	向量化的文字。