AssistantsClient class

비 Azure OpenAI 엔드포인트에 사용하기 위해 AssistantsClient의 instance 초기화합니다.

new AssistantsClient(openAiApiKey: KeyCredential, options?: AssistantsClientOptions)

매개 변수

설명

이 생성자로 초기화된 AssistantsClient 개체는 비 Azure OpenAI 유추 엔드포인트에서만 사용할 수 있습니다. Azure OpenAI 리소스에서 AssistantsClient를 사용하려면 리소스 URI 및 Azure 인증 자격 증명을 허용하는 생성자를 대신 사용합니다.

OpenAI 리소스에 사용할 AssistantsClient의 instance 초기화합니다.

new AssistantsClient(endpoint: string, credential: KeyCredential, options?: AssistantsClientOptions)

매개 변수

설명

이 생성자는 Azure OpenAI 리소스에서만 사용할 수 있는 AssistantsClient 개체를 초기화합니다. 비 Azure OpenAI 유추 엔드포인트에서 AssistantsClient를 사용하려면 비 Azure OpenAI API 키를 허용하는 생성자를 대신 사용합니다.

Azure OpenAI 리소스에 사용할 AssistantsClient의 instance 초기화합니다.

new AssistantsClient(endpoint: string, credential: TokenCredential, options?: AssistantsClientOptions)

매개 변수

이 클라이언트가 요청을 만드는 데 사용하는 파이프라인

pipeline: Pipeline

속성 값

진행 중인 스레드의 실행을 취소합니다.

function cancelRun(threadId: string, runId: string, options?: CancelRunOptions): Promise<ThreadRun>

매개 변수

반환

새 도우미 만듭니다.

function createAssistant(body: AssistantCreationOptions, options?: CreateAssistantOptions): Promise<Assistant>

매개 변수

반환

파일을 읽을 수 있는 도구에서 사용하기 위해 이전에 업로드한 파일을 도우미 연결합니다.

function createAssistantFile(assistantId: string, fileId: string, options?: CreateAssistantFileOptions): Promise<AssistantFile>

매개 변수

반환

지정된 스레드에 새 메시지를 만듭니다.

function createMessage(threadId: string, role: string, content: string, options?: CreateMessageOptions): Promise<ThreadMessage>

매개 변수

반환

도우미 스레드에 대한 새 실행을 만듭니다.

function createRun(threadId: string, createRunOptions: CreateRunOptions, options?: CreateRunRequestOptions): Promise<ThreadRun>

매개 변수

반환

새 스레드를 만듭니다. 스레드는 메시지를 포함하며 도우미가 실행할 수 있습니다.

function createThread(body?: AssistantThreadCreationOptions, options?: CreateThreadOptions): Promise<AssistantThread>

매개 변수

반환

새 도우미 스레드를 만들고 해당 새 스레드를 사용하여 실행을 즉시 시작합니다.

function createThreadAndRun(body: CreateAndRunThreadOptions, options?: CreateThreadAndRunOptions): Promise<ThreadRun>

매개 변수

반환

도우미 삭제합니다.

function deleteAssistant(assistantId: string, options?: DeleteAssistantOptions): Promise<AssistantDeletionStatus>

매개 변수

반환

이전에 연결된 파일을 도우미 연결 해제하여 파일을 읽을 수 있는 도구에서 사용할 수 없게 렌더링합니다.

function deleteAssistantFile(assistantId: string, fileId: string, options?: DeleteAssistantFileOptions): Promise<AssistantFileDeletionStatus>

매개 변수

반환

이전에 업로드한 파일을 삭제합니다.

function deleteFile(fileId: string, options?: DeleteFileOptions): Promise<FileDeletionStatus>

매개 변수

반환

기존 스레드를 삭제합니다.

function deleteThread(threadId: string, options?: DeleteThreadOptions): Promise<ThreadDeletionStatus>

매개 변수

반환

기존 도우미 검색합니다.

function getAssistant(assistantId: string, options?: GetAssistantOptions): Promise<Assistant>

매개 변수

반환

도우미 연결된 파일을 검색합니다.

function getAssistantFile(assistantId: string, fileId: string, options?: GetAssistantFileOptions): Promise<AssistantFile>

