@azure/ai-discovery package
Klasser
| BookshelfClient |
Klient för Microsoft Discovery Bookshelf-tjänsten. Exponerar |
| WorkspaceClient |
Klient för Microsoft Discovery Workspace-tjänsten. Exponerar de arbetsytsbegränsade operationsgrupperna: |
Gränssnitt
| BookshelfClientOptionalParams |
Valfria parametrar för klienten. |
| BookshelfClientRestorePollerOptions | |
| Citation |
En referens för ett genererat resultat. |
| ComputeUsage |
Översikt över beräkningsanvändning för ett projekt. |
| Conversation |
En konversation. |
| ConversationsCreateOptionalParams |
Valfria parametrar. |
| ConversationsDeleteOptionalParams |
Valfria parametrar. |
| ConversationsGetOptionalParams |
Valfria parametrar. |
| ConversationsListOptionalParams |
Valfria parametrar. |
| ConversationsOperations |
Gränssnitt som representerar konversationsoperationer. |
| ConversationsUpdateOptionalParams |
Valfria parametrar. |
| DiscoveryEngine |
Discovery engine-instans. |
| DiscoveryEngineUpdate |
Begäran om uppdatering av upptäcktsmotorn. Detta skapar upptäcktsmotorn om den inte redan existerar. |
| ExecutionHistoryEntry |
Genomförandehistorik för en uppgift. |
| IndexingMetrics |
Indexering av mätvärden för en run. |
| IndexingOperationResult |
Resultatdetaljer för en indexeringsoperation. |
| InfraOverrides |
Sätt explicit krav på verktygskörning – åsidosätter verktygsdefinitionen. |
| InlineFile |
En fil som ska inkluderas i indatan för ett verktyg som körs och sökvägen där den ska monteras, i förhållande till arbetskatalogen. |
| InputDataMount |
Data-URI och bana var den ska monteras i verktygscontainern. |
| Investigation |
En punkt på utredningslistan. |
| InvestigationOperationStatus |
Status för en långvarig utredningsoperation. |
| InvestigationsCreateOrReplaceOptionalParams |
Valfria parametrar. |
| InvestigationsDeleteOptionalParams |
Valfria parametrar. |
| InvestigationsGetDiscoveryEngineMemoryOptionalParams |
Valfria parametrar. |
| InvestigationsGetDiscoveryEngineOptionalParams |
Valfria parametrar. |
| InvestigationsGetOperationStatusOptionalParams |
Valfria parametrar. |
| InvestigationsGetOptionalParams |
Valfria parametrar. |
| InvestigationsListOptionalParams |
Valfria parametrar. |
| InvestigationsOperations |
Gränssnitt som representerar en utredningsoperation. |
| InvestigationsStartDiscoveryEngineOptionalParams |
Valfria parametrar. |
| InvestigationsStopDiscoveryEngineOptionalParams |
Valfria parametrar. |
| InvestigationsUpdateDiscoveryEngineOptionalParams |
Valfria parametrar. |
| InvestigationsUpdateOptionalParams |
Valfria parametrar. |
| KnowledgeBase |
En kunskapsbas. |
| KnowledgeBaseIndexingOperationResponse |
Svar för indexeringsoperationer. |
| KnowledgeBaseOperationResponse |
Svar som indikerar KnowledgeBase-operationen. |
| KnowledgeBaseSearchOperationResponse |
Svar för sökoperationer. |
| KnowledgeBasesCancelIndexingOptionalParams |
Valfria parametrar. |
| KnowledgeBasesCreateOrUpdateOptionalParams |
Valfria parametrar. |
| KnowledgeBasesDeleteOptionalParams |
Valfria parametrar. |
| KnowledgeBasesGetOperationStatusOptionalParams |
Valfria parametrar. |
| KnowledgeBasesGetOptionalParams |
Valfria parametrar. |
| KnowledgeBasesListOptionalParams |
Valfria parametrar. |
| KnowledgeBasesOperations |
Gränssnitt som representerar en kunskapsbasoperation. |
| KnowledgeBasesSearchOptionalParams |
Valfria parametrar. |
| KnowledgeBasesStartIndexingOptionalParams |
Valfria parametrar. |
| LastIndexingRun |
Detaljerna från den senaste indexeringsrundan. |
| NodepoolUsage |
Översikt över beräkningsanvändning för en nodepool. |
| Operation |
Sammanfattningsinformation för en operation. |
| OperationStatusRunResultError |
Ger statusinformation för långvariga åtgärder. |
| OutputDataMount |
Definition av en montering för att samla in verktygsdata. |
| OutputDataUri |
Modell för att tillhandahålla URI:n för utdata som samlas in från en specifik container-väg. |
| PageSettings |
Alternativ för byPage-metoden |
| PagedAsyncIterableIterator |
Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida. |
| PagedConversation |
En sidig samling konversationsobjekt |
| PagedInvestigation |
Sidad samling av undersökningsobjekt |
| PagedOperation |
En sidig samling av åtgärdsobjekt |
| PagedWorkingMemoryEntry |
Sidinköpt samling av WorkingMemoryEntry-objekt |
| RunResult |
Resultat |
| SearchRequest |
Sökaktionsförfrågningskroppen. |
| SearchResponse |
Resultat av en sökning i kunskapsbasen. |
| SearchResultItem |
Ett enda sökresultat. |
| StartTaskRequest |
Begär att du ska börja med en uppgift. |
| StorageAssetReference |
Referens till en lagringstillgång med identitetsinformation. |
| SupercomputerUsage |
Översikt över beräkningsanvändning för en superdator. |
| Tag |
Definition av tagg |
| Task |
Uppgiftsresurs. |
| TaskAssignee |
Information om uppgiftstilldelad. |
| TaskComment |
Uppgiftskommentar. |
| TaskResult |
Resultat av uppgiftsutförande. |
| TasksAddCommentOptionalParams |
Valfria parametrar. |
| TasksAddExecutionHistoryOptionalParams |
Valfria parametrar. |
| TasksCreateOptionalParams |
Valfria parametrar. |
| TasksDeleteOptionalParams |
Valfria parametrar. |
| TasksGetOptionalParams |
Valfria parametrar. |
| TasksListOptionalParams |
Valfria parametrar. |
| TasksOperations |
Gränssnitt som representerar en uppgiftsoperation. |
| TasksStartOptionalParams |
Valfria parametrar. |
| TasksUpdateOptionalParams |
Valfria parametrar. |
| ToolsCancelRunOptionalParams |
Valfria parametrar. |
| ToolsGetComputeUsageOptionalParams |
Valfria parametrar. |
| ToolsGetOperationsOptionalParams |
Valfria parametrar. |
| ToolsGetRunStatusOptionalParams |
Valfria parametrar. |
| ToolsOperations |
Gränssnitt som representerar ett verktygsoperationer. |
| ToolsRunOptionalParams |
Valfria parametrar. |
| WorkingMemoryEntry |
Arbetsminnesinmatning. |
| WorkspaceClientOptionalParams |
Valfria parametrar för klienten. |
| WorkspaceClientRestorePollerOptions | |
Typalias
| ByType |
Enum för entitetstyp Kända värden som stöds av tjänsten
Användare: En mänsklig användare. |
| CitationType |
Typen av källhänvisning. Kända värden som stöds av tjänstenfile_citation: En filanmärkning. |
| ContinuablePage |
Ett gränssnitt som beskriver en resultatsida. |
| ConversationCreateOrUpdateContent |
De skrivbara egenskaperna som tillhandahålls när man skapar eller uppdaterar en konversation. |
| DiscoveryEngineStatus |
Discovery Engine Status Kända värden som stöds av tjänsten
Inaktiv: Discovery Engine inaktiv |
| IndexingStatus |
Enum för indexeringsstatus Kända värden som stöds av tjänsten
NotStarted: Indexering Ej påbörjad |
| InvestigationCreateOrUpdateContent |
De skrivbara egenskaperna som tillhandahålls vid skapande eller uppdatering av en undersökning. |
| InvestigationStatus |
Status Kända värden som stöds av tjänsten
Skapad: Undersökning Skapad |
| KnowledgeBaseCreateOrUpdateContent |
De skrivbara egenskaper som tillhandahålls vid skapande eller uppdatering av en kunskapsbas. |
| KnowledgeBaseOperationResponseUnion |
Alias för KnowledgeBaseOperationResponseUnion |
| KnowledgeBaseOperationType |
Status som indikerar KnowledgeBase-operationen. Kända värden som stöds av tjänsten
Indexering: En indexeringsoperation. |
| OperationState |
Uppräkning som beskriver tillåtna åtgärdstillstånd. Kända värden som stöds av tjänsten
NotStarted: Åtgärden har inte startats. |
| ProvisioningState |
Resursetableringstillståndet. Kända värden som stöds av tjänsten
lyckades: Resursen har skapats. |
| RepeatabilityResult |
Upprepbarhetsresultat huvudalternativ |
| RunStatus |
Enum för run-status Kända värden som stöds av tjänsten
IntePåbörjad: Ej Påbörjad. |
| StorageMountProtocol |
Protokollet som används för montering av en lagringscontainer. Kända värden som stöds av tjänsten
NFS: NFS-protokoll. Den använda versionen av NFS kan variera beroende på lagringstyp |
| TaskCreateOrUpdateContent |
De skrivbara egenskaperna som tillhandahålls vid skapande eller uppdatering av en Uppgift. |
| TaskPriority |
Uppgiftsprioritetsnivå. Kända värden som stöds av tjänsten
Låg: Låg prioritet |
| TaskStatus |
Uppräkning av uppgiftsstatus. Kända värden som stöds av tjänsten
Ny: Uppgiften är nyskapad |
| WorkingMemoryEntryType |
Typ av arbetsminnesinmatning. Kända värden som stöds av tjänstenTanke: Tanke |
Uppräkningar
| KnownByType |
Enum för entitetstyp |
| KnownCitationType |
Typen av källhänvisning. |
| KnownDiscoveryEngineStatus |
Discovery Engine Status |
| KnownIndexingStatus |
Enum för indexeringsstatus |
| KnownInvestigationStatus |
Status |
| KnownKnowledgeBaseOperationType |
Status som indikerar KnowledgeBase-operationen. |
| KnownOperationState |
Uppräkning som beskriver tillåtna åtgärdstillstånd. |
| KnownProvisioningState |
Resursetableringstillståndet. |
| KnownRunStatus |
Enum för run-status |
| KnownStorageMountProtocol |
Protokollet som används för montering av en lagringscontainer. |
| KnownTaskPriority |
Uppgiftsprioritetsnivå. |
| KnownTaskStatus |
Uppräkning av uppgiftsstatus. |
| KnownWorkingMemoryEntryType |
Typ av arbetsminnesinmatning. |
Funktioner
| bookshelf |
Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget. |
| is |
Typeguard för RestError |
| workspace |
Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget. |
Variabler
| Rest |
En anpassad feltyp för misslyckade pipelinebegäranden. |
Funktionsinformation
bookshelfClientRestorePoller<TResponse, TResult>(BookshelfClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.
function bookshelfClientRestorePoller<TResponse, TResult>(client: BookshelfClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parametrar
- client
- BookshelfClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
BookshelfClientRestorePollerOptions<TResult, PathUncheckedResponse>
Returer
PollerLike<OperationState<TResult>, TResult>
isRestError(unknown)
Typeguard för RestError
function isRestError(e: unknown): e
Parametrar
- e
-
unknown
Något som fångas av en fångstklausul.
Returer
e
workspaceClientRestorePoller<TResponse, TResult>(WorkspaceClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.
function workspaceClientRestorePoller<TResponse, TResult>(client: WorkspaceClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parametrar
- client
- WorkspaceClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
WorkspaceClientRestorePollerOptions<TResult, PathUncheckedResponse>
Returer
PollerLike<OperationState<TResult>, TResult>
Variabelinformation
RestError
En anpassad feltyp för misslyckade pipelinebegäranden.
RestError: RestErrorConstructor