@azure/ai-discovery package

Klasy

BookshelfClient

Klient usługi Microsoft Discovery Bookshel. Udostępnia grupę knowledgeBases operacyjną do zarządzania i zapytań dotyczących baz wiedzy.

WorkspaceClient

Klient usługi Microsoft Discovery Workspace. Eksponuje grupy operacyjne w zakresie przestrzeni roboczej: conversations, , investigationstasks, oraz tools.

Interfejsy

BookshelfClientOptionalParams

Parametry opcjonalne dla klienta.

BookshelfClientRestorePollerOptions
Citation

Cytowanie wygenerowanego wyniku.

ComputeUsage

Przegląd wykorzystania obliczeniowego w projekcie.

Conversation

Rozmowa.

ConversationsCreateOptionalParams

Parametry opcjonalne.

ConversationsDeleteOptionalParams

Parametry opcjonalne.

ConversationsGetOptionalParams

Parametry opcjonalne.

ConversationsListOptionalParams

Parametry opcjonalne.

ConversationsOperations

Interfejs reprezentujący operacje Rozmowy.

ConversationsUpdateOptionalParams

Parametry opcjonalne.

DiscoveryEngine

Instancja silnika Discovery.

DiscoveryEngineUpdate

Prośba o aktualizację silnika Discovery. To stworzy silnik odkrywania, jeśli jeszcze nie istnieje.

ExecutionHistoryEntry

Wpis historii wykonania zadania.

IndexingMetrics

Indeksowanie metryk biegu.

IndexingOperationResult

Szczegóły wyników operacji indeksowania.

InfraOverrides

Wyraźnie ustaw wymagania uruchomienia narzędzia – nadpisuje definicję narzędzia.

InlineFile

Plik, który ma być uwzględniony w danych wejściowych dla uruchomienia narzędzia oraz ścieżce, na której zostanie zamontowany, względem katalogu roboczego.

InputDataMount

URI danych oraz ścieżka, na której będzie zamontowana w kontenerze narzędzi.

Investigation

To punkt na liście śledztwa.

InvestigationOperationStatus

Status długoletniej operacji śledczej.

InvestigationsCreateOrReplaceOptionalParams

Parametry opcjonalne.

InvestigationsDeleteOptionalParams

Parametry opcjonalne.

InvestigationsGetDiscoveryEngineMemoryOptionalParams

Parametry opcjonalne.

InvestigationsGetDiscoveryEngineOptionalParams

Parametry opcjonalne.

InvestigationsGetOperationStatusOptionalParams

Parametry opcjonalne.

InvestigationsGetOptionalParams

Parametry opcjonalne.

InvestigationsListOptionalParams

Parametry opcjonalne.

InvestigationsOperations

Interfejs reprezentujący operacje Investigations.

InvestigationsStartDiscoveryEngineOptionalParams

Parametry opcjonalne.

InvestigationsStopDiscoveryEngineOptionalParams

Parametry opcjonalne.

InvestigationsUpdateDiscoveryEngineOptionalParams

Parametry opcjonalne.

InvestigationsUpdateOptionalParams

Parametry opcjonalne.

KnowledgeBase

Baza wiedzy.

KnowledgeBaseIndexingOperationResponse

Odpowiedź na operacje indeksowania.

KnowledgeBaseOperationResponse

Odpowiedź wskazująca operację KnowledgeBase.

KnowledgeBaseSearchOperationResponse

Reakcja na operacje poszukiwawcze.

KnowledgeBasesCancelIndexingOptionalParams

Parametry opcjonalne.

KnowledgeBasesCreateOrUpdateOptionalParams

Parametry opcjonalne.

KnowledgeBasesDeleteOptionalParams

Parametry opcjonalne.

KnowledgeBasesGetOperationStatusOptionalParams

Parametry opcjonalne.

KnowledgeBasesGetOptionalParams

Parametry opcjonalne.

KnowledgeBasesListOptionalParams

Parametry opcjonalne.

KnowledgeBasesOperations

Interfejs reprezentujący operacje KnowledgeBases.

KnowledgeBasesSearchOptionalParams

Parametry opcjonalne.

KnowledgeBasesStartIndexingOptionalParams

Parametry opcjonalne.

LastIndexingRun

Szczegóły ostatniego cyklu indeksowania.

NodepoolUsage

Przegląd wykorzystania mocy obliczeniowej dla puli węzłów.

Operation

Podsumowanie informacji o operacji.

OperationStatusRunResultError

Zawiera szczegółowe informacje o stanie dla długotrwałych operacji.

OutputDataMount

Definicja montażu do zbierania danych wyjściowych narzędzi.

OutputDataUri

Model do dostarczania URI wyjścia zebranego z konkretnej ścieżki kontenera.

