ComputerVisionClientOperationsMixin 類別

繼承
builtins.object
ComputerVisionClientOperationsMixin

建構函式

ComputerVisionClientOperationsMixin()

方法

analyze_image

這項作業會根據影像內容擷取一組豐富的視覺功能。 支援兩個輸入法 – (1) 上傳影像或指定影像 URL (2) 。 在您的要求中,有選擇性參數可讓您選擇要傳回的功能。 根據預設,影像類別會在回應中傳回。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

analyze_image_by_domain

此作業會套用特定領域模型來辨識影像中的內容。 您可以使用 /models GET 要求來擷取電腦視覺 API 所支援的網域特定模型清單。 目前,API 提供下列領域特定模型:名人、地標。 支援兩個輸入法 – (1) 上傳影像或指定影像 URL (2) 。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

analyze_image_by_domain_in_stream

此作業會套用特定領域模型來辨識影像中的內容。 您可以使用 /models GET 要求來擷取電腦視覺 API 所支援的網域特定模型清單。 目前,API 提供下列領域特定模型:名人、地標。 支援兩個輸入法 – (1) 上傳影像或指定影像 URL (2) 。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

analyze_image_in_stream

這項作業會根據影像內容擷取一組豐富的視覺功能。 支援兩個輸入法 – (1) 上傳影像或指定影像 URL (2) 。 在您的要求中,有選擇性參數可讓您選擇要傳回的功能。 根據預設,影像類別會在回應中傳回。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

describe_image

此作業會產生具有完整句子的人類可讀語言影像的描述。 描述是以作業所傳回的內容標記集合為基礎。 您可以為每個影像產生一個以上的描述。 描述會依信賴分數排序。 如果適用,描述可能包含名人和地標領域模型的結果。 支援兩個輸入法 – (1) 上傳影像或指定影像 URL (2) 。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

describe_image_in_stream

此作業會產生具有完整句子的人類可讀語言影像的描述。 描述是以作業所傳回的內容標記集合為基礎。 您可以為每個影像產生一個以上的描述。 描述會依信賴分數排序。 如果適用,描述可能包含名人和地標領域模型的結果。 支援兩個輸入法 – (1) 上傳影像或指定影像 URL (2) 。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

detect_objects

在指定的影像上執行物件偵測。 支援兩個輸入法 – (1) 上傳影像或指定影像 URL (2) 。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

detect_objects_in_stream

在指定的影像上執行物件偵測。 支援兩個輸入法 – (1) 上傳影像或指定影像 URL (2) 。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

generate_thumbnail

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

generate_thumbnail_in_stream

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

get_area_of_interest

此作業會傳回影像最重要區域的周框方塊。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助判斷發生錯誤的原因。 失敗時,會傳回錯誤碼和錯誤訊息。 錯誤碼可以是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、FailedToProcess、Timeout 或 InternalServerError 的其中一個。

get_area_of_interest_in_stream

此作業會傳回影像最重要區域的周框方塊。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助判斷發生錯誤的原因。 失敗時,會傳回錯誤碼和錯誤訊息。 錯誤碼可以是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、FailedToProcess、Timeout 或 InternalServerError 的其中一個。

get_read_result

此介面用於取得讀取作業的 OCR 結果。 此介面的 URL 應該從讀取介面傳回的 [Operation-Location] 欄位擷取。

list_models

此作業會傳回電腦視覺 API 所支援之領域特定模型的清單。 目前,API 支援下列領域特定模型:名人辨識器、地標辨識器。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

read

使用此介面來取得讀取作業的結果,採用針對大量文字檔優化的光學字元辨識 (OCR) 演算法。 當您使用讀取介面時,回應會包含名為 'Operation-Location' 的欄位。 [作業位置] 欄位包含您必須用於 'GetReadResult' 作業才能存取 OCR 結果的 URL。.

read_in_stream

使用此介面來取得讀取作業的結果,採用針對大量文字檔優化的光學字元辨識 (OCR) 演算法。 當您使用讀取介面時,回應會包含名為 'Operation-Location' 的欄位。 [作業位置] 欄位包含您必須用於 'GetReadResult' 作業才能存取 OCR 結果的 URL。.

recognize_printed_text

