PredictionAPIClient class

  • リファレンス
パッケージ:
@azure/cognitiveservices-customvision-prediction
Extends
PredictionAPIClientContext

コンストラクター

PredictionAPIClient(ServiceClientCredentials, string, ServiceClientOptions)

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

継承されたプロパティ

credentials
endpoint

メソッド

classifyImage(string, string, HttpRequestBody, PredictionAPIClientClassifyImageOptionalParams)
classifyImage(string, string, HttpRequestBody, PredictionAPIClientClassifyImageOptionalParams, ServiceCallback<ImagePrediction>)
classifyImage(string, string, HttpRequestBody, ServiceCallback<ImagePrediction>)
classifyImageUrl(string, string, ImageUrl, PredictionAPIClientClassifyImageUrlOptionalParams)
classifyImageUrl(string, string, ImageUrl, PredictionAPIClientClassifyImageUrlOptionalParams, ServiceCallback<ImagePrediction>)
classifyImageUrl(string, string, ImageUrl, ServiceCallback<ImagePrediction>)
classifyImageUrlWithNoStore(string, string, ImageUrl, PredictionAPIClientClassifyImageUrlWithNoStoreOptionalParams)
classifyImageUrlWithNoStore(string, string, ImageUrl, PredictionAPIClientClassifyImageUrlWithNoStoreOptionalParams, ServiceCallback<ImagePrediction>)
classifyImageUrlWithNoStore(string, string, ImageUrl, ServiceCallback<ImagePrediction>)
classifyImageWithNoStore(string, string, HttpRequestBody, PredictionAPIClientClassifyImageWithNoStoreOptionalParams)
classifyImageWithNoStore(string, string, HttpRequestBody, PredictionAPIClientClassifyImageWithNoStoreOptionalParams, ServiceCallback<ImagePrediction>)
classifyImageWithNoStore(string, string, HttpRequestBody, ServiceCallback<ImagePrediction>)
detectImage(string, string, HttpRequestBody, PredictionAPIClientDetectImageOptionalParams)
detectImage(string, string, HttpRequestBody, PredictionAPIClientDetectImageOptionalParams, ServiceCallback<ImagePrediction>)
detectImage(string, string, HttpRequestBody, ServiceCallback<ImagePrediction>)
detectImageUrl(string, string, ImageUrl, PredictionAPIClientDetectImageUrlOptionalParams)
detectImageUrl(string, string, ImageUrl, PredictionAPIClientDetectImageUrlOptionalParams, ServiceCallback<ImagePrediction>)
detectImageUrl(string, string, ImageUrl, ServiceCallback<ImagePrediction>)
detectImageUrlWithNoStore(string, string, ImageUrl, PredictionAPIClientDetectImageUrlWithNoStoreOptionalParams)
detectImageUrlWithNoStore(string, string, ImageUrl, PredictionAPIClientDetectImageUrlWithNoStoreOptionalParams, ServiceCallback<ImagePrediction>)
detectImageUrlWithNoStore(string, string, ImageUrl, ServiceCallback<ImagePrediction>)
detectImageWithNoStore(string, string, HttpRequestBody, PredictionAPIClientDetectImageWithNoStoreOptionalParams)
detectImageWithNoStore(string, string, HttpRequestBody, PredictionAPIClientDetectImageWithNoStoreOptionalParams, ServiceCallback<ImagePrediction>)
detectImageWithNoStore(string, string, HttpRequestBody, ServiceCallback<ImagePrediction>)

継承されたメソッド

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

指定された OperationSpec を使用して設定された HTTP 要求を送信します。
sendRequest(RequestPrepareOptions | WebResourceLike)

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

コンストラクターの詳細

PredictionAPIClient(ServiceClientCredentials, string, ServiceClientOptions)

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

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

パラメーター

credentials
ServiceClientCredentials

クライアント サブスクリプションを一意に識別するサブスクリプション資格情報。

endpoint

string

サポートされている Cognitive Services エンドポイント。

options
ServiceClientOptions

