@azure/ai-discovery package

Classes

BookshelfClient	Cliente do serviço Microsoft Discovery Bookshelf. Expõe o knowledgeBases grupo operacional para gerir e consultar bases de conhecimento.
WorkspaceClient	Cliente do serviço Microsoft Discovery Workspace. Expõe os grupos de operações com âmbito de espaço de trabalho: conversations, investigations, tasks, e tools.

Interfaces

BookshelfClientOptionalParams	Parâmetros opcionais para o cliente.
BookshelfClientRestorePollerOptions
Citation	Uma citação para um resultado gerado.
ComputeUsage	Visão geral da utilização de computação para um projeto.
Conversation	Uma conversa.
ConversationsCreateOptionalParams	Parâmetros opcionais.
ConversationsDeleteOptionalParams	Parâmetros opcionais.
ConversationsGetOptionalParams	Parâmetros opcionais.
ConversationsListOptionalParams	Parâmetros opcionais.
ConversationsOperations	Interface representando operações de conversa.
ConversationsUpdateOptionalParams	Parâmetros opcionais.
DiscoveryEngine	Instância do motor de descoberta.
DiscoveryEngineUpdate	Pedido de atualização do motor de descoberta. Isto criará o motor de descoberta, caso ainda não exista.
ExecutionHistoryEntry	Entrada no histórico de execução de uma tarefa.
IndexingMetrics	Indexar métricas para uma corrida.
IndexingOperationResult	Detalhes do resultado para uma operação de indexação.
InfraOverrides	Definir explicitamente os requisitos de execução da ferramenta – sobrepõe-se à definição da ferramenta.
InlineFile	Um ficheiro a ser incluído nos dados de entrada para uma execução de ferramenta e o caminho onde será montado, relativo ao diretório de trabalho.
InputDataMount	URI de dados e caminho onde será montado no contentor da ferramenta.
Investigation	Um item da lista de investigação.
InvestigationOperationStatus	O estado de uma operação de investigação de longa duração.
InvestigationsCreateOrReplaceOptionalParams	Parâmetros opcionais.
InvestigationsDeleteOptionalParams	Parâmetros opcionais.
InvestigationsGetDiscoveryEngineMemoryOptionalParams	Parâmetros opcionais.
InvestigationsGetDiscoveryEngineOptionalParams	Parâmetros opcionais.
InvestigationsGetOperationStatusOptionalParams	Parâmetros opcionais.
InvestigationsGetOptionalParams	Parâmetros opcionais.
InvestigationsListOptionalParams	Parâmetros opcionais.
InvestigationsOperations	Interface representando operações de Investigações.
InvestigationsStartDiscoveryEngineOptionalParams	Parâmetros opcionais.
InvestigationsStopDiscoveryEngineOptionalParams	Parâmetros opcionais.
InvestigationsUpdateDiscoveryEngineOptionalParams	Parâmetros opcionais.
InvestigationsUpdateOptionalParams	Parâmetros opcionais.
KnowledgeBase	Uma base de conhecimento.
KnowledgeBaseIndexingOperationResponse	Resposta para operações de indexação.
KnowledgeBaseOperationResponse	Resposta indicando a operação da KnowledgeBase.
KnowledgeBaseSearchOperationResponse	Resposta para operações de busca.
KnowledgeBasesCancelIndexingOptionalParams	Parâmetros opcionais.
KnowledgeBasesCreateOrUpdateOptionalParams	Parâmetros opcionais.
KnowledgeBasesDeleteOptionalParams	Parâmetros opcionais.
KnowledgeBasesGetOperationStatusOptionalParams	Parâmetros opcionais.
KnowledgeBasesGetOptionalParams	Parâmetros opcionais.
KnowledgeBasesListOptionalParams	Parâmetros opcionais.
KnowledgeBasesOperations	Interface representando as operações de uma Base de Conhecimento.
KnowledgeBasesSearchOptionalParams	Parâmetros opcionais.
KnowledgeBasesStartIndexingOptionalParams	Parâmetros opcionais.
LastIndexingRun	Os detalhes da última sequência de indexação.
NodepoolUsage	Visão geral da utilização de computação para um nodepool.
Operation	Informação resumida para uma operação.
OperationStatusRunResultError	Fornece detalhes de status para operações de longa duração.
OutputDataMount	Definição de montagem para recolha de dados de saída de ferramenta.
OutputDataUri	Modelo para fornecer o URI da saída recolhida de um caminho específico do contentor.
PageSettings	Opções para o método byPage
PagedAsyncIterableIterator	Uma interface que permite iteração assíncrona iterável até a conclusão e por página.
PagedConversation	Coleção paginada de itens de Conversação
PagedInvestigation	Coleção paginada de itens da Investigação
PagedOperation	Coleção paginada de itens de operação
PagedWorkingMemoryEntry	Coleção paginada de itens WorkingMemoryEntry
RunResult	Resultado da corrida
SearchRequest	O corpo do pedido de ação de busca.
SearchResponse	Resultados de uma pesquisa numa base de conhecimento.
SearchResultItem	Um único item de resultado de pesquisa.
StartTaskRequest	Solicite ao corpo para iniciar uma tarefa.
StorageAssetReference	Referência a um ativo de armazenamento com informação de identidade.
SupercomputerUsage	Visão geral da utilização de computação para um supercomputador.
Tag	Definição de etiqueta
Task	Recurso de tarefa.
TaskAssignee	Informação do destinatário da tarefa.
TaskComment	Comentário da tarefa.
TaskResult	Resultado da execução da tarefa.
TasksAddCommentOptionalParams	Parâmetros opcionais.
TasksAddExecutionHistoryOptionalParams	Parâmetros opcionais.
TasksCreateOptionalParams	Parâmetros opcionais.
TasksDeleteOptionalParams	Parâmetros opcionais.
TasksGetOptionalParams	Parâmetros opcionais.
TasksListOptionalParams	Parâmetros opcionais.
TasksOperations	Interface representando operações de Tarefas.
TasksStartOptionalParams	Parâmetros opcionais.
TasksUpdateOptionalParams	Parâmetros opcionais.
ToolsCancelRunOptionalParams	Parâmetros opcionais.
ToolsGetComputeUsageOptionalParams	Parâmetros opcionais.
ToolsGetOperationsOptionalParams	Parâmetros opcionais.
ToolsGetRunStatusOptionalParams	Parâmetros opcionais.
ToolsOperations	Interface representando uma operação de ferramentas.
ToolsRunOptionalParams	Parâmetros opcionais.
WorkingMemoryEntry	Introdução de memória de trabalho.
WorkspaceClientOptionalParams	Parâmetros opcionais para o cliente.
WorkspaceClientRestorePollerOptions