光學字元辨識 (OCR) 偵測影像中的文字,並將辨識的字元擷取到機器可用的字元資料流。 成功時,將會傳回 OCR 結果。 失敗時,將會傳回錯誤碼與錯誤訊息。 錯誤碼可以是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、NotSupportedLanguage 或 InternalServerError 的其中一個。

recognize_printed_text_in_stream

光學字元辨識 (OCR) 偵測影像中的文字,並將辨識的字元擷取到機器可用的字元資料流。 成功時,將會傳回 OCR 結果。 失敗時,將會傳回錯誤碼與錯誤訊息。 錯誤碼可以是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、NotSupportedLanguage 或 InternalServerError 的其中一個。

tag_image

此作業會產生與所提供影像內容相關的單字或標記清單。 電腦視覺 API 可以根據影像中找到的物件、生活、生活或動作來傳回標記。 不同于類別,標籤不會根據階層式分類系統進行組織,而是對應至影像內容。 標記可能包含可避免不明確或提供內容的提示,例如 "ascomycete" 標記可能伴隨提示 "fungus"。 支援兩個輸入方法 – (1) 上傳影像或指定影像 URL (2) 。 成功回應會在 JSON 中傳回。 如果要求失敗,回應將包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

tag_image_in_stream

此作業會產生與所提供影像內容相關的單字或標籤清單。 電腦視覺 API 可以根據影像中找到的物件、生物、生物或動作來傳回標記。 不同于類別,標籤不會根據階層式分類系統來組織,但會對應至影像內容。 標記可能包含可避免不明確或提供內容的提示,例如 "ascomycete" 標記可能伴隨提示 "fungus"。 支援兩個輸入法 – (1) 上傳影像或指定影像 URL (2) 。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

analyze_image

這項作業會根據影像內容擷取一組豐富的視覺功能。 支援兩個輸入法 – (1) 上傳影像或指定影像 URL (2) 。 在您的要求中,有選擇性參數可讓您選擇要傳回的功能。 根據預設,影像類別會在回應中傳回。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

analyze_image(url, visual_features=None, details=None, language='en', description_exclude=None, model_version='latest', custom_headers=None, raw=False, **operation_config)

參數

url
str
必要

影像的可公開連線 URL。

visual_features
list[strVisualFeatureTypes]
預設值: None

字串,表示要傳回哪些視覺功能類型。 多個值應該以逗號分隔。 有效的視覺功能類型包括:類別 - 根據檔中定義的分類法分類影像內容。 標記 - 使用與影像內容相關的詳細單字清單來標記影像。 說明 - 用完整的英文句子說明映像內容。 臉部 - 偵測臉部是否存在。 若有的話,會產生座標、性別和年齡。 ImageType - 偵測映像是美工圖案或線條繪圖。 色彩 - 決定輔色、主要色彩,以及影像是否為黑色 & 白色。 成人 - 偵測影像在本質上是否為暴力, (描述裸體或性行為) , (或是閇描述極端暴力或血) 。 也會偵測出性暗示內容 (也就是挑逗內容)。 物件 - 偵測影像內的各種物件,包括近似位置。 物品引數僅於英文版中提供。 品牌 - 偵測影像內的各種品牌,包括近似位置。 品牌引數僅於英文版中提供。

details
list[strDetails]
預設值: None

字串,表示要傳回哪些網域特定詳細資料。 多個值應該以逗號分隔。 有效的視覺功能類型包括:名人 - 識別影像中偵測到的名人、地標 - 識別影像中值得注意的地標。

language
str
預設值: en

輸出產生所需的語言。 如果未指定此參數,預設值為 「en」。支援的語言:en - 英文、預設值。 es - 西班牙文、ja - 日文、pt - 葡萄牙文、zh - 簡體中文。 可能的值包括:'en'、'es'、'ja'、'pt'、'zh'

description_exclude
list[strDescriptionExclude]
預設值: None

產生描述時關閉指定的領域模型。

model_version
str
預設值: latest

選擇性參數,可指定 AI 模型的版本。 接受的值為:「latest」、「2021-04-01」。 預設為 「latest」。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

operation_config
必要

作業組態覆寫

傳回

ImageAnalysis 或 ClientRawResponse if raw=true

傳回類型

例外狀況

analyze_image_by_domain