パラメーター オプション

継承されたプロパティの詳細

credentials 

credentials: ServiceClientCredentials

プロパティ値

ServiceClientCredentials

PredictionAPIClientContext.credentialsから継承されます

endpoint 

endpoint: string

プロパティ値

string

PredictionAPIClientContext.endpointから継承

メソッドの詳細

classifyImage(string, string, HttpRequestBody, PredictionAPIClientClassifyImageOptionalParams) 

function classifyImage(projectId: string, publishedName: string, imageData: HttpRequestBody, options?: PredictionAPIClientClassifyImageOptionalParams): Promise<ClassifyImageResponse>

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageData
HttpRequestBody

バイナリ 画像データ。 サポートされている形式は、JPEG、GIF、PNG、BMP です。 最大 4 MB の画像をサポートします。

options
PredictionAPIClientClassifyImageOptionalParams

省略可能なパラメーター

戻り値

Promise<ClassifyImageResponse>

Promise<Models.ClassifyImageResponse>

classifyImage(string, string, HttpRequestBody, PredictionAPIClientClassifyImageOptionalParams, ServiceCallback<ImagePrediction>) 

function classifyImage(projectId: string, publishedName: string, imageData: HttpRequestBody, options: PredictionAPIClientClassifyImageOptionalParams, callback: ServiceCallback<ImagePrediction>)

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageData
HttpRequestBody

バイナリ 画像データ。 サポートされている形式は、JPEG、GIF、PNG、BMP です。 最大 4 MB の画像をサポートします。

options
PredictionAPIClientClassifyImageOptionalParams

省略可能なパラメーター

callback

ServiceCallback<ImagePrediction>

コールバック。

classifyImage(string, string, HttpRequestBody, ServiceCallback<ImagePrediction>) 

function classifyImage(projectId: string, publishedName: string, imageData: HttpRequestBody, callback: ServiceCallback<ImagePrediction>)

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageData
HttpRequestBody

バイナリ 画像データ。 サポートされている形式は、JPEG、GIF、PNG、BMP です。 最大 4 MB の画像をサポートします。

callback

ServiceCallback<ImagePrediction>

コールバック。

classifyImageUrl(string, string, ImageUrl, PredictionAPIClientClassifyImageUrlOptionalParams) 

function classifyImageUrl(projectId: string, publishedName: string, imageUrl: ImageUrl, options?: PredictionAPIClientClassifyImageUrlOptionalParams): Promise<ClassifyImageUrlResponse>

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageUrl
ImageUrl

評価するイメージの URL を含む ImageUrl。

options
PredictionAPIClientClassifyImageUrlOptionalParams

省略可能なパラメーター

戻り値

Promise<ClassifyImageUrlResponse>

Promise<Models.ClassifyImageUrlResponse>

classifyImageUrl(string, string, ImageUrl, PredictionAPIClientClassifyImageUrlOptionalParams, ServiceCallback<ImagePrediction>) 

function classifyImageUrl(projectId: string, publishedName: string, imageUrl: ImageUrl, options: PredictionAPIClientClassifyImageUrlOptionalParams, callback: ServiceCallback<ImagePrediction>)

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageUrl
ImageUrl

評価するイメージの URL を含む ImageUrl。

options
PredictionAPIClientClassifyImageUrlOptionalParams

省略可能なパラメーター

callback

ServiceCallback<ImagePrediction>

コールバック。

classifyImageUrl(string, string, ImageUrl, ServiceCallback<ImagePrediction>) 

function classifyImageUrl(projectId: string, publishedName: string, imageUrl: ImageUrl, callback: ServiceCallback<ImagePrediction>)

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageUrl
ImageUrl

評価するイメージの URL を含む ImageUrl。

callback

ServiceCallback<ImagePrediction>

コールバック。

classifyImageUrlWithNoStore(string, string, ImageUrl, PredictionAPIClientClassifyImageUrlWithNoStoreOptionalParams) 

