다음을 통해 공유


@azure/ai-agents package

클래스

AgentsClient
ToolSet

정의 및 리소스가 있는 도구 집합을 나타냅니다.

ToolUtility

다양한 도구를 만들기 위한 유틸리티 클래스입니다.

인터페이스

AISearchIndexResource

AI 검색 인덱스 리소스입니다.

Agent

모델을 호출하고 도구를 사용할 수 있는 에이전트를 나타냅니다.

AgentDeletionStatus

에이전트 삭제 작업의 상태입니다.

AgentErrorDetail

에이전트 API에서 반환된 오류 정보를 설명합니다.

AgentEventMessage

서버에서 보낸 이벤트 스트림의 각 이벤트에는 eventdata 속성이 있습니다. *

예시

  • 이벤트: Thread.Created
  • 데이터: {"id": "thread_123", "개체": "스레드", ...}
  • 새 개체를 만들거나, 새 상태로 전환하거나, 현재 상태일 때마다 이벤트를 내보냅니다.
  • 부분(델타)으로 스트리밍됩니다. 예를 들어 새 실행 시 thread.run.created 내보낸다.
  • 가 생성되고, 실행이 완료되면 thread.run.completed 등입니다. 에이전트가 선택하는 경우
  • 실행하는 동안 메시지를 만들려면 thread.message.created event내보낸다.
  • thread.message.in_progress 이벤트, 많은 thread.message.delta 이벤트 및 마지막으로
  • MouseDown 이벤트
  • 시간이 지남에 따라 이벤트를 더 추가할 수 있으므로 알 수 없는 이벤트를 정상적으로 처리하는 것이 좋습니다.
  • 코드에 있습니다.
AgentEventMessageStream

에이전트 이벤트 메시지의 스트림을 나타냅니다.

AgentThread

에이전트와 연결된 단일 스레드에 대한 정보입니다.

AgentThreadCreationOptions

새 에이전트 스레드를 만드는 데 사용되는 세부 정보입니다.

AgentV1Error

에이전트 API에서 반환된 오류 페이로드입니다.

AgentsClientOptionalParams

클라이언트에 대한 선택적 매개 변수입니다.

AgentsNamedToolChoice

모델에서 사용해야 하는 도구를 지정합니다. 모델이 강제로 특정 도구를 호출하도록 하는 데 사용합니다.

AgentsResponseFormat

모델의 예상 출력을 설명하는 개체입니다. json_object인 경우 function 형식 tools만 실행에 전달할 수 있습니다. text인 경우 모델은 텍스트 또는 필요한 값을 반환할 수 있습니다.

AzureAISearchToolDefinition

에이전트를 구성하는 데 사용되는 Azure AI 검색 도구에 대한 입력 정의 정보입니다.

AzureAISearchToolResource

azure_ai_search 도구에서 사용하는 인덱스 리소스 집합입니다.

AzureFunctionBinding

스토리지 큐 이름 및 URI를 유지하기 위한 구조입니다.

AzureFunctionDefinition

Azure 함수의 정의입니다.

AzureFunctionStorageQueue

스토리지 큐 이름 및 URI를 유지하기 위한 구조입니다.

AzureFunctionToolDefinition

에이전트를 구성하는 데 사용되는 Azure 함수 도구에 대한 입력 정의 정보입니다.

BingGroundingSearchConfiguration

Bing Grounding에 대한 검색 구성

BingGroundingSearchToolParameters

bing 접지 검색 도구 매개 변수입니다.

BingGroundingToolDefinition

에이전트를 구성하는 데 사용되는 bing 접지 검색 도구에 대한 입력 정의 정보입니다.

CodeInterpreterToolDefinition

에이전트를 구성하는 데 사용되는 코드 인터프리터 도구에 대한 입력 정의 정보입니다.

CodeInterpreterToolResource

code_interpreter 도구에서 사용하는 리소스 집합입니다.

ConnectedAgentDetails

한 에이전트를 다른 에이전트에 도구로 연결하기 위한 정보

ConnectedAgentToolDefinition

도메인별 하위 에이전트를 정의하는 연결된 에이전트 도구에 대한 입력 정의 정보입니다

CreateAgentOptionalParams

선택적 매개 변수입니다.

CreateThreadAndRunOptionalParams