此作業會套用特定領域模型來辨識影像中的內容。 您可以使用 /models GET 要求來擷取電腦視覺 API 所支援的網域特定模型清單。 目前,API 提供下列領域特定模型:名人、地標。 支援兩個輸入法 – (1) 上傳影像或指定影像 URL (2) 。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

analyze_image_by_domain(model, url, language='en', model_version='latest', custom_headers=None, raw=False, **operation_config)

參數

model
str
必要

要辨識的網域特定內容。

url
str
必要

影像的可公開連線 URL。

language
str
預設值: en

輸出產生所需的語言。 如果未指定此參數,預設值為 「en」。支援的語言:en - 英文、預設值。 es - 西班牙文、ja - 日文、pt - 葡萄牙文、zh - 簡體中文。 可能的值包括:'en'、'es'、'ja'、'pt'、'zh'

model_version
str
預設值: latest

選擇性參數,可指定 AI 模型的版本。 接受的值為:「latest」、「2021-04-01」。 預設為 「latest」。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,DomainModelResults 或 ClientRawResponse

傳回類型

例外狀況

analyze_image_by_domain_in_stream

此作業會套用特定領域模型來辨識影像中的內容。 您可以使用 /models GET 要求來擷取電腦視覺 API 所支援的網域特定模型清單。 目前,API 提供下列領域特定模型:名人、地標。 支援兩個輸入法 – (1) 上傳影像或指定影像 URL (2) 。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

analyze_image_by_domain_in_stream(model, image, language='en', model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)

參數

model
str
必要

要辨識的網域特定內容。

image
Generator
必要

影像資料流程。

language
str
預設值: en

輸出產生所需的語言。 如果未指定此參數,預設值為 「en」。支援的語言:en - 英文、預設值。 es - 西班牙文、ja - 日文、pt - 葡萄牙文、zh - 簡體中文。 可能的值包括:'en'、'es'、'ja'、'pt'、'zh'

model_version
str
預設值: latest

選擇性參數,可指定 AI 模型的版本。 接受的值為:「latest」、「2021-04-01」。 預設為 「latest」。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

callback
Callable[<xref:Bytes>, <xref:response=None>]
預設值: None

指定時,將會使用串流處理的每個資料區塊來呼叫 。 回呼應該採用兩個引數:目前資料區塊的位元組和回應物件。 如果資料正在上傳,回應會是 None。

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,DomainModelResults 或 ClientRawResponse

傳回類型

例外狀況

analyze_image_in_stream

這項作業會根據影像內容擷取一組豐富的視覺功能。 支援兩個輸入法 – (1) 上傳影像或指定影像 URL (2) 。 在您的要求中,有選擇性參數可讓您選擇要傳回的功能。 根據預設,影像類別會在回應中傳回。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

analyze_image_in_stream(image, visual_features=None, details=None, language='en', description_exclude=None, model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)

參數

image
Generator
必要

影像資料流程。

visual_features
list[strVisualFeatureTypes]
預設值: None

字串,表示要傳回哪些視覺功能類型。 多個值應該以逗號分隔。 有效的視覺功能類型包括:類別 - 根據檔中定義的分類法分類影像內容。 標記 - 使用與影像內容相關的詳細單字清單來標記影像。 說明 - 用完整的英文句子說明映像內容。 臉部 - 偵測臉部是否存在。 若有的話,會產生座標、性別和年齡。 ImageType - 偵測映像是美工圖案或線條繪圖。 色彩 - 決定輔色、主要色彩,以及影像是否為黑色 & 白色。 成人 - 偵測影像在本質上是否為暴力, (描述裸體或性行為) , (或是閇描述極端暴力或血) 。 也會偵測出性暗示內容 (也就是挑逗內容)。 物件 - 偵測影像內的各種物件,包括近似位置。 物品引數僅於英文版中提供。 品牌 - 偵測影像內的各種品牌,包括近似位置。 品牌引數僅於英文版中提供。

details
list[strDetails]
預設值: None

字串,表示要傳回哪些網域特定詳細資料。 多個值應該以逗號分隔。 有效的視覺功能類型包括:名人 - 識別影像中偵測到的名人、地標 - 識別影像中值得注意的地標。

language
str
預設值: en