function classifyImageUrlWithNoStore(projectId: string, publishedName: string, imageUrl: ImageUrl, options?: PredictionAPIClientClassifyImageUrlWithNoStoreOptionalParams): Promise<ClassifyImageUrlWithNoStoreResponse>

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageUrl
ImageUrl

評価するイメージの URL を含む {Iris.Web.Api.Models.ImageUrl}。

options
PredictionAPIClientClassifyImageUrlWithNoStoreOptionalParams

省略可能なパラメーター

戻り値

Promise<ClassifyImageUrlWithNoStoreResponse>

Promise<Models.ClassifyImageUrlWithNoStoreResponse>

classifyImageUrlWithNoStore(string, string, ImageUrl, PredictionAPIClientClassifyImageUrlWithNoStoreOptionalParams, ServiceCallback<ImagePrediction>) 

function classifyImageUrlWithNoStore(projectId: string, publishedName: string, imageUrl: ImageUrl, options: PredictionAPIClientClassifyImageUrlWithNoStoreOptionalParams, callback: ServiceCallback<ImagePrediction>)

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageUrl
ImageUrl

評価するイメージの URL を含む {Iris.Web.Api.Models.ImageUrl}。

options
PredictionAPIClientClassifyImageUrlWithNoStoreOptionalParams

省略可能なパラメーター

callback

ServiceCallback<ImagePrediction>

コールバック。

classifyImageUrlWithNoStore(string, string, ImageUrl, ServiceCallback<ImagePrediction>) 

function classifyImageUrlWithNoStore(projectId: string, publishedName: string, imageUrl: ImageUrl, callback: ServiceCallback<ImagePrediction>)

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageUrl
ImageUrl

評価するイメージの URL を含む {Iris.Web.Api.Models.ImageUrl}。

callback

ServiceCallback<ImagePrediction>

コールバック。

classifyImageWithNoStore(string, string, HttpRequestBody, PredictionAPIClientClassifyImageWithNoStoreOptionalParams) 

function classifyImageWithNoStore(projectId: string, publishedName: string, imageData: HttpRequestBody, options?: PredictionAPIClientClassifyImageWithNoStoreOptionalParams): Promise<ClassifyImageWithNoStoreResponse>

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageData
HttpRequestBody

バイナリ 画像データ。 サポートされている形式は、JPEG、GIF、PNG、BMP です。 最大 4 MB の画像をサポートします。

options
PredictionAPIClientClassifyImageWithNoStoreOptionalParams

省略可能なパラメーター

戻り値

Promise<ClassifyImageWithNoStoreResponse>

Promise<Models.ClassifyImageWithNoStoreResponse>

classifyImageWithNoStore(string, string, HttpRequestBody, PredictionAPIClientClassifyImageWithNoStoreOptionalParams, ServiceCallback<ImagePrediction>) 

function classifyImageWithNoStore(projectId: string, publishedName: string, imageData: HttpRequestBody, options: PredictionAPIClientClassifyImageWithNoStoreOptionalParams, callback: ServiceCallback<ImagePrediction>)

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageData
HttpRequestBody

バイナリ 画像データ。 サポートされている形式は、JPEG、GIF、PNG、BMP です。 最大 4 MB の画像をサポートします。

options
PredictionAPIClientClassifyImageWithNoStoreOptionalParams

省略可能なパラメーター

callback

ServiceCallback<ImagePrediction>

コールバック。

classifyImageWithNoStore(string, string, HttpRequestBody, ServiceCallback<ImagePrediction>) 

function classifyImageWithNoStore(projectId: string, publishedName: string, imageData: HttpRequestBody, callback: ServiceCallback<ImagePrediction>)

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageData
HttpRequestBody

バイナリ 画像データ。 サポートされている形式は、JPEG、GIF、PNG、BMP です。 最大 4 MB の画像をサポートします。

callback

ServiceCallback<ImagePrediction>

コールバック。

detectImage(string, string, HttpRequestBody, PredictionAPIClientDetectImageOptionalParams) 

