InvestigationsOperations interface

Package:

@azure/ai-discovery

Interface representing a Investigations operations.

Properties

createOrReplace	Creates an Investigation.
deleteInvestigation	Delete a Investigation.
get	Fetch a Investigation by name.
getDiscoveryEngine	Get the discovery engine for an investigation.
getOperationStatus	Get the status of a long-running operation.
list	List Investigation resources
listDiscoveryEngineMemory	List discovery engine working memory entries for an investigation.
startDiscoveryEngine	Start the discovery engine for an investigation.
stopDiscoveryEngine	Stop the discovery engine for an investigation.
update	Updates an Investigation.
updateDiscoveryEngine	Update the discovery engine for an investigation. This will create the discovery engine if it does not already exist.

Property Details

createOrReplace

Creates an Investigation.

createOrReplace: (projectName: string, investigationName: string, resource: InvestigationCreateOrUpdateContent, options?: InvestigationsCreateOrReplaceOptionalParams) => Promise<Investigation>

Property Value

(projectName: string, investigationName: string, resource: InvestigationCreateOrUpdateContent, options?: InvestigationsCreateOrReplaceOptionalParams) => Promise<Investigation>

deleteInvestigation

Delete a Investigation.

deleteInvestigation: (projectName: string, investigationName: string, options?: InvestigationsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(projectName: string, investigationName: string, options?: InvestigationsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Fetch a Investigation by name.

get: (projectName: string, investigationName: string, options?: InvestigationsGetOptionalParams) => Promise<Investigation>

Property Value

(projectName: string, investigationName: string, options?: InvestigationsGetOptionalParams) => Promise<Investigation>

getDiscoveryEngine

Get the discovery engine for an investigation.

getDiscoveryEngine: (projectName: string, investigationName: string, options?: InvestigationsGetDiscoveryEngineOptionalParams) => Promise<DiscoveryEngine>

Property Value

(projectName: string, investigationName: string, options?: InvestigationsGetDiscoveryEngineOptionalParams) => Promise<DiscoveryEngine>

getOperationStatus

Get the status of a long-running operation.

getOperationStatus: (projectName: string, investigationName: string, operationId: string, options?: InvestigationsGetOperationStatusOptionalParams) => Promise<InvestigationOperationStatus>

Property Value

(projectName: string, investigationName: string, operationId: string, options?: InvestigationsGetOperationStatusOptionalParams) => Promise<InvestigationOperationStatus>

list

List Investigation resources

list: (projectName: string, options?: InvestigationsListOptionalParams) => PagedAsyncIterableIterator<Investigation, Investigation[], PageSettings>

Property Value

(projectName: string, options?: InvestigationsListOptionalParams) => PagedAsyncIterableIterator<Investigation, Investigation[], PageSettings>

listDiscoveryEngineMemory

List discovery engine working memory entries for an investigation.

listDiscoveryEngineMemory: (projectName: string, investigationName: string, options?: InvestigationsGetDiscoveryEngineMemoryOptionalParams) => PagedAsyncIterableIterator<WorkingMemoryEntry, WorkingMemoryEntry[], PageSettings>

Property Value

(projectName: string, investigationName: string, options?: InvestigationsGetDiscoveryEngineMemoryOptionalParams) => PagedAsyncIterableIterator<WorkingMemoryEntry, WorkingMemoryEntry[], PageSettings>

startDiscoveryEngine

Start the discovery engine for an investigation.

startDiscoveryEngine: (projectName: string, investigationName: string, options?: InvestigationsStartDiscoveryEngineOptionalParams) => Promise<DiscoveryEngine>

Property Value

(projectName: string, investigationName: string, options?: InvestigationsStartDiscoveryEngineOptionalParams) => Promise<DiscoveryEngine>

stopDiscoveryEngine

Stop the discovery engine for an investigation.

stopDiscoveryEngine: (projectName: string, investigationName: string, options?: InvestigationsStopDiscoveryEngineOptionalParams) => Promise<DiscoveryEngine>

Property Value

(projectName: string, investigationName: string, options?: InvestigationsStopDiscoveryEngineOptionalParams) => Promise<DiscoveryEngine>

update

Updates an Investigation.

update: (projectName: string, investigationName: string, resource: InvestigationCreateOrUpdateContent, options?: InvestigationsUpdateOptionalParams) => Promise<Investigation>

Property Value

(projectName: string, investigationName: string, resource: InvestigationCreateOrUpdateContent, options?: InvestigationsUpdateOptionalParams) => Promise<Investigation>

updateDiscoveryEngine

Update the discovery engine for an investigation. This will create the discovery engine if it does not already exist.

updateDiscoveryEngine: (projectName: string, investigationName: string, body: DiscoveryEngineUpdate, options?: InvestigationsUpdateDiscoveryEngineOptionalParams) => Promise<DiscoveryEngine>

Property Value

(projectName: string, investigationName: string, body: DiscoveryEngineUpdate, options?: InvestigationsUpdateDiscoveryEngineOptionalParams) => Promise<DiscoveryEngine>