輸出產生所需的語言。 如果未指定此參數,預設值為 「en」。支援的語言:en - 英文、預設值。 es - 西班牙文、ja - 日文、pt - 葡萄牙文、zh - 簡體中文。 可能的值包括:'en'、'es'、'ja'、'pt'、'zh'

description_exclude
list[strDescriptionExclude]
預設值: None

產生描述時關閉指定的領域模型。

model_version
str
預設值: latest

選擇性參數,可指定 AI 模型的版本。 接受的值為:「latest」、「2021-04-01」。 預設為 「latest」。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

callback
Callable[<xref:Bytes>, <xref:response=None>]
預設值: None

指定時,將會使用串流處理的每個資料區塊來呼叫 。 回呼應該採用兩個引數:目前資料區塊的位元組和回應物件。 如果資料正在上傳,回應會是 None。

operation_config
必要

作業組態覆寫

傳回

ImageAnalysis 或 ClientRawResponse if raw=true

傳回類型

例外狀況

describe_image

此作業會產生具有完整句子的人類可讀語言影像的描述。 描述是以作業所傳回的內容標記集合為基礎。 您可以為每個影像產生一個以上的描述。 描述會依信賴分數排序。 如果適用,描述可能包含名人和地標領域模型的結果。 支援兩個輸入法 – (1) 上傳影像或指定影像 URL (2) 。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

describe_image(url, max_candidates=1, language='en', description_exclude=None, model_version='latest', custom_headers=None, raw=False, **operation_config)

參數

url
str
必要

影像的可公開連線 URL。

max_candidates
int
預設值: 1

要傳回的候選描述數目上限。 預設值是 1。

language
str
預設值: en

輸出產生所需的語言。 如果未指定此參數,預設值為 「en」。支援的語言:en - 英文、預設值。 es - 西班牙文、ja - 日文、pt - 葡萄牙文、zh - 簡體中文。 可能的值包括:'en'、'es'、'ja'、'pt'、'zh'

description_exclude
list[strDescriptionExclude]
預設值: None

產生描述時關閉指定的領域模型。

model_version
str
預設值: latest

選擇性參數,可指定 AI 模型的版本。 接受的值為:「latest」、「2021-04-01」。 預設為 「latest」。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,ImageDescription 或 ClientRawResponse

傳回類型

例外狀況

describe_image_in_stream

此作業會產生具有完整句子的人類可讀語言影像的描述。 描述是以作業所傳回的內容標記集合為基礎。 您可以為每個影像產生一個以上的描述。 描述會依信賴分數排序。 如果適用,描述可能包含名人和地標領域模型的結果。 支援兩個輸入法 – (1) 上傳影像或指定影像 URL (2) 。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

describe_image_in_stream(image, max_candidates=1, language='en', description_exclude=None, model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)

參數

image
Generator
必要

影像資料流程。

max_candidates
int
預設值: 1

要傳回的候選描述數目上限。 預設值是 1。

language
str
預設值: en

輸出產生所需的語言。 如果未指定此參數,預設值為 「en」。支援的語言:en - 英文、預設值。 es - 西班牙文、ja - 日文、pt - 葡萄牙文、zh - 簡體中文。 可能的值包括:'en'、'es'、'ja'、'pt'、'zh'

description_exclude
list[strDescriptionExclude]
預設值: None

產生描述時關閉指定的領域模型。

model_version
str
預設值: latest

選擇性參數,可指定 AI 模型的版本。 接受的值為:「latest」、「2021-04-01」。 預設為 「latest」。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

callback
Callable[<xref:Bytes>, <xref:response=None>]
預設值: None

指定時,將會使用串流處理的每個資料區塊來呼叫 。 回呼應該採用兩個引數:目前資料區塊的位元組和回應物件。 如果資料正在上傳,回應會是 None。

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,ImageDescription 或 ClientRawResponse

傳回類型

例外狀況

detect_objects

在指定的影像上執行物件偵測。 支援兩個輸入法 – (1) 上傳影像或指定影像 URL (2) 。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

detect_objects(url, model_version='latest', custom_headers=None, raw=False, **operation_config)

參數

url
str
必要

影像的可公開連線 URL。

model_version
str
預設值: latest

選擇性參數,可指定 AI 模型的版本。 接受的值為:「latest」、「2021-04-01」。 預設為 「latest」。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,DetectResult 或 ClientRawResponse

