EvaluatorsOperations interface

Package:

@azure/ai-projects

Operations for EvaluatorsOperations.

Properties

cancelGenerationJob	Cancels an evaluator generation job by its ID.
createGenerationJob	Creates an evaluator generation job. The service generates rubric-based evaluator definitions from the provided source materials asynchronously.
createVersion	Creates a new evaluator version with an auto-incremented version identifier.
deleteGenerationJob	Deletes an evaluator generation job by its ID. Deletes the job record only; the generated evaluator (if any) is preserved.
deleteVersion	Removes the specified evaluator version. Returns 204 whether the version existed or not.
getGenerationJob	Gets the details of an evaluator generation job by its ID.
getVersion	Retrieves the specified evaluator version, returning 404 if it does not exist.
list	Lists the latest version of each evaluator.
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.
listVersions	Returns the available versions for the specified evaluator.
updateVersion	Updates the specified evaluator version in place.

Property Details

cancelGenerationJob

Cancels an evaluator generation job by its ID.

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

Property Value

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

createGenerationJob

Creates an evaluator generation job. The service generates rubric-based evaluator definitions from the provided source materials asynchronously.

createGenerationJob: (job: EvaluatorGenerationInputs, options?: EvaluatorsCreateGenerationJobOptionalParams) => JobPoller<EvaluatorVersion>

Property Value

(job: EvaluatorGenerationInputs, options?: EvaluatorsCreateGenerationJobOptionalParams) => JobPoller<EvaluatorVersion>

createVersion

Creates a new evaluator version with an auto-incremented version identifier.

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

Property Value

(name: string, evaluatorVersion: EvaluatorVersion, options?: EvaluatorsCreateVersionOptionalParams) => 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?: EvaluatorsDeleteGenerationJobOptionalParams) => Promise<void>

Property Value

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

deleteVersion

Removes the specified evaluator version. Returns 204 whether the version existed or not.

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

Property Value

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

getGenerationJob

Gets the details of an evaluator generation job by its ID.

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

Property Value

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

getVersion

Retrieves the specified evaluator version, returning 404 if it does not exist.

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

Property Value

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

list

Lists the latest version of each evaluator.

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

Property Value

(options?: EvaluatorsListOptionalParams) => 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?: EvaluatorsListGenerationJobsOptionalParams) => PagedAsyncIterableIterator<EvaluatorGenerationJob, EvaluatorGenerationJob[], PageSettings>

Property Value

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

listVersions

Returns the available versions for the specified evaluator.

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

Property Value

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

updateVersion

Updates the specified evaluator version in place.

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

Property Value

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