EvaluatorsOperations interface

Package:

@azure/ai-projects

Interface representing a Evaluators operations.

Properties

createVersion	Create a new EvaluatorVersion with auto incremented version id
deleteVersion	Delete the specific version of the EvaluatorVersion. The service returns 204 No Content if the EvaluatorVersion was deleted successfully or if the EvaluatorVersion does not exist.
getVersion	Get the specific version of the EvaluatorVersion. The service returns 404 Not Found error if the EvaluatorVersion does not exist.
updateVersion	Update an existing EvaluatorVersion with the given version id

Methods

listVersions(EvaluatorsListLatestVersionsOptionalParams)	List the latest version of each evaluator
listVersions(string, EvaluatorsListVersionsOptionalParams)	List all versions of the given evaluator

Property Details

createVersion

Create a new EvaluatorVersion with auto incremented version id

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

Property Value

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

deleteVersion

Delete the specific version of the EvaluatorVersion. The service returns 204 No Content if the EvaluatorVersion was deleted successfully or if the EvaluatorVersion does not exist.

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

Property Value

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

getVersion

Get the specific version of the EvaluatorVersion. The service returns 404 Not Found error if the EvaluatorVersion does not exist.

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

Property Value

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

updateVersion

Update an existing EvaluatorVersion with the given version id

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

Property Value

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

Method Details

listVersions(EvaluatorsListLatestVersionsOptionalParams)

List the latest version of each evaluator

function listVersions(options?: EvaluatorsListLatestVersionsOptionalParams): PagedAsyncIterableIterator<EvaluatorVersion, EvaluatorVersion[], PageSettings>

Parameters

options

EvaluatorsListLatestVersionsOptionalParams

Returns

PagedAsyncIterableIterator<EvaluatorVersion, EvaluatorVersion[], PageSettings>

listVersions(string, EvaluatorsListVersionsOptionalParams)

List all versions of the given evaluator

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

Parameters

name

string

options

EvaluatorsListVersionsOptionalParams

Returns

PagedAsyncIterableIterator<EvaluatorVersion, EvaluatorVersion[], PageSettings>