ToolsOperations interface

Package:

@azure/ai-discovery

Interface representing a Tools operations.

Properties

cancelRun	Cancel an ongoing tool run.
getComputeUsage	Examine compute usage.
getRunStatus	Used for to poll status of a Tool run.
listOperations	List tool runs.
run	Run the specified tool in the context of the specified project.

Property Details

cancelRun

Cancel an ongoing tool run.

cancelRun: (projectName: string, operationId: string, options?: ToolsCancelRunOptionalParams) => PollerLike<OperationState<RunResult>, RunResult>

Property Value

(projectName: string, operationId: string, options?: ToolsCancelRunOptionalParams) => PollerLike<OperationState<RunResult>, RunResult>

getComputeUsage

Examine compute usage.

getComputeUsage: (projectName: string, options?: ToolsGetComputeUsageOptionalParams) => Promise<ComputeUsage>

Property Value

(projectName: string, options?: ToolsGetComputeUsageOptionalParams) => Promise<ComputeUsage>

getRunStatus

Used for to poll status of a Tool run.

getRunStatus: (projectName: string, operationId: string, options?: ToolsGetRunStatusOptionalParams) => Promise<OperationStatusRunResultError>

Property Value

(projectName: string, operationId: string, options?: ToolsGetRunStatusOptionalParams) => Promise<OperationStatusRunResultError>

listOperations

List tool runs.

listOperations: (projectName: string, options?: ToolsGetOperationsOptionalParams) => PagedAsyncIterableIterator<Operation, Operation[], PageSettings>

Property Value

(projectName: string, options?: ToolsGetOperationsOptionalParams) => PagedAsyncIterableIterator<Operation, Operation[], PageSettings>

run

Run the specified tool in the context of the specified project.

run: (projectName: string, toolId: string, nodePoolIds: string[], options?: ToolsRunOptionalParams) => PollerLike<OperationState<RunResult>, RunResult>

Property Value

(projectName: string, toolId: string, nodePoolIds: string[], options?: ToolsRunOptionalParams) => PollerLike<OperationState<RunResult>, RunResult>