@azure/ai-discovery package

Classes

BookshelfClient	Cliente do serviço Microsoft Discovery Bookshelf. Expõe o `knowledgeBases` grupo operacional para gerenciar e consultar bases de conhecimento.
WorkspaceClient	Cliente do serviço Microsoft Discovery Workspace. Expõe os grupos de operações com escopo 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 do uso 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 uma operação de Conversas.
ConversationsUpdateOptionalParams	Parâmetros opcionais.
DiscoveryEngine	Instância do motor de descoberta.
DiscoveryEngineUpdate	Solicitação de atualização do Discovery Engine. Isso criará o motor de descoberta, caso ele ainda não exista.
ExecutionHistoryEntry	Entrada do histórico de execução de uma tarefa.
IndexingMetrics	Indexando métricas para uma sequência.
IndexingOperationResult	Detalhes do resultado para uma operação de indexação.
InfraOverrides	Definir explicitamente os requisitos de execução da ferramenta – sobrepõe a definição da ferramenta.
InlineFile	Um arquivo a ser incluído nos dados de entrada para a execução de uma ferramenta e o caminho onde ele será montado, em relação ao diretório de trabalho.
InputDataMount	URI de dados e caminho onde ele será montado no contêiner da ferramenta.
Investigation	Um item da lista de investigação.
InvestigationOperationStatus	O status 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 uma operação 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 KnowledgeBase.
KnowledgeBasesSearchOptionalParams	Parâmetros opcionais.
KnowledgeBasesStartIndexingOptionalParams	Parâmetros opcionais.
LastIndexingRun	Os detalhes da última sequência de indexação.
NodepoolUsage	Visão geral do uso de computação para um nodepool.
Operation	Informações resumidas para uma operação.
OperationStatusRunResultError	Fornece detalhes de status para operações de execução longa.
OutputDataMount	Definição de suporte para coleta de dados de saída de ferramenta.
OutputDataUri	Modelo para fornecer o URI da saída coletada de um caminho específico de container.
PageSettings	Opções para o método byPage
PagedAsyncIterableIterator	Uma interface que permite iteração assíncrona iterável tanto para conclusão quanto por página.
PagedConversation	Coleção paginada de itens de conversa
PagedInvestigation	Coleção paginada de itens de investigação
PagedOperation	Coleção paginada de itens da operação
PagedWorkingMemoryEntry	Coleção paginada de itens do WorkingMemoryEntry
RunResult	Resultado da corrida
SearchRequest	O corpo do pedido de ação de busca.
SearchResponse	Resultados de uma busca na base de conhecimento.
SearchResultItem	Um único item de resultado de busca.
StartTaskRequest	Solicite ao corpo para iniciar uma tarefa.
StorageAssetReference	Referência a um ativo de armazenamento com informações de identidade.
SupercomputerUsage	Visão geral do uso de computação para um supercomputador.
Tag	Definição de Tag
Task	Recurso de tarefa.
TaskAssignee	Informações do destinatário da tarefa.
TaskComment	Comentário sobre a 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 as operações de uma ferramenta.
ToolsRunOptionalParams	Parâmetros opcionais.
WorkingMemoryEntry	Entrada de memória de trabalho.
WorkspaceClientOptionalParams	Parâmetros opcionais para o cliente.
WorkspaceClientRestorePollerOptions

Aliases de tipo