PageSettings

Opcje dla metody byPage

PagedAsyncIterableIterator

Interfejs, który umożliwia iterację asynchronialną zarówno do ukończenia, jak i według strony.

PagedConversation

Stronicowana kolekcja elementów konwersacji

PagedInvestigation

Kolekcja przedmiotów śledztwa z kolekcją

PagedOperation

Stronicowana kolekcja elementów operacji

PagedWorkingMemoryEntry

Kolekcja stron WorkingMemoryEntry

RunResult

Wyniki biegów

SearchRequest

Ciało żądania akcji poszukiwania.

SearchResponse

Wyniki wyszukiwania bazy wiedzy.

SearchResultItem

Jeden element w wynikach wyszukiwania.

StartTaskRequest

Ciało żądania do rozpoczęcia zadania.

StorageAssetReference

Odniesienie do zasobów magazynowych z informacjami o tożsamości.

SupercomputerUsage

Przegląd wykorzystania mocy obliczeniowej przez superkomputer.

Tag

Definicja tagu

Task

Zasób do zadania.

TaskAssignee

Informacje o przydzielonym zadaniu.

TaskComment

Komentarz do zadania.

TaskResult

Wynik wykonania zadania.

TasksAddCommentOptionalParams

Parametry opcjonalne.

TasksAddExecutionHistoryOptionalParams

Parametry opcjonalne.

TasksCreateOptionalParams

Parametry opcjonalne.

TasksDeleteOptionalParams

Parametry opcjonalne.

TasksGetOptionalParams

Parametry opcjonalne.

TasksListOptionalParams

Parametry opcjonalne.

TasksOperations

Interfejs reprezentujący operacje Zadania.

TasksStartOptionalParams

Parametry opcjonalne.

TasksUpdateOptionalParams

Parametry opcjonalne.

ToolsCancelRunOptionalParams

Parametry opcjonalne.

ToolsGetComputeUsageOptionalParams

Parametry opcjonalne.

ToolsGetOperationsOptionalParams

Parametry opcjonalne.

ToolsGetRunStatusOptionalParams

Parametry opcjonalne.

ToolsOperations

Interfejs reprezentujący operacje Tools.

ToolsRunOptionalParams

Parametry opcjonalne.

WorkingMemoryEntry

Wpis w pamięci roboczej.

WorkspaceClientOptionalParams

Parametry opcjonalne dla klienta.

WorkspaceClientRestorePollerOptions

Aliasy typu

ByType

Enum dla typu encji
KnownByType może być używany zamiennie z ByType, a ten enum zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Użytkownik: Użytkownik ludzki.
Zastosowanie: Aplikacja
System: System zaplecza.

CitationType

Rodzaj cytowania.
KnownCitationType może być używany zamiennie z CitationType, a ten enum zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

file_citation: Cytowanie w pliku.

ContinuablePage

Interfejs opisujący stronę wyników.

ConversationCreateOrUpdateContent

Właściwości zapisywalne dostarczane podczas tworzenia lub aktualizacji rozmowy.

DiscoveryEngineStatus

Status silnika Discovery
KnownDiscoveryEngineStatus może być używany zamiennie z DiscoveryEngineStatus, a ten enum zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Nieaktywny: Silnik Discovery nieaktywny
Aktywne: Discovery Engine aktywny

IndexingStatus

Enum for IndexingStatus
KnownIndexingStatus może być używany zamiennie z IndexingStatus, a ten enum zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

NotStarted: Indeksowanie Not started
Bieganie: Bieganie
Powodzenie: Powodzenie
Anulowane: Odwołane
Niepowodzenie: Niepowodzenie

InvestigationCreateOrUpdateContent

Właściwości zapisywalne dostępne podczas tworzenia lub aktualizacji dochodzenia.

InvestigationStatus

Stan
KnownInvestigationStatus może być używany zamiennie z InvestigationStatus, a ten enum zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Stworzone: Śledztwo utworzone
Zweryfikowane: Śledztwo potwierdzone
Niepowodzenie: Nieudane śledztwo

KnowledgeBaseCreateOrUpdateContent

Właściwości zapisu dostarczane podczas tworzenia lub aktualizacji KnowledgeBase.

KnowledgeBaseOperationResponseUnion

Alias dla KnowledgeBaseOperationResponseUnion

KnowledgeBaseOperationType

Status wskazujący operację KnowledgeBase.
KnownKnowledgeBaseOperationType może być używany zamiennie z KnowledgeBaseOperationType, a ten enum zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Indeksowanie: Operacja indeksowania.
CancelIndexing: Operacja cancel indexing.
Poszukiwanie: Operacja poszukiwawcza.
Usuń: Operacja usuwania.

OperationState