선택적 매개 변수입니다.

DeleteAgentOptionalParams

선택적 매개 변수입니다.

FileDeletionStatus

파일 삭제 작업의 상태 응답입니다.

FileInfo

모델을 호출하고 도구를 사용할 수 있는 에이전트를 나타냅니다.

FileListResponse

파일 목록 작업의 응답 데이터입니다.

FileSearchRankingOptions

파일 검색에 대한 순위 옵션입니다.

FileSearchToolCallContent

파일 검색 결과 콘텐츠 개체입니다.

FileSearchToolDefinition

에이전트를 구성하는 데 사용되는 파일 검색 도구에 대한 입력 정의 정보입니다.

FileSearchToolDefinitionDetails

파일 검색 도구에 대한 옵션을 재정의합니다.

FileSearchToolResource

file_search 도구에서 사용하는 리소스 집합입니다.

FilesDeleteFileOptionalParams

선택적 매개 변수입니다.

FilesGetFileContentOptionalParams

선택적 매개 변수입니다.

FilesGetFileOptionalParams

선택적 매개 변수입니다.

FilesListFilesOptionalParams

선택적 매개 변수입니다.

FilesOperations

파일 작업을 나타내는 인터페이스입니다.

FilesUploadFileOptionalParams

선택적 매개 변수입니다.

FunctionDefinition

함수에 대한 입력 정의 정보입니다.

FunctionName

function 도구를 사용하는 경우 사용할 함수 이름입니다.

FunctionToolDefinition

에이전트를 구성하는 데 사용되는 함수 도구에 대한 입력 정의 정보입니다.

GetAgentOptionalParams

선택적 매개 변수입니다.

IncompleteRunDetails

실행이 완료되지 않은 이유에 대한 세부 정보입니다. 실행이 불완전하지 않으면 null.

ListAgentsOptionalParams

선택적 매개 변수입니다.

MessageAttachment

이는 파일이 첨부된 도구에 대해 설명합니다.

MessageContent

스레드 메시지 콘텐츠의 단일 항목에 대한 추상 표현입니다.

MessageDelta

스트리밍 메시지 델타 청크 내에서 형식화된 '델타' 페이로드를 나타냅니다.

MessageDeltaChunk

메시지 델타, 즉 스트리밍 중에 메시지의 변경된 필드를 나타냅니다.

MessageDeltaContent

부분 스트리밍된 메시지 콘텐츠 페이로드의 추상 기본 표현입니다.

MessageDeltaImageFileContent

스트리밍 메시지 델타 청크 내의 스트리밍된 이미지 파일 콘텐츠 부분을 나타냅니다.

MessageDeltaImageFileContentObject

스트리밍 이미지 파일 콘텐츠 내의 'image_file' 페이로드를 나타냅니다.

MessageDeltaTextAnnotation

스트리밍된 텍스트 콘텐츠 파트의 텍스트 주석에 대한 추상 기본 표현입니다.

MessageDeltaTextContent

스트리밍 메시지 델타 청크 내의 스트리밍된 텍스트 콘텐츠 부분을 나타냅니다.

MessageDeltaTextContentObject

스트리밍 메시지 델타 청크 내에서 스트리밍된 텍스트 콘텐츠 부분의 데이터를 나타냅니다.

MessageDeltaTextFileCitationAnnotation

스트리밍 텍스트 콘텐츠 부분에 적용된 스트리밍된 파일 인용을 나타냅니다.

MessageDeltaTextFileCitationAnnotationObject

스트리밍 텍스트 콘텐츠 부분에 적용된 스트리밍된 파일 인용의 데이터를 나타냅니다.

MessageDeltaTextFilePathAnnotation

스트리밍 텍스트 콘텐츠 부분에 적용되는 스트리밍된 파일 경로 주석을 나타냅니다.

MessageDeltaTextFilePathAnnotationObject

스트리밍 텍스트 콘텐츠 부분에 적용되는 스트리밍된 파일 경로 주석의 데이터를 나타냅니다.

MessageDeltaTextUrlCitationAnnotation

메시지와 연결된 특정 URL을 가리키는 메시지 내의 인용입니다. 에이전트가 'bing_grounding'와 같은 도구를 사용하여 인터넷을 검색할 때 생성됩니다.

