ComputerVisionClient class

ComputerVisionClient クラスの新しいインスタンスを初期化します。

new ComputerVisionClient(credentials: ServiceClientCredentials, endpoint: string, options?: ServiceClientOptions)

パラメーター

credentials: ServiceClientCredentials

プロパティ値

ComputerVisionClientContext.credentialsから継承

endpoint: string

プロパティ値

ComputerVisionClientContext.endpointから継承

この操作では､画像の内容に基づいて、さまざまな視覚的特徴のセットを抽出できます。 2 つの入力メソッドがサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 要求内には、返す機能を選択できる省略可能なパラメーターがあります。 既定では、画像カテゴリは応答で返されます。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。

function analyzeImage(url: string, options?: ComputerVisionClientAnalyzeImageOptionalParams): Promise<AnalyzeImageResponse>

パラメーター

戻り値

Promise<Models.AnalyzeImageResponse>

function analyzeImage(url: string, options: ComputerVisionClientAnalyzeImageOptionalParams, callback: ServiceCallback<ImageAnalysis>)

パラメーター

function analyzeImage(url: string, callback: ServiceCallback<ImageAnalysis>)

パラメーター

この操作は、ドメイン固有モデルを適用することで、画像内のコンテンツを認識します。 Computer Vision API によってサポートされるドメイン固有モデルの一覧は、/models GET 要求を使用して取得できます。 現時点で、この API によって提供されるドメイン固有モデルは著名人とランドマークです。 2 つの入力メソッドがサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。

function analyzeImageByDomain(model: string, url: string, options?: ComputerVisionClientAnalyzeImageByDomainOptionalParams): Promise<AnalyzeImageByDomainResponse>

パラメーター

戻り値

Promise<Models.AnalyzeImageByDomainResponse>

function analyzeImageByDomain(model: string, url: string, options: ComputerVisionClientAnalyzeImageByDomainOptionalParams, callback: ServiceCallback<DomainModelResults>)

パラメーター

function analyzeImageByDomain(model: string, url: string, callback: ServiceCallback<DomainModelResults>)

パラメーター

この操作は、ドメイン固有モデルを適用することで、画像内のコンテンツを認識します。 Computer Vision API によってサポートされるドメイン固有モデルの一覧は、/models GET 要求を使用して取得できます。 現時点で、この API によって提供されるドメイン固有モデルは著名人とランドマークです。 2 つの入力メソッドがサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。

function analyzeImageByDomainInStream(model: string, image: HttpRequestBody, options?: ComputerVisionClientAnalyzeImageByDomainInStreamOptionalParams): Promise<AnalyzeImageByDomainInStreamResponse>

パラメーター

戻り値

Promise<Models.AnalyzeImageByDomainInStreamResponse>

function analyzeImageByDomainInStream(model: string, image: HttpRequestBody, options: ComputerVisionClientAnalyzeImageByDomainInStreamOptionalParams, callback: ServiceCallback<DomainModelResults>)

パラメーター

function analyzeImageByDomainInStream(model: string, image: HttpRequestBody, callback: ServiceCallback<DomainModelResults>)

パラメーター

この操作では､画像の内容に基づいて、さまざまな視覚的特徴のセットを抽出できます。 2 つの入力メソッドがサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 要求内には、返す機能を選択できる省略可能なパラメーターがあります。 既定では、画像カテゴリは応答で返されます。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。

function analyzeImageInStream(image: HttpRequestBody, options?: ComputerVisionClientAnalyzeImageInStreamOptionalParams): Promise<AnalyzeImageInStreamResponse>

パラメーター

戻り値

Promise<Models.AnalyzeImageInStreamResponse>

function analyzeImageInStream(image: HttpRequestBody, options: ComputerVisionClientAnalyzeImageInStreamOptionalParams, callback: ServiceCallback<ImageAnalysis>)

パラメーター

function analyzeImageInStream(image: HttpRequestBody, callback: ServiceCallback<ImageAnalysis>)

パラメーター

この操作は、完全な文を使用して、人間が判読できる言語でイメージ全体の説明を生成します。 説明はコンテンツ タグのコレクションに基づいていますが、コンテンツ タグもこの操作によって返されます。 各画像に対して複数の説明が生成されることがあります。 説明はその信頼度スコアの順に並んでいます。 説明には、該当する場合は、有名人およびランドマーク ドメイン モデルの結果が含まれる場合があります。 2 つの入力メソッドがサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。

function describeImage(url: string, options?: ComputerVisionClientDescribeImageOptionalParams): Promise<DescribeImageResponse>

パラメーター

戻り値

Promise<Models.DescribeImageResponse>

function describeImage(url: string, options: ComputerVisionClientDescribeImageOptionalParams, callback: ServiceCallback<ImageDescription>)

