BetaEvaluatorsOperations interface

パッケージ:

@azure/ai-projects

BetaEvaluatorsの操作を表すインターフェース。

プロパティ

cancelGenerationJob	評価者生成ジョブをIDでキャンセルします。
createGenerationJob	評価者生成の仕事が生まれます。 このサービスは、提供されたソース資料から非同期的にルーブリックベースの評価者定義を生成します。
createVersion	自動増分されたバージョン識別子を持つ新しい評価者バージョンを作成します。
deleteGenerationJob	評価者生成ジョブをIDで削除します。 ジョブレコードのみを削除します。生成された評価器(あれば)は保持されます。
deleteVersion	指定された評価者バージョンを削除します。 バージョンが存在したかどうかに関わらず204を返します。
getCredentials	指定された評価者バージョンに関連付けられたストレージアカウントにアクセスするためのSAS認証情報を取得します。
getGenerationJob	評価者生成ジョブの詳細をIDで取得します。
getVersion	指定された評価者バージョンを取得し、存在しない場合は404を返します。
list	各評価者の最新バージョンを記載しています。
listGenerationJobs	評価者生成ジョブのリストを返します。 List APIは伝播に数秒の遅延があるため、最近作成されたジョブがすぐに表示されないことがあります。Get evaluator generation job APIとジョブIDを使い、特定のジョブを遅滞なく取得できます。
listVersions	指定された評価者に対して利用可能なバージョンを返します。
pendingUpload	指定された評価者バージョンの新しい保留中のアップロードを開始するか、既存のアップロードを取得することができます。
updateVersion	指定された評価者バージョンを更新します。

プロパティの詳細

cancelGenerationJob

評価者生成ジョブをIDでキャンセルします。

cancelGenerationJob: (jobId: string, options?: BetaEvaluatorsCancelGenerationJobOptionalParams) => Promise<EvaluatorGenerationJob>

プロパティ値

(jobId: string, options?: BetaEvaluatorsCancelGenerationJobOptionalParams) => Promise<EvaluatorGenerationJob>

createGenerationJob

評価者生成の仕事が生まれます。 このサービスは、提供されたソース資料から非同期的にルーブリックベースの評価者定義を生成します。

createGenerationJob: (job: EvaluatorGenerationJob, options?: BetaEvaluatorsCreateGenerationJobOptionalParams) => JobPoller<EvaluatorVersion>

プロパティ値

(job: EvaluatorGenerationJob, options?: BetaEvaluatorsCreateGenerationJobOptionalParams) => JobPoller<EvaluatorVersion>

createVersion

自動増分されたバージョン識別子を持つ新しい評価者バージョンを作成します。

createVersion: (name: string, evaluatorVersion: EvaluatorVersion, options?: BetaEvaluatorsCreateVersionOptionalParams) => Promise<EvaluatorVersion>

プロパティ値

(name: string, evaluatorVersion: EvaluatorVersion, options?: BetaEvaluatorsCreateVersionOptionalParams) => Promise<EvaluatorVersion>

deleteGenerationJob

評価者生成ジョブをIDで削除します。 ジョブレコードのみを削除します。生成された評価器(あれば)は保持されます。

deleteGenerationJob: (jobId: string, options?: BetaEvaluatorsDeleteGenerationJobOptionalParams) => Promise<void>

プロパティ値

(jobId: string, options?: BetaEvaluatorsDeleteGenerationJobOptionalParams) => Promise<void>

deleteVersion

指定された評価者バージョンを削除します。 バージョンが存在したかどうかに関わらず204を返します。

deleteVersion: (name: string, version: string, options?: BetaEvaluatorsDeleteVersionOptionalParams) => Promise<void>

プロパティ値

(name: string, version: string, options?: BetaEvaluatorsDeleteVersionOptionalParams) => Promise<void>

getCredentials

指定された評価者バージョンに関連付けられたストレージアカウントにアクセスするためのSAS認証情報を取得します。

getCredentials: (name: string, credentialRequest: EvaluatorCredentialRequest, version: string, options?: BetaEvaluatorsGetCredentialsOptionalParams) => Promise<DatasetCredential>

プロパティ値

(name: string, credentialRequest: EvaluatorCredentialRequest, version: string, options?: BetaEvaluatorsGetCredentialsOptionalParams) => Promise<DatasetCredential>

getGenerationJob

評価者生成ジョブの詳細をIDで取得します。

getGenerationJob: (jobId: string, options?: BetaEvaluatorsGetGenerationJobOptionalParams) => Promise<EvaluatorGenerationJob>

プロパティ値

(jobId: string, options?: BetaEvaluatorsGetGenerationJobOptionalParams) => Promise<EvaluatorGenerationJob>

getVersion

指定された評価者バージョンを取得し、存在しない場合は404を返します。

getVersion: (name: string, version: string, options?: BetaEvaluatorsGetVersionOptionalParams) => Promise<EvaluatorVersion>

プロパティ値

(name: string, version: string, options?: BetaEvaluatorsGetVersionOptionalParams) => Promise<EvaluatorVersion>

list

各評価者の最新バージョンを記載しています。

list: (options?: BetaEvaluatorsListOptionalParams) => PagedAsyncIterableIterator<EvaluatorVersion, EvaluatorVersion[], PageSettings>

プロパティ値

(options?: BetaEvaluatorsListOptionalParams) => PagedAsyncIterableIterator<EvaluatorVersion, EvaluatorVersion[], PageSettings>

listGenerationJobs

評価者生成ジョブのリストを返します。 List APIは伝播に数秒の遅延があるため、最近作成されたジョブがすぐに表示されないことがあります。Get evaluator generation job APIとジョブIDを使い、特定のジョブを遅滞なく取得できます。

listGenerationJobs: (options?: BetaEvaluatorsListGenerationJobsOptionalParams) => PagedAsyncIterableIterator<EvaluatorGenerationJob, EvaluatorGenerationJob[], PageSettings>

プロパティ値

(options?: BetaEvaluatorsListGenerationJobsOptionalParams) => PagedAsyncIterableIterator<EvaluatorGenerationJob, EvaluatorGenerationJob[], PageSettings>

listVersions

指定された評価者に対して利用可能なバージョンを返します。

listVersions: (name: string, options?: BetaEvaluatorsListVersionsOptionalParams) => PagedAsyncIterableIterator<EvaluatorVersion, EvaluatorVersion[], PageSettings>

プロパティ値

(name: string, options?: BetaEvaluatorsListVersionsOptionalParams) => PagedAsyncIterableIterator<EvaluatorVersion, EvaluatorVersion[], PageSettings>

pendingUpload

指定された評価者バージョンの新しい保留中のアップロードを開始するか、既存のアップロードを取得することができます。

pendingUpload: (name: string, version: string, pendingUploadRequest: PendingUploadRequest, options?: BetaEvaluatorsPendingUploadOptionalParams) => Promise<PendingUploadResponse>

プロパティ値

(name: string, version: string, pendingUploadRequest: PendingUploadRequest, options?: BetaEvaluatorsPendingUploadOptionalParams) => Promise<PendingUploadResponse>

updateVersion

指定された評価者バージョンを更新します。

updateVersion: (name: string, version: string, evaluatorVersion: EvaluatorVersion, options?: BetaEvaluatorsUpdateVersionOptionalParams) => Promise<EvaluatorVersion>

プロパティ値

(name: string, version: string, evaluatorVersion: EvaluatorVersion, options?: BetaEvaluatorsUpdateVersionOptionalParams) => Promise<EvaluatorVersion>