MessageDeltaTextUrlCitationDetails

텍스트 스레드 메시지 콘텐츠에 사용되는 URL 인용의 표현입니다.

MessageImageFileContent

스레드 메시지의 이미지 파일 콘텐츠 표현입니다.

MessageImageFileDetails

스레드 메시지 콘텐츠에 표시된 이미지 참조입니다.

MessageImageFileParam

이미지 파일 블록을 생성할 때 내부적으로 업로드된 이미지 파일을 참조하는 방법을 정의합니다.

MessageImageUrlParam

image-URL 블록을 만들 때 외부 이미지 URL을 참조하는 방법을 정의합니다.

MessageIncompleteDetails

불완전한 상태를 입력하는 메시지에 대한 추가 세부 정보를 제공하는 정보입니다.

MessageInputContentBlock

메시지를 만들 때 단일 콘텐츠 블록을 정의합니다. 'type' 필드는 텍스트인지, 이미지 파일인지, 외부 이미지 URL인지를 결정합니다.

MessageInputImageFileBlock

파일 ID로 내부적으로 업로드된 이미지를 참조하는 새 메시지의 이미지 파일 블록입니다.

MessageInputImageUrlBlock

URL로 외부 이미지를 참조하는 새 메시지의 image-URL 블록입니다.

MessageInputTextBlock

일반 텍스트 내용을 포함하는 새 메시지의 텍스트 블록입니다.

MessageTextAnnotation

텍스트 스레드 메시지 콘텐츠에 대한 주석의 추상 표현입니다.

MessageTextContent

스레드 메시지 콘텐츠의 텍스트 항목 표현입니다.

MessageTextDetails

에이전트 스레드 메시지 콘텐츠의 단일 항목에 대한 텍스트 및 관련 주석입니다.

MessageTextFileCitationAnnotation

에이전트 또는 메시지와 연결된 특정 파일의 특정 견적을 가리키는 메시지 내의 인용입니다. 에이전트가 'file_search' 도구를 사용하여 파일을 검색할 때 생성됩니다.

MessageTextFileCitationDetails

텍스트 스레드 메시지 콘텐츠의 파일 기반 주석에 사용되는 파일 기반 텍스트 인용의 표현입니다.

MessageTextFilePathAnnotation

특정 경로에 있는 파일을 가리키는 메시지 내의 인용입니다.

MessageTextFilePathDetails

메시지 이미지 콘텐츠에서 사용하는 이미지 파일 ID의 캡슐화입니다.

MessageTextUrlCitationAnnotation

메시지와 연결된 특정 URL을 가리키는 메시지 내의 인용입니다. 에이전트가 'bing_grounding'와 같은 도구를 사용하여 인터넷을 검색할 때 생성됩니다.

MessageTextUrlCitationDetails

텍스트 스레드 메시지 콘텐츠에 사용되는 URL 인용의 표현입니다.

MessagesCreateMessageOptionalParams

선택적 매개 변수입니다.

MessagesGetMessageOptionalParams

선택적 매개 변수입니다.

MessagesListMessagesOptionalParams

선택적 매개 변수입니다.

MessagesOperations

메시지 작업을 나타내는 인터페이스입니다.

MessagesUpdateMessageOptionalParams

선택적 매개 변수입니다.

OpenApiAnonymousAuthDetails

OpenApi 익명 인증에 대한 보안 세부 정보

OpenApiAuthDetails

OpenApiFunctionDefinition에 대한 인증 세부 정보

OpenApiConnectionAuthDetails

OpenApi 연결 인증에 대한 보안 세부 정보

OpenApiConnectionSecurityScheme

OpenApi managed_identity 인증에 대한 보안 체계

OpenApiFunctionDefinition

openapi 함수에 대한 입력 정의 정보입니다.

OpenApiManagedAuthDetails

OpenApi managed_identity 인증에 대한 보안 세부 정보

OpenApiManagedSecurityScheme

OpenApi managed_identity 인증에 대한 보안 체계

OpenApiToolDefinition

에이전트를 구성하는 데 사용되는 OpenAPI 도구에 대한 입력 정의 정보입니다.

PageSettings

byPage 메서드에 대한 옵션

PagedAsyncIterableIterator