function detectImage(projectId: string, publishedName: string, imageData: HttpRequestBody, options?: PredictionAPIClientDetectImageOptionalParams): Promise<DetectImageResponse>

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageData
HttpRequestBody

バイナリ 画像データ。 サポートされている形式は、JPEG、GIF、PNG、BMP です。 最大 4 MB の画像をサポートします。

options
PredictionAPIClientDetectImageOptionalParams

省略可能なパラメーター

戻り値

Promise<DetectImageResponse>

Promise<Models.DetectImageResponse>

detectImage(string, string, HttpRequestBody, PredictionAPIClientDetectImageOptionalParams, ServiceCallback<ImagePrediction>) 

function detectImage(projectId: string, publishedName: string, imageData: HttpRequestBody, options: PredictionAPIClientDetectImageOptionalParams, callback: ServiceCallback<ImagePrediction>)

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageData
HttpRequestBody

バイナリ 画像データ。 サポートされている形式は、JPEG、GIF、PNG、BMP です。 最大 4 MB の画像をサポートします。

options
PredictionAPIClientDetectImageOptionalParams

省略可能なパラメーター

callback

ServiceCallback<ImagePrediction>

コールバック。

detectImage(string, string, HttpRequestBody, ServiceCallback<ImagePrediction>) 

function detectImage(projectId: string, publishedName: string, imageData: HttpRequestBody, callback: ServiceCallback<ImagePrediction>)

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageData
HttpRequestBody

バイナリ イメージ データ。 サポートされている形式は、JPEG、GIF、PNG、BMP です。 最大 4 MB のイメージをサポートします。

callback

ServiceCallback<ImagePrediction>

コールバック。

detectImageUrl(string, string, ImageUrl, PredictionAPIClientDetectImageUrlOptionalParams) 

function detectImageUrl(projectId: string, publishedName: string, imageUrl: ImageUrl, options?: PredictionAPIClientDetectImageUrlOptionalParams): Promise<DetectImageUrlResponse>

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageUrl
ImageUrl

評価するイメージの URL を含む ImageUrl。

options
PredictionAPIClientDetectImageUrlOptionalParams

省略可能なパラメーター

戻り値

Promise<DetectImageUrlResponse>

Promise<Models.DetectImageUrlResponse>

detectImageUrl(string, string, ImageUrl, PredictionAPIClientDetectImageUrlOptionalParams, ServiceCallback<ImagePrediction>) 

function detectImageUrl(projectId: string, publishedName: string, imageUrl: ImageUrl, options: PredictionAPIClientDetectImageUrlOptionalParams, callback: ServiceCallback<ImagePrediction>)

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageUrl
ImageUrl

評価するイメージの URL を含む ImageUrl。

options
PredictionAPIClientDetectImageUrlOptionalParams

省略可能なパラメーター

callback

ServiceCallback<ImagePrediction>

コールバック。

detectImageUrl(string, string, ImageUrl, ServiceCallback<ImagePrediction>) 

function detectImageUrl(projectId: string, publishedName: string, imageUrl: ImageUrl, callback: ServiceCallback<ImagePrediction>)

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageUrl
ImageUrl

評価するイメージの URL を含む ImageUrl。

callback

ServiceCallback<ImagePrediction>

コールバック。

detectImageUrlWithNoStore(string, string, ImageUrl, PredictionAPIClientDetectImageUrlWithNoStoreOptionalParams) 

function detectImageUrlWithNoStore(projectId: string, publishedName: string, imageUrl: ImageUrl, options?: PredictionAPIClientDetectImageUrlWithNoStoreOptionalParams): Promise<DetectImageUrlWithNoStoreResponse>

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageUrl
ImageUrl

評価する画像の URL を含む {Iris.Web.Api.Models.ImageUrl}。

options
PredictionAPIClientDetectImageUrlWithNoStoreOptionalParams

省略可能なパラメーター

戻り値

Promise<DetectImageUrlWithNoStoreResponse>

Promise<Models.DetectImageUrlWithNoStoreResponse>

