@azure/ai-discovery package

Classes

BookshelfClient	Client for the Microsoft Discovery Bookshelf service. Exposes the `knowledgeBases` operation group for managing and querying knowledge bases.
WorkspaceClient	Client for the Microsoft Discovery Workspace service. Exposes the workspace-scoped operation groups: `conversations`, `investigations`, `tasks`, and `tools`.

Interfaces

BookshelfClientOptionalParams	Optional parameters for the client.
BookshelfClientRestorePollerOptions
Citation	A citation for a generated result.
ComputeUsage	Overview of compute usage for a project.
Conversation	A conversation.
ConversationsCreateOptionalParams	Optional parameters.
ConversationsDeleteOptionalParams	Optional parameters.
ConversationsGetOptionalParams	Optional parameters.
ConversationsListOptionalParams	Optional parameters.
ConversationsOperations	Interface representing a Conversations operations.
ConversationsUpdateOptionalParams	Optional parameters.
DiscoveryEngine	Discovery engine instance.
DiscoveryEngineUpdate	Discovery Engine Update Request. This will create the discovery engine if it does not already exist.
ExecutionHistoryEntry	Execution history entry for a task.
IndexingMetrics	Indexing metrics for a run.
IndexingOperationResult	Result details for an indexing operation.
InfraOverrides	Explicitly set tool run requirements - overrides the tool definition.
InlineFile	A file to be included in the input data for a tool run and the path where it will be mounted, relative to the working directory.
InputDataMount	Data URI and path where it will be mounted in the tool container.
Investigation	A investigation list item.
InvestigationOperationStatus	The status of a long-running Investigation operation.
InvestigationsCreateOrReplaceOptionalParams	Optional parameters.
InvestigationsDeleteOptionalParams	Optional parameters.
InvestigationsGetDiscoveryEngineMemoryOptionalParams	Optional parameters.
InvestigationsGetDiscoveryEngineOptionalParams	Optional parameters.
InvestigationsGetOperationStatusOptionalParams	Optional parameters.
InvestigationsGetOptionalParams	Optional parameters.
InvestigationsListOptionalParams	Optional parameters.
InvestigationsOperations	Interface representing a Investigations operations.
InvestigationsStartDiscoveryEngineOptionalParams	Optional parameters.
InvestigationsStopDiscoveryEngineOptionalParams	Optional parameters.
InvestigationsUpdateDiscoveryEngineOptionalParams	Optional parameters.
InvestigationsUpdateOptionalParams	Optional parameters.
KnowledgeBase	A knowledgeBase.
KnowledgeBaseIndexingOperationResponse	Response for indexing operations.
KnowledgeBaseOperationResponse	Response indicating the KnowledgeBase operation.
KnowledgeBaseSearchOperationResponse	Response for search operations.
KnowledgeBasesCancelIndexingOptionalParams	Optional parameters.
KnowledgeBasesCreateOrUpdateOptionalParams	Optional parameters.
KnowledgeBasesDeleteOptionalParams	Optional parameters.
KnowledgeBasesGetOperationStatusOptionalParams	Optional parameters.
KnowledgeBasesGetOptionalParams	Optional parameters.
KnowledgeBasesListOptionalParams	Optional parameters.
KnowledgeBasesOperations	Interface representing a KnowledgeBases operations.
KnowledgeBasesSearchOptionalParams	Optional parameters.
KnowledgeBasesStartIndexingOptionalParams	Optional parameters.
LastIndexingRun	The details of the last indexing run.
NodepoolUsage	Overview of compute usage for a nodepool.
Operation	Summary information for an operation.
OperationStatusRunResultError	Provides status details for long running operations.
OutputDataMount	Definition of a mount for collecting tool output data.
OutputDataUri	Model for providing the URI of the output collected from a specific container path.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PagedConversation	Paged collection of Conversation items
PagedInvestigation	Paged collection of Investigation items
PagedOperation	Paged collection of Operation items
PagedWorkingMemoryEntry	Paged collection of WorkingMemoryEntry items
RunResult	Run result
SearchRequest	The search action request body.
SearchResponse	Results of a knowledge base search.
SearchResultItem	A single search result item.
StartTaskRequest	Request body for starting a task.
StorageAssetReference	Reference to a storage asset with identity information.
SupercomputerUsage	Overview of compute usage for a supercomputer.
Tag	Definition of Tag
Task	Task resource.
TaskAssignee	Task assignee information.
TaskComment	Task comment.
TaskResult	Task execution result.
TasksAddCommentOptionalParams	Optional parameters.
TasksAddExecutionHistoryOptionalParams	Optional parameters.
TasksCreateOptionalParams	Optional parameters.
TasksDeleteOptionalParams	Optional parameters.
TasksGetOptionalParams	Optional parameters.
TasksListOptionalParams	Optional parameters.
TasksOperations	Interface representing a Tasks operations.
TasksStartOptionalParams	Optional parameters.
TasksUpdateOptionalParams	Optional parameters.
ToolsCancelRunOptionalParams	Optional parameters.
ToolsGetComputeUsageOptionalParams	Optional parameters.
ToolsGetOperationsOptionalParams	Optional parameters.
ToolsGetRunStatusOptionalParams	Optional parameters.
ToolsOperations	Interface representing a Tools operations.
ToolsRunOptionalParams	Optional parameters.
WorkingMemoryEntry	Working memory entry.
WorkspaceClientOptionalParams	Optional parameters for the client.
WorkspaceClientRestorePollerOptions

Type Aliases