완료 및 페이지별로 비동기 반복 가능한 반복을 허용하는 인터페이스입니다.

PollingOptions

폴링 동작을 구성하는 옵션입니다.

PollingOptionsParams

폴링 동작을 구성하는 선택적 매개 변수입니다.

RequiredAction

에이전트 스레드가 계속 실행되도록 하는 데 필요한 작업의 추상 표현입니다.

RequiredFunctionToolCall

모델에서 실행을 계속 평가하는 데 필요한 함수 도구에 대한 요청된 호출의 표현입니다.

RequiredFunctionToolCallDetails

함수에 대한 이름 및 인수를 포함하는 함수 도구를 호출하는 필수 작업에서 제공하는 함수 호출에 대한 자세한 정보입니다.

RequiredToolCall

모델에서 실행을 계속하는 데 필요한 도구 호출의 추상 표현입니다.

ResponseFormatJsonSchema

응답 형식의 용도에 대한 설명이며, 모델에서 형식으로 응답하는 방법을 결정하는 데 사용됩니다.

ResponseFormatJsonSchemaType

정의되는 응답 형식의 형식: json_schema

RunCompletionUsage

실행과 관련된 사용 통계입니다. 이 값은 실행이 터미널 상태(예: null, in_progress등)에 없는 경우 queued.

RunError

에이전트 스레드 실행에서 발생한 오류의 세부 정보입니다.

RunStep

에이전트 스레드 실행의 단일 단계에 대한 자세한 정보입니다.

RunStepAzureAISearchToolCall

모델에서 실행된 Azure AI 검색을 나타내는 정의된 도구를 평가하여 발급한 Azure AI Search 도구에 대한 호출 레코드입니다.

RunStepBingGroundingToolCall

빙 접지로 실행된 검색을 나타내는 정의된 도구의 평가에서 모델에서 발급한 bing 접지 도구에 대한 호출 레코드입니다.

RunStepCodeInterpreterImageOutput

모델의 도구 호출에 대한 응답으로 코드 인터프리터 도구에서 내보낸 이미지 출력의 표현입니다.

RunStepCodeInterpreterImageReference

모델의 도구 호출에 대한 응답으로 코드 인터프리터 도구에서 내보낸 이미지 참조입니다.

RunStepCodeInterpreterLogOutput

모델의 도구 호출에 대한 응답으로 코드 인터프리터 도구에서 내보낸 로그 출력의 표현입니다.

RunStepCodeInterpreterToolCall

코드 인터프리터가 사용하고 내보낸 입력 및 출력을 나타내는 정의된 도구의 평가에서 모델에서 발급한 코드 인터프리터 도구에 대한 호출 레코드입니다.

RunStepCodeInterpreterToolCallDetails

모델에서 코드 인터프리터 호출에 대한 자세한 정보입니다.

RunStepCodeInterpreterToolCallOutput

코드 인터프리터 도구에서 내보낸 출력의 추상 표현입니다.

RunStepCompletionUsage

실행 단계와 관련된 사용 통계입니다.

RunStepDelta

스트리밍 실행 단계 델타 청크의 델타 페이로드를 나타냅니다.

RunStepDeltaChunk

실행 단계 델타, 즉, 스트리밍 중에 실행 단계에서 변경된 필드를 나타냅니다.

RunStepDeltaCodeInterpreterDetailItemObject

스트리밍 실행 단계의 도구 호출에서 코드 인터프리터 도구 호출 데이터를 나타냅니다.

RunStepDeltaCodeInterpreterImageOutput

코드 인터프리터 도구를 생성하고 스트리밍 실행 단계의 델타 도구 호출 컬렉션에 표시된 이미지 출력을 나타냅니다.

RunStepDeltaCodeInterpreterImageOutputObject

스트리밍 실행 단계의 코드 인터프리터 도구 호출 이미지 출력에 대한 데이터를 나타냅니다.

RunStepDeltaCodeInterpreterLogOutput

코드 인터프리터 도구에서 생성되고 스트리밍 실행 단계의 델타 도구 호출 컬렉션에 표시된 로그 출력을 나타냅니다.

RunStepDeltaCodeInterpreterOutput

스트리밍 실행 단계 도구 호출의 코드 인터프리터 도구 출력의 추상 기본 표현입니다.

