BetaEvaluatorsOperations interface
Interface representing a BetaEvaluators operations.
Properties
| cancel |
Cancels an evaluator generation job by its ID. |
| create |
Creates an evaluator generation job. The service generates rubric-based evaluator definitions from the provided source materials asynchronously. |
| create |
Creates a new evaluator version with an auto-incremented version identifier. |
| delete |
Deletes an evaluator generation job by its ID. Deletes the job record only; the generated evaluator (if any) is preserved. |
| delete |
Removes the specified evaluator version. Returns 204 whether the version existed or not. |
| get |
Retrieves SAS credentials for accessing the storage account associated with the specified evaluator version. |
| get |
Gets the details of an evaluator generation job by its ID. |
| get |
Retrieves the specified evaluator version, returning 404 if it does not exist. |
| list | Lists the latest version of each evaluator |
| list |
Returns a list of evaluator generation jobs. The List API has up to a few seconds of propagation delay, so a recently created job may not appear immediately; use the Get evaluator generation job API with the job ID to retrieve a specific job without delay. |
| list |
Returns the available versions for the specified evaluator. |
| pending |
Initiates a new pending upload or retrieves an existing one for the specified evaluator version. |
| update |
Updates the specified evaluator version in place. |
Property Details
cancelGenerationJob
Cancels an evaluator generation job by its ID.
cancelGenerationJob: (jobId: string, options?: BetaEvaluatorsCancelGenerationJobOptionalParams) => Promise<EvaluatorGenerationJob>Property Value
(jobId: string, options?: BetaEvaluatorsCancelGenerationJobOptionalParams) => Promise<EvaluatorGenerationJob>
createGenerationJob
Creates an evaluator generation job. The service generates rubric-based evaluator definitions from the provided source materials asynchronously.
createGenerationJob: (job: EvaluatorGenerationJob, options?: BetaEvaluatorsCreateGenerationJobOptionalParams) => Promise<EvaluatorGenerationJob>Property Value
(job: EvaluatorGenerationJob, options?: BetaEvaluatorsCreateGenerationJobOptionalParams) => Promise<EvaluatorGenerationJob>
createVersion
Creates a new evaluator version with an auto-incremented version identifier.
createVersion: (name: string, evaluatorVersion: EvaluatorVersion, options?: BetaEvaluatorsCreateVersionOptionalParams) => Promise<EvaluatorVersion>Property Value
(name: string, evaluatorVersion: EvaluatorVersion, options?: BetaEvaluatorsCreateVersionOptionalParams) => Promise<EvaluatorVersion>
deleteGenerationJob
Deletes an evaluator generation job by its ID. Deletes the job record only; the generated evaluator (if any) is preserved.
deleteGenerationJob: (jobId: string, options?: BetaEvaluatorsDeleteGenerationJobOptionalParams) => Promise<void>Property Value
(jobId: string, options?: BetaEvaluatorsDeleteGenerationJobOptionalParams) => Promise<void>
deleteVersion
Removes the specified evaluator version. Returns 204 whether the version existed or not.
deleteVersion: (name: string, version: string, options?: BetaEvaluatorsDeleteVersionOptionalParams) => Promise<void>Property Value
(name: string, version: string, options?: BetaEvaluatorsDeleteVersionOptionalParams) => Promise<void>
getCredentials
Retrieves SAS credentials for accessing the storage account associated with the specified evaluator version.
getCredentials: (name: string, credentialRequest: EvaluatorCredentialRequest, version: string, options?: BetaEvaluatorsGetCredentialsOptionalParams) => Promise<DatasetCredential>Property Value
(name: string, credentialRequest: EvaluatorCredentialRequest, version: string, options?: BetaEvaluatorsGetCredentialsOptionalParams) => Promise<DatasetCredential>
getGenerationJob
Gets the details of an evaluator generation job by its ID.
getGenerationJob: (jobId: string, options?: BetaEvaluatorsGetGenerationJobOptionalParams) => Promise<EvaluatorGenerationJob>Property Value
(jobId: string, options?: BetaEvaluatorsGetGenerationJobOptionalParams) => Promise<EvaluatorGenerationJob>
getVersion
Retrieves the specified evaluator version, returning 404 if it does not exist.
getVersion: (name: string, version: string, options?: BetaEvaluatorsGetVersionOptionalParams) => Promise<EvaluatorVersion>Property Value
(name: string, version: string, options?: BetaEvaluatorsGetVersionOptionalParams) => Promise<EvaluatorVersion>
list
Lists the latest version of each evaluator
list: (options?: BetaEvaluatorsListOptionalParams) => PagedAsyncIterableIterator<EvaluatorVersion, EvaluatorVersion[], PageSettings>Property Value
(options?: BetaEvaluatorsListOptionalParams) => PagedAsyncIterableIterator<EvaluatorVersion, EvaluatorVersion[], PageSettings>
listGenerationJobs
Returns a list of evaluator generation jobs. The List API has up to a few seconds of propagation delay, so a recently created job may not appear immediately; use the Get evaluator generation job API with the job ID to retrieve a specific job without delay.
listGenerationJobs: (options?: BetaEvaluatorsListGenerationJobsOptionalParams) => PagedAsyncIterableIterator<EvaluatorGenerationJob, EvaluatorGenerationJob[], PageSettings>Property Value
(options?: BetaEvaluatorsListGenerationJobsOptionalParams) => PagedAsyncIterableIterator<EvaluatorGenerationJob, EvaluatorGenerationJob[], PageSettings>
listVersions
Returns the available versions for the specified evaluator.
listVersions: (name: string, options?: BetaEvaluatorsListVersionsOptionalParams) => PagedAsyncIterableIterator<EvaluatorVersion, EvaluatorVersion[], PageSettings>Property Value
(name: string, options?: BetaEvaluatorsListVersionsOptionalParams) => PagedAsyncIterableIterator<EvaluatorVersion, EvaluatorVersion[], PageSettings>
pendingUpload
Initiates a new pending upload or retrieves an existing one for the specified evaluator version.
pendingUpload: (name: string, version: string, pendingUploadRequest: PendingUploadRequest, options?: BetaEvaluatorsPendingUploadOptionalParams) => Promise<PendingUploadResponse>Property Value
(name: string, version: string, pendingUploadRequest: PendingUploadRequest, options?: BetaEvaluatorsPendingUploadOptionalParams) => Promise<PendingUploadResponse>
updateVersion
Updates the specified evaluator version in place.
updateVersion: (name: string, version: string, evaluatorVersion: EvaluatorVersion, options?: BetaEvaluatorsUpdateVersionOptionalParams) => Promise<EvaluatorVersion>Property Value
(name: string, version: string, evaluatorVersion: EvaluatorVersion, options?: BetaEvaluatorsUpdateVersionOptionalParams) => Promise<EvaluatorVersion>