Generate Thumbnail - Generate Thumbnail

Service:

Cognitive Services - Computer Vision

API Version:

3.2

這項作業會產生具有使用者指定寬度和高度的縮圖影像。 根據預設，此服務會分析影像、識別相關區域 (ROI)，並根據 ROI 產生智慧裁剪的座標。 當您指定與輸入影像不同的外觀比例時，智慧裁剪有助於。 成功的回應會包含縮圖影像二進位檔。 如果要求失敗，回應會包含錯誤碼和訊息，以協助判斷發生錯誤的原因。 失敗時，會傳回錯誤碼和錯誤訊息。 錯誤碼可能是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、InvalidThumbnailSize、NotSupportedImage、FailedToProcess、Timeout 或 InternalServerError 的其中一個。

POST {Endpoint}/vision/v3.2/generateThumbnail?width={width}&height={height}

With optional parameters:

POST {Endpoint}/vision/v3.2/generateThumbnail?width={width}&height={height}&smartCropping={smartCropping}&model-version={model-version}

URI 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string	支援的認知服務端點。
height	query	True	integer int32	縮圖的高度，以像素為單位。 它必須介於 1 到 1024 之間。 建議的最小值為 50。
width	query	True	integer int32	縮圖的寬度，以像素為單位。 它必須介於 1 到 1024 之間。 建議的最小值為 50。
model-version	query		string	選擇性參數，可指定 AI 模型的版本。 接受的值包括：“latest”、“2021-04-01”、“2021-05-01”。 預設為 「latest」。。 Regex pattern: ^(latest|\d{4}-\d{2}-\d{2})(-preview)?$
smartCropping	query		boolean	用於啟用智慧裁剪的布爾值旗標。

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string

要求本文

名稱	必要	類型	Description
url	True	string	影像的可公開連線 URL。

回應

名稱	類型	Description
200 OK	file	二進位格式產生的縮圖。 Media Types: "application/octet-stream"
Other Status Codes	ComputerVisionErrorResponse	錯誤回應。 Media Types: "application/octet-stream"

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

範例

Successful GenerateThumbnail request

Sample Request

HTTP

POST https://westus.api.cognitive.microsoft.com/vision/v3.2/generateThumbnail?width=500&height=500&smartCropping=True


{
  "url": "{url}"
}

Sample Response

Status code:

200

"{Binary}"

定義

名稱	Description
ComputerVisionError	API 要求錯誤。
ComputerVisionErrorCodes	錯誤碼。
ComputerVisionErrorResponse	API 錯誤回應。
ComputerVisionInnerError	API 要求錯誤的詳細數據。
ComputerVisionInnerErrorCodeValue	錯誤碼。
ImageUrl

ComputerVisionError

API 要求錯誤。

名稱	類型	Description
code	ComputerVisionErrorCodes	錯誤碼。
innererror	ComputerVisionInnerError	內部錯誤包含更具體的資訊。
message	string	說明服務所報告錯誤的訊息。

ComputerVisionErrorCodes

錯誤碼。

名稱	類型	Description
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
ServiceUnavailable	string

ComputerVisionErrorResponse

API 錯誤回應。

名稱	類型	Description
error	ComputerVisionError	錯誤內容。

ComputerVisionInnerError

API 要求錯誤的詳細數據。

名稱	類型	Description
code	ComputerVisionInnerErrorCodeValue	錯誤碼。
message	string	錯誤訊息。

ComputerVisionInnerErrorCodeValue

錯誤碼。

名稱	類型	Description
BadArgument	string
CancelledRequest	string
DetectFaceError	string
FailedToProcess	string
InternalServerError	string
InvalidDetails	string
InvalidImageFormat	string
InvalidImageSize	string
InvalidImageUrl	string
InvalidModel	string
InvalidThumbnailSize	string
NotSupportedFeature	string
NotSupportedImage	string
NotSupportedLanguage	string
NotSupportedVisualFeature	string
StorageException	string
Timeout	string
Unspecified	string
UnsupportedMediaType	string

ImageUrl

名稱	類型	Description
url	string	影像的可公開連線 URL。