RunStepDeltaCodeInterpreterToolCall

스트리밍 실행 단계의 도구 호출 세부 정보 내에서 코드 인터프리터 도구 호출을 나타냅니다.

RunStepDeltaDetail

스트리밍 실행 단계의 델타 페이로드에 있는 단일 실행 단계 세부 정보 항목을 나타냅니다.

RunStepDeltaFileSearchToolCall

스트리밍 실행 단계의 도구 호출 세부 정보 내에서 파일 검색 도구 호출을 나타냅니다.

RunStepDeltaFunction

스트리밍 실행 단계 델타의 함수 도구 호출에 있는 함수 데이터를 나타냅니다.

RunStepDeltaFunctionToolCall

스트리밍 실행 단계의 도구 호출 세부 정보 내에서 함수 도구 호출을 나타냅니다.

RunStepDeltaMessageCreation

스트리밍 실행 단계 델타 내에서 메시지 생성을 나타냅니다.

RunStepDeltaMessageCreationObject

스트리밍 실행 단계 메시지 생성 응답 개체 내의 데이터를 나타냅니다.

RunStepDeltaToolCall

스트리밍 실행 단계의 델타 도구 호출 세부 정보 내에서 단일 도구 호출의 추상 기본 표현입니다.

RunStepDeltaToolCallObject

스트리밍 실행 단계의 일부로 도구 호출 호출을 나타냅니다.

RunStepDetails

실행 단계에 대한 세부 정보의 추상 표현입니다.

RunStepError

실패한 실행 단계와 관련된 오류 정보입니다.

RunStepFileSearchToolCall

실행된 파일 검색을 나타내는 정의된 도구 평가에서 모델에서 발급한 파일 검색 도구에 대한 호출 레코드입니다.

RunStepFileSearchToolCallResult

파일 검색 도구 호출 결과입니다.

RunStepFileSearchToolCallResults

파일 검색의 결과입니다.

RunStepFunctionToolCall

지정된 함수에서 사용하고 내보낸 입력 및 출력을 나타내는 정의된 도구의 평가에서 모델에서 발급한 함수 도구에 대한 호출 레코드입니다.

RunStepFunctionToolCallDetails

모델에서 호출하는 함수에 대한 자세한 정보입니다.

RunStepMessageCreationDetails

메시지 만들기 실행 단계와 관련된 자세한 정보입니다.

RunStepMessageCreationReference

실행 단계의 일부로 만든 메시지의 세부 정보입니다.

RunStepOpenAPIToolCall

실행된 OpenAPI 작업을 나타내는 정의된 도구의 평가에서 모델에서 발급한 OpenAPI 도구에 대한 호출 레코드입니다.

RunStepToolCall

기존 실행에 대한 실행 단계 내에 기록된 자세한 도구 호출의 추상 표현입니다.

RunStepToolCallDetails

실행 단계 호출 도구와 관련된 자세한 정보입니다.

RunStepsGetRunStepOptionalParams

선택적 매개 변수입니다.

RunStepsListRunStepsOptionalParams

선택적 매개 변수입니다.

RunStepsOperations

RunSteps 작업을 나타내는 인터페이스입니다.

RunsCancelRunOptionalParams

선택적 매개 변수입니다.

RunsCreateRunOptionalParams

선택적 매개 변수입니다.

RunsGetRunOptionalParams

선택적 매개 변수입니다.

RunsListRunsOptionalParams

선택적 매개 변수입니다.

RunsOperations

실행 작업을 나타내는 인터페이스입니다.

RunsSubmitToolOutputsToRunOptionalParams

선택적 매개 변수입니다.

RunsUpdateRunOptionalParams

선택적 매개 변수입니다.

SubmitToolOutputsAction

에이전트 스레드 실행을 계속하려면 제출해야 하는 필수 도구 호출에 대한 세부 정보입니다.

SubmitToolOutputsDetails

도구 출력을 제출하기 위해 호출해야 하는 도구를 설명하는 세부 정보입니다.

ThreadDeletionStatus

스레드 삭제 작업의 상태입니다.

ThreadMessage

에이전트 스레드 내의 단일 기존 메시지입니다.

ThreadMessageOptions

초기 상태에 대해 해당 스레드를 만드는 동안 제공된 에이전트 스레드 내의 단일 메시지입니다.