ByType	Enum for entity type KnownByType can be used interchangeably with ByType, this enum contains the known values that the service supports. Known values supported by the service User: A human user. Application: Application System: The backend system.
CitationType	The type of citation. KnownCitationType can be used interchangeably with CitationType, this enum contains the known values that the service supports. Known values supported by the service file_citation: A file citation.
ContinuablePage	An interface that describes a page of results.
ConversationCreateOrUpdateContent	The writable properties supplied when creating or updating a Conversation.
DiscoveryEngineStatus	Discovery Engine Status KnownDiscoveryEngineStatus can be used interchangeably with DiscoveryEngineStatus, this enum contains the known values that the service supports. Known values supported by the service Inactive: Discovery Engine Inactive Active: Discovery Engine Active
IndexingStatus	Enum for IndexingStatus KnownIndexingStatus can be used interchangeably with IndexingStatus, this enum contains the known values that the service supports. Known values supported by the service NotStarted: Indexing Not started Running: Running Succeeded: Succeeded Canceled: Canceled Failed: Failed
InvestigationCreateOrUpdateContent	The writable properties supplied when creating or updating an Investigation.
InvestigationStatus	Status KnownInvestigationStatus can be used interchangeably with InvestigationStatus, this enum contains the known values that the service supports. Known values supported by the service Created: Investigation Created Validated: Investigation Validated Failed: Investigation Failed
KnowledgeBaseCreateOrUpdateContent	The writable properties supplied when creating or updating a KnowledgeBase.
KnowledgeBaseOperationResponseUnion	Alias for KnowledgeBaseOperationResponseUnion
KnowledgeBaseOperationType	Status indicating the KnowledgeBase operation. KnownKnowledgeBaseOperationType can be used interchangeably with KnowledgeBaseOperationType, this enum contains the known values that the service supports. Known values supported by the service Indexing: An indexing operation. CancelIndexing: A cancel indexing operation. Search: A search operation. Delete: A delete operation.
OperationState	Enum describing allowed operation states. KnownOperationState can be used interchangeably with OperationState, this enum contains the known values that the service supports. Known values supported by the service NotStarted: The operation has not started. Running: The operation is in progress. Succeeded: The operation has completed successfully. Failed: The operation has failed. Canceled: The operation has been canceled by the user.
ProvisioningState	The resource provisioning state. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled. Accepted: The resource create request has been accepted Provisioning: The resource is being provisioned Updating: The resource is updating Deleting: The resource is being deleted
RepeatabilityResult	Repeatability Result header options
RunStatus	Enum for run status KnownRunStatus can be used interchangeably with RunStatus, this enum contains the known values that the service supports. Known values supported by the service NotStarted: Not Started Running: Running Succeeded: Succeeded Canceled: Canceled Failed: Failed
StorageMountProtocol	The protocol to use for mounting an storage container. KnownStorageMountProtocol can be used interchangeably with StorageMountProtocol, this enum contains the known values that the service supports. Known values supported by the service NFS: NFS protocol. Version of NFS used may vary based on storage type BlobfuseCaching: Blobfuse in file cache mode.
TaskCreateOrUpdateContent	The writable properties supplied when creating or updating a Task.
TaskPriority	Task priority level. KnownTaskPriority can be used interchangeably with TaskPriority, this enum contains the known values that the service supports. Known values supported by the service Low: Low priority Medium: Medium priority High: High priority
TaskStatus	Task status enumeration. KnownTaskStatus can be used interchangeably with TaskStatus, this enum contains the known values that the service supports. Known values supported by the service New: The task is newly created OnHold: The task is on hold Complete: The task has been completed Removed: The task has been removed FlaggedHuman: The task has been flagged for human review FlaggedAi: The task has been flagged for AI review Executing: The task is currently executing ExecutionDone: The task execution is done Stale: The task has become stale Failed: The task has failed Incomplete: The task is incomplete
WorkingMemoryEntryType	Working memory entry type. KnownWorkingMemoryEntryType can be used interchangeably with WorkingMemoryEntryType, this enum contains the known values that the service supports. Known values supported by the service Thought: Thought

Enums

KnownByType	Enum for entity type
KnownCitationType	The type of citation.
KnownDiscoveryEngineStatus	Discovery Engine Status
KnownIndexingStatus	Enum for IndexingStatus
KnownInvestigationStatus	Status
KnownKnowledgeBaseOperationType	Status indicating the KnowledgeBase operation.
KnownOperationState	Enum describing allowed operation states.
KnownProvisioningState	The resource provisioning state.
KnownRunStatus	Enum for run status
KnownStorageMountProtocol	The protocol to use for mounting an storage container.
KnownTaskPriority	Task priority level.
KnownTaskStatus	Task status enumeration.
KnownWorkingMemoryEntryType	Working memory entry type.

Functions

bookshelfClientRestorePoller<TResponse, TResult>(BookshelfClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.
isRestError(unknown)	Typeguard for RestError
workspaceClientRestorePoller<TResponse, TResult>(WorkspaceClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

bookshelfClientRestorePoller<TResponse, TResult>(BookshelfClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function bookshelfClientRestorePoller<TResponse, TResult>(client: BookshelfClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: BookshelfClient

serializedState: string

sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>

options: BookshelfClientRestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

e

workspaceClientRestorePoller<TResponse, TResult>(WorkspaceClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function workspaceClientRestorePoller<TResponse, TResult>(client: WorkspaceClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: WorkspaceClient

serializedState: string

sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>

options: WorkspaceClientRestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/ai-discovery package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

bookshelfClientRestorePoller<TResponse, TResult>(BookshelfClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Parameters

Returns

isRestError(unknown)

Parameters

Returns

workspaceClientRestorePoller<TResponse, TResult>(WorkspaceClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Parameters

Returns

Variable Details

RestError

Type