@azure/ai-discovery package

Klassen

BookshelfClient	Client voor de Microsoft Discovery Bookshelf-service. Maakt de knowledgeBases operationele groep beschikbaar voor het beheren en doorvragen van kennisbanken.
WorkspaceClient	Client voor de Microsoft Discovery Workspace-service. Maakt de workspace-scoped operatiegroepen bloot: conversations, , investigations, tasks, en tools.

Interfaces

BookshelfClientOptionalParams	Optionele parameters voor de client.
BookshelfClientRestorePollerOptions
Citation	Een bronvermelding voor een gegenereerd resultaat.
ComputeUsage	Overzicht van het rekengebruik voor een project.
Conversation	Een gesprek.
ConversationsCreateOptionalParams	Optionele parameters.
ConversationsDeleteOptionalParams	Optionele parameters.
ConversationsGetOptionalParams	Optionele parameters.
ConversationsListOptionalParams	Optionele parameters.
ConversationsOperations	Interface die de gespreksoperaties vertegenwoordigt.
ConversationsUpdateOptionalParams	Optionele parameters.
DiscoveryEngine	Discovery engine-instantie.
DiscoveryEngineUpdate	Aanvraag voor update van de ontdekkingsmotor. Dit zal de ontdekkingsmotor creëren als die nog niet bestaat.
ExecutionHistoryEntry	Invoer in uitvoeringsgeschiedenis voor een taak.
IndexingMetrics	Indexering van metrics voor een run.
IndexingOperationResult	Resultaatdetails voor een indexeringsoperatie.
InfraOverrides	Stel expliciet de vereisten voor het uitvoeren van tools in - overschrijft de tooldefinitie.
InlineFile	Een bestand dat wordt opgenomen in de invoergegevens voor een tool en het pad waarop het wordt gemounted, relatief tot de werkmap.
InputDataMount	Data-URI en het pad waar het in de toolcontainer wordt gemount.
Investigation	Een onderzoekslijst.
InvestigationOperationStatus	De status van een langlopende onderzoeksoperatie.
InvestigationsCreateOrReplaceOptionalParams	Optionele parameters.
InvestigationsDeleteOptionalParams	Optionele parameters.
InvestigationsGetDiscoveryEngineMemoryOptionalParams	Optionele parameters.
InvestigationsGetDiscoveryEngineOptionalParams	Optionele parameters.
InvestigationsGetOperationStatusOptionalParams	Optionele parameters.
InvestigationsGetOptionalParams	Optionele parameters.
InvestigationsListOptionalParams	Optionele parameters.
InvestigationsOperations	Interface die een Investigations-operatie vertegenwoordigt.
InvestigationsStartDiscoveryEngineOptionalParams	Optionele parameters.
InvestigationsStopDiscoveryEngineOptionalParams	Optionele parameters.
InvestigationsUpdateDiscoveryEngineOptionalParams	Optionele parameters.
InvestigationsUpdateOptionalParams	Optionele parameters.
KnowledgeBase	Een kennisbasis.
KnowledgeBaseIndexingOperationResponse	Antwoord voor indexeringsoperaties.
KnowledgeBaseOperationResponse	Antwoord dat de KnowledgeBase-operatie aangeeft.
KnowledgeBaseSearchOperationResponse	Respons voor zoekoperaties.
KnowledgeBasesCancelIndexingOptionalParams	Optionele parameters.
KnowledgeBasesCreateOrUpdateOptionalParams	Optionele parameters.
KnowledgeBasesDeleteOptionalParams	Optionele parameters.
KnowledgeBasesGetOperationStatusOptionalParams	Optionele parameters.
KnowledgeBasesGetOptionalParams	Optionele parameters.
KnowledgeBasesListOptionalParams	Optionele parameters.
KnowledgeBasesOperations	Interface die de operaties van een kennisbasis vertegenwoordigt.
KnowledgeBasesSearchOptionalParams	Optionele parameters.
KnowledgeBasesStartIndexingOptionalParams	Optionele parameters.
LastIndexingRun	De details van de laatste indexeringsuitvoering.
NodepoolUsage	Overzicht van het rekengebruik voor een nodepool.
Operation	Samenvattende informatie voor een operatie.
OperationStatusRunResultError	Biedt statusdetails voor langlopende bewerkingen.
OutputDataMount	Definitie van een mount voor het verzamelen van gereedschapsuitvoergegevens.
OutputDataUri	Model voor het leveren van de URI van de output die wordt verzameld van een specifiek containerpad.
PageSettings	Opties voor de methode byPage
PagedAsyncIterableIterator	Een interface waarmee asynchrone iteratie zowel kan worden voltooid als per pagina.
PagedConversation	Gepaged verzameling van gespreksitems
PagedInvestigation	Gepagineerde verzameling onderzoeksitems
PagedOperation	Gebonden verzameling van operatie-items
PagedWorkingMemoryEntry	Gepagineerde collectie van WorkingMemoryEntry-items
RunResult	Uitslag van de run
SearchRequest	Het zoekactieverzoek.
SearchResponse	Resultaten van een zoekopdracht in de kennisbank.
SearchResultItem	Een enkel zoekresultaat.
StartTaskRequest	Vraag het lichaam om een taak te starten.
StorageAssetReference	Verwijs naar een opslagasset met identiteitsinformatie.
SupercomputerUsage	Overzicht van het rekengebruik voor een supercomputer.
Tag	Definitie van Tag
Task	Taakbron.
TaskAssignee	Informatie over taaktoegewezen.
TaskComment	Taakopmerking.
TaskResult	Resultaat van taakuitvoering.
TasksAddCommentOptionalParams	Optionele parameters.
TasksAddExecutionHistoryOptionalParams	Optionele parameters.
TasksCreateOptionalParams	Optionele parameters.
TasksDeleteOptionalParams	Optionele parameters.
TasksGetOptionalParams	Optionele parameters.
TasksListOptionalParams	Optionele parameters.
TasksOperations	Interface die een takenbewerking vertegenwoordigt.
TasksStartOptionalParams	Optionele parameters.
TasksUpdateOptionalParams	Optionele parameters.
ToolsCancelRunOptionalParams	Optionele parameters.
ToolsGetComputeUsageOptionalParams	Optionele parameters.
ToolsGetOperationsOptionalParams	Optionele parameters.
ToolsGetRunStatusOptionalParams	Optionele parameters.
ToolsOperations	Interface die de operaties van een Tool vertegenwoordigt.
ToolsRunOptionalParams	Optionele parameters.
WorkingMemoryEntry	Ingang in het werkgeheugen.
WorkspaceClientOptionalParams	Optionele parameters voor de client.
WorkspaceClientRestorePollerOptions

