Azure.AI.Discovery Namespace

Classes

Name Description
AzureAIDiscoveryContext

Context class which will be filled in by the System.ClientModel.SourceGeneration. For more information https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/System.ClientModel/src/docs/ModelReaderWriterContext.md

BookshelfClient

The BookshelfClient.

BookshelfClientHostExtensions

Extension methods to add BookshelfClient to an IHostApplicationBuilder.

BookshelfClientOptions

Client options for BookshelfClient.

BookshelfClientSettings

Represents the settings used to configure a BookshelfClient that can be loaded from an IConfigurationSection.

ComputeUsage

Overview of compute usage for a project.

DiscoveryCitation

A citation for a generated result.

DiscoveryConversation

A conversation.

DiscoveryConversationsClient

The DiscoveryConversationsClient sub-client.

DiscoveryEngine

Discovery engine instance.

DiscoveryInvestigation

A investigation list item.

DiscoveryInvestigationsClient

The DiscoveryInvestigationsClient sub-client.

DiscoveryModelFactory

A factory class for creating instances of the models for mocking.

DiscoveryTag

Definition of Tag.

DiscoveryTask

Task resource.

DiscoveryTasksClient

The DiscoveryTasksClient sub-client.

DiscoveryToolsClient

The DiscoveryToolsClient sub-client.

ExecutionHistoryEntry

Execution history entry for a task.

IndexingMetrics

Indexing metrics for a run.

IndexingOperationResult

Result details for an indexing operation.

InfrastructureOverrides

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.

InvestigationOperationStatus

The status of a long-running Investigation operation.

KnowledgeBase

A knowledgeBase.

KnowledgeBaseIndexingOperationResponse

Response for indexing operations.

KnowledgeBaseOperationResponse

Response indicating the KnowledgeBase operation. Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeBaseIndexingOperationResponse and KnowledgeBaseSearchOperationResponse.

KnowledgeBases

The KnowledgeBases sub-client.

KnowledgeBaseSearchOperationResponse

Response for search operations.

LastIndexingRun

The details of the last indexing run.

NodePoolUsage

Overview of compute usage for a nodepool.

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.

PagedConversation

Paged collection of Conversation items.

PagedInvestigation

Paged collection of Investigation items.

PagedOperation

Paged collection of Operation items.

PagedWorkingMemoryEntry

Paged collection of WorkingMemoryEntry items.

RunOperationStatus

Provides status details for long running operations.

RunRequestEnvironmentVariable

The RunRequestEnvironmentVariable.

RunResult

Run result.

RunResultToolReport

The RunResultToolReport.

RunResultToolReportStatusInformation

The RunResultToolReportStatusInformation.

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.

TaskAssignee

Task assignee information.

TaskComment

Task comment.

TaskResult

Task execution result.

WorkingMemoryEntry

Working memory entry.

WorkspaceClient

The WorkspaceClient.

WorkspaceClientHostExtensions

Extension methods to add WorkspaceClient to an IHostApplicationBuilder.

WorkspaceClientOptions

Client options for WorkspaceClient.

WorkspaceClientSettings

Represents the settings used to configure a WorkspaceClient that can be loaded from an IConfigurationSection.

WorkspaceOperation

Summary information for an operation.

Structs

Name Description
CitationType

The type of citation.

DiscoveryActorType

Enum for entity type.

DiscoveryEngineStatus

Discovery Engine Status.

DiscoveryProvisioningState

The resource provisioning state.

IndexingStatus

Enum for IndexingStatus.

InvestigationStatus

Status.

OperationState

Enum describing allowed operation states.

RunStatus

Enum for run status.

StorageMountProtocol

The protocol to use for mounting an storage container.

TaskPriority

Task priority level.

TaskStatus

Task status enumeration.

WorkingMemoryEntryType

Working memory entry type.

Enums

Name Description
BookshelfClientOptions.ServiceVersion

The version of the service to use.

WorkspaceClientOptions.ServiceVersion

The version of the service to use.