@azure/ai-discovery package

클래스

BookshelfClient	Microsoft Discovery Bookshelf 서비스의 클라이언트입니다. 지식 기반 관리 및 질의를 위한 운영 그룹을 노출합니다 knowledgeBases .
WorkspaceClient	Microsoft Discovery Workspace 서비스의 클라이언트입니다. 작업 공간 범위가 적용된 연산 그룹을 노출합니다: conversations, investigations, taskstools, .

인터페이스

BookshelfClientOptionalParams	클라이언트에 대한 선택적 매개 변수입니다.
BookshelfClientRestorePollerOptions
Citation	생성된 결과에 대한 인용.
ComputeUsage	프로젝트의 컴퓨팅 사용 개요.
Conversation	대화.
ConversationsCreateOptionalParams	선택적 매개 변수입니다.
ConversationsDeleteOptionalParams	선택적 매개 변수입니다.
ConversationsGetOptionalParams	선택적 매개 변수입니다.
ConversationsListOptionalParams	선택적 매개 변수입니다.
ConversationsOperations	대화 작업을 나타내는 인터페이스.
ConversationsUpdateOptionalParams	선택적 매개 변수입니다.
DiscoveryEngine	디스커버리 엔진 인스턴스.
DiscoveryEngineUpdate	디스커버리 엔진 업데이트 요청. 이 과정에서 이미 존재하지 않는 디스커버리 엔진이 생성됩니다.
ExecutionHistoryEntry	작업의 실행 기록 항목.
IndexingMetrics	런을 위한 지표 인덱싱.
IndexingOperationResult	인덱싱 연산의 결과 세부 정보.
InfraOverrides	도구 실행 요구사항을 명시적으로 설정하면 도구 정의를 덮어씁니다.
InlineFile	도구 실행을 위한 입력 데이터에 포함되는 파일과, 작업 디렉터리에 대해 마운트될 경로가 있습니다.
InputDataMount	데이터 URI와 도구 컨테이너에 장착될 경로.
Investigation	조사 목록 항목.
InvestigationOperationStatus	장기 수사 작전의 현황.
InvestigationsCreateOrReplaceOptionalParams	선택적 매개 변수입니다.
InvestigationsDeleteOptionalParams	선택적 매개 변수입니다.
InvestigationsGetDiscoveryEngineMemoryOptionalParams	선택적 매개 변수입니다.
InvestigationsGetDiscoveryEngineOptionalParams	선택적 매개 변수입니다.
InvestigationsGetOperationStatusOptionalParams	선택적 매개 변수입니다.
InvestigationsGetOptionalParams	선택적 매개 변수입니다.
InvestigationsListOptionalParams	선택적 매개 변수입니다.
InvestigationsOperations	수사팀 작전을 나타내는 인터페이스.
InvestigationsStartDiscoveryEngineOptionalParams	선택적 매개 변수입니다.
InvestigationsStopDiscoveryEngineOptionalParams	선택적 매개 변수입니다.
InvestigationsUpdateDiscoveryEngineOptionalParams	선택적 매개 변수입니다.
InvestigationsUpdateOptionalParams	선택적 매개 변수입니다.
KnowledgeBase	지식 기반.
KnowledgeBaseIndexingOperationResponse	인덱싱 작업에 대한 응답.
KnowledgeBaseOperationResponse	KnowledgeBase 운영을 나타내는 응답.
KnowledgeBaseSearchOperationResponse	수색 작전 대응.
KnowledgeBasesCancelIndexingOptionalParams	선택적 매개 변수입니다.
KnowledgeBasesCreateOrUpdateOptionalParams	선택적 매개 변수입니다.
KnowledgeBasesDeleteOptionalParams	선택적 매개 변수입니다.
KnowledgeBasesGetOperationStatusOptionalParams	선택적 매개 변수입니다.
KnowledgeBasesGetOptionalParams	선택적 매개 변수입니다.
KnowledgeBasesListOptionalParams	선택적 매개 변수입니다.
KnowledgeBasesOperations	지식 기반 작업을 나타내는 인터페이스.
KnowledgeBasesSearchOptionalParams	선택적 매개 변수입니다.
KnowledgeBasesStartIndexingOptionalParams	선택적 매개 변수입니다.
LastIndexingRun	마지막 색인 작성 세부 사항.
NodepoolUsage	노드풀의 컴퓨트 사용량 개요.
Operation	작전 요약 정보.
OperationStatusRunResultError	장기 실행 작업에 대한 상태 세부 정보를 제공합니다.
OutputDataMount	공구 출력 데이터를 수집하는 마운트의 정의.
OutputDataUri	특정 컨테이너 경로에서 수집된 출력의 URI를 제공하는 모델입니다.
PageSettings	byPage 메서드에 대한 옵션
PagedAsyncIterableIterator	완료 및 페이지별로 비동기 반복 가능한 반복을 허용하는 인터페이스입니다.
PagedConversation	대화 항목의 페이징된 컬렉션
PagedInvestigation	조사 자료 페이지드 컬렉션
PagedOperation	작업 항목의 페이징된 컬렉션
PagedWorkingMemoryEntry	WorkingMemoryEntry 항목의 페이지드 컬렉션
RunResult	득점 결과
SearchRequest	수색 행동 요청 본문.
SearchResponse	지식 기반 검색 결과.
SearchResultItem	단일 검색 결과 항목.
StartTaskRequest	작업 시작 요청 기관.
StorageAssetReference	신원 정보가 포함된 저장 자산에 대한 참조.
SupercomputerUsage	슈퍼컴퓨터의 컴퓨트 사용 개요.
Tag	태그의 정의
Task	과제 자원.
TaskAssignee	작업 할당자 정보.
TaskComment	작업 댓글.
TaskResult	작업 실행 결과.
TasksAddCommentOptionalParams	선택적 매개 변수입니다.
TasksAddExecutionHistoryOptionalParams	선택적 매개 변수입니다.
TasksCreateOptionalParams	선택적 매개 변수입니다.
TasksDeleteOptionalParams	선택적 매개 변수입니다.
TasksGetOptionalParams	선택적 매개 변수입니다.
TasksListOptionalParams	선택적 매개 변수입니다.
TasksOperations	작업 작업을 나타내는 인터페이스.
TasksStartOptionalParams	선택적 매개 변수입니다.
TasksUpdateOptionalParams	선택적 매개 변수입니다.
ToolsCancelRunOptionalParams	선택적 매개 변수입니다.
ToolsGetComputeUsageOptionalParams	선택적 매개 변수입니다.
ToolsGetOperationsOptionalParams	선택적 매개 변수입니다.
ToolsGetRunStatusOptionalParams	선택적 매개 변수입니다.
ToolsOperations	도구 작업을 나타내는 인터페이스.
ToolsRunOptionalParams	선택적 매개 변수입니다.
WorkingMemoryEntry	작업 기억 입력.
WorkspaceClientOptionalParams	클라이언트에 대한 선택적 매개 변수입니다.
WorkspaceClientRestorePollerOptions