detectImageUrlWithNoStore(string, string, ImageUrl, PredictionAPIClientDetectImageUrlWithNoStoreOptionalParams, ServiceCallback<ImagePrediction>) 

function detectImageUrlWithNoStore(projectId: string, publishedName: string, imageUrl: ImageUrl, options: PredictionAPIClientDetectImageUrlWithNoStoreOptionalParams, callback: ServiceCallback<ImagePrediction>)

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageUrl
ImageUrl

評価する画像の URL を含む {Iris.Web.Api.Models.ImageUrl}。

options
PredictionAPIClientDetectImageUrlWithNoStoreOptionalParams

省略可能なパラメーター

callback

ServiceCallback<ImagePrediction>

コールバック。

detectImageUrlWithNoStore(string, string, ImageUrl, ServiceCallback<ImagePrediction>) 

function detectImageUrlWithNoStore(projectId: string, publishedName: string, imageUrl: ImageUrl, callback: ServiceCallback<ImagePrediction>)

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageUrl
ImageUrl

評価する画像の URL を含む {Iris.Web.Api.Models.ImageUrl}。

callback

ServiceCallback<ImagePrediction>

コールバック。

detectImageWithNoStore(string, string, HttpRequestBody, PredictionAPIClientDetectImageWithNoStoreOptionalParams) 

function detectImageWithNoStore(projectId: string, publishedName: string, imageData: HttpRequestBody, options?: PredictionAPIClientDetectImageWithNoStoreOptionalParams): Promise<DetectImageWithNoStoreResponse>

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageData
HttpRequestBody

バイナリ イメージ データ。 サポートされている形式は、JPEG、GIF、PNG、BMP です。 最大 4 MB のイメージをサポートします。

options
PredictionAPIClientDetectImageWithNoStoreOptionalParams

省略可能なパラメーター

戻り値

Promise<DetectImageWithNoStoreResponse>

Promise<Models.DetectImageWithNoStoreResponse>

detectImageWithNoStore(string, string, HttpRequestBody, PredictionAPIClientDetectImageWithNoStoreOptionalParams, ServiceCallback<ImagePrediction>) 

function detectImageWithNoStore(projectId: string, publishedName: string, imageData: HttpRequestBody, options: PredictionAPIClientDetectImageWithNoStoreOptionalParams, callback: ServiceCallback<ImagePrediction>)

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageData
HttpRequestBody

バイナリ イメージ データ。 サポートされている形式は、JPEG、GIF、PNG、BMP です。 最大 4 MB のイメージをサポートします。

options
PredictionAPIClientDetectImageWithNoStoreOptionalParams

省略可能なパラメーター

callback

ServiceCallback<ImagePrediction>

コールバック。

detectImageWithNoStore(string, string, HttpRequestBody, ServiceCallback<ImagePrediction>) 

function detectImageWithNoStore(projectId: string, publishedName: string, imageData: HttpRequestBody, callback: ServiceCallback<ImagePrediction>)

パラメーター

projectId

string

プロジェクト ID。

publishedName

string

評価対象のモデルの名前を指定します。

imageData
HttpRequestBody

バイナリ イメージ データ。 サポートされている形式は、JPEG、GIF、PNG、BMP です。 最大 4 MB のイメージをサポートします。

callback

ServiceCallback<ImagePrediction>

コールバック。

継承済みメソッドの詳細

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

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

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

パラメーター

operationArguments
OperationArguments

HTTP 要求のテンプレート値が設定される引数。

operationSpec
OperationSpec

httpRequest の設定に使用する OperationSpec。

callback

ServiceCallback<any>

応答を受信したときに呼び出すコールバック。

戻り値

Promise<RestResponse>

PredictionAPIClientContext.sendOperationRequestから継承されます

sendRequest(RequestPrepareOptions | WebResourceLike)

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

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

パラメーター

options

RequestPrepareOptions | WebResourceLike

戻り値

Promise<HttpOperationResponse>

PredictionAPIClientContext.sendRequestから継承