Type-aliassen

ByType	Enum voor entiteitstype KnownByType kan door elkaar worden gebruikt met ByType; dit enum bevat de bekende waarden die de dienst ondersteunt. Bekende waarden die door de service worden ondersteund Gebruiker: Een menselijke gebruiker. Toepassing: Toepassing Systeem: Het backend-systeem.
CitationType	Het type citaat. KnownCitationType kan door elkaar worden gebruikt met CitationType; dit enum bevat de bekende waarden die de dienst ondersteunt. Bekende waarden die door de service worden ondersteund file_citation: Een dossiervermelding.
ContinuablePage	Een interface die een pagina met resultaten beschrijft.
ConversationCreateOrUpdateContent	De beschrijfbare eigenschappen die worden aangeboden bij het aanmaken of bijwerken van een gesprek.
DiscoveryEngineStatus	Discovery Engine Status KnownDiscoveryEngineStatus kan door elkaar worden gebruikt met DiscoveryEngineStatus; dit enum bevat de bekende waarden die de dienst ondersteunt. Bekende waarden die door de service worden ondersteund Inactief: Discovery Engine inactief Actief: Discovery Engine Actief
IndexingStatus	Enum voor IndexingStatus KnownIndexingStatus kan uitwisselbaar worden gebruikt met IndexingStatus; dit enum bevat de bekende waarden die de dienst ondersteunt. Bekende waarden die door de service worden ondersteund NotStarted: Indexeren Niet gestart Hardlopen: Hardlopen Geslaagd: Geslaagd Geannuleerd: Geannuleerd Mislukt: Mislukt
InvestigationCreateOrUpdateContent	De schrijfbare eigenschappen die worden verstrekt bij het opstellen of bijwerken van een onderzoek.
InvestigationStatus	Status KnownInvestigationStatus kan door elkaar worden gebruikt met InvestigationStatus; dit enum bevat de bekende waarden die de dienst ondersteunt. Bekende waarden die door de service worden ondersteund Aangemaakt: Onderzoek Gemaakt Gevalideerd: Onderzoek gevalideerd Mislukt: Onderzoek mislukt
KnowledgeBaseCreateOrUpdateContent	De beschrijfbare eigenschappen die worden geleverd bij het aanmaken of updaten van een kennisbasis.
KnowledgeBaseOperationResponseUnion	Alias voor KnowledgeBaseOperationResponseUnion
KnowledgeBaseOperationType	Status die de KnowledgeBase-operatie aangeeft. KnownKnowledgeBaseOperationType kan uitwisselbaar worden gebruikt met KnowledgeBaseOperationType; deze enum bevat de bekende waarden die de dienst ondersteunt. Bekende waarden die door de service worden ondersteund Indexering: Een indexeringsoperatie. CancelIndexing: Een annuleringsindexeringsoperatie. Zoeken: Een zoekoperatie. Verwijderen: Een verwijderoperatie.
OperationState	Enum beschrijft de toegestane bewerkingstoestanden. KnownOperationState kan door elkaar worden gebruikt met OperationState, bevat deze opsomming de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund NotStarted: De bewerking is niet gestart. Actief: De bewerking is aan de gang. Geslaagd: De bewerking is met succes voltooid. Mislukt: de bewerking is mislukt. Geannuleerd: De bewerking is geannuleerd door de gebruiker.
ProvisioningState	De inrichtingsstatus van de resource. KnownProvisioningState kan door elkaar worden gebruikt met ProvisioningState, bevat deze opsomming de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund geslaagde: resource is gemaakt. mislukt: het maken van resources is mislukt. Geannuleerd: het maken van resources is geannuleerd. Geaccepteerd: Het resource cre-verzoek is geaccepteerd Inrichting: de resource wordt ingericht Bijgewerkt: de bron wordt bijgewerkt Verwijderen: De bron wordt verwijderd
RepeatabilityResult	Opties voor herhaalbaarheidsresultaat-headers
RunStatus	Enum voor runstatus KnownRunStatus kan door elkaar worden gebruikt met RunStatus, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund NietBegonnen: Niet Begonnen Hardlopen: Hardlopen Geslaagd: Geslaagd Geannuleerd: Geannuleerd Mislukt: Mislukt
StorageMountProtocol	Het protocol om te gebruiken voor het monteren van een opslagcontainer. KnownStorageMountProtocol kan uitwisselbaar worden gebruikt met StorageMountProtocol; deze enum bevat de bekende waarden die de dienst ondersteunt. Bekende waarden die door de service worden ondersteund NFS: NFS-protocol. De gebruikte versie van NFS kan variëren op basis van het type opslag BlobfuseCaching: Blobfuse in bestandscachemodus.
TaskCreateOrUpdateContent	De beschrijfbare eigenschappen die worden geleverd bij het aanmaken of updaten van een Taak.
TaskPriority	Taakprioriteitsniveau. KnownTaskPriority kan afwisselbaar worden gebruikt met TaskPriority; dit enum bevat de bekende waarden die de dienst ondersteunt. Bekende waarden die door de service worden ondersteund Laag: Lage prioriteit Medium: Medium prioriteit Hoog: Hoge prioriteit
TaskStatus	Taakstatusopsomming. KnownTaskStatus kan door elkaar worden gebruikt met TaskStatus, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Nieuw: De taak is nieuw gecreëerd OnHold: De taak staat op pauze Voltooid: De taak is voltooid Verwijderd: De taak is verwijderd FlaggedHuman: De taak is gemarkeerd voor menselijke beoordeling FlaggedAi: De taak is gemarkeerd voor AI-beoordeling Uitvoeren: De taak wordt momenteel uitgevoerd ExecutionDone: De taakuitvoering is voltooid Oud: De taak is saai geworden Mislukt: De taak is mislukt Onvolledig: De taak is onvoltooid
WorkingMemoryEntryType	Type werkgeheugeninvoer. KnownWorkingMemoryEntryType kan uitwisselbaar worden gebruikt met WorkingMemoryEntryType; dit enum bevat de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Gedachte: Gedachte