Aliases de Tipo

ByType	Enum para o tipo de entidade KnownByType pode ser usado de forma intercambiável com ByType, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Utilizador: Um utilizador humano. Aplicação: Aplicação Sistema: O sistema de backend.
CitationType	O tipo de citação. KnownCitationType pode ser usado de forma intercambiável com CitationType, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço file_citation: Uma citação de ficheiro.
ContinuablePage	Uma interface que descreve uma página de resultados.
ConversationCreateOrUpdateContent	As propriedades graváveis fornecidas ao criar ou atualizar uma Conversa.
DiscoveryEngineStatus	Estado do Motor de Descoberta KnowDiscoveryEngineStatus pode ser usado de forma intercambiável com DiscoveryEngineStatus, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Inativo: Motor de Descoberta Inativo Ativo: Motor de Descoberta Ativo
IndexingStatus	Enum for IndexingStatus KnownIndexingStatus pode ser usado de forma intercambiável com IndexingStatus, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço NotStarted: Indexação Não iniciada Corrida: Corrida Conseguido: Bem sucedido Cancelado: Cancelado Falha: Falha
InvestigationCreateOrUpdateContent	As propriedades graváveis fornecidas ao criar ou atualizar uma Investigação.
InvestigationStatus	Situação KnownInvestigationStatus pode ser usado de forma intercambiável com InvestigationStatus, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Criado: Investigação Criada Validado: Investigação Validada Falhado: Investigação Falhada
KnowledgeBaseCreateOrUpdateContent	As propriedades graváveis fornecidas ao criar ou atualizar uma Base de Conhecimento.
KnowledgeBaseOperationResponseUnion	Alias para KnowledgeBaseOperationResponseUnion
KnowledgeBaseOperationType	Estado indicando a operação da KnowledgeBase. KnowKnowledgeBaseOperationType pode ser usado de forma intercambiável com KnowledgeBaseOperationType, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Indexação: Uma operação de indexação. CancelIndexing: Uma operação de cancelar indexação. Busca: Uma operação de busca. Eliminar: Uma operação de eliminação.
OperationState	Enum descrevendo estados de operação permitidos. KnownOperationState pode ser usado de forma intercambiável com OperationState, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço NotStarted: A operação não foi iniciada. Em execução: A operação está em andamento. Êxito: A operação foi concluída com êxito. Falha: A operação falhou. Cancelado: A operação foi cancelada pelo usuário.
ProvisioningState	O estado de provisionamento de recursos. KnownProvisioningState pode ser usado de forma intercambiável com ProvisioningState, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Successful: O recurso foi criado. Falha: Falha na criação de recursos. cancelado: A criação de recursos foi cancelada. Aceite: O pedido de criação de recursos foi aceite Provisionamento: O recurso está sendo provisionado Atualização: O recurso está sendo atualizado Eliminação: O recurso está a ser eliminado
RepeatabilityResult	Opções de cabeçalho de resultados de repetibilidade
RunStatus	Enum para o estado da corrida KnownRunStatus pode ser usado de forma intercambiável com RunStatus, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço NotStarted: Not Started Corrida: Corrida Conseguido: Bem sucedido Cancelado: Cancelado Falha: Falha
StorageMountProtocol	O protocolo a usar para montar um contentor de armazenamento. O KnowStorageMountProtocol pode ser usado de forma intercambiável com o StorageMountProtocol, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço NFS: protocolo NFS. A versão do NFS utilizada pode variar consoante o tipo de armazenamento BlobfuseCaching: Blobfuse no modo de cache de ficheiros.
TaskCreateOrUpdateContent	As propriedades graváveis fornecidas ao criar ou atualizar uma Tarefa.
TaskPriority	Nível de prioridade de tarefa. ConhecidaPrioridade de Tarefas pode ser usada de forma intercambiável com Prioridade de Tarefa, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Baixa: Baixa prioridade Média: Prioridade média Alta: Alta prioridade
TaskStatus	Enumeração do estado da tarefa. KnownTaskStatus pode ser usado de forma intercambiável com TaskStatus, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Novo: A tarefa é recentemente criada Em Espera: A tarefa está suspensa Concluído: A tarefa foi concluída Removida: A tarefa foi removida FlaggedHuman: A tarefa foi assinalada para revisão humana FlaggedAi: A tarefa foi assinalada para revisão por IA Execução: A tarefa está atualmente a ser executada ExecutionDone: A execução da tarefa está concluída Estagnado: A tarefa tornou-se monótona Falhou: A tarefa falhou Incompleto: A tarefa está incompleta
WorkingMemoryEntryType	Tipo de entrada de memória de trabalho. KnowWorkingMemoryEntryType pode ser usado de forma intercambiável com WorkingMemoryEntryType, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Pensamento: Pensamento