형식 별칭

ByType	엔티티 타입을 위한 열거 KnownByType 은 ByType과 상호 교환 가능하며, 이 열거는 서비스가 지원하는 알려진 값을 포함합니다. 서비스에서 지원하는 알려진 값 사용자: 인간 사용자. 적용: 적용 시스템: 백엔드 시스템입니다.
CitationType	인용문의 종류. KnownCitationType 은 CitationType과 상호 교환 가능하며, 이 열거형은 서비스가 지원하는 알려진 값을 포함합니다. 서비스에서 지원하는 알려진 값 file_citation: 파일 인용문.
ContinuablePage	결과 페이지를 설명하는 인터페이스입니다.
ConversationCreateOrUpdateContent	대화를 생성하거나 업데이트할 때 제공되는 작성 가능한 속성들.
DiscoveryEngineStatus	디스커버리 엔진 현황 KnownDiscoveryEngineStatus 는 DiscoveryEngineStatus와 서로 교환하여 사용할 수 있으며, 이 열거는 서비스가 지원하는 알려진 값들을 포함합니다. 서비스에서 지원하는 알려진 값 비활성 상태: 디스커버리 엔진 비활성 활성화: 디스커버리 엔진 활성화
IndexingStatus	인덱싱 상태 열거 KnownIndexingStatus 는 IndexingStatus와 상호 교환 가능하며, 이 열거는 서비스가 지원하는 알려진 값을 포함합니다. 서비스에서 지원하는 알려진 값 시작하지 않음: 색인 작성 시작 안 됨 달리기: 달리기 성공: 성공 취소: 취소됨 실패: 실패
InvestigationCreateOrUpdateContent	조사를 생성하거나 업데이트할 때 제공되는 작성 가능한 속성들.
InvestigationStatus	상태 KnownInvestigationStatus 는 InvestigationStatus와 서로 교환하여 사용할 수 있으며, 이 열거는 서비스가 지원하는 알려진 값을 포함합니다. 서비스에서 지원하는 알려진 값 생성됨: 조사 생성됨 검증됨: 조사 검증됨 실패: 조사 실패
KnowledgeBaseCreateOrUpdateContent	지식 베이스를 생성하거나 업데이트할 때 제공되는 작성 가능한 속성들입니다.
KnowledgeBaseOperationResponseUnion	지식베이스 운영반응유니언의 별칭
KnowledgeBaseOperationType	지식 기반 운영 상태를 나타냅니다. KnownKnowledgeBaseOperationType 은 KnowledgeBaseOperationType과 상호 교환 가능하며, 이 열거는 서비스가 지원하는 알려진 값을 포함합니다. 서비스에서 지원하는 알려진 값 인덱싱: 인덱싱 연산입니다. CancelIndexing: 취소 인덱싱 연산입니다. 수색: 수색 작전입니다. 삭제: 삭제 작업입니다.
OperationState	허용된 작업 상태를 설명하는 열거형입니다. KnownOperationState OperationState와 교환하여 사용할 수 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 NotStarted: 작업이 시작되지 않았습니다. 실행 중: 작업이 진행 중입니다. 성공: 작업이 성공적으로 완료되었습니다. 실패: 작업이 실패했습니다. 취소됨: 사용자가 작업을 취소했습니다.
ProvisioningState	리소스 프로비저닝 상태입니다. KnownProvisioningState ProvisioningState와 교환하여 사용할 수 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 성공: 리소스가 생성되었습니다. 실패한: 리소스를 만들지 못했습니다. 취소된: 리소스 만들기가 취소되었습니다. 수락됨: 자원 생성 요청이 수락되었습니다 프로비저닝: 리소스가 프로비전되고 있습니다. 업데이트 중: 리소스가 업데이트 중입니다. 삭제: 자원이 삭제되고 있습니다
RepeatabilityResult	반복성 결과 헤더 옵션
RunStatus	실행 상태를 위한 열거 KnownRunStatus RunStatus와 교환하여 사용할 수 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 시작하지 않았다: 시작하지 않았다 달리기: 달리기 성공: 성공 취소: 취소됨 실패: 실패
StorageMountProtocol	저장 컨테이너를 마운트할 때 사용하는 프로토콜입니다. KnownStorageMountProtocol 은 StorageMountProtocol과 상호 교환 가능하며, 이 열거는 서비스가 지원하는 알려진 값을 포함합니다. 서비스에서 지원하는 알려진 값 NFS: NFS 프로토콜. 사용되는 NFS 버전은 저장 유형에 따라 다를 수 있습니다 BlobfuseCaching: 파일 캐시 모드에서 Blobfuse를 사용할 수 있습니다.
TaskCreateOrUpdateContent	작업을 생성하거나 업데이트할 때 제공된 작성 가능한 속성들.
TaskPriority	작업 우선순위 수준. KnownTaskPriority 는 TaskPriority와 상호 교환 가능하며, 이 열거는 서비스가 지원하는 알려진 값을 포함합니다. 서비스에서 지원하는 알려진 값 낮음: 낮은 우선순위 중간: 중간 우선순위 높음: 우선순위 높음
TaskStatus	작업 상태 열거. KnownTaskStatus TaskStatus와 교환하여 사용할 수 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 신규: 과제가 새로 생성되었습니다 대기: 작업이 보류 중입니다 완료: 과제가 완료되었습니다 삭제됨: 해당 작업이 삭제되었습니다 FlaggedHuman: 작업이 인간 검토를 위해 표시되었습니다 FlaggedAi: 이 작업이 AI 검토를 위해 표시되었습니다 실행 중: 작업 실행 중입니다 ExecutionDone: 작업 실행 완료 진부해졌다: 과제가 식상해졌다 실패: 과제가 실패했다 미완료: 과제가 미완성입니다
WorkingMemoryEntryType	작업 기억 입력 유형. KnownWorkingMemoryEntryType 은 WorkingMemoryEntryType과 교환 가능하며, 이 열거는 서비스가 지원하는 알려진 값을 포함합니다. 서비스에서 지원하는 알려진 값 생각: 생각