傳回類型

例外狀況

detect_objects_in_stream

在指定的影像上執行物件偵測。 支援兩個輸入法 – (1) 上傳影像或指定影像 URL (2) 。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

detect_objects_in_stream(image, model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)

參數

image
Generator
必要

影像資料流程。

model_version
str
預設值: latest

選擇性參數,可指定 AI 模型的版本。 接受的值為:「latest」、「2021-04-01」。 預設為 「latest」。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

callback
Callable[<xref:Bytes>, <xref:response=None>]
預設值: None

指定時,將會使用串流處理的每個資料區塊來呼叫 。 回呼應該採用兩個引數:目前資料區塊的位元組和回應物件。 如果資料正在上傳,回應會是 None。

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,DetectResult 或 ClientRawResponse

傳回類型

例外狀況

generate_thumbnail

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

generate_thumbnail(width, height, url, smart_cropping=False, model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)

參數

width
int
必要

縮圖的寬度,以圖元為單位。 它必須介於 1 到 1024 之間。 建議的最小值為 50。

height
int
必要

縮圖的高度,以圖元為單位。 它必須介於 1 到 1024 之間。 建議的最小值為 50。

url
str
必要

影像的可公開連線 URL。

smart_cropping
bool
預設值: False

用於啟用智慧裁剪的布林值旗標。

model_version
str
預設值: latest

選擇性參數,可指定 AI 模型的版本。 接受的值為:「latest」、「2021-04-01」。 預設為 「latest」。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

callback
Callable[<xref:Bytes>, <xref:response=None>]
預設值: None

指定時,將會使用串流處理的每個資料區塊來呼叫 。 回呼應該採用兩個引數:目前資料區塊的位元組和回應物件。 如果資料正在上傳,回應會是 None。

operation_config
必要

作業組態覆寫

傳回

object 或 ClientRawResponse if raw=true

傳回類型

例外狀況

generate_thumbnail_in_stream

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

generate_thumbnail_in_stream(width, height, image, smart_cropping=False, model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)

參數

width
int
必要

縮圖的寬度,以圖元為單位。 它必須介於 1 到 1024 之間。 建議的最小值為 50。

height
int
必要

縮圖的高度,以圖元為單位。 它必須介於 1 到 1024 之間。 建議的最小值為 50。

image
Generator
必要

影像資料流程。

smart_cropping
bool
預設值: False

用於啟用智慧裁剪的布林值旗標。

model_version
str
預設值: latest

選擇性參數,可指定 AI 模型的版本。 接受的值為:「latest」、「2021-04-01」。 預設為 「latest」。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

callback
Callable[<xref:Bytes>, <xref:response=None>]
預設值: None

指定時,將會使用串流處理的每個資料區塊來呼叫 。 回呼應該採用兩個引數:目前資料區塊的位元組和回應物件。 如果資料正在上傳,回應會是 None。

operation_config
必要

作業組態覆寫

傳回

object 或 ClientRawResponse if raw=true

傳回類型

例外狀況

get_area_of_interest

此作業會傳回影像最重要區域的周框方塊。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助判斷發生錯誤的原因。 失敗時,會傳回錯誤碼和錯誤訊息。 錯誤碼可以是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、FailedToProcess、Timeout 或 InternalServerError 的其中一個。

get_area_of_interest(url, model_version='latest', custom_headers=None, raw=False, **operation_config)

參數

url
str
必要

影像的可公開連線 URL。

model_version
str
預設值: latest

選擇性參數,可指定 AI 模型的版本。 接受的值為:「latest」、「2021-04-01」。 預設為 「latest」。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,AreaOfInterestResult 或 ClientRawResponse

傳回類型

例外狀況

get_area_of_interest_in_stream

此作業會傳回影像最重要區域的周框方塊。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助判斷發生錯誤的原因。 失敗時,會傳回錯誤碼和錯誤訊息。 錯誤碼可以是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、FailedToProcess、Timeout 或 InternalServerError 的其中一個。

get_area_of_interest_in_stream(image, model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)

參數

image
Generator
必要

影像資料流程。

model_version
str
預設值: latest