Enumerações

KnownByType	Enum para o tipo de entidade
KnownCitationType	O tipo de citação.
KnownDiscoveryEngineStatus	Estado do Motor de Descoberta
KnownIndexingStatus	Enum for IndexingStatus
KnownInvestigationStatus	Situação
KnownKnowledgeBaseOperationType	Estado indicando a operação da KnowledgeBase.
KnownOperationState	Enum descrevendo estados de operação permitidos.
KnownProvisioningState	O estado de provisionamento de recursos.
KnownRunStatus	Enum para o estado da corrida
KnownStorageMountProtocol	O protocolo a usar para montar um contentor de armazenamento.
KnownTaskPriority	Nível de prioridade de tarefa.
KnownTaskStatus	Enumeração do estado da tarefa.
KnownWorkingMemoryEntryType	Tipo de entrada de memória de trabalho.

Funções

bookshelfClientRestorePoller<TResponse, TResult>(BookshelfClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.
isRestError(unknown)	Typeguard para RestError
workspaceClientRestorePoller<TResponse, TResult>(WorkspaceClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.

Variáveis

RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.

Detalhes de Função

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

Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.

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

Parâmetros

client

BookshelfClient

serializedState

string

sourceOperation

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

options

BookshelfClientRestorePollerOptions<TResult, PathUncheckedResponse>

Devoluções

PollerLike<OperationState<TResult>, TResult>

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parâmetros

e

unknown

Algo apanhado por uma cláusula de captura.

Devoluções

e

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

Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.

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

Parâmetros

client

WorkspaceClient

serializedState

string

sourceOperation

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

options

WorkspaceClientRestorePollerOptions<TResult, PathUncheckedResponse>

Devoluções

PollerLike<OperationState<TResult>, TResult>

Detalhes das variáveis

RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.

RestError: RestErrorConstructor

Tipo

RestErrorConstructor