@azure/ai-discovery package

Classes

BookshelfClient	Client pour le service Microsoft Discovery Bookshelf. Expose le `knowledgeBases` groupe opérationnel à la gestion et à l’interrogation des bases de connaissances.
WorkspaceClient	Client pour le service Microsoft Discovery Workspace. Expose les groupes d’opérations à portée d’espace de travail : `conversations`, `investigations`, `tasks`, et `tools`.

Interfaces

BookshelfClientOptionalParams	Paramètres facultatifs pour le client.
BookshelfClientRestorePollerOptions
Citation	Une citation pour un résultat généré.
ComputeUsage	Aperçu de l’utilisation du calcul pour un projet.
Conversation	Une conversation.
ConversationsCreateOptionalParams	Paramètres facultatifs.
ConversationsDeleteOptionalParams	Paramètres facultatifs.
ConversationsGetOptionalParams	Paramètres facultatifs.
ConversationsListOptionalParams	Paramètres facultatifs.
ConversationsOperations	Interface représentant une opération de conversation.
ConversationsUpdateOptionalParams	Paramètres facultatifs.
DiscoveryEngine	Instance du moteur de découverte.
DiscoveryEngineUpdate	Demande de mise à jour du moteur de découverte. Cela créera le moteur de découverte s’il n’existe pas déjà.
ExecutionHistoryEntry	Entrée de l’historique d’exécution pour une tâche.
IndexingMetrics	Indexation des métriques pour une partie.
IndexingOperationResult	Détails des résultats pour une opération d’indexation.
InfraOverrides	Définir explicitement les exigences d’exécution de l’outil - cela supprime la définition de l’outil.
InlineFile	Un fichier à inclure dans les données d’entrée pour une exécution d’outil et le chemin où il sera monté, par rapport au répertoire de travail.
InputDataMount	L’URI des données et le chemin où il sera monté dans le conteneur d’outils.
Investigation	Un élément de liste d’enquête.
InvestigationOperationStatus	L’état d’une opération d’enquête de longue date.
InvestigationsCreateOrReplaceOptionalParams	Paramètres facultatifs.
InvestigationsDeleteOptionalParams	Paramètres facultatifs.
InvestigationsGetDiscoveryEngineMemoryOptionalParams	Paramètres facultatifs.
InvestigationsGetDiscoveryEngineOptionalParams	Paramètres facultatifs.
InvestigationsGetOperationStatusOptionalParams	Paramètres facultatifs.
InvestigationsGetOptionalParams	Paramètres facultatifs.
InvestigationsListOptionalParams	Paramètres facultatifs.
InvestigationsOperations	Interface représentant une opération d’Investigations.
InvestigationsStartDiscoveryEngineOptionalParams	Paramètres facultatifs.
InvestigationsStopDiscoveryEngineOptionalParams	Paramètres facultatifs.
InvestigationsUpdateDiscoveryEngineOptionalParams	Paramètres facultatifs.
InvestigationsUpdateOptionalParams	Paramètres facultatifs.
KnowledgeBase	Une base de connaissances.
KnowledgeBaseIndexingOperationResponse	Réponse pour les opérations d’indexation.
KnowledgeBaseOperationResponse	Réponse indiquant le fonctionnement de la KnowledgeBase.
KnowledgeBaseSearchOperationResponse	Réponse pour les opérations de recherche.
KnowledgeBasesCancelIndexingOptionalParams	Paramètres facultatifs.
KnowledgeBasesCreateOrUpdateOptionalParams	Paramètres facultatifs.
KnowledgeBasesDeleteOptionalParams	Paramètres facultatifs.
KnowledgeBasesGetOperationStatusOptionalParams	Paramètres facultatifs.
KnowledgeBasesGetOptionalParams	Paramètres facultatifs.
KnowledgeBasesListOptionalParams	Paramètres facultatifs.
KnowledgeBasesOperations	Interface représentant les opérations d’une base de connaissances.
KnowledgeBasesSearchOptionalParams	Paramètres facultatifs.
KnowledgeBasesStartIndexingOptionalParams	Paramètres facultatifs.
LastIndexingRun	Les détails de la dernière série d’indexation.
NodepoolUsage	Aperçu de l’utilisation du calcul pour un pool de nœuds.
Operation	Informations résumées pour une opération.
OperationStatusRunResultError	Fournit des détails d’état pour les opérations de longue durée.
OutputDataMount	Définition d’un support pour la collecte des données de sortie d’outil.
OutputDataUri	Modèle pour fournir l’URI de la sortie collectée à partir d’un chemin de conteneur spécifique.
PageSettings	Options de la méthode byPage
PagedAsyncIterableIterator	Interface qui permet une itération itérable asynchrone à la fois à l’achèvement et à la page.
PagedConversation	Collection paginée d’éléments de conversation
PagedInvestigation	Collection d’objets d’enquête à pages
PagedOperation	Regroupement paginé des éléments d’opération
PagedWorkingMemoryEntry	Collection paginate des éléments WorkingMemoryEntry
RunResult	Résultat de la série
SearchRequest	Le corps de la demande d’action de recherche.
SearchResponse	Résultats d’une recherche dans une base de connaissances.
SearchResultItem	Un seul élément de recherche dans les résultats de recherche.
StartTaskRequest	Demande à l’organisme pour commencer une tâche.
StorageAssetReference	Référence à un actif de stockage avec des informations d’identité.
SupercomputerUsage	Aperçu de l’utilisation des calculs pour un superordinateur.
Tag	Définition de Tag
Task	Ressource pour la tâche.
TaskAssignee	Informations sur les assignés de tâche.
TaskComment	Commentaire sur la tâche.
TaskResult	Résultat d’exécution de la tâche.
TasksAddCommentOptionalParams	Paramètres facultatifs.
TasksAddExecutionHistoryOptionalParams	Paramètres facultatifs.
TasksCreateOptionalParams	Paramètres facultatifs.
TasksDeleteOptionalParams	Paramètres facultatifs.
TasksGetOptionalParams	Paramètres facultatifs.
TasksListOptionalParams	Paramètres facultatifs.
TasksOperations	Interface représentant une opération de Tâches.
TasksStartOptionalParams	Paramètres facultatifs.
TasksUpdateOptionalParams	Paramètres facultatifs.
ToolsCancelRunOptionalParams	Paramètres facultatifs.
ToolsGetComputeUsageOptionalParams	Paramètres facultatifs.
ToolsGetOperationsOptionalParams	Paramètres facultatifs.
ToolsGetRunStatusOptionalParams	Paramètres facultatifs.
ToolsOperations	Interface représentant une opération Tools.
ToolsRunOptionalParams	Paramètres facultatifs.
WorkingMemoryEntry	Saisie de mémoire de travail.
WorkspaceClientOptionalParams	Paramètres facultatifs pour le client.
WorkspaceClientRestorePollerOptions

