@azure/ai-discovery package

Classi

BookshelfClient	Client per il servizio Microsoft Discovery Bookshelf. Espone il knowledgeBases gruppo operativo per gestire e interrogare le knowledge base.
WorkspaceClient	Client per il servizio Microsoft Discovery Workspace. Espone i gruppi di operazioni con ambito di spazio di lavoro: conversations, investigations, tasks, e tools.

Interfacce

BookshelfClientOptionalParams	Parametri facoltativi per il client.
BookshelfClientRestorePollerOptions
Citation	Una citazione per un risultato generato.
ComputeUsage	Panoramica dell'uso del calcolo per un progetto.
Conversation	Una conversazione.
ConversationsCreateOptionalParams	Parametri facoltativi.
ConversationsDeleteOptionalParams	Parametri facoltativi.
ConversationsGetOptionalParams	Parametri facoltativi.
ConversationsListOptionalParams	Parametri facoltativi.
ConversationsOperations	Interfaccia che rappresenta un'operazione di Conversations.
ConversationsUpdateOptionalParams	Parametri facoltativi.
DiscoveryEngine	Istanza del motore di scoperta.
DiscoveryEngineUpdate	Richiesta di aggiornamento del motore di scoperta. Questo creerà il motore di discovery se non esiste già.
ExecutionHistoryEntry	Voce della cronologia delle esecuzioni per un compito.
IndexingMetrics	Indicizzazione delle metriche per una run.
IndexingOperationResult	Dettagli del risultato per un'operazione di indicizzazione.
InfraOverrides	Imposta esplicitamente i requisiti di esecuzione dello strumento - sovrascrive la definizione dello strumento.
InlineFile	Un file da includere nei dati di input per l'esecuzione di uno strumento e il percorso in cui sarà montato, rispetto alla directory di lavoro.
InputDataMount	URI dei dati e percorso dove saranno montati nel contenitore degli utensili.
Investigation	Un elemento della lista delle indagini.
InvestigationOperationStatus	Lo stato di un'operazione investigativa di lunga durata.
InvestigationsCreateOrReplaceOptionalParams	Parametri facoltativi.
InvestigationsDeleteOptionalParams	Parametri facoltativi.
InvestigationsGetDiscoveryEngineMemoryOptionalParams	Parametri facoltativi.
InvestigationsGetDiscoveryEngineOptionalParams	Parametri facoltativi.
InvestigationsGetOperationStatusOptionalParams	Parametri facoltativi.
InvestigationsGetOptionalParams	Parametri facoltativi.
InvestigationsListOptionalParams	Parametri facoltativi.
InvestigationsOperations	Interfaccia che rappresenta un'operazione di Investigations.
InvestigationsStartDiscoveryEngineOptionalParams	Parametri facoltativi.
InvestigationsStopDiscoveryEngineOptionalParams	Parametri facoltativi.
InvestigationsUpdateDiscoveryEngineOptionalParams	Parametri facoltativi.
InvestigationsUpdateOptionalParams	Parametri facoltativi.
KnowledgeBase	Una base di conoscenza.
KnowledgeBaseIndexingOperationResponse	Risposta per le operazioni di indicizzazione.
KnowledgeBaseOperationResponse	Risposta che indica il funzionamento della KnowledgeBase.
KnowledgeBaseSearchOperationResponse	Risposta per operazioni di ricerca.
KnowledgeBasesCancelIndexingOptionalParams	Parametri facoltativi.
KnowledgeBasesCreateOrUpdateOptionalParams	Parametri facoltativi.
KnowledgeBasesDeleteOptionalParams	Parametri facoltativi.
KnowledgeBasesGetOperationStatusOptionalParams	Parametri facoltativi.
KnowledgeBasesGetOptionalParams	Parametri facoltativi.
KnowledgeBasesListOptionalParams	Parametri facoltativi.
KnowledgeBasesOperations	Interfaccia che rappresenta le operazioni di una KnowledgeBase.
KnowledgeBasesSearchOptionalParams	Parametri facoltativi.
KnowledgeBasesStartIndexingOptionalParams	Parametri facoltativi.
LastIndexingRun	I dettagli dell'ultima serie di indicizzazione.
NodepoolUsage	Panoramica dell'uso del calcolo per un nodepool.
Operation	Informazioni riassuntive per un'operazione.
OperationStatusRunResultError	Fornisce dettagli sullo stato per le operazioni a esecuzione prolungata.
OutputDataMount	Definizione di supporto per la raccolta dei dati di output degli utensili.
OutputDataUri	Modello per fornire l'URI dell'output raccolto da un percorso container specifico.
PageSettings	Opzioni per il metodo byPage
PagedAsyncIterableIterator	Interfaccia che consente l'iterazione iterabile asincrona sia al completamento che alla pagina.
PagedConversation	Raccolta di elementi di conversazione di paging
PagedInvestigation	Collezione pagizzata degli oggetti dell'Indagine
PagedOperation	Raccolta di paging di elementi dell'operazione
PagedWorkingMemoryEntry	Collezione paginata di elementi WorkingMemoryEntry
RunResult	Risultato della corsa
SearchRequest	Il corpo della richiesta di azione di ricerca.
SearchResponse	Risultati di una ricerca nella base della conoscenza.
SearchResultItem	Un singolo elemento nei risultati di ricerca.
StartTaskRequest	Richiedi l'organizzazione per iniziare un compito.
StorageAssetReference	Riferimento a un asset di archiviazione con informazioni identità.
SupercomputerUsage	Panoramica dell'uso del calcolo per un supercomputer.
Tag	Definizione di tag
Task	Risorsa per il compito.
TaskAssignee	Informazioni sull'assegnato al compito.
TaskComment	Commento sul compito.
TaskResult	Risultato dell'esecuzione del compito.
TasksAddCommentOptionalParams	Parametri facoltativi.
TasksAddExecutionHistoryOptionalParams	Parametri facoltativi.
TasksCreateOptionalParams	Parametri facoltativi.
TasksDeleteOptionalParams	Parametri facoltativi.
TasksGetOptionalParams	Parametri facoltativi.
TasksListOptionalParams	Parametri facoltativi.
TasksOperations	Interfaccia che rappresenta le operazioni di Task.
TasksStartOptionalParams	Parametri facoltativi.
TasksUpdateOptionalParams	Parametri facoltativi.
ToolsCancelRunOptionalParams	Parametri facoltativi.
ToolsGetComputeUsageOptionalParams	Parametri facoltativi.
ToolsGetOperationsOptionalParams	Parametri facoltativi.
ToolsGetRunStatusOptionalParams	Parametri facoltativi.
ToolsOperations	Interfaccia che rappresenta le operazioni di uno strumento.
ToolsRunOptionalParams	Parametri facoltativi.
WorkingMemoryEntry	Inserimento della memoria di lavoro.
WorkspaceClientOptionalParams	Parametri facoltativi per il client.
WorkspaceClientRestorePollerOptions