選擇性參數,可指定 AI 模型的版本。 接受的值為:「latest」、「2021-04-01」。 預設為 「latest」。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

callback
Callable[<xref:Bytes>, <xref:response=None>]
預設值: None

指定時,將會使用串流處理的每個資料區塊來呼叫 。 回呼應該採用兩個引數:目前資料區塊的位元組和回應物件。 如果資料正在上傳,回應會是 None。

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,AreaOfInterestResult 或 ClientRawResponse

傳回類型

例外狀況

get_read_result

此介面用於取得讀取作業的 OCR 結果。 此介面的 URL 應該從讀取介面傳回的 [Operation-Location] 欄位擷取。

get_read_result(operation_id, custom_headers=None, raw=False, **operation_config)

參數

operation_id
str
必要

在 'Read' 介面的回應中傳回的讀取作業識別碼。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,ReadOperationResult 或 ClientRawResponse

傳回類型

例外狀況

list_models

此作業會傳回電腦視覺 API 所支援之領域特定模型的清單。 目前,API 支援下列領域特定模型:名人辨識器、地標辨識器。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

list_models(custom_headers=None, raw=False, **operation_config)

參數

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,ListModelsResult 或 ClientRawResponse

傳回類型

例外狀況

read

使用此介面來取得讀取作業的結果,採用針對大量文字檔優化的光學字元辨識 (OCR) 演算法。 當您使用讀取介面時,回應會包含名為 'Operation-Location' 的欄位。 [作業位置] 欄位包含您必須用於 'GetReadResult' 作業才能存取 OCR 結果的 URL。.

read(url, language=None, pages=None, model_version='latest', reading_order='basic', custom_headers=None, raw=False, **operation_config)

參數

url
str
必要

影像的可公開連線 URL。

language
strOcrDetectionLanguage
預設值: None

檔中文字的 BCP-47 語言代碼。 Read 支援自動語言識別和多語言檔,因此如果您想要強制以該特定語言處理檔,則只提供語言代碼。 如需支援的語言清單,請參閱 https://aka.ms/ocr-languages 。 可能的值包括:'af'、'ast'、'bi'、 'br'、'ca'、'ceb'、'ch'、'co'、'crh'、'cs'、'csb'、'da'、'de'、'en'、'es'、'et'、'eu'、'fi'、'fil'、'fj'、'fr'、'fur'、'fy'、'ga'、'gd'、'gil'、'gl'、'gl'、 'gv'、'hni'、'hsb'、'ht'、'hu'、'ia'、'id'、'it'、'iu'、'ja'、'jv'、'kaa'、'kac ''、'kea'、''、'kl'、'ko'、'ku'、'kw'、'lb'、'ms'、'wwww'、'nap'、'nl'、'no'、'oc'、'oc'、 'pl'、'pt'、'quc'、'rm'、'sco'、'sl'、'sq'、'sv'、'sw'、'tet'、'tr'、'tt'、'uz'、'vo'、'wae'、'yua'、'za'、'zh-Hans'、'zh-Hant'、'zu'

pages
list[str]
預設值: None

多頁檔的自訂頁碼 (PDF/TIFF) ,輸入您想要取得 OCR 結果的頁面數目。 對於某個範圍的頁面,請使用連字號。 以逗號分隔每個頁面或範圍。

model_version
str
預設值: latest

選擇性參數,指定用於文字擷取的 OCR 模型版本。 接受的值包括:「latest」、「latest-preview」、「2021-04-12」。 預設為 「latest」。

reading_order
str
預設值: basic

選擇性參數,指定在排序擷取文字元素時應該套用的讀取循序演算法。 可以是 'basic' 或 'natural'。 如果未指定,則會預設為 'basic'

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,則為 None 或 ClientRawResponse

傳回類型

None,

例外狀況

read_in_stream

使用此介面來取得讀取作業的結果,採用針對大量文字檔優化的光學字元辨識 (OCR) 演算法。 當您使用讀取介面時,回應會包含名為 'Operation-Location' 的欄位。 [作業位置] 欄位包含您必須用於 'GetReadResult' 作業才能存取 OCR 結果的 URL。.

read_in_stream(image, language=None, pages=None, model_version='latest', reading_order='basic', custom_headers=None, raw=False, callback=None, **operation_config)

參數

image
Generator
必要