매개 변수

반환

특정 파일에 대한 정보를 반환합니다. 파일 콘텐츠를 검색하지 않습니다.

function getFile(fileId: string, options?: GetFileOptions): Promise<InputFile>

매개 변수

반환

기존 스레드에서 기존 메시지를 가져옵니다.

function getMessage(threadId: string, messageId: string, options?: GetMessageOptions): Promise<ThreadMessage>

매개 변수

반환

스레드 내의 메시지에 첨부된 파일에 대한 정보를 가져옵니다.

function getMessageFile(threadId: string, messageId: string, fileId: string, options?: GetMessageFileOptions): Promise<MessageFile>

매개 변수

반환

기존 스레드에서 기존 실행을 가져옵니다.

function getRun(threadId: string, runId: string, options?: GetRunOptions): Promise<ThreadRun>

매개 변수

반환

스레드 실행에서 단일 실행 단계를 가져옵니다.

function getRunStep(threadId: string, runId: string, stepId: string, options?: GetRunStepOptions): Promise<RunStep>

매개 변수

반환

기존 스레드에 대한 정보를 가져옵니다.

function getThread(threadId: string, options?: GetThreadOptions): Promise<AssistantThread>

매개 변수

반환

파일을 읽을 수 있는 도구에서 사용하는 특정 도우미 첨부된 파일 목록을 가져옵니다.

function listAssistantFiles(assistantId: string, options?: ListAssistantFilesOptions): Promise<ListResponseOf<AssistantFile>>

매개 변수

반환

이전에 만든 도우미 목록을 가져옵니다.

function listAssistants(options?: ListAssistantsOptions): Promise<ListResponseOf<Assistant>>

매개 변수

반환

이전에 업로드한 파일의 목록을 가져옵니다.

function listFiles(options?: ListFilesOptions): Promise<FileListResponse>

매개 변수

반환

스레드에서 메시지와 연결된 이전에 업로드한 파일의 목록을 가져옵니다.

function listMessageFiles(threadId: string, messageId: string, options?: ListMessageFilesOptions): Promise<ListResponseOf<MessageFile>>

매개 변수

반환

스레드에 있는 메시지 목록을 가져옵니다.

function listMessages(threadId: string, options?: ListMessagesOptions): Promise<ListResponseOf<ThreadMessage>>

매개 변수

반환

지정된 스레드에 대한 실행 목록을 가져옵니다.

function listRuns(threadId: string, options?: ListRunsOptions): Promise<ListResponseOf<ThreadRun>>

매개 변수

반환

스레드 실행에서 실행 단계 목록을 가져옵니다.

function listRunSteps(threadId: string, runId: string, options?: ListRunStepsOptions): Promise<ListResponseOf<RunStep>>

매개 변수

반환

실행에서 도구 호출에서 요청한 대로 도구의 출력을 제출합니다. 제출된 도구 출력이 필요한 실행에는 'submit_tool_outputs'의 required_action.type이 있는 'requires_action'의 상태 있습니다.

function submitToolOutputsToRun(threadId: string, runId: string, toolOutputs: ToolOutput[], options?: SubmitToolOutputsToRunOptions): Promise<ThreadRun>

매개 변수

반환

기존 도우미 수정합니다.

function updateAssistant(assistantId: string, body: UpdateAssistantOptions, options?: UpdateAssistantRequestOptions): Promise<Assistant>

매개 변수

반환

기존 스레드에서 기존 메시지를 수정합니다.

function updateMessage(threadId: string, messageId: string, options?: UpdateMessageOptions): Promise<ThreadMessage>

매개 변수

반환

기존 스레드 실행을 수정합니다.

function updateRun(threadId: string, runId: string, options?: UpdateRunOptions): Promise<ThreadRun>

매개 변수

반환

기존 스레드를 수정합니다.

function updateThread(threadId: string, options?: UpdateThreadOptions): Promise<AssistantThread>

매개 변수

반환

다른 작업에서 사용할 파일을 업로드합니다.

function uploadFile(file: Uint8Array, purpose: string, options?: UploadFileOptions): Promise<InputFile>

매개 변수

반환