パラメーター

function describeImage(url: string, callback: ServiceCallback<ImageDescription>)

パラメーター

この操作は、完全な文を使用して、人間が判読できる言語でイメージ全体の説明を生成します。 説明はコンテンツ タグのコレクションに基づいていますが、コンテンツ タグもこの操作によって返されます。 各画像に対して複数の説明が生成されることがあります。 説明はその信頼度スコアの順に並んでいます。 説明には、著名人およびランドマーク ドメイン モデルの結果が含まれる場合があります (該当する場合)。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。

function describeImageInStream(image: HttpRequestBody, options?: ComputerVisionClientDescribeImageInStreamOptionalParams): Promise<DescribeImageInStreamResponse>

パラメーター

戻り値

Promise<Models.DescribeImageInStreamResponse>

function describeImageInStream(image: HttpRequestBody, options: ComputerVisionClientDescribeImageInStreamOptionalParams, callback: ServiceCallback<ImageDescription>)

パラメーター

function describeImageInStream(image: HttpRequestBody, callback: ServiceCallback<ImageDescription>)

パラメーター

指定した画像に対して物体検出を実行します。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。

function detectObjects(url: string, options?: ComputerVisionClientDetectObjectsOptionalParams): Promise<DetectObjectsResponse>

パラメーター

戻り値

Promise<Models.DetectObjectsResponse>

function detectObjects(url: string, options: ComputerVisionClientDetectObjectsOptionalParams, callback: ServiceCallback<DetectResult>)

パラメーター

function detectObjects(url: string, callback: ServiceCallback<DetectResult>)

パラメーター

指定した画像に対して物体検出を実行します。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。

function detectObjectsInStream(image: HttpRequestBody, options?: ComputerVisionClientDetectObjectsInStreamOptionalParams): Promise<DetectObjectsInStreamResponse>

パラメーター

戻り値

Promise<Models.DetectObjectsInStreamResponse>

function detectObjectsInStream(image: HttpRequestBody, options: ComputerVisionClientDetectObjectsInStreamOptionalParams, callback: ServiceCallback<DetectResult>)

パラメーター

function detectObjectsInStream(image: HttpRequestBody, callback: ServiceCallback<DetectResult>)

パラメーター

この操作は、ユーザーが指定した幅と高さのサムネイル画像を生成します。 既定では、サービスが画像を分析し、関心領域 (ROI) を特定し、ROI に基づいてスマート トリミング座標を生成します。 スマートトリミングは、入力画像とは異なる縦横比を指定する場合に役立ちます。 成功時の応答には、サムネイル画像のバイナリが格納されます。 要求が失敗した場合、応答にはエラー コードと、問題の特定に役立つメッセージが含まれます。 エラーが発生すると、エラー コードとエラー メッセージが返されます。 エラー コードは、InvalidImageUrl、InvalidImageFormat、InvalidImageSize、InvalidThumbnailSize、NotSupportedImage、FailedToProcess、Timeout、または InternalServerError のいずれかです。

function generateThumbnail(width: number, height: number, url: string, options?: ComputerVisionClientGenerateThumbnailOptionalParams): Promise<GenerateThumbnailResponse>

パラメーター

戻り値

Promise<Models.GenerateThumbnailResponse>

function generateThumbnail(width: number, height: number, url: string, options: ComputerVisionClientGenerateThumbnailOptionalParams, callback: ServiceCallback<void>)

パラメーター

function generateThumbnail(width: number, height: number, url: string, callback: ServiceCallback<void>)

パラメーター

この操作は、ユーザーが指定した幅と高さのサムネイル画像を生成します。 既定では、サービスが画像を分析し、関心領域 (ROI) を特定し、ROI に基づいてスマート トリミング座標を生成します。 スマートトリミングは、入力画像とは異なる縦横比を指定する場合に役立ちます。 成功時の応答には、サムネイル画像のバイナリが格納されます。 要求が失敗した場合、応答にはエラー コードと、問題の特定に役立つメッセージが含まれます。 エラーが発生すると、エラー コードとエラー メッセージが返されます。 エラー コードは、InvalidImageUrl、InvalidImageFormat、InvalidImageSize、InvalidThumbnailSize、NotSupportedImage、FailedToProcess、Timeout、または InternalServerError のいずれかです。

function generateThumbnailInStream(width: number, height: number, image: HttpRequestBody, options?: ComputerVisionClientGenerateThumbnailInStreamOptionalParams): Promise<GenerateThumbnailInStreamResponse>

パラメーター

戻り値

Promise<Models.GenerateThumbnailInStreamResponse>

