Azure AI Foundry 에이전트 서비스(미리 보기)
Azure AI Foundry 에이전트 서비스 기능을 워크플로에 쉽게 통합합니다.
이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.
| 서비스 | 클래스 | Regions |
|---|---|---|
| Copilot Studio | Premium | 다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 논리 앱 | 스탠다드 | 다음을 제외한 모든 Logic Apps 지역 : - Azure Government 지역 - Azure 중국 지역 - 미국 국방부(DoD) |
| Power Apps | Premium | 다음을 제외한 모든 Power Apps 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| Power Automate (파워 오토메이트) | Premium | 다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 연락처 | |
|---|---|
| 이름 | Microsoft |
| URL | https://support.microsoft.com |
| 커넥터 메타데이터 | |
|---|---|
| 게시자 | Microsoft |
| 웹 사이트 | https://learn.microsoft.com/en-us/azure/ai-services/agents/ |
| 개인 정보 보호 정책 | https://learn.microsoft.com/en-us/legal/cognitive-services/agents/data-privacy-security |
| 카테고리 | AI; 비즈니스 인텔리전스 |
연결을 만드는 중
커넥터는 다음 인증 유형을 지원합니다.
| Logic Apps 앱 관리 ID | LogicApps 관리 ID를 사용하여 연결 만들기 | LOGICAPPS만 | 공유 가능 |
| Microsoft Entra ID 사용자 로그인 | Microsoft Entra ID 자격 증명으로 로그인 | 모든 지역 | 공유할 수 없음 |
| 기본값 [사용되지 않음] | 이 옵션은 명시적 인증 유형이 없는 이전 연결에만 해당되며 이전 버전과의 호환성을 위해서만 제공됩니다. | 모든 지역 | 공유할 수 없음 |
Logic Apps 관리 ID
인증 ID: managedIdentityAuth
적용 가능: LOGICAPPS만 해당
LogicApps 관리 ID를 사용하여 연결 만들기
공유 가능한 연결입니다. 전원 앱이 다른 사용자와 공유되면 연결도 공유됩니다. 자세한 내용은 캔버스 앱에 대한 커넥터 개요를 참조하세요. - Power Apps | Microsoft Docs
| 이름 | 유형 | Description | 필수 |
|---|---|---|---|
| LogicApps 관리 ID | 관리되는 ID | Logic Apps 관리 ID로 로그인 | 진실 |
| Azure AI 프로젝트 엔드포인트 | 문자열 | https://{account-name}.services.ai.azure.com/api/projects/{project-name}와 같은 Azure AI 프로젝트 엔드포인트의 이름입니다. | 진실 |
Microsoft Entra ID 사용자 로그인
인증 ID: entraIDUserLogin
적용 가능: 모든 지역
Microsoft Entra ID 자격 증명으로 로그인
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
| 이름 | 유형 | Description | 필수 |
|---|---|---|---|
| Azure AI 프로젝트 엔드포인트 | 문자열 | https://{account-name}.services.ai.azure.com/api/projects/{project-name}와 같은 Azure AI 프로젝트 엔드포인트의 이름입니다. | 진실 |
기본값 [사용되지 않음]
적용 가능: 모든 지역
이 옵션은 명시적 인증 유형이 없는 이전 연결에만 해당되며 이전 버전과의 호환성을 위해서만 제공됩니다.
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
제한 한도
| Name | 호출 | 갱신 기간 |
|---|---|---|
| 연결당 API 호출 | 1000 | 60초 |
동작
| 메시지 나열 |
메시지 나열 |
| 스레드 만들기 |
스레드 만들기 |
| 실행 생성 |
실행 생성 |
| 실행 시작 |
실행 시작 |
| 애플리케이션을 기반으로 하는 외부 에이전트 활동 프로토콜 |
애플리케이션을 기반으로 하는 외부 에이전트 활동 프로토콜 |
| 에이전트 나열 |
에이전트 나열 |
| 에이전트 식별자를 기반으로 하는 외부 에이전트 활동 프로토콜 |
에이전트 식별자를 기반으로 하는 외부 에이전트 활동 프로토콜 |
| 에이전트 호출 |
에이전트를 호출합니다. |
메시지 나열
메시지 나열
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
API 버전
|
api-version | True | string |
API 버전 |
|
메시지를 만들 스레드의 ID입니다.
|
ThreadId | True | string |
메시지를 만들 스레드의 ID입니다. |
반환
스레드 만들기
스레드 만들기
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
API 버전
|
api-version | True | string |
API 버전 |
|
역할
|
role | string |
메시지를 만드는 엔터티의 역할입니다. 사용자 또는 도우미일 수 있습니다. 'user'는 메시지가 실제 사용자가 보낸 것이며 대부분의 경우 사용자가 생성한 메시지를 나타내는 데 사용되어야 임을 나타냅니다. 'assistant'는 메시지가 도우미에 의해 생성됨을 나타냅니다. 도우미의 메시지를 대화에 삽입하려면 이 값을 사용합니다. |
|
|
내용
|
content | string |
메시지의 내용입니다. |
|
|
이름
|
name | string |
실행에서 사용할 수 있는 파일 ID 또는 메시지 목록입니다. |
|
|
metadata
|
metadata | object |
개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
|
|
metadata
|
metadata | object |
개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
|
|
tool_resources
|
tool_resources | object |
이 스레드의 도우미 도구에서 사용할 수 있는 리소스 집합입니다. 리소스는 도구 유형에 따라 다릅니다. 예를 들어 code_interpreter 도구에는 파일 ID 목록이 필요하지만 file_search 도구에는 벡터 저장소 ID 목록이 필요합니다. |
반환
실행 생성
실행 생성
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
API 버전
|
api-version | True | string |
API 버전 |
|
메시지를 만들 스레드의 ID입니다.
|
ThreadId | True | string |
메시지를 만들 스레드의 ID입니다. |
|
assistant_id
|
assistant_id | True | string |
이 실행을 수행하는 데 사용할 도우미의 ID입니다. |
|
model
|
model | string |
이 실행을 실행하는 데 사용할 모델 배포 이름입니다. 제공된 경우 도우미의 모델 배포 이름을 재정의합니다. |
|
|
instructions
|
instructions | string |
도우미의 지침을 재정의합니다. 실행 단위로 동작을 수정하는 데 유용합니다. |
|
|
additional_instructions
|
additional_instructions | string |
실행 지침 끝에 추가 지침을 추가합니다. |
|
|
역할
|
role | string |
메시지를 만드는 엔터티의 역할입니다. 사용자 또는 도우미일 수 있습니다. 'user'는 메시지가 실제 사용자가 보낸 것이며 대부분의 경우 사용자가 생성한 메시지를 나타내는 데 사용되어야 임을 나타냅니다. 'assistant'는 메시지가 도우미에 의해 생성됨을 나타냅니다. 도우미의 메시지를 대화에 삽입하려면 이 값을 사용합니다. |
|
|
내용
|
content | string |
메시지의 내용입니다. |
|
|
이름
|
name | string |
실행에서 사용할 수 있는 파일 ID 또는 메시지 목록입니다. |
|
|
metadata
|
metadata | object |
개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
|
|
이름
|
name | string |
실행에 사용할 수 있는 도구 목록입니다. |
|
|
metadata
|
metadata | object |
개체에 연결된 16개의 키-값 쌍 집합입니다. 키 최대 길이: 64자, 값 최대 길이: 512자. |
|
|
온도
|
temperature | number |
샘플링 온도(0-2). 값이 높을수록(예: 0.8) 임의성이 증가하고, 값이 낮을수록(예: 0.2) 출력이 더 결정적입니다. |
|
|
top_p (탑 피)
|
top_p | number |
온도에 대한 핵 샘플링 대안입니다. 0.1은 상위 10개% 확률 질량이 고려됨을 의미합니다. |
|
|
스트림
|
stream | boolean |
true이면 서버에서 보낸 이벤트로 실행하는 동안 이벤트 스트림을 반환하고 'data: [DONE]' 메시지로 종료합니다. |
|
|
max_prompt_tokens
|
max_prompt_tokens | integer |
실행에 사용될 수 있는 완료 토큰의 최대 수입니다. 초과하면 실행이 불완전한 것으로 종료됩니다. |
|
|
max_completion_tokens
|
max_completion_tokens | integer |
실행에 사용될 수 있는 완료 토큰의 최대 수입니다. 초과하면 실행이 불완전한 것으로 종료됩니다. |
|
|
truncation_strategy
|
truncation_strategy | object |
실행 전에 스레드가 잘리는 방법을 제어하여 초기 컨텍스트 창을 관리합니다. |
|
|
tool_choice
|
tool_choice | object |
모델이 호출하는 도구를 제어합니다. 기본값은 'auto'입니다. 그러면 모델이 결정할 수 있습니다. 도구 사용을 사용하지 않도록 설정하려면 'none'으로 설정할 수 있습니다. |
|
|
응답_형식
|
response_format | object |
출력 형식을 지정합니다. { 'type': 'json_object' }을(를) 설정하면 유효한 JSON 응답에 JSON 모드가 활성화됩니다. |
반환
실행 시작
실행 시작
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
API 버전
|
api-version | True | string |
API 버전 |
|
메시지를 만들 스레드의 ID입니다.
|
ThreadId | True | string |
메시지를 만들 스레드의 ID입니다. |
|
실행의 ID입니다.
|
RunId | True | string |
실행의 ID입니다. |
반환
애플리케이션을 기반으로 하는 외부 에이전트 활동 프로토콜
애플리케이션을 기반으로 하는 외부 에이전트 활동 프로토콜
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
에이전트 애플리케이션.
|
MyApplication | True | string |
에이전트 애플리케이션. |
|
|
object |
반환
- response
- object
에이전트 나열
에이전트 나열
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
API 버전
|
api-version | True | string |
API 버전 |
반환
에이전트 식별자를 기반으로 하는 외부 에이전트 활동 프로토콜
에이전트 식별자를 기반으로 하는 외부 에이전트 활동 프로토콜
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
메시지를 보낼 에이전트의 ID입니다.
|
AgentId | True | string |
메시지를 보낼 에이전트의 ID입니다. |
|
|
object |
반환
- response
- object
에이전트 호출
에이전트를 호출합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
API 버전
|
api-version | True | string |
API 버전 |
|
metadata
|
metadata | object |
개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 구조화된 형식으로 개체에 대한 추가 정보를 저장하고 API 또는 대시보드를 통해 개체를 쿼리하는 데 유용할 수 있습니다. 키는 최대 길이가 64자인 문자열입니다. 값은 최대 길이가 512자인 문자열입니다. |
|
|
사용자
|
user | string |
최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. 자세히알아보세요. |
|
|
top_logprobs
|
top_logprobs | integer |
각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. |
|
|
previous_response_id
|
previous_response_id | string |
모델에 대한 이전 응답의 고유 ID입니다. 멀티 턴 대화를 만드는 데 사용합니다. 대화 상태에 대해 자세히 알아봅니다. |
|
|
background
|
background | boolean |
백그라운드에서 모델 응답을 실행할지 여부입니다. 자세히알아보세요. |
|
|
max_output_tokens
|
max_output_tokens | integer |
표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한 입니다. |
|
|
최대_도구_호출수
|
max_tool_calls | integer |
응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. |
|
|
type
|
type | True | string |
모델이 출력해야 하는 형식을 지정하는 개체입니다. 구성 기본 형식은 gpt-4o 및 최신 모델에는 권장되지 않습니다.
|
|
type
|
type | True | string |
응답을 생성하는 데 사용할 수 있는 도구입니다. |
|
tool_choice
|
tool_choice |
모델이 응답을 생성할 때 사용할 도구(또는 도구)를 선택하는 방법입니다. 매개 변수를 |
||
|
아이디
|
id | True | string |
사용할 프롬프트 템플릿의 고유 식별자입니다. |
|
version
|
version | string |
프롬프트 템플릿의 선택적 버전입니다. |
|
|
variables
|
variables | object |
프롬프트에서 변수를 대체할 값의 선택적 맵입니다. 대체 값은 문자열이거나 이미지 또는 파일과 같은 다른 응답 입력 형식일 수 있습니다. |
|
|
truncation
|
truncation | string |
모델 응답에 사용할 잘림 전략입니다.
|
|
|
입력
|
input |
응답을 생성하는 데 사용되는 모델에 대한 텍스트, 이미지 또는 파일 입력입니다. 더 알아보세요: |
||
|
include
|
include | string |
모델 응답에 포함할 추가 출력 데이터를 지정합니다. 현재 지원되는 값은 다음과 같습니다.
|
|
|
병렬 도구 호출
|
parallel_tool_calls | boolean |
모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. |
|
|
store
|
store | boolean |
API를 통해 나중에 검색할 수 있도록 생성된 모델 응답을 저장할지 여부입니다. |
|
|
instructions
|
instructions | string |
모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다. 함께 |
|
|
type
|
type | True | string | |
|
이름
|
name | True | string |
에이전트의 이름입니다. |
|
version
|
version | True | string |
에이전트의 버전 식별자입니다. |
반환
정의
listAgentsResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
객체
|
object | string |
응답 개체 형식의 세부 정보입니다. |
|
데이터
|
data | array of Data |
서비스에서 반환된 메시지 목록입니다. |
|
첫번째_아이디
|
first_id | string |
첫 번째 ID의 세부 정보입니다. |
|
마지막 아이디
|
last_id | string |
마지막 ID의 세부 정보입니다. |
|
더_있음
|
has_more | boolean |
더 많은 에이전트가 있는지 여부를 알려줍니다. |
createThreadResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
API 엔드포인트에서 참조할 수 있는 식별자입니다. |
|
객체
|
object | string |
항상 스레드인 개체 형식입니다. |
|
생성_시간
|
created_at | integer |
스레드가 만들어진 시점의 Unix 타임스탬프(초)입니다. |
|
metadata
|
metadata | object |
개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
createRunResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
API 엔드포인트에서 참조할 수 있는 식별자입니다. |
|
객체
|
object | string |
항상 thread.run인 개체 형식입니다. |
|
생성_시간
|
created_at | integer |
실행이 만들어진 시점의 Unix 타임스탬프(초)입니다. |
|
thread_id
|
thread_id | string |
이 실행의 일부로 실행된 스레드의 ID입니다. |
|
assistant_id
|
assistant_id | string |
이 실행을 실행하는 데 사용되는 도우미의 ID입니다. |
|
status
|
status | string |
대기 중, in_progress, requires_action, 취소, 취소, 실패, 완료 또는 만료될 수 있는 실행 상태입니다. |
|
required_action
|
required_action | object |
실행을 계속하는 데 필요한 작업에 대한 세부 정보입니다. 작업이 필요하지 않은 경우 null이 됩니다. |
|
마지막_오류
|
last_error | object |
이 실행과 관련된 마지막 오류입니다. 오류가 없으면 null이 됩니다. |
|
만료_일자
|
expires_at | integer |
실행이 만료된 시점의 Unix 타임스탬프(초)입니다. |
|
started_at
|
started_at | integer |
실행이 시작된 시점의 Unix 타임스탬프(초)입니다. |
|
cancelled_at
|
cancelled_at | integer |
실행이 취소된 경우의 Unix 타임스탬프(초)입니다. |
|
failed_at
|
failed_at | integer |
실행이 실패한 시점의 Unix 타임스탬프(초)입니다. |
|
completed_at
|
completed_at | integer |
실행이 완료된 시점의 Unix 타임스탬프(초)입니다. |
|
model
|
model | string |
도우미가 이 실행에 사용한 모델 배포 이름입니다. |
|
instructions
|
instructions | string |
도우미가 이 실행에 사용한 지침입니다. |
|
도구들
|
tools | array of tools |
도우미가 이 실행에 사용한 도구 목록입니다. |
|
파일_아이디
|
file_ids | array of fileIds |
이 실행에 사용된 도우미의 파일 ID 목록입니다. |
|
metadata
|
metadata | object |
개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
|
tool_choice
|
tool_choice | object |
모델이 호출하는 도구(있는 경우)를 제어합니다. 'none'은 모델이 도구를 호출하지 않고 대신 메시지를 생성한다는 것을 의미합니다. 'auto'는 모델이 메시지를 생성하거나 도구를 호출하는 중에서 선택할 수 있습니다. {'type': 'file_search'} 또는 {'type': 'function', 'function': {'name': 'my_function'}}와 같은 도구를 지정하면 모델이 해당 도구를 호출하게 됩니다. |
|
max_prompt_tokens
|
max_prompt_tokens | number |
실행 과정에서 사용되도록 지정된 프롬프트 토큰의 최대 수입니다. |
|
max_completion_tokens
|
max_completion_tokens | number |
실행 과정에서 사용되도록 지정된 완료 토큰의 최대 수입니다. |
|
usage
|
usage | object |
실행과 관련된 사용 통계. 실행이 터미널 상태(예: in_progress, 큐에 대기됨)가 아닌 경우 이 값은 null이 됩니다. |
|
truncation_strategy
|
truncation_strategy | object |
실행하기 전에 스레드가 잘리는 방법을 제어합니다. |
|
응답_형식
|
response_format | string |
모델이 출력해야 하는 형식입니다. gpt-3.5-turbo-1106 이후 GPT-4 터보 및 모든 GPT-3.5 터보 모델과 호환됩니다. |
getRunResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
API 엔드포인트에서 참조할 수 있는 식별자입니다. |
|
객체
|
object | string |
항상 thread.run인 개체 형식입니다. |
|
생성_시간
|
created_at | integer |
실행이 만들어진 시점의 Unix 타임스탬프(초)입니다. |
|
thread_id
|
thread_id | string |
이 실행의 일부로 실행된 스레드의 ID입니다. |
|
assistant_id
|
assistant_id | string |
이 실행을 실행하는 데 사용되는 도우미의 ID입니다. |
|
status
|
status | string |
대기 중, in_progress, requires_action, 취소, 취소, 실패, 완료 또는 만료될 수 있는 실행 상태입니다. |
|
required_action
|
required_action | object |
실행을 계속하는 데 필요한 작업에 대한 세부 정보입니다. 작업이 필요하지 않은 경우 null이 됩니다. |
|
마지막_오류
|
last_error | object |
이 실행과 관련된 마지막 오류입니다. 오류가 없으면 null이 됩니다. |
|
만료_일자
|
expires_at | integer |
실행이 만료된 시점의 Unix 타임스탬프(초)입니다. |
|
started_at
|
started_at | integer |
실행이 시작된 시점의 Unix 타임스탬프(초)입니다. |
|
cancelled_at
|
cancelled_at | integer |
실행이 취소된 경우의 Unix 타임스탬프(초)입니다. |
|
failed_at
|
failed_at | integer |
실행이 실패한 시점의 Unix 타임스탬프(초)입니다. |
|
completed_at
|
completed_at | integer |
실행이 완료된 시점의 Unix 타임스탬프(초)입니다. |
|
model
|
model | string |
도우미가 이 실행에 사용한 모델 배포 이름입니다. |
|
instructions
|
instructions | string |
도우미가 이 실행에 사용한 지침입니다. |
|
도구들
|
tools | array of tools |
도우미가 이 실행에 사용한 도구 목록입니다. |
|
파일_아이디
|
file_ids | array of fileIds |
이 실행에 사용된 도우미의 파일 ID 목록입니다. |
|
metadata
|
metadata | object |
개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
|
tool_choice
|
tool_choice | object |
모델이 호출하는 도구(있는 경우)를 제어합니다. 'none'은 모델이 도구를 호출하지 않고 대신 메시지를 생성한다는 것을 의미합니다. 'auto'는 모델이 메시지를 생성하거나 도구를 호출하는 중에서 선택할 수 있습니다. {'type': 'file_search'} 또는 {'type': 'function', 'function': {'name': 'my_function'}}와 같은 도구를 지정하면 모델이 해당 도구를 호출하게 됩니다. |
|
max_prompt_tokens
|
max_prompt_tokens | number |
실행 과정에서 사용되도록 지정된 프롬프트 토큰의 최대 수입니다. |
|
max_completion_tokens
|
max_completion_tokens | number |
실행 과정에서 사용되도록 지정된 완료 토큰의 최대 수입니다. |
|
usage
|
usage | object |
실행과 관련된 사용 통계. 실행이 터미널 상태(예: in_progress, 큐에 대기됨)가 아닌 경우 이 값은 null이 됩니다. |
|
truncation_strategy
|
truncation_strategy | object |
실행하기 전에 스레드가 잘리는 방법을 제어합니다. |
|
응답_형식
|
response_format | string |
모델이 출력해야 하는 형식입니다. gpt-3.5-turbo-1106 이후 GPT-4 터보 및 모든 GPT-3.5 터보 모델과 호환됩니다. |
listMessageResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
객체
|
object | string |
응답 개체 형식의 세부 정보 |
|
데이터
|
data | array of Data |
서비스에서 반환된 메시지 목록입니다. |
|
첫번째_아이디
|
first_id | string |
첫 번째 ID의 세부 정보 |
|
마지막 아이디
|
last_id | string |
마지막 ID의 세부 정보 |
|
더_있음
|
has_more | boolean |
더 많은 에이전트가 있는지 여부를 알려줍니다. |
데이터
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
API 엔드포인트에서 참조할 수 있는 식별자입니다. |
|
객체
|
object | string |
항상 도우미인 개체 형식입니다. |
|
생성_시간
|
created_at | integer |
도우미가 만들어진 시점의 Unix 타임스탬프(초)입니다. |
|
이름
|
name | string |
도우미의 이름입니다. 최대 길이는 256자입니다. |
|
description
|
description | string |
도우미에 대한 설명입니다. 최대 길이는 512자입니다. |
|
model
|
model | string |
사용할 모델 배포 이름의 이름입니다. |
|
instructions
|
instructions | string |
도우미가 사용하는 시스템 지침입니다. 최대 길이는 32768자입니다. |
|
도구들
|
tools | array of tools |
도우미에서 사용하도록 설정된 도구 목록입니다. 도우미당 최대 128개의 도구가 있을 수 있습니다. 도구는 code_interpreter 또는 함수 형식일 수 있습니다. 함수 설명은 최대 1,024자일 수 있습니다. |
|
metadata
|
metadata | object |
개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 구조화된 형식으로 추가 정보를 저장하는 데 유용합니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
|
온도
|
temperature | number |
기본값은 1입니다. 사용할 샘플링 온도를 0에서 2 사이로 결정합니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. |
|
top_p (탑 피)
|
top_p | number |
기본값은 1입니다. 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. |
|
응답_형식
|
response_format | object |
모델이 출력해야 하는 형식을 지정합니다. 이 매개 변수를 { 'type': 'json_object' }로 설정하면 JSON 모드가 활성화되어 메시지가 유효한 JSON인지 확인합니다. |
|
tool_resources
|
tool_resources | object |
도우미 도구에서 사용하는 리소스 집합입니다. 리소스는 도구 유형에 따라 다릅니다. 예를 들어 code_interpreter 도구에는 파일 ID 목록이 필요하지만 file_search 도구에는 벡터 저장소 ID 목록이 필요합니다. |
OpenAI.ServiceTier
요청을 처리하는 데 사용되는 처리 유형을 지정합니다.
- 'auto'로 설정하면 요청이 프로젝트 설정에 구성된 서비스 계층으로 처리됩니다. 달리 구성하지 않는 한 프로젝트는 '기본값'을 사용합니다.
- 'default'로 설정하면 선택한 모델의 표준 가격 책정 및 성능으로 요청이 처리됩니다.
- 'flex' 또는 'priority'로 설정하면 해당 서비스 계층으로 요청이 처리됩니다. 우선 순위 처리에 대해 자세히 알아보려면 영업 담당자에게 문의하세요.
- 설정하지 않으면 기본 동작은 'auto'입니다.
매개 변수가 service_tier 설정되면 응답 본문에는 요청을 처리하는 데 실제로 사용되는 처리 모드를 기반으로 하는 값이 포함 service_tier 됩니다. 이 응답 값은 매개 변수에 설정된 값과 다를 수 있습니다.
요청을 처리하는 데 사용되는 처리 유형을 지정합니다.
- 'auto'로 설정하면 요청이 프로젝트 설정에 구성된 서비스 계층으로 처리됩니다. 달리 구성하지 않는 한 프로젝트는 '기본값'을 사용합니다.
- 'default'로 설정하면 선택한 모델의 표준 가격 책정 및 성능으로 요청이 처리됩니다.
- 'flex' 또는 'priority'로 설정하면 해당 서비스 계층으로 요청이 처리됩니다. 우선 순위 처리에 대해 자세히 알아보려면 영업 담당자에게 문의하세요.
- 설정하지 않으면 기본 동작은 'auto'입니다.
매개 변수가 service_tier 설정되면 응답 본문에는 요청을 처리하는 데 실제로 사용되는 처리 모드를 기반으로 하는 값이 포함 service_tier 됩니다. 이 응답 값은 매개 변수에 설정된 값과 다를 수 있습니다.
OpenAI.Reasoning
o 시리즈 모델만
추론 모델에 대한 구성 옵션입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
effort
|
effort | string | |
|
summary
|
summary | string |
모델에서 수행하는 추론에 대한 요약입니다. 이는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용할 수 있습니다.
|
|
generate_summary
|
generate_summary | string |
사용되지 않음: 대신 사용합니다 모델에서 수행하는 추론에 대한 요약입니다. 이는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용할 수 있습니다.
|
OpenAI.ResponseTextFormatConfiguration (응답 텍스트 형식 구성)
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
type
|
type | OpenAI.ResponseTextFormatConfigurationType |
모델이 출력해야 하는 형식을 지정하는 개체입니다. 구성 기본 형식은 gpt-4o 및 최신 모델에는 권장되지 않습니다.
|
오픈AI.응답텍스트형식구성유형
모델이 출력해야 하는 형식을 지정하는 개체입니다.
구성 { "type": "json_schema" } 은 구조적 출력을 사용하도록 설정하여 모델이 제공된 JSON 스키마와 일치하도록 합니다.
구조적 출력 가이드에서 자세히 알아보세요.
기본 형식은 { "type": "text" } 추가 옵션이 없습니다.
gpt-4o 및 최신 모델에는 권장되지 않습니다.
{ "type": "json_object" } 이전 JSON 모드를 사용하도록 설정하면 모델이 생성하는 메시지가 유효한 JSON인지 확인합니다. 이를 지원하는 모델에는 사용하는 json_schema 것이 좋습니다.
모델이 출력해야 하는 형식을 지정하는 개체입니다.
구성 { "type": "json_schema" } 은 구조적 출력을 사용하도록 설정하여 모델이 제공된 JSON 스키마와 일치하도록 합니다.
구조적 출력 가이드에서 자세히 알아보세요.
기본 형식은 { "type": "text" } 추가 옵션이 없습니다.
gpt-4o 및 최신 모델에는 권장되지 않습니다.
{ "type": "json_object" } 이전 JSON 모드를 사용하도록 설정하면 모델이 생성하는 메시지가 유효한 JSON인지 확인합니다. 이를 지원하는 모델에는 사용하는 json_schema 것이 좋습니다.
OpenAI.Tool
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
type
|
type | OpenAI.ToolType |
응답을 생성하는 데 사용할 수 있는 도구입니다. |
OpenAI 툴 타입
OpenAI.Prompt
프롬프트 템플릿 및 해당 변수에 대한 참조입니다. 자세히알아보세요.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
사용할 프롬프트 템플릿의 고유 식별자입니다. |
|
version
|
version | string |
프롬프트 템플릿의 선택적 버전입니다. |
|
variables
|
variables | OpenAI.ResponsePromptVariables |
프롬프트에서 변수를 대체할 값의 선택적 맵입니다. 대체 값은 문자열이거나 이미지 또는 파일과 같은 다른 응답 입력 형식일 수 있습니다. |
OpenAI.Response
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
metadata
|
metadata | object |
개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 구조화된 형식으로 개체에 대한 추가 정보를 저장하고 API 또는 대시보드를 통해 개체를 쿼리하는 데 유용할 수 있습니다. 키는 최대 길이가 64자인 문자열입니다. 값은 최대 길이가 512자인 문자열입니다. |
|
온도
|
temperature | float |
사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 |
|
top_p (탑 피)
|
top_p | float |
모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이 항목 또는 |
|
사용자
|
user | string |
최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. 자세히알아보세요. |
|
서비스 계층
|
service_tier | OpenAI.ServiceTier |
요청을 처리하는 데 사용되는 처리 유형을 지정합니다.
매개 변수가 |
|
top_logprobs
|
top_logprobs | integer |
각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. |
|
previous_response_id
|
previous_response_id | string |
모델에 대한 이전 응답의 고유 ID입니다. 멀티 턴 대화를 만드는 데 사용합니다. 대화 상태에 대해 자세히 알아봅니다. |
|
model
|
model | string |
이 응답을 만드는 데 사용할 모델 배포입니다. |
|
reasoning
|
reasoning | OpenAI.Reasoning |
o 시리즈 모델만 추론 모델에 대한 구성 옵션입니다. |
|
background
|
background | boolean |
백그라운드에서 모델 응답을 실행할지 여부입니다. 자세히알아보세요. |
|
max_output_tokens
|
max_output_tokens | integer |
표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한 입니다. |
|
최대_도구_호출수
|
max_tool_calls | integer |
응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. |
|
format
|
text.format | OpenAI.ResponseTextFormatConfiguration | |
|
도구들
|
tools | array of OpenAI.Tool |
응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. 매개 변수를 설정 모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다. |
|
tool_choice
|
tool_choice |
모델이 응답을 생성할 때 사용할 도구(또는 도구)를 선택하는 방법입니다. 매개 변수를 |
|
|
prompt
|
prompt | OpenAI.Prompt |
프롬프트 템플릿 및 해당 변수에 대한 참조입니다. 자세히알아보세요. |
|
truncation
|
truncation | string |
모델 응답에 사용할 잘림 전략입니다.
|
|
아이디
|
id | string |
이 응답의 고유 식별자입니다. |
|
객체
|
object | string |
이 리소스의 개체 유형은 항상 |
|
status
|
status | string |
응답 생성의 상태입니다.
|
|
생성_시간
|
created_at | unixtime |
이 응답을 만든 시점의 Unix 타임스탬프(초)입니다. |
|
오류
|
error | OpenAI.ResponseError |
모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다. |
|
이유
|
incomplete_details.reason | string |
응답이 불완전한 이유입니다. |
|
output
|
output | array of OpenAI.ItemResource |
모델에서 생성된 콘텐츠 항목의 배열입니다.
|
|
instructions
|
instructions |
모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다. 함께 |
|
|
output_text
|
output_text | string |
SDK 전용 편의 속성으로, |
|
usage
|
usage | OpenAI.ResponseUsage |
입력 토큰, 출력 토큰, 출력 토큰 분석 및 사용된 총 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다. |
|
병렬 도구 호출
|
parallel_tool_calls | boolean |
모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. |
|
아이디
|
conversation.id | string | |
|
agent
|
agent | AgentId |
OpenAI.ResponseError
모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
코드
|
code | OpenAI.ResponseErrorCode |
응답에 대한 오류 코드입니다. |
|
message
|
message | string |
사람이 읽을 수 있는 오류 설명입니다. |
OpenAI.ResponseErrorCode
OpenAI.ItemResource
응답을 생성하는 데 사용되는 콘텐츠 항목입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
type
|
type | OpenAI.ItemType | |
|
아이디
|
id | string |
OpenAI.ItemType
OpenAI.ResponseUsage
입력 토큰, 출력 토큰, 출력 토큰 분석 및 사용된 총 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
input_tokens
|
input_tokens | integer |
입력 토큰의 수입니다. |
|
cached_tokens
|
input_tokens_details.cached_tokens | integer |
캐시에서 검색된 토큰 수입니다. 프롬프트 캐싱에 대해 자세히 알아보세요. |
|
output_tokens
|
output_tokens | integer |
출력 토큰의 수입니다. |
|
추론 토큰
|
output_tokens_details.reasoning_tokens | integer |
추론 토큰의 수입니다. |
|
total_tokens
|
total_tokens | integer |
사용된 총 토큰 수입니다. |
AgentId
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
type
|
type | string | |
|
이름
|
name | string |
에이전트의 이름입니다. |
|
version
|
version | string |
에이전트의 버전 식별자입니다. |
OpenAI.ResponsePromptVariables
프롬프트에서 변수를 대체할 값의 선택적 맵입니다. 대체 값은 문자열이거나 이미지 또는 파일과 같은 다른 응답 입력 형식일 수 있습니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
|
object |
프롬프트에서 변수를 대체할 값의 선택적 맵입니다. 대체 값은 문자열이거나 이미지 또는 파일과 같은 다른 응답 입력 형식일 수 있습니다. |
도구들
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
이름
|
name | string |
실행에 사용할 수 있는 도구 목록입니다. |
fileIds
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
이름
|
name | string |
실행에서 사용할 수 있는 파일 ID 목록입니다. |
객체
'object' 형식입니다.