ThreadRun

에이전트 스레드의 단일 평가 실행을 나타내는 데이터입니다.

ThreadsCreateThreadOptionalParams

선택적 매개 변수입니다.

ThreadsDeleteThreadOptionalParams

선택적 매개 변수입니다.

ThreadsGetThreadOptionalParams

선택적 매개 변수입니다.

ThreadsListThreadsOptionalParams

선택적 매개 변수입니다.

ThreadsOperations

스레드 작업을 나타내는 인터페이스입니다.

ThreadsUpdateThreadOptionalParams

선택적 매개 변수입니다.

ToolDefinition

에이전트에서 사용할 수 있는 입력 도구 정의의 추상 표현입니다.

ToolOutput

도구 중에 제공된 데이터는 제출을 출력하여 보류 중인 도구 호출을 해결하고 모델을 계속 진행할 수 있도록 합니다.

ToolResources

에이전트 도구에서 사용하는 리소스 집합입니다. 리소스는 도구 유형에 따라 다릅니다. 예를 들어 code_interpreter 도구에는 파일 ID 목록이 필요하지만 file_search 도구에는 벡터 저장소 ID 목록이 필요합니다.

TruncationObject

실행 전에 스레드가 잘리는 방법에 대한 컨트롤입니다. 실행의 초기 컨텍스트 창을 제어하는 데 사용합니다.

UpdateAgentOptionalParams

선택적 매개 변수입니다.

VectorStore

벡터 저장소는 file_search 도구에서 사용할 수 있는 처리된 파일의 컬렉션입니다.

VectorStoreAutoChunkingStrategyRequest

기본 전략. 이 전략은 현재 800의 max_chunk_size_tokens 사용하고 400의 chunk_overlap_tokens 사용합니다.

VectorStoreAutoChunkingStrategyResponse

청크 전략을 알 수 없는 경우 반환됩니다. 일반적으로 API에 chunking_strategy 개념이 도입되기 전에 파일이 인덱싱되었기 때문입니다.

VectorStoreChunkingStrategyRequest

벡터 저장소 청크 전략 구성의 추상 표현입니다.

VectorStoreChunkingStrategyResponse

벡터 저장소 청크 전략 구성의 추상 표현입니다.

VectorStoreConfiguration

벡터 스토리지 구성은 엔터프라이즈 파일 검색에 여러 파일을 사용할 수 있는 경우 사용되는 데이터 원본 목록입니다.

VectorStoreConfigurations

벡터 스토리지 구성 목록(예: Azure 자산 ID 목록)을 포함하는 구조체입니다.

VectorStoreDataSource

Azure 자산 URI 경로 및 엔터프라이즈 파일 검색을 위한 데이터 원본으로 사용되는 파일의 자산 형식을 포함하는 구조입니다.

VectorStoreDeletionStatus

벡터 저장소를 삭제하기 위한 응답 개체입니다.

VectorStoreExpirationPolicy

벡터 저장소에 대한 만료 정책입니다.

VectorStoreFile

벡터 저장소에 연결된 파일에 대한 설명입니다.

VectorStoreFileBatch

벡터 저장소에 연결된 파일의 일괄 처리입니다.

VectorStoreFileBatchesCancelVectorStoreFileBatchOptionalParams

선택적 매개 변수입니다.

VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams

선택적 매개 변수입니다.

VectorStoreFileBatchesGetVectorStoreFileBatchOptionalParams

선택적 매개 변수입니다.

VectorStoreFileBatchesListVectorStoreFileBatchFilesOptionalParams

선택적 매개 변수입니다.

VectorStoreFileBatchesOperations

VectorStoreFileBatches 작업을 나타내는 인터페이스입니다.

VectorStoreFileCount

상태별로 그룹화된 이 벡터 저장소에서 처리되거나 처리되는 파일의 수입니다.

VectorStoreFileDeletionStatus

벡터 저장소 파일 관계를 삭제하기 위한 응답 개체입니다.

VectorStoreFileError

이 벡터 저장소에 대한 파일을 처리하는 동안 발생할 수 있는 오류에 대한 세부 정보

VectorStoreFilesCreateVectorStoreFileOptionalParams

선택적 매개 변수입니다.