function generateThumbnailInStream(width: number, height: number, image: HttpRequestBody, options: ComputerVisionClientGenerateThumbnailInStreamOptionalParams, callback: ServiceCallback<void>)

パラメーター

function generateThumbnailInStream(width: number, height: number, image: HttpRequestBody, callback: ServiceCallback<void>)

パラメーター

この操作は、画像の最も重要な部分を囲む境界ボックスを返します。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを判断するのに役立つメッセージが含まれます。 エラーが発生すると、エラー コードとエラー メッセージが返されます。 このエラー コードには、InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、FailedToProcess、Timeout、または InternalServerError のいずれかが考えられます。

function getAreaOfInterest(url: string, options?: ComputerVisionClientGetAreaOfInterestOptionalParams): Promise<GetAreaOfInterestResponse>

パラメーター

戻り値

Promise<Models.GetAreaOfInterestResponse>

function getAreaOfInterest(url: string, options: ComputerVisionClientGetAreaOfInterestOptionalParams, callback: ServiceCallback<AreaOfInterestResult>)

パラメーター

function getAreaOfInterest(url: string, callback: ServiceCallback<AreaOfInterestResult>)

パラメーター

この操作は、画像の最も重要な部分を囲む境界ボックスを返します。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを判断するのに役立つメッセージが含まれます。 エラーが発生すると、エラー コードとエラー メッセージが返されます。 このエラー コードには、InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、FailedToProcess、Timeout、または InternalServerError のいずれかが考えられます。

function getAreaOfInterestInStream(image: HttpRequestBody, options?: ComputerVisionClientGetAreaOfInterestInStreamOptionalParams): Promise<GetAreaOfInterestInStreamResponse>

パラメーター

戻り値

Promise<Models.GetAreaOfInterestInStreamResponse>

function getAreaOfInterestInStream(image: HttpRequestBody, options: ComputerVisionClientGetAreaOfInterestInStreamOptionalParams, callback: ServiceCallback<AreaOfInterestResult>)

パラメーター

function getAreaOfInterestInStream(image: HttpRequestBody, callback: ServiceCallback<AreaOfInterestResult>)

パラメーター

このインターフェイスは、読み取り操作の OCR 結果を取得するために使用されます。 このインターフェイスの URL は、読み取りインターフェイスから返される 'Operation-Location' フィールドから取得する必要があります。

function getReadResult(operationId: string, options?: RequestOptionsBase): Promise<GetReadResultResponse>

パラメーター

戻り値

Promise<Models.GetReadResultResponse>

function getReadResult(operationId: string, options: RequestOptionsBase, callback: ServiceCallback<ReadOperationResult>)

パラメーター

function getReadResult(operationId: string, callback: ServiceCallback<ReadOperationResult>)

パラメーター

この操作は、Computer Vision API でサポートされているドメイン固有モデルの一覧を返します。 現時点では、この API によってサポートされるドメイン固有モデルは著名人認識機能とランドマーク認識機能です。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。

function listModels(options?: RequestOptionsBase): Promise<ListModelsResponse>

パラメーター

戻り値

Promise<Models.ListModelsResponse>

function listModels(options: RequestOptionsBase, callback: ServiceCallback<ListModelsResult>)

パラメーター

function listModels(callback: ServiceCallback<ListModelsResult>)

パラメーター

このインターフェイスを使用して読み取り操作の結果を取得し、テキストの多いドキュメント用に最適化された最新の光学式文字認識 (OCR) アルゴリズムを使用します。 Read インターフェイスを使用すると、応答には "Operation-Location" というフィールドが含まれます。 'Operation-Location' フィールドには、OCR 結果にアクセスするために 'GetReadResult' 操作に使用する必要がある URL が含まれています。

function read(url: string, options?: ComputerVisionClientReadOptionalParams): Promise<ReadResponse>

パラメーター

戻り値

Promise<Models.ReadResponse>

function read(url: string, options: ComputerVisionClientReadOptionalParams, callback: ServiceCallback<void>)

パラメーター

function read(url: string, callback: ServiceCallback<void>)

パラメーター

このインターフェイスを使用して読み取り操作の結果を取得し、テキストの多いドキュメント用に最適化された最新の光学式文字認識 (OCR) アルゴリズムを使用します。 Read インターフェイスを使用すると、応答には "Operation-Location" というフィールドが含まれます。 'Operation-Location' フィールドには、OCR 結果にアクセスするために 'GetReadResult' 操作に使用する必要がある URL が含まれています。

function readInStream(image: HttpRequestBody, options?: ComputerVisionClientReadInStreamOptionalParams): Promise<ReadInStreamResponse>

パラメーター

戻り値

Promise<Models.ReadInStreamResponse>