Alias de type

ByType	Enum pour le type d’entité KnownByType peut être utilisé de manière interchangeable avec ByType, cet enum contient les valeurs connues que le service supporte. Valeurs connues prises en charge par le service Utilisateur : Un utilisateur humain. Application : Application Système : Le système backend.
CitationType	Le type de citation. KnownCitationType peut être utilisé de manière interchangeable avec CitationType, cet enum contient les valeurs connues que le service supporte. Valeurs connues prises en charge par le service file_citation : Une citation de dossier.
ContinuablePage	Interface qui décrit une page de résultats.
ConversationCreateOrUpdateContent	Les propriétés d’écriture fournies lors de la création ou de la mise à jour d’une conversation.
DiscoveryEngineStatus	Statut du moteur de découverte KnownDiscoveryEngineStatus peut être utilisé de manière interchangeable avec DiscoveryEngineStatus, cet enum contient les valeurs connues que le service supporte. Valeurs connues prises en charge par le service Inactif : Moteur de découverte inactif Actif : Moteur de découverte actif
IndexingStatus	Enum for IndexingStatus KnownIndexingStatus peut être utilisé de manière interchangeable avec IndexingStatus, cet enum contient les valeurs connues que le service supporte. Valeurs connues prises en charge par le service NotStarted : Indexation Non lancée Course : Course Réussi : Réussi Annulé : Annulé Échec : Échec
InvestigationCreateOrUpdateContent	Les propriétés manuscrites fournies lors de la création ou de la mise à jour d’une enquête.
InvestigationStatus	État KnownInvestigationStatus peut être utilisé de manière interchangeable avec InvestigationStatus, cet enum contient les valeurs connues que le service supporte. Valeurs connues prises en charge par le service Créé : Enquête menée Validé : Enquête validée Échec : Enquête échouée
KnowledgeBaseCreateOrUpdateContent	Les propriétés scriptibles fournies lors de la création ou de la mise à jour d’une KnowledgeBase.
KnowledgeBaseOperationResponseUnion	Alias pour KnowledgeBaseOperationResponseUnion
KnowledgeBaseOperationType	Statut indiquant l’opération de la base de connaissances. KnownKnowledgeBaseOperationType peut être utilisé de manière interchangeable avec KnowledgeBaseOperationType, cet enum contient les valeurs connues que le service supporte. Valeurs connues prises en charge par le service Indexation : une opération d’indexation. CancelIndexing : Une opération d’indexation d’annulation. Recherche : une opération de recherche. Supprimer : Une opération de suppression.
OperationState	Enum décrivant les états de fonctionnement autorisés. KnownOperationState pouvez être utilisé de manière interchangeable avec OperationState, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service NotStarted : l’opération n’a pas démarré. En cours d’exécution : l’opération est en cours. Réussite : l’opération s’est terminée avec succès. Échec : l’opération a échoué. Annulé : l’opération a été annulée par l’utilisateur.
ProvisioningState	État d’approvisionnement des ressources. KnownProvisioningState peut être utilisé de manière interchangeable avec ProvisioningState, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service réussi: la ressource a été créée. échec: échec de la création de ressources. annulé : la création de ressources a été annulée. Accepté : La demande de création de ressource a été acceptée Provisionnement : la ressource est en cours d’approvisionnement Mise à jour : la ressource est en cours de mise à jour Suppression : La ressource est supprimée
RepeatabilityResult	Options d’en-tête de résultat de répétabilité
RunStatus	Enum pour le statut des runs KnownRunStatus pouvez être utilisé de manière interchangeable avec RunStatus, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service NotStarted : Not Started Course : Course Réussi : Réussi Annulé : Annulé Échec : Échec
StorageMountProtocol	Le protocole à utiliser pour monter un conteneur de stockage. KnownStorageMountProtocol peut être utilisé de manière interchangeable avec StorageMountProtocol, cet enum contient les valeurs connues prises en charge par le service. Valeurs connues prises en charge par le service NFS : protocole NFS. La version du NFS utilisée peut varier selon le type de stockage BlobfuseCaching : Blobfuse en mode cache de fichiers.
TaskCreateOrUpdateContent	Les propriétés écrivables fournies lors de la création ou de la mise à jour d’une tâche.
TaskPriority	Niveau de priorité de tâche. KnownTaskPriority peut être utilisé de manière interchangeable avec TaskPriority, cet enum contient les valeurs connues que le service supporte. Valeurs connues prises en charge par le service Faible : Faible priorité Moyen : Priorité moyenne Haute : Haute priorité
TaskStatus	Énumération de l’état des tâches. KnownTaskStatus peut être utilisé de manière interchangeable avec TaskStatus, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Nouveau : La tâche est nouvellement créée En attente : La tâche est en pause Terminé : La tâche est terminée Supprimé : La tâche a été supprimée FlaggedHuman : La tâche a été signalée pour examen humain FlaggedAI : La tâche a été signalée pour une révision IA Exécution : La tâche est actuellement en cours ExecutionDone : L’exécution de la tâche est terminée Stagnante : La tâche est devenue lassante Échec : La tâche a échoué Incomplète : La tâche est incomplète
WorkingMemoryEntryType	Type d’entrée de mémoire de travail. KnownWorkingMemoryEntryType peut être utilisé de manière interchangeable avec WorkingMemoryEntryType ; cet enum contient les valeurs connues prises en charge par le service. Valeurs connues prises en charge par le service Pensée : Pensée