VectorStoreFilesDeleteVectorStoreFileOptionalParams

선택적 매개 변수입니다.

VectorStoreFilesGetVectorStoreFileOptionalParams

선택적 매개 변수입니다.

VectorStoreFilesListVectorStoreFilesOptionalParams

선택적 매개 변수입니다.

VectorStoreFilesOperations

VectorStoreFiles 작업을 나타내는 인터페이스입니다.

VectorStoreStaticChunkingStrategyOptions

벡터 저장소 정적 청크 전략을 구성하는 옵션입니다.

VectorStoreStaticChunkingStrategyRequest

정적으로 구성된 청크 분할 전략입니다.

VectorStoreStaticChunkingStrategyResponse

정적으로 구성된 청크 분할 전략입니다.

VectorStoresCreateVectorStoreOptionalParams

선택적 매개 변수입니다.

VectorStoresDeleteVectorStoreOptionalParams

선택적 매개 변수입니다.

VectorStoresGetVectorStoreOptionalParams

선택적 매개 변수입니다.

VectorStoresListVectorStoresOptionalParams

선택적 매개 변수입니다.

VectorStoresModifyVectorStoreOptionalParams

선택적 매개 변수입니다.

VectorStoresOperations

VectorStores 작업을 나타내는 인터페이스입니다.

형식 별칭

AgentEventStreamData

에이전트의 스트림 이벤트 데이터를 나타냅니다.

AgentRunResponse

에이전트는 스트림을 지원하는 응답을 실행합니다.

AgentStreamEvent

AgentStreamEvent의 별칭

AgentsNamedToolChoiceType

에이전트 명명된 도구에 사용할 수 있는 도구 유형입니다.

AgentsResponseFormatMode

모델이 도구 호출의 반환 형식을 처리하는 모드를 나타냅니다.

AgentsResponseFormatOption

AgentsResponseFormatOption의 별칭

AgentsToolChoiceOption

AgentsToolChoiceOption의 별칭

AgentsToolChoiceOptionMode

도구 선택 항목을 사용하는 방법을 지정합니다.

AzureAISearchQueryType

Azure AI Search 도구에 사용할 수 있는 쿼리 유형입니다.

ContinuablePage

결과 페이지를 설명하는 인터페이스입니다.

FileContents

이진 파일의 내용에 유효한 값입니다.

FilePurpose

파일의 의도된 사용을 나타내는 가능한 값입니다.

FileState

파일의 상태입니다.

ImageDetailLevel

이미지의 세부 수준을 지정합니다. 'auto', 'low', 'high' 또는 알 수 없는 미래 값일 수 있습니다.

IncompleteDetailsReason

실행이 완료되지 않은 이유입니다. 실행 과정에서 도달한 특정 토큰 제한을 가리킵니다.

ListSortOrder

응답 개체 목록을 요청할 때 사용할 수 있는 정렬 옵션입니다.

MessageAttachmentToolDefinition

MessageAttachmentToolDefinition에 대한 별칭

MessageBlockType

메시지 내의 콘텐츠 블록의 종류를 지정합니다. 텍스트, 이미지 파일, 외부 이미지 URL 또는 알 수 없는 미래 유형일 수 있습니다.

MessageContentUnion

MessageContentUnion의 별칭

MessageDeltaContentUnion

MessageDeltaContentUnion의 별칭

MessageDeltaTextAnnotationUnion

MessageDeltaTextAnnotationUnion의 별칭

MessageIncompleteDetailsReason

메시지가 불완전으로 표시된 이유를 설명하는 일련의 이유입니다.

MessageInputContent

MessageInputContent의 별칭

MessageInputContentBlockUnion

MessageInputContentBlockUnion의 별칭

MessageRole

스레드의 메시지에 기인하는 역할에 사용할 수 있는 값입니다.

MessageStatus

스레드 메시지에 사용할 수 있는 실행 상태 값입니다.

MessageTextAnnotationUnion

MessageTextAnnotationUnion의 별칭

OpenApiAuthDetailsUnion

OpenApiAuthDetailsUnion의 별칭

OpenApiAuthType

OpenApi 엔드포인트에 대한 인증 유형입니다. 허용되는 유형은 다음과 같습니다.

  • 익명(인증 필요 없음)
  • 연결(AI Foundry에서 설정한 대로 엔드포인트에 connection_id 필요)
  • Managed_Identity(ID 기반 인증을 위한 대상 그룹 필요)