影像資料流程。

language
strOcrDetectionLanguage
預設值: None

檔中文字的 BCP-47 語言代碼。 Read 支援自動語言識別和多語言檔,因此如果您想要強制以該特定語言處理檔,則只提供語言代碼。 如需支援的語言清單,請參閱 https://aka.ms/ocr-languages 。 可能的值包括:'af'、'ast'、'bi'、 'br'、'ca'、'ceb'、'ch'、'co'、'crh'、'cs'、'csb'、'da'、'de'、'en'、'es'、'et'、'eu'、'fi'、'fil'、'fj'、'fr'、'fur'、'fy'、'ga'、'gd'、'br'、'gl'、'gl'、 'gv'、'hni'、'hsb'、'ht'、'hu'、'ia'、'id'、'it'、'iu'、'ja'、'jv'、'kaa'、'kac'、'kea'、'wt'、'kl'、'ko'、'ku'、'kw'、'lb'、'ms'、'wwww'、'nap'、'nl'、'no'、'oc'、' 'pl'、'pt'、'quc'、'rm'、'sco'、'sl'、'sq'、'sv'、'sw'、'tet'、'tr'、'tt'、'uz'、'vo'、'wae'、'yua'、'za'、'zh-Hans'、'zh-Hant'、'zu'

pages
list[str]
預設值: None

多頁檔的自訂頁碼 (PDF/TIFF) ,輸入您想要取得 OCR 結果的頁面數目。 對於一系列的頁面,請使用連字號。 以逗號分隔每個頁面或範圍。

model_version
str
預設值: latest

選擇性參數,指定用於文字擷取的 OCR 模型版本。 接受的值包括:「latest」、「latest-preview」、「2021-04-12」。 預設為 「latest」。

reading_order
str
預設值: basic

選擇性參數,指定在排序擷取文字元素時應該套用的讀取循序演算法。 可以是 'basic' 或 'natural'。 如果未指定,則會預設為 'basic'

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

callback
Callable[<xref:Bytes>, <xref:response=None>]
預設值: None

指定時,將會使用資料流程處理的每個資料區塊來呼叫。 回呼應該採用兩個引數:目前資料區塊的位元組和回應物件。 如果資料正在上傳,回應會是 None。

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,則為 None 或 ClientRawResponse

傳回類型

None,

例外狀況

recognize_printed_text

光學字元辨識 (OCR) 偵測影像中的文字,並將辨識的字元擷取到機器可用的字元資料流。 成功時,將會傳回 OCR 結果。 失敗時,將會傳回錯誤碼與錯誤訊息。 錯誤碼可以是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、NotSupportedLanguage 或 InternalServerError 的其中一個。

recognize_printed_text(url, detect_orientation=True, language='unk', model_version='latest', custom_headers=None, raw=False, **operation_config)

參數

detect_orientation
bool
預設值: True

是否偵測影像中的文字方向。 使用 detectOrientation=true 時,OCR 服務會嘗試偵測影像方向,並在進一步處理 (之前加以更正,例如,如果影像反轉) 。

url
str
必要

影像的可公開連線 URL。

language
strOcrLanguages
預設值: unk

影像中要偵測到之文字的 BCP-47 語言代碼。 預設值為 'unk'。 可能的值包括:'unk'、'zh-Hans'、'zh-Hant'、 'cs'、'da'、'nl'、'en'、'fi'、'fr'、'de'、'el'、'hu'、'it'、'ja'、'ko'、'nb'、'pl'、'pt'、'ru'、'es'、'sv'、'tr'、'ar'、'ro'、'sr-Cyrl'、'sr-Latn'、'sk'

model_version
str
預設值: latest

選擇性參數,可指定 AI 模型的版本。 接受的值包括:「latest」、「2021-04-01」。 預設為 「latest」。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,OcrResult 或 ClientRawResponse

傳回類型

例外狀況

recognize_printed_text_in_stream

光學字元辨識 (OCR) 偵測影像中的文字,並將辨識的字元擷取到機器可用的字元資料流。 成功時,將會傳回 OCR 結果。 失敗時,將會傳回錯誤碼與錯誤訊息。 錯誤碼可以是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、NotSupportedLanguage 或 InternalServerError 的其中一個。