Alias tipo

ByType	Enum per il tipo di entità KnownByType può essere usato in modo intercambiabile con ByType, questo enum contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Utente: Un utilizzatore umano. Applicazione: Applicazione Sistema: Il sistema backend.
CitationType	Il tipo di citazione. KnownCitationType può essere usato in modo intercambiabile con CitationType, questo enum contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio file_citation: Una citazione del fascicolo.
ContinuablePage	Interfaccia che descrive una pagina di risultati.
ConversationCreateOrUpdateContent	Le proprietà scrivibili fornite durante la creazione o l'aggiornamento di una Conversazione.
DiscoveryEngineStatus	Stato del motore Discovery KnownDiscoveryEngineStatus può essere usato in modo intercambiabile con DiscoveryEngineStatus, questo enum contiene i valori noti che il servizio supporta. Valori noti supportati dal servizio Inattivo: Discovery Engine inattivo Attivo: Discovery Engine Attivo
IndexingStatus	Enum for IndexingStatus KnownIndexingStatus può essere usato in modo intercambiabile con IndexingStatus, questo enum contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio NotStarted: Indicizzazione Non avviata Corsa: Corsa Riuscito: Riuscito Cancellato: Cancellato Non riuscito: Non riuscito
InvestigationCreateOrUpdateContent	Le proprietà scrivibili fornite durante la creazione o l'aggiornamento di un'Indagine.
InvestigationStatus	Stato di sistema KnownInvestigationStatus può essere usato in modo intercambiabile con InvestigationStatus, questo enum contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Creato: Indagine Avviata Validato: Indagine Validata Fallito: Indagine fallita
KnowledgeBaseCreateOrUpdateContent	Le proprietà scrivibili fornite durante la creazione o l'aggiornamento di una KnowledgeBase.
KnowledgeBaseOperationResponseUnion	Alias per KnowledgeBaseOperationResponseUnion
KnowledgeBaseOperationType	Stato che indica il funzionamento della KnowledgeBase. KnownKnowledgeBaseOperationType può essere usato in modo intercambiabile con KnowledgeBaseOperationType, questo enum contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Indicizzazione: un'operazione di indicizzazione. CancelIndexing: un'operazione di annullamento dell'indicizzazione. Ricerca: un'operazione di ricerca. Cancella: un'operazione di cancellazione.
OperationState	Enumerazione che descrive gli stati di funzionamento consentiti. KnownOperationState può essere usato in modo intercambiabile con OperationState, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio NotStarted: l'operazione non è stata avviata. In esecuzione: l'operazione è in corso. Succeeded: l'operazione è stata completata correttamente. Non riuscita: l'operazione non è riuscita. Annullato: l'operazione è stata annullata dall'utente.
ProvisioningState	Stato del provisioning delle risorse. KnownProvisioningState può essere usato in modo intercambiabile con ProvisioningState, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Operazione riuscita: la risorsa è stata creata. non riuscito: creazione della risorsa non riuscita. annullata: la creazione della risorsa è stata annullata. Accettato: La richiesta di creazione di risorse è stata accettata Provisioning: è in corso il provisioning della risorsa Aggiornamento: la risorsa è in fase di aggiornamento Cancellazione: La risorsa viene eliminata
RepeatabilityResult	Opzioni di header per risultati di ripetibilità
RunStatus	Enum per lo stato delle run KnownRunStatus può essere usato in modo intercambiabile con RunStatus, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio NonIniziato: Non Iniziato Corsa: Corsa Riuscito: Riuscito Cancellato: Cancellato Non riuscito: Non riuscito
StorageMountProtocol	Il protocollo da utilizzare per montare un container di stoccaggio. KnownStorageMountProtocol può essere usato in modo intercambiabile con StorageMountProtocol, questo enum contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio NFS: protocollo NFS. La versione di NFS utilizzata può variare in base al tipo di archiviazione BlobfuseCaching: Blobfuse in modalità file cache.
TaskCreateOrUpdateContent	Le proprietà scrivibili fornite durante la creazione o l'aggiornamento di un Task.
TaskPriority	Livello di priorità del compito. KnownTaskPriority può essere usato in modo intercambiabile con TaskPriority, questo enum contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Bassa: Bassa priorità Medio: Priorità media Alta: Alta priorità
TaskStatus	Enumerazione dello stato dei compiti. KnownTaskStatus può essere usato in modo intercambiabile con TaskStatus, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Nuovo: Il compito è stato creato di nuovo Attesa: Il compito è sospeso Completato: Il compito è stato completato Rimosso: Il compito è stato rimosso FlaggedHuman: Il compito è stato segnalato per la revisione umana FlaggedAi: Il compito è stato segnalato per la revisione dell'IA Esecuzione: Il compito è attualmente in esecuzione ExecutionDone: L'esecuzione del compito è completata Stantio: Il compito è diventato noioso Fallito: Il compito è fallito Incompleto: Il compito è incompleto
WorkingMemoryEntryType	Tipo di inserimento della memoria di lavoro. KnownWorkingMemoryEntryType può essere usato in modo intercambiabile con WorkingMemoryEntryType, questo enum contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Pensiero: Pensiero