RequiredActionUnion

RequiredActionUnion의 별칭

RequiredToolCallUnion

RequiredToolCallUnion의 별칭

ResponseFormat

가능한 API 응답 형식.

RunAdditionalFieldList

응답에 포함할 추가 필드 목록입니다.

RunStatus

에이전트 스레드 실행의 상태에 사용할 수 있는 값입니다.

RunStepCodeInterpreterToolCallOutputUnion

RunStepCodeInterpreterToolCallOutputUnion의 별칭

RunStepDeltaCodeInterpreterOutputUnion

RunStepDeltaCodeInterpreterOutputUnion의 별칭

RunStepDeltaDetailUnion

RunStepDeltaDetailUnion의 별칭

RunStepDeltaToolCallUnion

RunStepDeltaToolCallUnion의 별칭

RunStepDetailsUnion

RunStepDetailsUnion의 별칭

RunStepErrorCode

실패한 실행 단계로 인한 가능한 오류 코드 값입니다.

RunStepStatus

실행 단계의 상태에 사용할 수 있는 값입니다.

RunStepToolCallUnion

RunStepToolCallUnion의 별칭

RunStepType

가능한 실행 단계 유형

ToolDefinitionUnion

ToolDefinitionUnion의 별칭

TruncationStrategy

스레드에 대한 가능한 자르기 전략입니다.

VectorStoreChunkingStrategyRequestType

청크 전략의 유형

VectorStoreChunkingStrategyRequestUnion

VectorStoreChunkingStrategyRequestUnion의 별칭

VectorStoreChunkingStrategyResponseType

청크 전략의 유형

VectorStoreChunkingStrategyResponseUnion

VectorStoreChunkingStrategyResponseUnion의 별칭

VectorStoreExpirationPolicyAnchor

이 벡터 저장소의 일과 만료 사이의 관계를 설명합니다

VectorStoreFileBatchStatus

벡터 저장소 파일 배치의 상태입니다.

VectorStoreFileErrorCode

벡터 저장소 파일 처리를 위한 오류 코드 변형

VectorStoreFileStatus

벡터 저장소 파일 상태

VectorStoreFileStatusFilter

벡터 저장소 파일 검색 엔드포인트에 대한 쿼리 매개 변수 필터

VectorStoreStatus

벡터 저장 가능 상태

열거형

DoneEvent

스트림의 성공적인 끝을 나타내는 터미널 이벤트입니다.

ErrorEvent

스트리밍하는 동안 서버 쪽 오류를 나타내는 터미널 이벤트입니다.

KnownVersions

Azure AI 에이전트 API 버전

MessageStreamEvent

메시지 작업 관련 스트리밍 이벤트

RunStepStreamEvent

단계 작업 관련 스트리밍 이벤트 실행

RunStreamEvent

작업 관련 스트리밍 이벤트 실행

ThreadStreamEvent

스레드 작업 관련 스트리밍 이벤트

VectorStoreDataSourceAssetType

벡터 스토리지 자산의 유형입니다. 자산 유형은 uri_asset일 수 있으며, 이 경우 자산 URI ID를 포함해야 하고, id_asset 경우 데이터 ID를 포함해야 합니다.

connectionToolType

에이전트를 구성하는 데 사용되는 연결 도구 유형

함수

isOutputOfType<T>(ToolDefinitionUnion | RequiredAction | RequiredToolCall, string)

지정된 출력이 지정된 형식인지 여부를 확인합니다.

함수 세부 정보

isOutputOfType<T>(ToolDefinitionUnion | RequiredAction | RequiredToolCall, string)

지정된 출력이 지정된 형식인지 여부를 확인합니다.

function isOutputOfType<T>(output: ToolDefinitionUnion | RequiredAction | RequiredToolCall, type: string): output

매개 변수

output

ToolDefinitionUnion | RequiredAction | RequiredToolCall

RequiredAction, RequiredToolCall또는 ToolDefinitionUnion형식일 수 있는 확인할 작업입니다.

type

string

작업을 확인할 형식입니다.

반환

output

동작이 지정된 형식인지 여부를 나타내는 부울입니다.