Wyliczenie opisujące dozwolone stany operacji.
KnownOperationState można używać zamiennie z operacją OperationState, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

NotStarted: Operacja nie została rozpoczęta.
Uruchomione: Operacja jest w toku.
Powodzenie: operacja została zakończona pomyślnie.
Niepowodzenie: Operacja nie powiodła się.
Anulowana: Operacja została anulowana przez użytkownika.

ProvisioningState

Stan aprowizacji zasobu.
KnownProvisioningState można używać zamiennie z parametrem ProvisioningState, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

pomyślnie: utworzono zasób.
Niepowodzenie: tworzenie zasobu nie powiodło się.
Anulowano: tworzenie zasobów zostało anulowane.
Zaakceptowane: Wniosek o utworzenie zasobów został zaakceptowany
Aprowizacja: zasób jest aprowizowany
Aktualizowanie: Zasób jest aktualizowany
Usuwanie: Zasób jest usuwany

RepeatabilityResult

Opcje nagłówka Powtarzalność Result

RunStatus

Enum dla statusu uruchomienia
ZnaneRunStatus można używać zamiennie z elementem RunStatus, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

NieRozpoczęła: Nie zaczęła
Bieganie: Bieganie
Powodzenie: Powodzenie
Anulowane: Odwołane
Niepowodzenie: Niepowodzenie

StorageMountProtocol

Protokół stosowany do montażu pojemnika magazynowego.
KnownStorageMountProtocol może być używany zamiennie z StorageMountProtocol, a ten enum zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

NFS: protokół NFS. Wersja używanego NFS może się różnić w zależności od typu pamięci masowej
BlobfuseCaching: Blobfuse w trybie pamięci podręcznej plików.

TaskCreateOrUpdateContent

Właściwości zapisywalne dostarczane podczas tworzenia lub aktualizacji zadania.

TaskPriority

Priorytet zadania.
KnownTaskPriority może być używany zamiennie z TaskPriority, a ten enum zawiera znane wartości, które obsługuje usługa.

Znane wartości obsługiwane przez usługę

Niski: Niski priorytet
Średni: Średni priorytet
Wysoki: Wysoki priorytet

TaskStatus

Enumeracja statusu zadania.
ZnaneTaskStatus można używać zamiennie z wartością TaskStatus, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Nowość: Zadanie zostało nowo utworzone
OnHold: Zadanie jest wstrzymane
Zakończone: Zadanie zostało wykonane
Usunięto: Zadanie zostało usunięte
FlaggedHuman: Zadanie zostało oznaczone do oceny przez człowieka
FlaggedAi: Zadanie zostało oznaczone do przeglądu AI
Wykonywanie: Zadanie jest obecnie wykonywane
WykonanieWykonane: Wykonanie zadania zostało zakończone
Nudne: Zadanie stało się monotonne
Niepowodzenie: Zadanie zakończyło się niepowodzeniem
Nieukończone: Zadanie jest nieukończone

WorkingMemoryEntryType

Typ wpisu w pamięci roboczej.
KnowWorkingMemoryEntryType może być używany zamiennie z WorkingMemoryEntryType, a ten enum zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Myśl: Myśl

Wyliczenia

KnownByType

Enum dla typu encji

KnownCitationType

Rodzaj cytowania.

KnownDiscoveryEngineStatus

Status silnika Discovery

KnownIndexingStatus

Enum for IndexingStatus

KnownInvestigationStatus

Status

KnownKnowledgeBaseOperationType

Status wskazujący operację KnowledgeBase.

KnownOperationState

Wyliczenie opisujące dozwolone stany operacji.

KnownProvisioningState

Stan aprowizacji zasobu.

KnownRunStatus

Enum dla statusu uruchomienia

KnownStorageMountProtocol

Protokół stosowany do montażu pojemnika magazynowego.

KnownTaskPriority

Priorytet zadania.

KnownTaskStatus

Enumeracja statusu zadania.

KnownWorkingMemoryEntryType

Typ wpisu w pamięci roboczej.

Funkcje

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

Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie.

isRestError(unknown)

Funkcja Typeguard dla błędu RestError

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

Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie.

Zmienne

RestError

Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.

Szczegóły funkcji

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

Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie.

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

Parametry

serializedState

string

sourceOperation

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

Zwraca

PollerLike<OperationState<TResult>, TResult>

isRestError(unknown)

Funkcja Typeguard dla błędu RestError

function isRestError(e: unknown): e

Parametry

e

unknown

Coś złapanego przez klauzulę catch.

Zwraca

e

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

Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie.

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

Parametry

serializedState

string

sourceOperation

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

Zwraca

PollerLike<OperationState<TResult>, TResult>

Szczegóły zmiennej

RestError

Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.

RestError: RestErrorConstructor

Typ