Enumerazioni

KnownByType	Enum per il tipo di entità
KnownCitationType	Il tipo di citazione.
KnownDiscoveryEngineStatus	Stato del motore Discovery
KnownIndexingStatus	Enum for IndexingStatus
KnownInvestigationStatus	Condizione
KnownKnowledgeBaseOperationType	Stato che indica il funzionamento della KnowledgeBase.
KnownOperationState	Enumerazione che descrive gli stati di funzionamento consentiti.
KnownProvisioningState	Stato del provisioning delle risorse.
KnownRunStatus	Enum per lo stato delle run
KnownStorageMountProtocol	Il protocollo da utilizzare per montare un container di stoccaggio.
KnownTaskPriority	Livello di priorità del compito.
KnownTaskStatus	Enumerazione dello stato dei compiti.
KnownWorkingMemoryEntryType	Tipo di inserimento della memoria di lavoro.

Funzioni

bookshelfClientRestorePoller<TResponse, TResult>(BookshelfClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Crea un poller dallo stato serializzato di un altro poller. Questo può essere utile quando si desidera creare poller in un host diverso o un poller deve essere costruito dopo che quello originale non è nell'ambito.
isRestError(unknown)	Typeguard per RestError
workspaceClientRestorePoller<TResponse, TResult>(WorkspaceClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Crea un poller dallo stato serializzato di un altro poller. Questo può essere utile quando si desidera creare poller in un host diverso o un poller deve essere costruito dopo che quello originale non è nell'ambito.

Variabili

RestError

Tipo di errore personalizzato per le richieste di pipeline non riuscite.

Dettagli funzione

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

Crea un poller dallo stato serializzato di un altro poller. Questo può essere utile quando si desidera creare poller in un host diverso o un poller deve essere costruito dopo che quello originale non è nell'ambito.

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

Parametri

client

BookshelfClient

serializedState

string

sourceOperation

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

options

BookshelfClientRestorePollerOptions<TResult, PathUncheckedResponse>

Valori restituiti

PollerLike<OperationState<TResult>, TResult>

isRestError(unknown)

Typeguard per RestError

function isRestError(e: unknown): e

Parametri

e

unknown

Un elemento rilevato da una clausola catch.

Valori restituiti

e

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

Crea un poller dallo stato serializzato di un altro poller. Questo può essere utile quando si desidera creare poller in un host diverso o un poller deve essere costruito dopo che quello originale non è nell'ambito.

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

Parametri

client

WorkspaceClient

serializedState

string

sourceOperation

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

options

WorkspaceClientRestorePollerOptions<TResult, PathUncheckedResponse>

Valori restituiti

PollerLike<OperationState<TResult>, TResult>

Dettagli delle variabili

RestError

Tipo di errore personalizzato per le richieste di pipeline non riuscite.

RestError: RestErrorConstructor

Tipo

RestErrorConstructor