열거형

KnownByType	엔티티 타입을 위한 열거
KnownCitationType	인용문의 종류.
KnownDiscoveryEngineStatus	디스커버리 엔진 현황
KnownIndexingStatus	인덱싱 상태 열거
KnownInvestigationStatus	상태
KnownKnowledgeBaseOperationType	지식 기반 운영 상태를 나타냅니다.
KnownOperationState	허용된 작업 상태를 설명하는 열거형입니다.
KnownProvisioningState	리소스 프로비저닝 상태입니다.
KnownRunStatus	실행 상태를 위한 열거
KnownStorageMountProtocol	저장 컨테이너를 마운트할 때 사용하는 프로토콜입니다.
KnownTaskPriority	작업 우선순위 수준.
KnownTaskStatus	작업 상태 열거.
KnownWorkingMemoryEntryType	작업 기억 입력 유형.

함수

bookshelfClientRestorePoller<TResponse, TResult>(BookshelfClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	다른 폴러의 직렬화된 상태에서 폴러를 만듭니다. 이는 다른 호스트에서 폴러를 만들거나 원래 호스트가 범위에 없는 후 폴러를 생성해야 하는 경우에 유용할 수 있습니다.
isRestError(unknown)	RestError용 Typeguard
workspaceClientRestorePoller<TResponse, TResult>(WorkspaceClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	다른 폴러의 직렬화된 상태에서 폴러를 만듭니다. 이는 다른 호스트에서 폴러를 만들거나 원래 호스트가 범위에 없는 후 폴러를 생성해야 하는 경우에 유용할 수 있습니다.

변수

RestError

실패한 파이프라인 요청에 대한 사용자 지정 오류 유형입니다.

함수 세부 정보

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

다른 폴러의 직렬화된 상태에서 폴러를 만듭니다. 이는 다른 호스트에서 폴러를 만들거나 원래 호스트가 범위에 없는 후 폴러를 생성해야 하는 경우에 유용할 수 있습니다.

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

매개 변수

client

BookshelfClient

serializedState

string

sourceOperation

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

options

BookshelfClientRestorePollerOptions<TResult, PathUncheckedResponse>

반품

PollerLike<OperationState<TResult>, TResult>

isRestError(unknown)

RestError용 Typeguard

function isRestError(e: unknown): e

매개 변수

e

unknown

캐치 절에 의해 잡힌 무언가.

반품

e

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

다른 폴러의 직렬화된 상태에서 폴러를 만듭니다. 이는 다른 호스트에서 폴러를 만들거나 원래 호스트가 범위에 없는 후 폴러를 생성해야 하는 경우에 유용할 수 있습니다.

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

매개 변수

client

WorkspaceClient

serializedState

string

sourceOperation

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

options

WorkspaceClientRestorePollerOptions<TResult, PathUncheckedResponse>

반품

PollerLike<OperationState<TResult>, TResult>

변수 세부 정보

RestError

실패한 파이프라인 요청에 대한 사용자 지정 오류 유형입니다.

RestError: RestErrorConstructor

형식

RestErrorConstructor