recognize_printed_text_in_stream(image, detect_orientation=True, language='unk', model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)

參數

detect_orientation
bool
預設值: True

是否偵測影像中的文字方向。 使用 detectOrientation=true 時,OCR 服務會嘗試偵測影像方向,並在進一步處理 (之前加以更正,例如,如果影像反轉) 。

image
Generator
必要

影像資料流程。

language
strOcrLanguages
預設值: unk

影像中要偵測到之文字的 BCP-47 語言代碼。 預設值為 'unk'。 可能的值包括:'unk'、'zh-Hans'、'zh-Hant'、 'cs'、'da'、'nl'、'en'、'fi'、'fr'、'de'、'el'、'hu'、'it'、'ja'、'ko'、'nb'、'pl'、'pt'、'ru'、'es'、'sv'、'tr'、'ar'、'ro'、'sr-Cyrl'、'sr-Latn'、'sk'

model_version
str
預設值: latest

選擇性參數,可指定 AI 模型的版本。 接受的值包括:「latest」、「2021-04-01」。 預設為 「latest」。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

callback
Callable[<xref:Bytes>, <xref:response=None>]
預設值: None

指定時,將會使用資料流程處理的每個資料區塊來呼叫。 回呼應該採用兩個引數:目前資料區塊的位元組和回應物件。 如果資料正在上傳,回應會是 None。

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,OcrResult 或 ClientRawResponse

傳回類型

例外狀況

tag_image

此作業會產生與所提供影像內容相關的單字或標記清單。 電腦視覺 API 可以根據影像中找到的物件、生活、生活或動作來傳回標記。 不同于類別,標籤不會根據階層式分類系統進行組織,而是對應至影像內容。 標記可能包含可避免不明確或提供內容的提示,例如 "ascomycete" 標記可能伴隨提示 "fungus"。 支援兩個輸入方法 – (1) 上傳影像或指定影像 URL (2) 。 成功回應會在 JSON 中傳回。 如果要求失敗,回應將包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

tag_image(url, language='en', model_version='latest', custom_headers=None, raw=False, **operation_config)

參數

url
str
必要

影像的可公開連線 URL。

language
str
預設值: en

輸出產生所需的語言。 如果未指定此參數,預設值為 「en」。支援的語言:en - 英文、預設值。 es - 西班牙文、ja - 日文、pt - 葡萄牙文、zh - 簡體中文。 可能的值包括:'en'、'es'、'ja'、'pt'、'zh'

model_version
str
預設值: latest

選擇性參數,可指定 AI 模型的版本。 接受的值包括:「latest」、「2021-04-01」。 預設為 「latest」。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,TagResult 或 ClientRawResponse

傳回類型

例外狀況

tag_image_in_stream

此作業會產生與所提供影像內容相關的單字或標籤清單。 電腦視覺 API 可以根據影像中找到的物件、生物、生物或動作來傳回標記。 不同于類別,標籤不會根據階層式分類系統來組織,但會對應至影像內容。 標記可能包含可避免不明確或提供內容的提示,例如 "ascomycete" 標記可能伴隨提示 "fungus"。 支援兩個輸入法 – (1) 上傳影像或指定影像 URL (2) 。 成功的回應將會以 JSON 傳回。 如果要求失敗,回應會包含錯誤碼和訊息,以協助瞭解發生錯誤的原因。

tag_image_in_stream(image, language='en', model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)

參數

image
Generator
必要

影像資料流程。

language
str
預設值: en

輸出產生所需的語言。 如果未指定此參數,預設值為 「en」。支援的語言:en - 英文、預設值。 es - 西班牙文、ja - 日文、pt - 葡萄牙文、zh - 簡體中文。 可能的值包括:'en'、'es'、'ja'、'pt'、'zh'

model_version
str
預設值: latest

選擇性參數,可指定 AI 模型的版本。 接受的值包括:「latest」、「2021-04-01」。 預設為 「latest」。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

callback
Callable[<xref:Bytes>, <xref:response=None>]
預設值: None

指定時,將會使用串流處理的每個資料區塊來呼叫 。 回呼應該採用兩個引數:目前資料區塊的位元組和回應物件。 如果資料正在上傳,回應會是 None。

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,TagResult 或 ClientRawResponse

傳回類型

例外狀況