ComputerVisionClientOperationsMixin クラス
- 継承
-
builtins.objectComputerVisionClientOperationsMixin
コンストラクター
ComputerVisionClientOperationsMixin()
メソッド
analyze_image |
この操作では、画像の内容に基づいて、さまざまな視覚的特徴のセットを抽出できます。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 要求内には、返す機能を選択できる省略可能なパラメーターがあります。 既定では、画像カテゴリは応答で返されます。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。 |
analyze_image_by_domain |
この操作は、ドメイン固有モデルを適用することで、画像内のコンテンツを認識します。 Computer Vision API によってサポートされるドメイン固有モデルの一覧は、/models GET 要求を使用して取得できます。 現時点で、この API によって提供されるドメイン固有モデルは著名人とランドマークです。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。 |
analyze_image_by_domain_in_stream |
この操作は、ドメイン固有モデルを適用することで、画像内のコンテンツを認識します。 Computer Vision API によってサポートされるドメイン固有モデルの一覧は、/models GET 要求を使用して取得できます。 現時点で、この API によって提供されるドメイン固有モデルは著名人とランドマークです。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。 |
analyze_image_in_stream |
この操作では、画像の内容に基づいて、さまざまな視覚的特徴のセットを抽出できます。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 要求内には、返す機能を選択できる省略可能なパラメーターがあります。 既定では、画像カテゴリは応答で返されます。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。 |
describe_image |
この操作は、完全な文を使用して、人間が判読できる言語でイメージ全体の説明を生成します。 説明はコンテンツ タグのコレクションに基づいていますが、コンテンツ タグもこの操作によって返されます。 各画像に対して複数の説明が生成されることがあります。 説明はその信頼度スコアの順に並んでいます。 説明には、該当する場合は、有名人およびランドマーク ドメイン モデルの結果が含まれる場合があります。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。 |
describe_image_in_stream |
この操作は、完全な文を使用して、人間が判読できる言語でイメージ全体の説明を生成します。 説明はコンテンツ タグのコレクションに基づいていますが、コンテンツ タグもこの操作によって返されます。 各画像に対して複数の説明が生成されることがあります。 説明はその信頼度スコアの順に並んでいます。 説明には、該当する場合は、有名人およびランドマーク ドメイン モデルの結果が含まれる場合があります。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。 |
detect_objects |
指定した画像に対して物体検出を実行します。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。 |
detect_objects_in_stream |
指定した画像に対して物体検出を実行します。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は 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 |
この操作は、Computer Vision API でサポートされているドメイン固有モデルの一覧を返します。 現時点では、この API によってサポートされるドメイン固有モデルは著名人認識機能とランドマーク認識機能です。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。 |
read |
このインターフェイスを使用して読み取り操作の結果を取得し、テキストが多いドキュメント用に最適化された最新の光学式文字認識 (OCR) アルゴリズムを使用します。 Read インターフェイスを使用すると、応答には "Operation-Location" というフィールドが含まれます。 'Operation-Location' フィールドには、OCR 結果にアクセスするために 'GetReadResult' 操作に使用する必要がある URL が含まれています。. |
read_in_stream |
このインターフェイスを使用して読み取り操作の結果を取得し、テキストが多いドキュメント用に最適化された最新の光学式文字認識 (OCR) アルゴリズムを使用します。 Read インターフェイスを使用すると、応答には "Operation-Location" というフィールドが含まれます。 'Operation-Location' フィールドには、OCR 結果にアクセスするために 'GetReadResult' 操作に使用する必要がある 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 |
この操作は、指定された画像のコンテンツに関連する単語すなわちタグのリストを生成します。 Computer Vision API は、画像内で検出された物体、生物、景色、または動作に基づくタグを返すことができます。 カテゴリとは異なり、タグは階層的分類システムで整理されていませんが、画像のコンテンツに対応しています。 タグにあいまいさを回避するためのヒントが含まれたり、タグによってコンテキストが提供されたりすることがあります。たとえば、"ascomycete" (子嚢菌) というタグに "fungus" (菌類) というヒントが付く場合があります。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。 |
tag_image_in_stream |
この操作は、指定された画像のコンテンツに関連する単語すなわちタグのリストを生成します。 Computer Vision API は、画像内で検出された物体、生物、景色、または動作に基づくタグを返すことができます。 カテゴリとは異なり、タグは階層的分類システムで整理されていませんが、画像のコンテンツに対応しています。 タグにあいまいさを回避するためのヒントが含まれたり、タグによってコンテキストが提供されたりすることがあります。たとえば、"ascomycete" (子嚢菌) というタグに "fungus" (菌類) というヒントが付く場合があります。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。 |
analyze_image
この操作では、画像の内容に基づいて、さまざまな視覚的特徴のセットを抽出できます。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 要求内には、返す機能を選択できる省略可能なパラメーターがあります。 既定では、画像カテゴリは応答で返されます。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。
analyze_image(url, visual_features=None, details=None, language='en', description_exclude=None, model_version='latest', custom_headers=None, raw=False, **operation_config)
パラメーター
- visual_features
- list[str または VisualFeatureTypes]
返すビジュアル機能の種類を示す文字列。 複数の値をコンマ区切りにする必要があります。 有効なビジュアル機能の種類は次のとおりです。カテゴリ - ドキュメントで定義されている分類に従って画像コンテンツを分類します。 タグ - 画像のコンテンツに関連する単語の詳細な一覧で画像にタグを付けます。 Description - 英文でのイメージのコンテンツの説明です。 顔 - 顔が存在するかどうかを検出します。 存在する場合は、座標、性別、および年齢を生成します。 ImageType - イメージがクリップアートか線画かを検出します。 [色] - アクセントの色、優先色、およびイメージが白黒&かどうかを決定します。 成人 - 画像が本質的にポルノ(ヌードや性行為を表す)、またはゴーリー(極端な暴力や血液を示す)であるかどうかを検出します。 性的な暗示を含むコンテンツ (わいせつコンテンツ) も検出されます。 オブジェクト - おおよその位置など、画像内のさまざまなオブジェクトを検出します。 Objects 引数は、英語でのみ使用できます。 [ブランド] - おおよその場所など、画像内のさまざまなブランドを検出します。 Brands 引数は、英語でのみ使用できます。
返すドメイン固有の詳細を示す文字列。 複数の値をコンマ区切りにする必要があります。 有効なビジュアル機能の種類には、著名人 - 画像で検出された場合は有名人を識別し、ランドマークはイメージ内の注目すべきランドマークを識別します。
- language
- str
出力生成に必要な言語。 このパラメーターを指定しない場合、既定値は "en" です。サポートされている言語:en - 英語、既定値。 es - スペイン語、ja - 日本語、pt - ポルトガル語、zh - 簡体字中国語。 指定できる値は、'en'、'es'、'ja'、'pt'、'zh' です。
- model_version
- str
AI モデルのバージョンを指定する省略可能なパラメーター。 指定できる値は、"latest"、"2021-04-01" です。 既定値は "latest" です。
- operation_config
操作構成のオーバーライド。
戻り値
imageAnalysis または ClientRawResponse (raw=true の場合)
の戻り値の型 :
例外
analyze_image_by_domain
この操作は、ドメイン固有モデルを適用することで、画像内のコンテンツを認識します。 Computer Vision API によってサポートされるドメイン固有モデルの一覧は、/models GET 要求を使用して取得できます。 現時点で、この API によって提供されるドメイン固有モデルは著名人とランドマークです。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。
analyze_image_by_domain(model, url, language='en', model_version='latest', custom_headers=None, raw=False, **operation_config)
パラメーター
- language
- str
出力生成に必要な言語。 このパラメーターを指定しない場合、既定値は "en" です。サポートされている言語:en - 英語、既定値。 es - スペイン語、ja - 日本語、pt - ポルトガル語、zh - 簡体字中国語。 指定できる値は、'en'、'es'、'ja'、'pt'、'zh' です。
- model_version
- str
AI モデルのバージョンを指定する省略可能なパラメーター。 指定できる値は、"latest"、"2021-04-01" です。 既定値は "latest" です。
- operation_config
操作構成のオーバーライド。
戻り値
domainModelResults または ClientRawResponse (raw=true の場合)
の戻り値の型 :
例外
analyze_image_by_domain_in_stream
この操作は、ドメイン固有モデルを適用することで、画像内のコンテンツを認識します。 Computer Vision API によってサポートされるドメイン固有モデルの一覧は、/models GET 要求を使用して取得できます。 現時点で、この API によって提供されるドメイン固有モデルは著名人とランドマークです。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。
analyze_image_by_domain_in_stream(model, image, language='en', model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)
パラメーター
- language
- str
出力生成に必要な言語。 このパラメーターを指定しない場合、既定値は "en" です。サポートされている言語:en - 英語、既定値。 es - スペイン語、ja - 日本語、pt - ポルトガル語、zh - 簡体字中国語。 指定できる値は、'en'、'es'、'ja'、'pt'、'zh' です。
- model_version
- str
AI モデルのバージョンを指定する省略可能なパラメーター。 指定できる値は、"latest"、"2021-04-01" です。 既定値は "latest" です。
- callback
- Callable[<xref:Bytes>, <xref:response=None>]
を指定すると、ストリーミングされるデータの各チャンクで が呼び出されます。 コールバックは、データの現在のチャンクのバイトと応答オブジェクトの 2 つの引数を受け取る必要があります。 データがアップロードされている場合、応答は None になります。
- operation_config
操作構成のオーバーライド。
戻り値
domainModelResults または ClientRawResponse (raw=true の場合)
の戻り値の型 :
例外
analyze_image_in_stream
この操作では、画像の内容に基づいて、さまざまな視覚的特徴のセットを抽出できます。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 要求内には、返す機能を選択できる省略可能なパラメーターがあります。 既定では、画像カテゴリは応答で返されます。 成功した応答は 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)
パラメーター
- visual_features
- list[str または VisualFeatureTypes]
返すビジュアル機能の種類を示す文字列。 複数の値をコンマ区切りにする必要があります。 有効なビジュアル機能の種類は次のとおりです。カテゴリ - ドキュメントで定義されている分類に従って画像コンテンツを分類します。 タグ - 画像のコンテンツに関連する単語の詳細な一覧で画像にタグを付けます。 Description - 英文でのイメージのコンテンツの説明です。 顔 - 顔が存在するかどうかを検出します。 存在する場合は、座標、性別、および年齢を生成します。 ImageType - イメージがクリップアートか線画かを検出します。 [色] - アクセントの色、優先色、およびイメージが白黒&かどうかを決定します。 成人 - 画像が本質的にポルノ(ヌードや性行為を表す)、またはゴーリー(極端な暴力や血液を示す)であるかどうかを検出します。 性的な暗示を含むコンテンツ (わいせつコンテンツ) も検出されます。 オブジェクト - おおよその位置など、画像内のさまざまなオブジェクトを検出します。 Objects 引数は、英語でのみ使用できます。 [ブランド] - おおよその場所など、画像内のさまざまなブランドを検出します。 Brands 引数は、英語でのみ使用できます。
返すドメイン固有の詳細を示す文字列。 複数の値をコンマ区切りにする必要があります。 有効なビジュアル機能の種類は次のとおりです。 [有名人] - 画像で検出された場合は有名人を識別し、ランドマークは画像内の注目すべきランドマークを識別します。
- language
- str
出力生成に必要な言語。 このパラメーターを指定しない場合、既定値は "en" です。サポートされている言語:en - 英語、既定値。 es - スペイン語、ja - 日本語、pt - ポルトガル語、zh - 簡体字中国語。 使用できる値は、'en'、'es'、'ja'、'pt'、'zh' です。
- model_version
- str
AI モデルのバージョンを指定する省略可能なパラメーター。 使用できる値は、"latest"、"2021-04-01" です。 既定値は "latest" です。
- callback
- Callable[<xref:Bytes>, <xref:response=None>]
を指定すると、ストリーミングされるデータの各チャンクで が呼び出されます。 コールバックは、現在のデータ チャンクと応答オブジェクトのバイトである 2 つの引数を受け取る必要があります。 データがアップロードされている場合、応答は None になります。
- operation_config
操作の構成がオーバーライドされます。
戻り値
ImageAnalysis または ClientRawResponse (raw=true の場合)
の戻り値の型 :
例外
describe_image
この操作は、完全な文を使用して、人間が判読できる言語でイメージ全体の説明を生成します。 説明はコンテンツ タグのコレクションに基づいていますが、コンテンツ タグもこの操作によって返されます。 各画像に対して複数の説明が生成されることがあります。 説明はその信頼度スコアの順に並んでいます。 説明には、該当する場合は、有名人およびランドマーク ドメイン モデルの結果が含まれる場合があります。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。
describe_image(url, max_candidates=1, language='en', description_exclude=None, model_version='latest', custom_headers=None, raw=False, **operation_config)
パラメーター
- language
- str
出力生成に必要な言語。 このパラメーターを指定しない場合、既定値は "en" です。サポートされている言語:en - 英語、既定値。 es - スペイン語、ja - 日本語、pt - ポルトガル語、zh - 簡体字中国語。 使用できる値は、'en'、'es'、'ja'、'pt'、'zh' です。
- model_version
- str
AI モデルのバージョンを指定する省略可能なパラメーター。 使用できる値は、"latest"、"2021-04-01" です。 既定値は "latest" です。
- operation_config
操作の構成がオーバーライドされます。
戻り値
imageDescription または ClientRawResponse (raw=true の場合)
の戻り値の型 :
例外
describe_image_in_stream
この操作は、完全な文を使用して、人間が判読できる言語でイメージ全体の説明を生成します。 説明はコンテンツ タグのコレクションに基づいていますが、コンテンツ タグもこの操作によって返されます。 各画像に対して複数の説明が生成されることがあります。 説明はその信頼度スコアの順に並んでいます。 説明には、該当する場合は、有名人およびランドマーク ドメイン モデルの結果が含まれる場合があります。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は 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)
パラメーター
- language
- str
出力生成に必要な言語。 このパラメーターを指定しない場合、既定値は "en" です。サポートされている言語:en - 英語、既定値。 es - スペイン語、ja - 日本語、pt - ポルトガル語、zh - 簡体字中国語。 使用できる値は、'en'、'es'、'ja'、'pt'、'zh' です。
- model_version
- str
AI モデルのバージョンを指定する省略可能なパラメーター。 使用できる値は、"latest"、"2021-04-01" です。 既定値は "latest" です。
- callback
- Callable[<xref:Bytes>, <xref:response=None>]
を指定すると、ストリーミングされるデータの各チャンクで が呼び出されます。 コールバックは、現在のデータ チャンクと応答オブジェクトのバイトである 2 つの引数を受け取る必要があります。 データがアップロードされている場合、応答は None になります。
- operation_config
操作の構成がオーバーライドされます。
戻り値
imageDescription または ClientRawResponse (raw=true の場合)
の戻り値の型 :
例外
detect_objects
指定した画像に対して物体検出を実行します。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。
detect_objects(url, model_version='latest', custom_headers=None, raw=False, **operation_config)
パラメーター
- model_version
- str
AI モデルのバージョンを指定する省略可能なパラメーター。 使用できる値は、"latest"、"2021-04-01" です。 既定値は "latest" です。
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は DetectResult または ClientRawResponse
の戻り値の型 :
例外
detect_objects_in_stream
指定した画像に対して物体検出を実行します。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。
detect_objects_in_stream(image, model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)
パラメーター
- model_version
- str
AI モデルのバージョンを指定する省略可能なパラメーター。 使用できる値は、"latest"、"2021-04-01" です。 既定値は "latest" です。
- callback
- Callable[<xref:Bytes>, <xref:response=None>]
を指定すると、ストリーミングされるデータの各チャンクで が呼び出されます。 コールバックは、現在のデータ チャンクと応答オブジェクトのバイトである 2 つの引数を受け取る必要があります。 データがアップロードされている場合、応答は 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)
パラメーター
- model_version
- str
AI モデルのバージョンを指定する省略可能なパラメーター。 指定できる値は、"latest"、"2021-04-01" です。 既定値は "latest" です。
- callback
- Callable[<xref:Bytes>, <xref:response=None>]
を指定すると、ストリーミングされるデータの各チャンクで が呼び出されます。 コールバックは、データの現在のチャンクのバイトと応答オブジェクトの 2 つの引数を受け取る必要があります。 データがアップロードされている場合、応答は None になります。
- operation_config
操作構成のオーバーライド。
戻り値
object または ClientRawResponse (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)
パラメーター
- model_version
- str
AI モデルのバージョンを指定する省略可能なパラメーター。 指定できる値は、"latest"、"2021-04-01" です。 既定値は "latest" です。
- callback
- Callable[<xref:Bytes>, <xref:response=None>]
を指定すると、ストリーミングされるデータの各チャンクで が呼び出されます。 コールバックは、データの現在のチャンクのバイトと応答オブジェクトの 2 つの引数を受け取る必要があります。 データがアップロードされている場合、応答は None になります。
- operation_config
操作構成のオーバーライド。
戻り値
object または ClientRawResponse (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)
パラメーター
- model_version
- str
AI モデルのバージョンを指定する省略可能なパラメーター。 指定できる値は、"latest"、"2021-04-01" です。 既定値は "latest" です。
- operation_config
操作構成のオーバーライド。
戻り値
AreaOfInterestResult または ClientRawResponse (raw=true の場合)
の戻り値の型 :
例外
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)
パラメーター
- model_version
- str
AI モデルのバージョンを指定する省略可能なパラメーター。 指定できる値は、"latest"、"2021-04-01" です。 既定値は "latest" です。
- callback
- Callable[<xref:Bytes>, <xref:response=None>]
を指定すると、ストリーミングされるデータの各チャンクで が呼び出されます。 コールバックは、データの現在のチャンクのバイトと応答オブジェクトの 2 つの引数を受け取る必要があります。 データがアップロードされている場合、応答は None になります。
- operation_config
操作構成のオーバーライド。
戻り値
AreaOfInterestResult または ClientRawResponse (raw=true の場合)
の戻り値の型 :
例外
get_read_result
このインターフェイスは、読み取り操作の OCR 結果を取得するために使用されます。 このインターフェイスの URL は、読み取りインターフェイスから返される 'Operation-Location' フィールドから取得する必要があります。
get_read_result(operation_id, custom_headers=None, raw=False, **operation_config)
パラメーター
- operation_config
操作構成のオーバーライド。
戻り値
readOperationResult または ClientRawResponse (raw=true の場合)
の戻り値の型 :
例外
list_models
この操作は、Computer Vision API でサポートされているドメイン固有モデルの一覧を返します。 現時点では、この API によってサポートされるドメイン固有モデルは著名人認識機能とランドマーク認識機能です。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。
list_models(custom_headers=None, raw=False, **operation_config)
パラメーター
- operation_config
操作構成のオーバーライド。
戻り値
raw=true の場合は ListModelsResult または ClientRawResponse
の戻り値の型 :
例外
read
このインターフェイスを使用して読み取り操作の結果を取得し、テキストが多いドキュメント用に最適化された最新の光学式文字認識 (OCR) アルゴリズムを使用します。 Read インターフェイスを使用すると、応答には "Operation-Location" というフィールドが含まれます。 'Operation-Location' フィールドには、OCR 結果にアクセスするために 'GetReadResult' 操作に使用する必要がある URL が含まれています。.
read(url, language=None, pages=None, model_version='latest', reading_order='basic', custom_headers=None, raw=False, **operation_config)
パラメーター
- language
- str または OcrDetectionLanguage
ドキュメント内のテキストの 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'、'ga'、'gd'、'gil'、'gl'、'gl'、 'gv'、'hni'、'hsb'、'ht'、'hu'、'ia'、'id'、'it'、'iu'、'ja'、'jvm'、'kaa'、'kac'、'kea'、'kha'、'kl'、'ko'、'ku'、'kw'、'lb'、'ms'、'mww'、'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'
複数ページのドキュメントのカスタム ページ番号 (PDF/TIFF) は、OCR 結果を取得するページの数を入力します。 ページの範囲には、ハイフンを使用します。 各ページまたは範囲をコンマで区切ります。
- model_version
- str
テキスト抽出に使用される OCR モデルのバージョンを指定する省略可能なパラメーター。 使用できる値は、"latest"、"latest-preview"、"2021-04-12" です。 既定値は "latest" です。
- reading_order
- str
抽出テキスト要素の順序付け時に適用する読み取り順序アルゴリズムを指定する省略可能なパラメーター。 'basic' または 'natural' を指定できます。 指定しない場合、既定値は 'basic' になります
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は None または ClientRawResponse
の戻り値の型 :
例外
read_in_stream
このインターフェイスを使用して読み取り操作の結果を取得し、テキストが多いドキュメント用に最適化された最新の光学式文字認識 (OCR) アルゴリズムを使用します。 Read インターフェイスを使用すると、応答には "Operation-Location" というフィールドが含まれます。 'Operation-Location' フィールドには、OCR 結果にアクセスするために 'GetReadResult' 操作に使用する必要がある URL が含まれています。.
read_in_stream(image, language=None, pages=None, model_version='latest', reading_order='basic', custom_headers=None, raw=False, callback=None, **operation_config)
パラメーター
- language
- str または OcrDetectionLanguage
ドキュメント内のテキストの 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'、'jvm'、'kaa'、'kac'、'kea'、'kha'、'kl'、'ko'、'ku'、'kw'、'lb'、'ms'、'mww'、'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'
複数ページのドキュメントのカスタム ページ番号 (PDF/TIFF)、OCR 結果を取得するページの数を入力します。 ページの範囲には、ハイフンを使用します。 各ページまたは範囲をコンマで区切ります。
- model_version
- str
テキスト抽出に使用される OCR モデルのバージョンを指定する省略可能なパラメーター。 使用できる値は、"latest"、"latest-preview"、"2021-04-12" です。 既定値は "latest" です。
- reading_order
- str
抽出テキスト要素の順序付け時に適用する読み取り順序アルゴリズムを指定する省略可能なパラメーター。 'basic' または 'natural' を指定できます。 指定しない場合、既定値は 'basic' になります
- callback
- Callable[<xref:Bytes>, <xref:response=None>]
を指定すると、ストリーミングされるデータの各チャンクで が呼び出されます。 コールバックは、現在のデータ チャンクと応答オブジェクトのバイトである 2 つの引数を受け取る必要があります。 データがアップロードされている場合、応答は None になります。
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は None または ClientRawResponse
の戻り値の型 :
例外
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
画像内のテキストの向きを検出するかどうか。 detectOrientation=true を指定すると、OCR サービスは画像の向きを検出し、さらに処理する前に修正しようとします (逆さまである場合など)。
- language
- str または OcrLanguages
画像で検出されるテキストの 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
AI モデルのバージョンを指定する省略可能なパラメーター。 使用できる値は、"latest"、"2021-04-01" です。 既定値は "latest" です。
- 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
画像内のテキストの向きを検出するかどうか。 detectOrientation=true を指定すると、OCR サービスは画像の向きを検出し、さらに処理する前に修正しようとします (逆さまである場合など)。
- language
- str または OcrLanguages
画像で検出されるテキストの 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
AI モデルのバージョンを指定する省略可能なパラメーター。 使用できる値は、"latest"、"2021-04-01" です。 既定値は "latest" です。
- callback
- Callable[<xref:Bytes>, <xref:response=None>]
を指定すると、ストリーミングされるデータの各チャンクで が呼び出されます。 コールバックは、現在のデータ チャンクと応答オブジェクトのバイトである 2 つの引数を受け取る必要があります。 データがアップロードされている場合、応答は None になります。
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は OcrResult または ClientRawResponse
の戻り値の型 :
例外
tag_image
この操作は、指定された画像のコンテンツに関連する単語すなわちタグのリストを生成します。 Computer Vision API は、画像内で検出された物体、生物、景色、または動作に基づくタグを返すことができます。 カテゴリとは異なり、タグは階層的分類システムで整理されていませんが、画像のコンテンツに対応しています。 タグにあいまいさを回避するためのヒントが含まれたり、タグによってコンテキストが提供されたりすることがあります。たとえば、"ascomycete" (子嚢菌) というタグに "fungus" (菌類) というヒントが付く場合があります。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。
tag_image(url, language='en', model_version='latest', custom_headers=None, raw=False, **operation_config)
パラメーター
- language
- str
出力生成に必要な言語。 このパラメーターを指定しない場合、既定値は "en" です。サポートされている言語:en - 英語、既定値。 es - スペイン語、ja - 日本語、pt - ポルトガル語、zh - 簡体字中国語。 使用できる値は、'en'、'es'、'ja'、'pt'、'zh' です。
- model_version
- str
AI モデルのバージョンを指定する省略可能なパラメーター。 使用できる値は、"latest"、"2021-04-01" です。 既定値は "latest" です。
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は TagResult または ClientRawResponse
の戻り値の型 :
例外
tag_image_in_stream
この操作は、指定された画像のコンテンツに関連する単語すなわちタグのリストを生成します。 Computer Vision API は、画像内で検出された物体、生物、景色、または動作に基づくタグを返すことができます。 カテゴリとは異なり、タグは階層的分類システムで整理されていませんが、画像のコンテンツに対応しています。 タグにあいまいさを回避するためのヒントが含まれたり、タグによってコンテキストが提供されたりすることがあります。たとえば、"ascomycete" (子嚢菌) というタグに "fungus" (菌類) というヒントが付く場合があります。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。
tag_image_in_stream(image, language='en', model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)
パラメーター
- language
- str
出力生成に必要な言語。 このパラメーターを指定しない場合、既定値は "en" です。サポートされている言語:en - 英語、既定値。 es - スペイン語、ja - 日本語、pt - ポルトガル語、zh - 簡体字中国語。 使用できる値は、'en'、'es'、'ja'、'pt'、'zh' です。
- model_version
- str
AI モデルのバージョンを指定する省略可能なパラメーター。 使用できる値は、"latest"、"2021-04-01" です。 既定値は "latest" です。
- callback
- Callable[<xref:Bytes>, <xref:response=None>]
を指定すると、ストリーミングされるデータの各チャンクで が呼び出されます。 コールバックは、現在のデータ チャンクと応答オブジェクトのバイトである 2 つの引数を受け取る必要があります。 データがアップロードされている場合、応答は None になります。
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は TagResult または ClientRawResponse
の戻り値の型 :
例外
Azure SDK for Python