Énumérations

KnownByType	Enum pour le type d’entité
KnownCitationType	Le type de citation.
KnownDiscoveryEngineStatus	Statut du moteur de découverte
KnownIndexingStatus	Enum for IndexingStatus
KnownInvestigationStatus	Status
KnownKnowledgeBaseOperationType	Statut indiquant l’opération de la base de connaissances.
KnownOperationState	Enum décrivant les états de fonctionnement autorisés.
KnownProvisioningState	État d’approvisionnement des ressources.
KnownRunStatus	Enum pour le statut des runs
KnownStorageMountProtocol	Le protocole à utiliser pour monter un conteneur de stockage.
KnownTaskPriority	Niveau de priorité de tâche.
KnownTaskStatus	Énumération de l’état des tâches.
KnownWorkingMemoryEntryType	Type d’entrée de mémoire de travail.

Functions

bookshelfClientRestorePoller<TResponse, TResult>(BookshelfClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue.
isRestError(unknown)	Typeguard pour RestError
workspaceClientRestorePoller<TResponse, TResult>(WorkspaceClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue.

Variables

RestError

Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.

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

Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue.

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

Paramètres

client: BookshelfClient

serializedState: string

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

options: BookshelfClientRestorePollerOptions<TResult, PathUncheckedResponse>

Retours

PollerLike<OperationState<TResult>, TResult>

isRestError(unknown)

Typeguard pour RestError

function isRestError(e: unknown): e

Paramètres

e: unknown

Quelque chose d’intercepté par une clause catch.

Retours

e

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

Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue.

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

Paramètres

client: WorkspaceClient

serializedState: string

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

options: WorkspaceClientRestorePollerOptions<TResult, PathUncheckedResponse>

Retours

PollerLike<OperationState<TResult>, TResult>

RestError

Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/ai-discovery package

Classes

Interfaces

Alias de type

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Énumérations

Functions

Variables

Informations relatives à la fonction

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

Paramètres

Retours

isRestError(unknown)

Paramètres

Retours

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

Paramètres

Retours

Détails de variable

RestError

Type