function readInStream(image: HttpRequestBody, options: ComputerVisionClientReadInStreamOptionalParams, callback: ServiceCallback<void>)

パラメーター

function readInStream(image: HttpRequestBody, callback: ServiceCallback<void>)

パラメーター

光学式文字認識 (OCR) により画像内のテキストを検出し、認識した文字を抽出して、コンピューターで処理可能な文字ストリームに変換します。 成功すると、OCR の結果が返されます。 エラーが発生すると、エラー コードとエラー メッセージが返されます。 エラー コードには、InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、NotSupportedLanguage、または InternalServerError のいずれかを指定できます。

function recognizePrintedText(detectOrientation: boolean, url: string, options?: ComputerVisionClientRecognizePrintedTextOptionalParams): Promise<RecognizePrintedTextResponse>

パラメーター

戻り値

Promise<Models.RecognizePrintedTextResponse>

function recognizePrintedText(detectOrientation: boolean, url: string, options: ComputerVisionClientRecognizePrintedTextOptionalParams, callback: ServiceCallback<OcrResult>)

パラメーター

function recognizePrintedText(detectOrientation: boolean, url: string, callback: ServiceCallback<OcrResult>)

パラメーター

光学式文字認識 (OCR) により画像内のテキストを検出し、認識した文字を抽出して、コンピューターで処理可能な文字ストリームに変換します。 成功すると、OCR の結果が返されます。 エラーが発生すると、エラー コードとエラー メッセージが返されます。 エラー コードには、InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、NotSupportedLanguage、または InternalServerError のいずれかを指定できます。

function recognizePrintedTextInStream(detectOrientation: boolean, image: HttpRequestBody, options?: ComputerVisionClientRecognizePrintedTextInStreamOptionalParams): Promise<RecognizePrintedTextInStreamResponse>

パラメーター

戻り値

Promise<Models.RecognizePrintedTextInStreamResponse>

function recognizePrintedTextInStream(detectOrientation: boolean, image: HttpRequestBody, options: ComputerVisionClientRecognizePrintedTextInStreamOptionalParams, callback: ServiceCallback<OcrResult>)

パラメーター

function recognizePrintedTextInStream(detectOrientation: boolean, image: HttpRequestBody, callback: ServiceCallback<OcrResult>)

パラメーター

この操作は、指定された画像のコンテンツに関連する単語すなわちタグのリストを生成します。 Computer Vision API は、画像内で検出された物体、生物、景色、または動作に基づくタグを返すことができます。 カテゴリとは異なり、タグは階層的分類システムで整理されていませんが、画像のコンテンツに対応しています。 タグにあいまいさを回避するためのヒントが含まれたり、タグによってコンテキストが提供されたりすることがあります。たとえば、"ascomycete" (子嚢菌) というタグに "fungus" (菌類) というヒントが付く場合があります。 2 つの入力メソッドがサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。

function tagImage(url: string, options?: ComputerVisionClientTagImageOptionalParams): Promise<TagImageResponse>

パラメーター

戻り値

Promise<Models.TagImageResponse>

function tagImage(url: string, options: ComputerVisionClientTagImageOptionalParams, callback: ServiceCallback<TagResult>)

パラメーター

function tagImage(url: string, callback: ServiceCallback<TagResult>)

パラメーター

この操作は、指定された画像のコンテンツに関連する単語すなわちタグのリストを生成します。 Computer Vision API は、画像内で検出された物体、生物、景色、または動作に基づくタグを返すことができます。 カテゴリとは異なり、タグは階層的分類システムで整理されていませんが、画像のコンテンツに対応しています。 タグにあいまいさを回避するためのヒントが含まれたり、タグによってコンテキストが提供されたりすることがあります。たとえば、"ascomycete" (子嚢菌) というタグに "fungus" (菌類) というヒントが付く場合があります。 2 つの入力メソッドがサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。 成功した応答は JSON で返されます。 要求が失敗した場合、応答にはエラー コードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。

function tagImageInStream(image: HttpRequestBody, options?: ComputerVisionClientTagImageInStreamOptionalParams): Promise<TagImageInStreamResponse>

パラメーター

戻り値

Promise<Models.TagImageInStreamResponse>

function tagImageInStream(image: HttpRequestBody, options: ComputerVisionClientTagImageInStreamOptionalParams, callback: ServiceCallback<TagResult>)

パラメーター

function tagImageInStream(image: HttpRequestBody, callback: ServiceCallback<TagResult>)

パラメーター

指定された OperationSpec を使用して設定された HTTP 要求を送信します。

function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>

パラメーター

戻り値

ComputerVisionClientContext.sendOperationRequestから継承

指定された httpRequest を送信します。

function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>

パラメーター

戻り値

ComputerVisionClientContext.sendRequestから継承