ByType	Enum para tipo de entidade KnownByType pode ser usado de forma intercambiável com ByType, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos compatíveis com o serviço Usuário: Um usuário 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, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos compatíveis com o serviço file_citation: Uma citação de arquivo.
ContinuablePage	Uma interface que descreve uma página de resultados.
ConversationCreateOrUpdateContent	As propriedades graváveis fornecidas ao criar ou atualizar uma Conversa.
DiscoveryEngineStatus	Status do Motor Discovery KnownDiscoveryEngineStatus pode ser usado de forma intercambiável com DiscoveryEngineStatus, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos compatíveis com o serviço Inativo: Discovery Engine Inativo Ativo: Motor de Descoberta Ativo
IndexingStatus	Enum for IndexingStatus KnownIndexingStatus pode ser usado de forma intercambiável com IndexingStatus, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos compatíveis com o serviço NotStarted: Indexação Não iniciada Correndo: Correndo Bem sucedido: Bem sucedido Cancelado: Cancelado Falha: Falha
InvestigationCreateOrUpdateContent	As propriedades graváveis fornecidas ao criar ou atualizar uma Investigação.
InvestigationStatus	Status KnownInvestigationStatus pode ser usado de forma intercambiável com InvestigationStatus, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos compatíveis com o serviço Criado: Investigação Criada Validado: Investigação Validada Fracassado: Investigação Falhada
KnowledgeBaseCreateOrUpdateContent	As propriedades graváveis fornecidas ao criar ou atualizar uma KnowledgeBase.
KnowledgeBaseOperationResponseUnion	Alias para KnowledgeBaseOperationResponseUnion
KnowledgeBaseOperationType	Status 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 compatíveis com o serviço Indexação: Uma operação de indexação. CancelIndexing: Uma operação de cancelar indexação. Busca: Uma operação de busca. Exclusão: Uma operação de deleção.
OperationState	Enumeração que descreve os estados de operação permitidos. KnownOperationState pode ser usado de forma intercambiável com OperationState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço NotStarted: a operação não foi iniciada. Em execução: a operação está em andamento. Bem-sucedida: 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, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço bem-sucedido: o recurso foi criado. falha no: falha na criação de recursos. cancelou: a criação de recursos foi cancelada. Aceito: A solicitação de criação de recurso foi aceita Provisionamento: o recurso está sendo provisionado Atualizando: o recurso está atualizando Excluindo: O recurso está sendo excluído
RepeatabilityResult	Opções de cabeçalho de resultados de repetibilidade
RunStatus	Enum para status de execução KnownRunStatus pode ser usado de forma intercambiável com RunStatus, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço NotStarted: Not Started Correndo: Correndo Bem sucedido: Bem sucedido Cancelado: Cancelado Falha: Falha
StorageMountProtocol	O protocolo a ser usado para montar um contêiner de armazenamento. KnowStorageMountProtocol pode ser usado de forma intercambiável com StorageMountProtocol, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos compatíveis com o serviço NFS: protocolo NFS. A versão do NFS usada pode variar dependendo do tipo de armazenamento BlobfuseCaching: Blobfuse no modo cache de arquivos.
TaskCreateOrUpdateContent	As propriedades graváveis fornecidas ao criar ou atualizar uma tarefa.
TaskPriority	Nível de prioridade de tarefa. ConhecidaPrioridade de Tarefa pode ser usada de forma intercambiável com Prioridade de Tarefa, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos compatíveis com o serviço Baixa: Baixa prioridade Média: Prioridade média Alta: Alta prioridade
TaskStatus	Enumeração de status de tarefa. KnownTaskStatus pode ser usado de forma intercambiável com TaskStatus, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Novo: A tarefa é recém-criada Em espera: A tarefa está suspensa Concluído: A tarefa foi concluída Removida: A tarefa foi removida FlaggedHuman: A tarefa foi sinalizada para revisão humana FlaggedAi: A tarefa foi sinalizada para revisão por IA Executando: A tarefa está atualmente em execução ExecutionDone: A execução da tarefa está concluída Estagnado: A tarefa ficou estagnada Fracassado: A tarefa falhou Incompleto: A tarefa está incompleta
WorkingMemoryEntryType	Tipo de entrada de memória de trabalho. KnownWorkingMemoryEntryType pode ser usado de forma intercambiável com WorkingMemoryEntryType, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos compatíveis com o serviço Pensamento: Pensamento

Enumerações

KnownByType	Enum para tipo de entidade
KnownCitationType	O tipo de citação.
KnownDiscoveryEngineStatus	Status do Motor Discovery
KnownIndexingStatus	Enum for IndexingStatus
KnownInvestigationStatus	Status
KnownKnowledgeBaseOperationType	Status indicando a operação da KnowledgeBase.
KnownOperationState	Enumeração que descreve os estados de operação permitidos.
KnownProvisioningState	O estado de provisionamento de recursos.
KnownRunStatus	Enum para status de execução
KnownStorageMountProtocol	O protocolo a ser usado para montar um contêiner de armazenamento.
KnownTaskPriority	Nível de prioridade de tarefa.
KnownTaskStatus	Enumeração de status de 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 sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver no escopo.
isRestError(unknown)	Typeguard para RestError
workspaceClientRestorePoller<TResponse, TResult>(WorkspaceClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Cria um sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver no escopo.

Variáveis

RestError

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

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

Cria um sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver 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>

Retornos

PollerLike<OperationState<TResult>, TResult>

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parâmetros

e: unknown

Algo pego por uma cláusula catch.

Retornos

e

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

Cria um sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver 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>

Retornos

PollerLike<OperationState<TResult>, TResult>

RestError

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

RestError: RestErrorConstructor

Tipo

RestErrorConstructor

@azure/ai-discovery package

Classes

Interfaces

Aliases de tipo

Valores conhecidos compatíveis com o serviço

Valores conhecidos compatíveis com o serviço

Valores conhecidos compatíveis com o serviço

Valores conhecidos compatíveis com o serviço

Valores conhecidos compatíveis com o serviço

Valores conhecidos compatíveis com o serviço

Valores conhecidos compatíveis com o serviço

Valores conhecidos compatíveis com o serviço

Valores conhecidos compatíveis com o serviço

Valores conhecidos compatíveis com o serviço

Valores conhecidos compatíveis com o serviço

Valores conhecidos compatíveis com o serviço

Valores conhecidos compatíveis com o serviço

Enumerações

Funções

Variáveis

Detalhes da função

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

Parâmetros

Retornos

isRestError(unknown)

Parâmetros

Retornos

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

Parâmetros

Retornos

Detalhes da variável

RestError

Tipo