Enums

KnownByType	Enum voor entiteitstype
KnownCitationType	Het type citaat.
KnownDiscoveryEngineStatus	Discovery Engine Status
KnownIndexingStatus	Enum voor IndexingStatus
KnownInvestigationStatus	Status
KnownKnowledgeBaseOperationType	Status die de KnowledgeBase-operatie aangeeft.
KnownOperationState	Enum beschrijft de toegestane bewerkingstoestanden.
KnownProvisioningState	De inrichtingsstatus van de resource.
KnownRunStatus	Enum voor runstatus
KnownStorageMountProtocol	Het protocol om te gebruiken voor het monteren van een opslagcontainer.
KnownTaskPriority	Taakprioriteitsniveau.
KnownTaskStatus	Taakstatusopsomming.
KnownWorkingMemoryEntryType	Type werkgeheugeninvoer.

Functies

bookshelfClientRestorePoller<TResponse, TResult>(BookshelfClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Hiermee maakt u een poller op basis van de geserialiseerde status van een andere poller. Dit kan handig zijn als u pollers wilt maken op een andere host of een poller moet worden gemaakt nadat het oorspronkelijke poller niet binnen het bereik valt.
isRestError(unknown)	Typeguard voor RestError
workspaceClientRestorePoller<TResponse, TResult>(WorkspaceClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Hiermee maakt u een poller op basis van de geserialiseerde status van een andere poller. Dit kan handig zijn als u pollers wilt maken op een andere host of een poller moet worden gemaakt nadat het oorspronkelijke poller niet binnen het bereik valt.

Variabelen

RestError

Een aangepast fouttype voor mislukte pijplijnaanvragen.

Functiedetails

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

Hiermee maakt u een poller op basis van de geserialiseerde status van een andere poller. Dit kan handig zijn als u pollers wilt maken op een andere host of een poller moet worden gemaakt nadat het oorspronkelijke poller niet binnen het bereik valt.

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

Parameters

client

BookshelfClient

serializedState

string

sourceOperation

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

options

BookshelfClientRestorePollerOptions<TResult, PathUncheckedResponse>

Retouren

PollerLike<OperationState<TResult>, TResult>

isRestError(unknown)

Typeguard voor RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Iets betrapt door een catch-component.

Retouren

e

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

Hiermee maakt u een poller op basis van de geserialiseerde status van een andere poller. Dit kan handig zijn als u pollers wilt maken op een andere host of een poller moet worden gemaakt nadat het oorspronkelijke poller niet binnen het bereik valt.

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

Parameters

client

WorkspaceClient

serializedState

string

sourceOperation

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

options

WorkspaceClientRestorePollerOptions<TResult, PathUncheckedResponse>

Retouren

PollerLike<OperationState<TResult>, TResult>

Variabele details

RestError

Een aangepast fouttype voor mislukte pijplijnaanvragen.

RestError: RestErrorConstructor

Type

RestErrorConstructor