다음을 통해 공유


Microsoft Foundry Project REST 참조

API 버전: 2025-11-15-preview

에이전트 - 에이전트 만들기

POST {endpoint}/agents?api-version=2025-11-15-preview

에이전트를 만듭니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
정의 객체
└) 종류 AgentKind 아니오
└rai_config RaiConfig 책임 있는 AI(RAI) 콘텐츠 필터링 및 안전 기능에 대한 구성입니다. 아니오
description 문자열 에이전트에 대한 사람이 읽을 수 있는 설명입니다. 아니오
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
이름 문자열 에이전트를 식별하는 고유 이름입니다. 이름은 에이전트를 검색/업데이트/삭제하는 데 사용할 수 있습니다.
- 영숫자로 시작하고 끝나야 합니다.
- 중간에 하이픈을 포함할 수 있습니다.
- 63자를 초과하지 않아야 합니다.

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json AgentObject

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

에이전트 - 에이전트 나열

GET {endpoint}/agents?api-version=2025-11-15-preview

모든 에이전트의 목록을 반환합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
친절한 query 아니오 종류별로 에이전트를 필터링합니다. 제공되지 않으면 모든 에이전트가 반환됩니다.
limit query 아니오 integer 반환할 개체 수에 대한 제한입니다. 제한 범위는 1에서 100 사이이며
기본값은 20입니다.
order query 아니오 문자열
가능한 값: ascdesc
개체의 created_at 타임스탬프를 기준으로 순서를 정렬합니다. asc(오름차순의 경우), desc
(내림차순의 경우).
query 아니오 문자열 페이지 매김에 사용되는 커서입니다. after는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 다음 페이지를 가져오기 위해 after=obj_foo 포함할 수 있습니다.
before query 아니오 문자열 페이지 매김에 사용되는 커서입니다. before는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 이전 페이지를 가져오기 위해 before=obj_foo 포함할 수 있습니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json 객체 요청된 항목 목록에 대한 응답 데이터입니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

에이전트 - 에이전트 가져오기

GET {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

에이전트를 검색합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
agent_name 경로 문자열 검색할 에이전트의 이름입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json AgentObject

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

에이전트 - 에이전트 업데이트

POST {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

에이전트 정의에 변경 사항이 있는 경우 새 버전을 추가하여 에이전트를 업데이트합니다. 변경 사항이 없으면 기존 에이전트 버전을 반환합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
agent_name 경로 문자열 검색할 에이전트의 이름입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
정의 객체
└) 종류 AgentKind 아니오
└rai_config RaiConfig 책임 있는 AI(RAI) 콘텐츠 필터링 및 안전 기능에 대한 구성입니다. 아니오
description 문자열 에이전트에 대한 사람이 읽을 수 있는 설명입니다. 아니오
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json AgentObject

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

에이전트 - 에이전트 삭제

DELETE {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

에이전트를 삭제합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
agent_name 경로 문자열 삭제할 에이전트의 이름입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json DeleteAgentResponse

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

에이전트 - 매니페스트에서 에이전트 업데이트

POST {endpoint}/agents/{agent_name}/import?api-version=2025-11-15-preview

에이전트 정의가 변경된 경우 새 버전을 추가하여 매니페스트에서 에이전트를 업데이트합니다. 변경 사항이 없으면 기존 에이전트 버전을 반환합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
agent_name 경로 문자열 업데이트할 에이전트의 이름입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
description 문자열 에이전트에 대한 사람이 읽을 수 있는 설명입니다. 아니오
manifest_id 문자열 에이전트 버전을 가져올 매니페스트 ID입니다.
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
parameter_values 객체 완전히 구체화된 에이전트를 생성할 매니페스트에 대한 입력입니다.

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json AgentObject

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

에이전트 - 에이전트 컨테이너 작업 나열

GET {endpoint}/agents/{agent_name}/operations?api-version=2025-11-15-preview

에이전트에 대한 컨테이너 작업을 나열합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
agent_name 경로 문자열 에이전트의 이름입니다.
limit query 아니오 integer 반환할 개체 수에 대한 제한입니다. 제한 범위는 1에서 100 사이이며
기본값은 20입니다.
order query 아니오 문자열
가능한 값: ascdesc
개체의 created_at 타임스탬프를 기준으로 순서를 정렬합니다. asc(오름차순의 경우), desc
(내림차순의 경우).
query 아니오 문자열 페이지 매김에 사용되는 커서입니다. after는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 다음 페이지를 가져오기 위해 after=obj_foo 포함할 수 있습니다.
before query 아니오 문자열 페이지 매김에 사용되는 커서입니다. before는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 이전 페이지를 가져오기 위해 before=obj_foo 포함할 수 있습니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json 객체 요청된 항목 목록에 대한 응답 데이터입니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

에이전트 - 에이전트 컨테이너 작업 가져오기

GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=2025-11-15-preview

에이전트에 대한 컨테이너 작업의 상태를 가져옵니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
agent_name 경로 문자열 에이전트의 이름입니다.
operation_id 경로 문자열 작업 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json AgentContainerOperationObject

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse 또는 ApiErrorResponse

에이전트 - 에이전트 버전 만들기

POST {endpoint}/agents/{agent_name}/versions?api-version=2025-11-15-preview

새 에이전트 버전을 만듭니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
agent_name 경로 문자열 에이전트를 식별하는 고유 이름입니다. 이름은 에이전트를 검색/업데이트/삭제하는 데 사용할 수 있습니다.
- 영숫자로 시작하고 끝나야 합니다.
- 중간에 하이픈을 포함할 수 있습니다.
- 63자를 초과하지 않아야 합니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
정의 객체
└) 종류 AgentKind 아니오
└rai_config RaiConfig 책임 있는 AI(RAI) 콘텐츠 필터링 및 안전 기능에 대한 구성입니다. 아니오
description 문자열 에이전트에 대한 사람이 읽을 수 있는 설명입니다. 아니오
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json AgentVersionObject

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

에이전트 - 에이전트 버전 나열

GET {endpoint}/agents/{agent_name}/versions?api-version=2025-11-15-preview

에이전트의 버전 목록을 반환합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
agent_name 경로 문자열 버전을 검색할 에이전트의 이름입니다.
limit query 아니오 integer 반환할 개체 수에 대한 제한입니다. 제한 범위는 1에서 100 사이이며
기본값은 20입니다.
order query 아니오 문자열
가능한 값: ascdesc
개체의 created_at 타임스탬프를 기준으로 순서를 정렬합니다. asc(오름차순의 경우), desc
(내림차순의 경우).
query 아니오 문자열 페이지 매김에 사용되는 커서입니다. after는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 다음 페이지를 가져오기 위해 after=obj_foo 포함할 수 있습니다.
before query 아니오 문자열 페이지 매김에 사용되는 커서입니다. before는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 이전 페이지를 가져오기 위해 before=obj_foo 포함할 수 있습니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json 객체 요청된 항목 목록에 대한 응답 데이터입니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

에이전트 - 에이전트 버전 가져오기

GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=2025-11-15-preview

에이전트의 특정 버전을 검색합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
agent_name 경로 문자열 검색할 에이전트의 이름입니다.
agent_version 경로 문자열 검색할 에이전트의 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json AgentVersionObject

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

에이전트 - 에이전트 버전 삭제

DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=2025-11-15-preview

특정 버전의 에이전트를 삭제합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
agent_name 경로 문자열 삭제할 에이전트의 이름입니다.
agent_version 경로 문자열 삭제할 에이전트의 버전

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json DeleteAgentVersionResponse

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

에이전트 - 에이전트 컨테이너 가져오기

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=2025-11-15-preview

특정 버전의 에이전트에 대한 컨테이너를 가져옵니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
agent_name 경로 문자열 에이전트의 이름입니다.
agent_version 경로 문자열 에이전트의 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json AgentContainerObject

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

에이전트 - 에이전트 버전 컨테이너 작업 나열

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=2025-11-15-preview

특정 버전의 에이전트에 대한 컨테이너 작업을 나열합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
agent_name 경로 문자열 에이전트의 이름입니다.
agent_version 경로 문자열 에이전트의 버전입니다.
limit query 아니오 integer 반환할 개체 수에 대한 제한입니다. 제한 범위는 1에서 100 사이이며
기본값은 20입니다.
order query 아니오 문자열
가능한 값: ascdesc
개체의 created_at 타임스탬프를 기준으로 순서를 정렬합니다. asc(오름차순의 경우), desc
(내림차순의 경우).
query 아니오 문자열 페이지 매김에 사용되는 커서입니다. after는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 다음 페이지를 가져오기 위해 after=obj_foo 포함할 수 있습니다.
before query 아니오 문자열 페이지 매김에 사용되는 커서입니다. before는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 이전 페이지를 가져오기 위해 before=obj_foo 포함할 수 있습니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json 객체 요청된 항목 목록에 대한 응답 데이터입니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

에이전트 - 에이전트 컨테이너 삭제

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=2025-11-15-preview

특정 버전의 에이전트에 대한 컨테이너를 삭제합니다. 컨테이너가 없으면 작업이 no-op. 작업은 장기 실행 작업입니다. Azure REST API에서 장기 실행 작업에 대한 디자인 지침에 따릅니다. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
agent_name 경로 문자열 에이전트의 이름입니다.
agent_version 경로 문자열 에이전트의 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 202

설명: 처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다.

콘텐츠-타입 유형 설명
application/json AgentContainerOperationObject

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

에이전트 - 에이전트 컨테이너 시작

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=2025-11-15-preview

특정 버전의 에이전트에 대한 컨테이너를 시작합니다. 컨테이너가 이미 실행 중인 경우 작업이 no-op. 작업은 장기 실행 작업입니다. Azure REST API에서 장기 실행 작업에 대한 디자인 지침에 따릅니다. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
agent_name 경로 문자열 에이전트의 이름입니다.
agent_version 경로 문자열 에이전트의 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
max_replicas integer 최대 복제본 수입니다. 기본값은 1입니다. 아니오 1
min_replicas integer 최소 복제본 수입니다. 기본값은 1입니다. 아니오 1

응답

상태 코드: 202

설명: 처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다.

콘텐츠-타입 유형 설명
application/json AgentContainerOperationObject

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

에이전트 - 에이전트 컨테이너 중지

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=2025-11-15-preview

특정 버전의 에이전트에 대한 컨테이너를 중지합니다. 컨테이너가 실행되고 있지 않거나 이미 중지된 경우 작업이 no-op. 작업은 장기 실행 작업입니다. Azure REST API에서 장기 실행 작업에 대한 디자인 지침에 따릅니다. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
agent_name 경로 문자열 에이전트의 이름입니다.
agent_version 경로 문자열 에이전트의 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 202

설명: 처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다.

콘텐츠-타입 유형 설명
application/json AgentContainerOperationObject

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse 또는 ApiErrorResponse

에이전트 - 에이전트 컨테이너 업데이트

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=2025-11-15-preview

특정 버전의 에이전트에 대한 컨테이너를 업데이트합니다. 컨테이너가 실행되고 있지 않으면 작업이 no-op. 작업은 장기 실행 작업입니다. Azure REST API에서 장기 실행 작업에 대한 디자인 지침에 따릅니다. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
agent_name 경로 문자열 에이전트의 이름입니다.
agent_version 경로 문자열 에이전트의 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
max_replicas integer 최대 복제본 수입니다. 아니오
min_replicas integer 최소 복제본 수입니다. 아니오

응답

상태 코드: 202

설명: 처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다.

콘텐츠-타입 유형 설명
application/json AgentContainerOperationObject

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

에이전트 - 매니페스트에서 에이전트 버전 만들기

POST {endpoint}/agents/{agent_name}/versions:import?api-version=2025-11-15-preview

매니페스트에서 새 에이전트 버전을 생성합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
agent_name 경로 문자열 에이전트를 식별하는 고유 이름입니다. 이름은 에이전트를 검색/업데이트/삭제하는 데 사용할 수 있습니다.
- 영숫자로 시작하고 끝나야 합니다.
- 중간에 하이픈을 포함할 수 있습니다.
- 63자를 초과하지 않아야 합니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
description 문자열 에이전트에 대한 사람이 읽을 수 있는 설명입니다. 아니오
manifest_id 문자열 에이전트 버전을 가져올 매니페스트 ID입니다.
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
parameter_values 객체 완전히 구체화된 에이전트를 생성할 매니페스트에 대한 입력입니다.

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json AgentVersionObject

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

에이전트 - 매니페스트에서 에이전트 만들기

POST {endpoint}/agents:import?api-version=2025-11-15-preview

매니페스트에서 에이전트를 만듭니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
description 문자열 에이전트에 대한 사람이 읽을 수 있는 설명입니다. 아니오
manifest_id 문자열 에이전트 버전을 가져올 매니페스트 ID입니다.
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
이름 문자열 에이전트를 식별하는 고유 이름입니다. 이름은 에이전트를 검색/업데이트/삭제하는 데 사용할 수 있습니다.
- 영숫자로 시작하고 끝나야 합니다.
- 중간에 하이픈을 포함할 수 있습니다.
- 63자를 초과하지 않아야 합니다.
parameter_values 객체 완전히 구체화된 에이전트를 생성할 매니페스트에 대한 입력입니다.

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json AgentObject

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

연결 - 목록

GET {endpoint}/connections?api-version=2025-11-15-preview

연결 자격 증명을 채우지 않고 프로젝트의 모든 연결을 나열합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
connectionType query 아니오 이 특정 유형의 연결을 나열합니다.
defaultConnection query 아니오 부울 기본 연결인 연결 나열
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json PagedConnection

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

연결 - 가져오기

GET {endpoint}/connections/{name}?api-version=2025-11-15-preview

연결 자격 증명을 채우지 않고 이름으로 연결 가져오기

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 사용자가 제공한 연결의 이름입니다.
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json Connection

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

연결 - 자격 증명으로 가져오기

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=2025-11-15-preview

연결 자격 증명과 함께 이름으로 연결 가져오기

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 사용자가 제공한 연결의 이름입니다.
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json Connection

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

데이터 세트 - 최신 목록

GET {endpoint}/datasets?api-version=2025-11-15-preview

각 DatasetVersion의 최신 버전을 나열합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json PagedDatasetVersion

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

데이터 세트 - 버전 나열

GET {endpoint}/datasets/{name}/versions?api-version=2025-11-15-preview

지정된 DatasetVersion의 모든 버전을 나열합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 리소스의 이름

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json PagedDatasetVersion

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

데이터 세트 - 버전 가져오기

GET {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

DatasetVersion의 특정 버전을 가져옵니다. DatasetVersion이 없는 경우 서비스는 404 찾을 수 없음 오류를 반환합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 리소스의 이름
버전 경로 문자열 검색할 DatasetVersion의 특정 버전 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json DatasetVersion

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

데이터 세트 - 버전 삭제

DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

DatasetVersion의 특정 버전을 삭제합니다. DatasetVersion이 성공적으로 삭제되었거나 DatasetVersion이 없는 경우 서비스는 204 No Content를 반환합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 리소스의 이름
버전 경로 문자열 삭제할 DatasetVersion의 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 204

설명: 이 요청에 대해 보낼 콘텐츠는 없지만 헤더가 유용할 수 있습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

데이터 세트 - 버전 만들기 또는 업데이트

PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

지정된 버전 ID로 새 DatasetVersion을 만들거나 기존 DatasetVersion을 업데이트합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 리소스의 이름
버전 경로 문자열 만들거나 업데이트할 DatasetVersion의 특정 버전 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/merge-patch+json

이름 유형 Description 필수 기본값
description 문자열 자산 설명 텍스트입니다. 아니오
tags 객체 태그 사전입니다. 태그를 추가, 제거 및 업데이트할 수 있습니다. 아니오
type 객체 데이터 형식을 결정하는 열거형입니다.

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json DatasetVersion

상태 코드: 201

설명: 요청이 성공했고 결과적으로 새 리소스가 생성되었습니다.

콘텐츠-타입 유형 설명
application/json DatasetVersion

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

데이터 세트 - 자격 증명 가져오기

POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=2025-11-15-preview

SAS 자격 증명을 가져와 데이터 세트 버전과 연결된 스토리지 계정에 액세스합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 리소스의 이름
버전 경로 문자열 작업할 DatasetVersion의 특정 버전 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json AssetCredentialResponse

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

데이터 세트 - 업로드 버전 보류 중 시작

POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=2025-11-15-preview

특정 버전에 대한 데이터 세트의 새 업로드를 시작하거나 기존에 보류 중인 업로드를 가져옵니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 리소스의 이름
버전 경로 문자열 작업할 DatasetVersion의 특정 버전 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
연결 이름 문자열 임시 SAS 토큰을 생성하는 데 사용할 Azure Storage 계정 연결 이름 아니오
pendingUploadId 문자열 PendingUploadId를 제공하지 않으면 임의의 GUID가 사용됩니다. 아니오
pendingUploadType enum BlobReference는 유일하게 지원되는 형식입니다.
가능한 값: BlobReference

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json PendingUploadResponse

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

배포 - 목록

GET {endpoint}/deployments?api-version=2025-11-15-preview

프로젝트에 배포된 모든 모델 나열

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
modelPublisher query 아니오 문자열 모델을 필터링 기준으로 하는 모델 게시자
modelName query 아니오 문자열 모델을 필터링하는 기준으로 사용할 모델 이름(게시자별 이름)
deploymentType query 아니오 목록 필터링 기준으로 사용할 배포 유형
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json PagedDeployment

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

배포 - 가져오기

GET {endpoint}/deployments/{name}?api-version=2025-11-15-preview

배포된 모델을 가져옵니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 배포의 이름입니다
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json Deployment

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

평가 규칙 - 목록

GET {endpoint}/evaluationrules?api-version=2025-11-15-preview

모든 평가 규칙을 나열합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
actionType query 아니오 평가 규칙 유형별로 필터링합니다.
에이전트 이름 query 아니오 문자열 에이전트 이름으로 필터링합니다.
enabled query 아니오 부울 사용 상태별로 필터링합니다.
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json PagedEvaluationRule

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

평가 규칙 - 가져오기

GET {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

평가 규칙을 가져옵니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
아이디 경로 문자열 평가 규칙의 고유 식별자입니다.
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json EvaluationRule

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

평가 규칙 - 삭제

DELETE {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

평가 규칙을 삭제합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
아이디 경로 문자열 평가 규칙의 고유 식별자입니다.
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 204

설명: 이 요청에 대해 보낼 콘텐츠는 없지만 헤더가 유용할 수 있습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

평가 규칙 - 만들기 또는 업데이트

PUT {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

평가 규칙을 만들거나 업데이트합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
아이디 경로 문자열 평가 규칙의 고유 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
조치 객체 평가 작업 모델.
└─ 형식 EvaluationRuleActionType 평가 작업의 유형입니다. 아니오
description 문자열 평가 규칙에 대한 설명입니다. 아니오
displayName 문자열 평가 규칙의 표시 이름입니다. 아니오
enabled 부울 평가 규칙이 사용하도록 설정되었는지 여부를 나타냅니다. 기본값은 true입니다.
eventType 객체 평가 규칙 이벤트의 유형입니다.
filter 객체 평가 필터 모델. 아니오
└> agentName 문자열 상담원 이름으로 필터링합니다. 아니오
아이디 문자열 평가 규칙의 고유 식별자입니다.
시스템 데이터 객체 평가 규칙에 대한 시스템 메타데이터입니다.

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json EvaluationRule

상태 코드: 201

설명: 요청이 성공했고 결과적으로 새 리소스가 생성되었습니다.

콘텐츠-타입 유형 설명
application/json EvaluationRule

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

평가 분류 - 목록

GET {endpoint}/evaluationtaxonomies?api-version=2025-11-15-preview

평가 분류 목록

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
inputName query 아니오 문자열 평가 입력 이름으로 필터링합니다.
inputType query 아니오 문자열 분류 입력 유형별로 필터링합니다.
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json PagedEvaluationTaxonomy

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

평가 분류 - 가져오기

GET {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

이름으로 실행을 가져옵니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 리소스의 이름
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json EvaluationTaxonomy

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

평가 분류 - 삭제

DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

이름별로 평가 분류를 삭제합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 리소스의 이름
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 204

설명: 이 요청에 대해 보낼 콘텐츠는 없지만 헤더가 유용할 수 있습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

평가 분류 - 만들기

PUT {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

평가 분류를 생성합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 평가 분류의 이름입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
description 문자열 자산 설명 텍스트입니다. 아니오
속성 객체 평가 분류에 대한 추가 속성입니다. 아니오
tags 객체 태그 사전입니다. 태그를 추가, 제거 및 업데이트할 수 있습니다. 아니오
taxonomyCategories array 분류 범주 목록. 아니오
taxonomyInput 객체 평가 분류에 대한 입력 구성입니다.
└─ 형식 EvaluationTaxonomyInputType 평가 분류의 입력 유형입니다. 아니오

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json EvaluationTaxonomy

상태 코드: 201

설명: 요청이 성공했고 결과적으로 새 리소스가 생성되었습니다.

콘텐츠-타입 유형 설명
application/json EvaluationTaxonomy

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

평가 분류 - 업데이트

PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

평가 분류를 업데이트합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 평가 분류의 이름입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
description 문자열 자산 설명 텍스트입니다. 아니오
속성 객체 평가 분류에 대한 추가 속성입니다. 아니오
tags 객체 태그 사전입니다. 태그를 추가, 제거 및 업데이트할 수 있습니다. 아니오
taxonomyCategories array 분류 범주 목록. 아니오
taxonomyInput 객체 평가 분류에 대한 입력 구성입니다. 아니오
└─ 형식 EvaluationTaxonomyInputType 평가 분류의 입력 유형입니다. 아니오

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json EvaluationTaxonomy

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

계산기 - 최신 버전 나열

GET {endpoint}/evaluators?api-version=2025-11-15-preview

각 평가자의 최신 버전 나열

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
type query 아니오 유형별로 평가자를 필터링합니다. 가능한 값: 'all', 'custom', 'builtin'.
limit query 아니오 integer 반환할 개체 수에 대한 제한입니다. 제한 범위는 1~100이며 기본값은 20입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json PagedEvaluatorVersion

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

계산기 - 버전 나열

GET {endpoint}/evaluators/{name}/versions?api-version=2025-11-15-preview

지정된 평가자의 모든 버전 나열

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 리소스의 이름
type query 아니오 유형별로 평가자를 필터링합니다. 가능한 값: 'all', 'custom', 'builtin'.
limit query 아니오 integer 반환할 개체 수에 대한 제한입니다. 제한 범위는 1~100이며 기본값은 20입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json PagedEvaluatorVersion

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

계산기 - 버전 만들기

POST {endpoint}/evaluators/{name}/versions?api-version=2025-11-15-preview

자동 증가된 버전 ID를 사용하여 새 EvaluatorVersion 만들기

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 리소스의 이름

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
categories array 평가자의 범주
정의 객체 판별자를 사용한 기본 평가자 구성
└data_schema 평가자의 입력 데이터에 대한 JSON 스키마(초안 2020-12)입니다. 여기에는 유형, 속성, 필수와 같은 매개변수가 포함됩니다. 아니오
└init_parameters 평가자의 입력 매개 변수에 대한 JSON 스키마(초안 2020-12)입니다. 여기에는 유형, 속성, 필수와 같은 매개변수가 포함됩니다. 아니오
└) 메트릭 객체 이 평가자가 생성한 출력 메트릭 목록 아니오
└─ 형식 EvaluatorDefinitionType 평가자 정의 유형 아니오
description 문자열 자산 설명 텍스트입니다. 아니오
display_name 문자열 평가자의 표시 이름입니다. Foundry에서 계산기를 쉽게 찾을 수 있습니다. 고유할 필요는 없습니다. 아니오
evaluator_type 객체 평가자의 유형
metadata 객체 평가자에 대한 메타데이터 아니오
tags 객체 태그 사전입니다. 태그를 추가, 제거 및 업데이트할 수 있습니다. 아니오

응답

상태 코드: 201

설명: 요청이 성공했고 결과적으로 새 리소스가 생성되었습니다.

콘텐츠-타입 유형 설명
application/json EvaluatorVersion

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

평가자 - 버전 가져오기

GET {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

EvaluatorVersion의 특정 버전을 가져옵니다. EvaluatorVersion이 없는 경우 서비스는 404 찾을 수 없음 오류를 반환합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 리소스의 이름
버전 경로 문자열 검색할 EvaluatorVersion의 특정 버전 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json EvaluatorVersion

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

계산기 - 버전 삭제

DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

EvaluatorVersion의 특정 버전을 삭제합니다. EvaluatorVersion이 성공적으로 삭제되었거나 EvaluatorVersion이 없는 경우 서비스는 204 No Content를 반환합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 리소스의 이름
버전 경로 문자열 삭제할 EvaluatorVersion의 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 204

설명: 이 요청에 대해 보낼 콘텐츠는 없지만 헤더가 유용할 수 있습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

계산기 - 버전 업데이트

PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

지정된 버전 ID로 기존 EvaluatorVersion을 업데이트합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 리소스의 이름
버전 경로 문자열 업데이트할 EvaluatorVersion의 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
categories array 평가자의 범주 아니오
description 문자열 자산 설명 텍스트입니다. 아니오
display_name 문자열 평가자의 표시 이름입니다. Foundry에서 계산기를 쉽게 찾을 수 있습니다. 고유할 필요는 없습니다. 아니오
metadata 객체 평가자에 대한 메타데이터 아니오
tags 객체 태그 사전입니다. 태그를 추가, 제거 및 업데이트할 수 있습니다. 아니오

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json EvaluatorVersion

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

인덱스 - 최신 목록

GET {endpoint}/indexes?api-version=2025-11-15-preview

각 인덱스의 최신 버전을 나열합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json PagedIndex

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

인덱스 - 버전 나열

GET {endpoint}/indexes/{name}/versions?api-version=2025-11-15-preview

지정된 인덱스의 모든 버전 나열

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 리소스의 이름

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json PagedIndex

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

인덱스 - 버전 가져오기

GET {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

인덱스의 특정 버전을 가져옵니다. 인덱스가 없는 경우 서비스는 404 찾을 수 없음 오류를 반환합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 리소스의 이름
버전 경로 문자열 검색할 인덱스의 특정 버전 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json Index

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

인덱스 - 버전 삭제

DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

인덱스의 특정 버전을 삭제합니다. 인덱스가 성공적으로 삭제되었거나 인덱스가 없는 경우 서비스는 204 No Content를 반환합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 리소스의 이름
버전 경로 문자열 삭제할 인덱스의 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 204

설명: 이 요청에 대해 보낼 콘텐츠는 없지만 헤더가 유용할 수 있습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

인덱스 - 버전 만들기 또는 업데이트

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

지정된 버전 ID로 새 인덱스를 만들거나 기존 인덱스를 업데이트합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 리소스의 이름
버전 경로 문자열 만들거나 업데이트할 인덱스의 특정 버전 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/merge-patch+json

이름 유형 Description 필수 기본값
description 문자열 자산 설명 텍스트입니다. 아니오
tags 객체 태그 사전입니다. 태그를 추가, 제거 및 업데이트할 수 있습니다. 아니오
type 객체

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json Index

상태 코드: 201

설명: 요청이 성공했고 결과적으로 새 리소스가 생성되었습니다.

콘텐츠-타입 유형 설명
application/json Index

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

인사이트 - 생성

POST {endpoint}/insights?api-version=2025-11-15-preview

인사이트 생성

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
반복성 -Request-ID 머리글 아니오 문자열 요청 멱등성을 보장하기 위한 고유한 클라이언트 생성 식별자입니다. 중복 평가를 방지하기 위해 재시도에 동일한 ID를 사용합니다.
반복성 -First-Sent 머리글 아니오 문자열 이 요청이 처음 시작된 시기를 나타내는 타임스탬프입니다. 멱등성 제어를 위해 repeatability-request-id와 함께 사용됩니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
displayName 문자열 인사이트에 대한 사용자에게 친숙한 표시 이름입니다.
아이디 문자열 인사이트 보고서의 고유 식별자입니다.
metadata 객체 인사이트에 대한 메타데이터입니다.
└> completedAt 문자열 인사이트가 완료된 타임스탬프입니다. 아니오
└) createdAt 문자열 인사이트가 생성된 타임스탬프입니다. 아니오
request 객체 인사이트 보고서의 요청입니다.
└─ 형식 InsightType 요청의 유형입니다. 아니오
결과 객체 통찰력의 결과. 아니오
└─ 형식 InsightType 인사이트 결과의 유형입니다. 아니오
객체 허용된 작업 상태를 설명하는 열거형입니다.

응답

상태 코드: 201

설명: 요청이 성공했고 결과적으로 새 리소스가 생성되었습니다.

콘텐츠-타입 유형 설명
application/json 통찰력

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

인사이트 - 목록

GET {endpoint}/insights?api-version=2025-11-15-preview

모든 인사이트를 시간 역순으로 나열합니다(최신 것부터 시작).

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
type query 아니오 분석 유형별로 필터링합니다.
evalId query 아니오 문자열 평가 ID로 필터링합니다.
runId query 아니오 문자열 평가 실행 ID를 기준으로 필터링합니다.
에이전트 이름 query 아니오 문자열 에이전트 이름으로 필터링합니다.
includeCoordinates query 아니오 부울 응답에 시각화를 위한 좌표를 포함할지 여부입니다. 기본값은 false입니다.
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json PagedInsight

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

인사이트 - 가져오기

GET {endpoint}/insights/{id}?api-version=2025-11-15-preview

ID별로 특정 인사이트를 얻습니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
아이디 경로 문자열 인사이트 보고서의 고유 식별자입니다.
includeCoordinates query 아니오 부울 응답에 시각화를 위한 좌표를 포함할지 여부입니다. 기본값은 false입니다.
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json 통찰력

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

메모리 저장소 만들기

POST {endpoint}/memory_stores?api-version=2025-11-15-preview

메모리 저장소를 만듭니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
정의 객체 메모리 저장소 구성에 대한 기본 정의입니다.
└) 종류 MemoryStoreKind 메모리 저장소의 종류입니다. 아니오
description 문자열 메모리 저장소에 대한 사람이 읽을 수 있는 설명입니다. 아니오
metadata 객체 메모리 저장소와 연결할 임의의 키-값 메타데이터입니다. 아니오
이름 문자열 메모리 저장소의 이름입니다.

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json MemoryStoreObject

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

메모리 저장소 나열

GET {endpoint}/memory_stores?api-version=2025-11-15-preview

모든 메모리 저장소를 나열합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
limit query 아니오 integer 반환할 개체 수에 대한 제한입니다. 제한 범위는 1에서 100 사이이며
기본값은 20입니다.
order query 아니오 문자열
가능한 값: ascdesc
개체의 created_at 타임스탬프를 기준으로 순서를 정렬합니다. asc(오름차순의 경우), desc
(내림차순의 경우).
query 아니오 문자열 페이지 매김에 사용되는 커서입니다. after는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 다음 페이지를 가져오기 위해 after=obj_foo 포함할 수 있습니다.
before query 아니오 문자열 페이지 매김에 사용되는 커서입니다. before는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 이전 페이지를 가져오기 위해 before=obj_foo 포함할 수 있습니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json 객체 요청된 항목 목록에 대한 응답 데이터입니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

메모리 저장소 업데이트

POST {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

메모리 저장소를 업데이트합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 업데이트할 메모리 저장소의 이름입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
description 문자열 메모리 저장소에 대한 사람이 읽을 수 있는 설명입니다. 아니오
metadata 객체 메모리 저장소와 연결할 임의의 키-값 메타데이터입니다. 아니오

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json MemoryStoreObject

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

메모리 저장소 가져오기

GET {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

메모리 저장소를 검색합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 검색할 메모리 저장소의 이름입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json MemoryStoreObject

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

메모리 저장소 삭제

DELETE {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

메모리 저장소를 삭제합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 삭제할 메모리 저장소의 이름입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json DeleteMemoryStoreResponse

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

업데이트 결과 가져오기

GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=2025-11-15-preview

메모리 저장소 업데이트 결과를 가져옵니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 메모리 저장소의 이름입니다.
update_id 경로 문자열 메모리 업데이트 작업의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json MemoryStoreUpdateResponse

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

범위 메모리 삭제

POST {endpoint}/memory_stores/{name}:delete_scope?api-version=2025-11-15-preview

메모리 저장소에서 특정 범위와 연결된 모든 메모리를 삭제합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 메모리 저장소의 이름입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
scope 문자열 사용자 ID와 같이 삭제할 메모리를 논리적으로 그룹화하고 격리하는 네임스페이스입니다.

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json MemoryStoreDeleteScopeResponse

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

추억 검색

POST {endpoint}/memory_stores/{name}:search_memories?api-version=2025-11-15-preview

대화 컨텍스트를 기반으로 메모리 저장소에서 관련 메모리를 검색합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 검색할 메모리 저장소의 이름입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
items array 관련 추억을 검색할 항목입니다. 아니오
options 객체 메모리 검색 옵션. 아니오
└max_memories integer 반환할 최대 메모리 항목 수입니다. 아니오
previous_search_id 문자열 이전 검색 요청의 고유 ID로, 마지막 작업이 중단된 위치에서 증분 메모리 검색을 사용할 수 있습니다. 아니오
scope 문자열 사용자 ID와 같은 메모리를 논리적으로 그룹화하고 격리하는 네임스페이스입니다.

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json MemoryStoreSearchResponse

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

추억 업데이트

POST {endpoint}/memory_stores/{name}:update_memories?api-version=2025-11-15-preview

대화 메모리로 메모리 저장소를 업데이트합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 업데이트할 메모리 저장소의 이름입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
items array 추억을 추출할 수 있는 대화 항목입니다. 아니오
previous_update_id 문자열 이전 업데이트 요청의 고유 ID로, 마지막 작업이 중단된 위치에서 증분 메모리 업데이트를 사용할 수 있습니다. 아니오
scope 문자열 사용자 ID와 같은 메모리를 논리적으로 그룹화하고 격리하는 네임스페이스입니다.
update_delay integer 메모리 업데이트를 처리하기 전의 시간 초과 기간(초)입니다.
이 기간 동안 새 업데이트 요청이 수신되면 현재 요청을 취소하고 시간 제한을 재설정합니다.
지연 없이 업데이트를 즉시 트리거하려면 0으로 설정합니다.
기본값은 300(5분)입니다.
아니오 300

응답

상태 코드: 202

설명: 처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다.

콘텐츠-타입 유형 설명
application/json MemoryStoreUpdateResponse

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

대화 만들기

POST {endpoint}/openai/conversations?api-version=2025-11-15-preview

대화를 만듭니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
items array 대화 컨텍스트를 포함할 초기 항목입니다.
한 번에 최대 20개 항목을 추가할 수 있습니다.
아니오
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json OpenAI.ConversationResource

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

대화 나열

GET {endpoint}/openai/conversations?api-version=2025-11-15-preview

모든 대화 목록을 반환합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
limit query 아니오 integer 반환할 개체 수에 대한 제한입니다. 제한 범위는 1에서 100 사이이며
기본값은 20입니다.
order query 아니오 문자열
가능한 값: ascdesc
개체의 created_at 타임스탬프를 기준으로 순서를 정렬합니다. asc(오름차순의 경우), desc
(내림차순의 경우).
query 아니오 문자열 페이지 매김에 사용되는 커서입니다. after는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 다음 페이지를 가져오기 위해 after=obj_foo 포함할 수 있습니다.
before query 아니오 문자열 페이지 매김에 사용되는 커서입니다. before는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 이전 페이지를 가져오기 위해 before=obj_foo 포함할 수 있습니다.
agent_name query 아니오 문자열 상담원 이름으로 필터링합니다. 제공된 경우 지정된 에이전트와 연결된 항목만 반환됩니다.
agent_id query 아니오 문자열 에이전트 ID를 사용하여 형식으로 필터링합니다 name:version. 제공된 경우 지정된 에이전트 ID와 연결된 항목만 반환됩니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json 객체 요청된 항목 목록에 대한 응답 데이터입니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

대화 업데이트

POST {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

대화를 업데이트합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
conversation_id 경로 문자열 업데이트할 대화의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json OpenAI.ConversationResource

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

대화 가져오기

GET {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

대화를 검색합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
conversation_id 경로 문자열 검색할 대화의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json OpenAI.ConversationResource

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

대화 삭제

DELETE {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

대화를 삭제합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
conversation_id 경로 문자열 삭제할 대화의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json OpenAI.DeletedConversationResource

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

대화 항목 만들기

POST {endpoint}/openai/conversations/{conversation_id}/items?api-version=2025-11-15-preview

지정된 ID를 사용하여 대화에서 항목을 만듭니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
conversation_id 경로 문자열 항목을 만들어야 하는 대화의 ID입니다.
include query 아니오 array 응답에 포함할 추가 필드입니다.
include 자세한 내용은 대화 항목을 나열하는 매개 변수를 참조하세요.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
items array 대화에 추가할 항목입니다. 한 번에 최대 20개 항목을 추가할 수 있습니다.

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json OpenAI.ConversationItemList

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

대화 항목 나열

GET {endpoint}/openai/conversations/{conversation_id}/items?api-version=2025-11-15-preview

지정된 ID를 사용하여 대화의 모든 항목을 나열합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
conversation_id 경로 문자열 항목을 나열해야 하는 대화의 ID입니다.
limit query 아니오 integer 반환할 개체 수에 대한 제한입니다. 제한 범위는 1에서 100 사이이며
기본값은 20입니다.
order query 아니오 문자열
가능한 값: ascdesc
개체의 created_at 타임스탬프를 기준으로 순서를 정렬합니다. asc(오름차순의 경우), desc
(내림차순의 경우).
query 아니오 문자열 페이지 매김에 사용되는 커서입니다. after는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 다음 페이지를 가져오기 위해 after=obj_foo 포함할 수 있습니다.
before query 아니오 문자열 페이지 매김에 사용되는 커서입니다. before는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 이전 페이지를 가져오기 위해 before=obj_foo 포함할 수 있습니다.
item_type query 아니오 항목 유형별로 필터링합니다. 제공된 경우 지정된 형식의 항목만 반환됩니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json 객체 요청된 항목 목록에 대한 응답 데이터입니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

대화 항목 가져오기

GET {endpoint}/openai/conversations/{conversation_id}/items/{item_id}?api-version=2025-11-15-preview

지정된 ID와의 대화에서 단일 항목을 가져옵니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
conversation_id 경로 문자열 항목이 포함된 대화의 ID입니다.
item_id 경로 문자열 검색할 대화 항목의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json OpenAI.ItemResource

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

대화 항목 삭제

DELETE {endpoint}/openai/conversations/{conversation_id}/items/{item_id}?api-version=2025-11-15-preview

지정된 ID를 사용하여 대화에서 항목을 삭제합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
conversation_id 경로 문자열 항목을 삭제해야 하는 대화의 ID입니다.
item_id 경로 문자열 삭제할 대화 항목의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json OpenAI.ConversationResource

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

OpenAI evals - 목록 회피

GET {endpoint}/openai/evals?api-version=2025-11-15-preview

모든 평가 목록을 프로젝트에 대한 평가를 나열합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
query 아니오 문자열 이전 페이지 매김 요청의 마지막 실행에 대한 식별자입니다.
limit query 아니오 검색할 실행 횟수입니다.
order query 아니오 문자열
가능한 값: ascdesc
타임스탬프별로 실행 순서를 정렬합니다. asc는 오름차순, desc는 내림차순에 사용합니다. 기본값은 asc입니다.
정렬 기준 query 아니오 문자열
가능한 값: created_atupdated_at
생성 시간 또는 마지막으로 업데이트된 시간별로 Evals를 정렬할 수 있습니다. 사용하세요
created_at 생성 시간 또는 updated_at 마지막으로 업데이트된 시간에 대한 것입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json 객체 요청된 항목 목록에 대한 응답 데이터입니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

OpenAI evals - eval 만들기

POST {endpoint}/openai/evals?api-version=2025-11-15-preview

평가 만들기 모델의 성능을 테스트하는 데 사용할 수 있는 평가 구조를 만듭니다. 평가는 평가에 사용되는 데이터의 스키마를 지시하는 데이터 원본에 대한 테스트 조건 및 구성 집합입니다. 평가를 만든 후 다른 모델 및 모델 매개 변수에서 실행할 수 있습니다. 여러 유형의 채점자 및 데이터 원본을 지원합니다. 자세한 내용은 다음을 참조하세요.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
데이터 소스 구성 객체 평가 실행에 사용되는 데이터 원본에 대한 스키마를 정의하는 CustomDataSourceConfig 개체입니다.
이 스키마는 다음과 같은 데이터의 모양을 정의하는 데 사용됩니다.
- 테스트 조건을 정의하는 데 사용되며
- 실행을 만들 때 필요한 데이터
└─ include_sample_schema (샘플 스키마 포함) 부울 eval이 샘플 네임스페이스를 채울 것으로 예상해야 하는지 여부(예: 데이터 원본에서 응답을 생성하여) 아니오
└item_schema 객체 데이터 원본의 각 행에 대한 json 스키마입니다. 아니오
└) 메타데이터 객체 저장된 완료 데이터 원본에 대한 메타데이터 필터입니다. 아니오
└) 시나리오 enum 데이터 스키마 시나리오.
가능한 값: red_team, responsestraces
아니오
└─ 형식 enum 항상 label_model인 개체 형식입니다.
가능한 값: azure_ai_source
아니오
metadata OpenAI.Metadata 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
이름 문자열 평가의 이름입니다. 아니오
속성 객체 추가 정보를 저장하기 위해 개체에 연결할 수 있는 변경할 수 없는 16개의 키-값 쌍 집합입니다.
키는 최대 길이가 64자인 문자열입니다. 값은 최대 길이가 512자인 문자열입니다.
아니오
테스트 기준 array 이 그룹의 모든 eval 실행에 대한 채점자 목록입니다. 채점자는 다음과 같이 {{item.variable_name}}이중 중괄호 표기법을 사용하여 데이터 원본의 변수를 참조할 수 있습니다. 모델의 출력을 참조하려면 네임스페이 sample 스(예: {{sample.output_text}})를 사용합니다.

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json Eval

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

OpenAI evals - eval 삭제

DELETE {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

평가를 삭제하고 평가를 삭제합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
eval_id 경로 문자열 삭제할 평가의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json DeleteEvalResponse

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

OpenAI evals - get eval

GET {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

평가를 가져오면 ID로 평가를 가져옵니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
eval_id 경로 문자열 검색할 평가의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json Eval

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

OpenAI evals - 업데이트 eval

POST {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

평가 업데이트 평가의 특정 속성을 업데이트합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
eval_id 경로 문자열 업데이트할 평가의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
metadata OpenAI.Metadata 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
이름 문자열 아니오
속성 객체 추가 정보를 저장하기 위해 개체에 연결할 수 있는 변경할 수 없는 16개의 키-값 쌍 집합입니다.
키는 최대 길이가 64자인 문자열입니다. 값은 최대 길이가 512자인 문자열입니다.
아니오

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json Eval

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

OpenAI evals - 목록 실행

GET {endpoint}/openai/evals/{eval_id}/runs?api-version=2025-11-15-preview

평가에 대한 실행 목록을 가져옵니다. 평가에 대한 실행 목록을 가져옵니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
eval_id 경로 문자열 실행을 검색할 평가의 ID입니다.
query 아니오 문자열 이전 페이지 매김 요청의 마지막 실행에 대한 식별자입니다.
limit query 아니오 검색할 실행 횟수입니다.
order query 아니오 문자열
가능한 값: ascdesc
타임스탬프별로 실행 순서를 정렬합니다. asc는 오름차순, desc는 내림차순에 사용합니다. 기본값은 asc입니다.
상태 query 아니오 문자열
가능한 값: queued, in_progress, completedcanceled, failed . 상태별로 필터를 실행합니다. , , queuedin_progressfailed, completedcanceled하나입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json 객체 요청된 항목 목록에 대한 응답 데이터입니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

OpenAI evals - eval run 만들기

POST {endpoint}/openai/evals/{eval_id}/runs?api-version=2025-11-15-preview

평가 실행 만들기

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
eval_id 경로 문자열 실행을 만들 평가의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
데이터_소스 객체 eval과 일치하는 JSONL 파일을 지정하는 JsonlRunDataSource 개체
└input_messages OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate 또는 OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference 모델에서 샘플링할 때 사용됩니다. 모델에 전달된 메시지의 구조를 지정합니다. 미리 빌드된 궤적(즉, item.input_trajectory)에 대한 참조이거나 네임스페이스에 대한 변수 참조가 있는 템플릿일 수 item 있습니다. 아니오
└item_generation_params RedTeamItemGenerationParams 항목 생성에 대한 매개 변수입니다. 아니오
└─ 모델 문자열 완성을 생성하는 데 사용할 모델의 이름입니다(예: "o3-mini"). 아니오
└─ 샘플링_파라미터 OpenAI.CreateEvalResponsesRunDataSourceSamplingParams 아니오
└) 원본 OpenAI.EvalJsonlFileContentSource 또는 OpenAI.EvalJsonlFileIdSource 또는 OpenAI.EvalResponsesSource 이 실행의 데이터 원본에서 item 네임스페이스를 채우는 내용을 결정합니다. 아니오
└> 대상 대상 평가 대상 구성입니다. 아니오
└─ 형식 문자열 데이터 원본 형식 판별자입니다. 아니오
metadata OpenAI.Metadata 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
이름 문자열 실행의 이름입니다. 아니오
속성 객체 추가 정보를 저장하기 위해 개체에 연결할 수 있는 변경할 수 없는 16개의 키-값 쌍 집합입니다.
키는 최대 길이가 64자인 문자열입니다. 값은 최대 길이가 512자인 문자열입니다.
아니오

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json EvalRun

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

OpenAI evals - eval run 삭제

DELETE {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview

평가 실행 삭제는 eval 실행을 삭제합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
eval_id 경로 문자열 실행을 삭제할 평가의 ID입니다.
run_id 경로 문자열 삭제할 실행의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json DeleteEvalRunResponse

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

OpenAI evals - get eval run

GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview

평가 실행 가져오기 ID로 계산 실행 가져오기.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
eval_id 경로 문자열 실행을 검색할 평가의 ID입니다.
run_id 경로 문자열 검색할 실행의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json EvalRun

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

OpenAI evals - eval 실행 취소

POST {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview

평가 취소 실행 진행 중인 평가 실행을 취소합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
eval_id 경로 문자열 취소하려는 평가의 ID입니다.
run_id 경로 문자열 취소할 실행의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json EvalRun

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

OpenAI evals - eval 실행 출력 항목 가져오기

GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}/output_items?api-version=2025-11-15-preview

평가 실행 출력 항목 가져오기 평가 실행에 대한 출력 항목 목록을 가져옵니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
eval_id 경로 문자열
run_id 경로 문자열 출력 항목을 검색할 실행의 ID입니다.
query 아니오 문자열 이전 페이지 매김 요청의 마지막 실행에 대한 식별자입니다.
limit query 아니오 검색할 실행 횟수입니다.
order query 아니오 문자열
가능한 값: ascdesc
타임스탬프별로 실행 순서를 정렬합니다. asc는 오름차순, desc는 내림차순에 사용합니다. 기본값은 asc입니다.
상태 query 아니오 문자열
가능한 값: failpass
상태별로 출력 항목을 필터링합니다. 실패한 출력으로 필터링하는 데 사용 failed
항목 또는 pass 전달된 출력 항목별로 필터링합니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json 객체 요청된 항목 목록에 대한 응답 데이터입니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

OpenAI evals - eval 실행 출력 항목 가져오기

GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}?api-version=2025-11-15-preview

평가 실행의 출력 항목을 가져오면 ID별로 평가 실행 출력 항목을 가져옵니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
eval_id 경로 문자열 실행을 검색할 평가의 ID입니다.
run_id 경로 문자열 검색할 실행의 ID입니다.
output_item_id 경로 문자열 검색할 출력 항목의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json EvalRunOutputItem

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

미세 조정 작업 만들기

POST {endpoint}/openai/fine-tuning/jobs?api-version=2025-11-15-preview

지정된 데이터 세트에서 새 모델을 만드는 프로세스를 시작하는 미세 조정 작업을 만듭니다.

응답에는 작업 상태와 작업이 완료되면 미세 조정된 모델의 이름을 포함한 큐에 있는 작업의 세부 정보가 포함됩니다.

미세 조정에 대해 자세히 알아보기

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
하이퍼 매개 변수 객체 미세 조정 작업에 사용되는 하이퍼 매개 변수입니다.
이 값은 method 대신 사용되지 않으며, method 매개 변수로 전달해야 합니다.
아니오
└ batch_size enum
가능한 값: auto
아니오
└ 학습률 배수기 enum
가능한 값: auto
아니오
└n_epochs enum
가능한 값: auto
아니오
통합 array 미세 조정 작업에 사용할 수 있는 통합 목록입니다. 아니오
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
method OpenAI.FineTuneMethod 미세 조정에 사용되는 메서드입니다. 아니오
모델 string(아래 유효한 모델 참조) 미세 조정할 모델의 이름입니다. 다음 중 하나를 선택할 수 있습니다.
지원되는 모델.
seed integer 시드는 작업의 재현성을 제어합니다. 동일한 시드 및 작업 매개 변수를 전달하면 동일한 결과가 생성되지만 드문 경우에 다를 수 있습니다.
시드를 지정하지 않으면 시드가 생성됩니다.
아니오
suffix 문자열 미세 조정된 모델 이름에 추가될 최대 64자의 문자열입니다.

예를 들어 suffix "custom-model-name"은 다음과 같은 ft:gpt-4o-mini:openai:custom-model-name:7p4lURel모델 이름을 생성합니다.
아니오 None
교육 파일 문자열 학습 데이터가 포함된 업로드된 파일의 ID입니다.



데이터 세트의 형식을 JSONL 파일로 지정해야 합니다. 또한 용도 fine-tune로 파일을 업로드해야 합니다.

파일의 내용은 모델에서 채팅, 완료 형식을 사용하는지 또는 미세 조정 메서드에서 기본 설정 형식을 사용하는지에 따라 달라야 합니다.

자세한 내용은 미세 조정 가이드를 참조하세요.
검증_파일 문자열 유효성 검사 데이터를 포함하는 업로드된 파일의 ID입니다.

이 파일을 제공하는 경우 데이터는 유효성 검사를 생성하는 데 사용됩니다.
미세 조정 중에 메트릭을 주기적으로 측정합니다. 이러한 메트릭은 다음에서 볼 수 있습니다.
미세 조정 결과 파일입니다.
학습 파일과 유효성 검사 파일 모두에 동일한 데이터가 있으면 안 됩니다.

데이터 세트의 형식을 JSONL 파일로 지정해야 합니다. 용도 fine-tune로 파일을 업로드해야 합니다.

자세한 내용은 미세 조정 가이드를 참조하세요.
아니오

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json OpenAI.FineTuningJob

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

페이지를 매긴 미세 조정 작업 나열

GET {endpoint}/openai/fine-tuning/jobs?api-version=2025-11-15-preview

조직의 미세 조정 작업 나열

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
query 아니오 문자열 이전 페이지 매김 요청의 마지막 작업에 대한 식별자입니다.
limit query 아니오 integer 검색할 미세 조정 작업의 수.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json OpenAI.ListPaginatedFineTuningJobsResponse

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

미세 조정 작업 검색

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}?api-version=2025-11-15-preview

미세 조정 작업에 대한 정보를 가져옵니다.

미세 조정에 대해 자세히 알아보기

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
fine_tuning_job_id (미세 조정 작업 ID) 경로 문자열 미세 조정 작업의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json OpenAI.FineTuningJob

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

미세 조정 작업 취소

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/cancel?api-version=2025-11-15-preview

미세 조정 작업을 즉시 취소합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
fine_tuning_job_id (미세 조정 작업 ID) 경로 문자열 취소할 미세 조정 작업의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json OpenAI.FineTuningJob

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

미세 조정 작업 검사점 나열

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=2025-11-15-preview

미세 조정 작업의 검사점을 나열합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
fine_tuning_job_id (미세 조정 작업 ID) 경로 문자열 검사점을 가져오기 위한 미세 조정 작업의 ID.
query 아니오 문자열 이전 페이지 요청의 마지막 검사점 ID에 대한 식별자입니다.
limit query 아니오 integer 검색할 검사점의 수입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json OpenAI.ListFineTuningJobCheckpointsResponse

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

미세 조정 작업 이벤트 나열

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/events?api-version=2025-11-15-preview

미세 조정 작업에 대한 세분화된 상태 업데이트를 가져옵니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
fine_tuning_job_id (미세 조정 작업 ID) 경로 문자열 이벤트를 가져올 미세 조정 작업의 ID.
query 아니오 문자열 이전 페이지 요청의 마지막 이벤트에 대한 식별자입니다.
limit query 아니오 integer 검색할 이벤트의 수입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json OpenAI.ListFineTuningJobEventsResponse

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

미세 조정 작업 일시 중지

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/pause?api-version=2025-11-15-preview

실행 중인 미세 조정 작업을 일시 중지합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
fine_tuning_job_id (미세 조정 작업 ID) 경로 문자열 일시 중지할 미세 조정 작업의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json OpenAI.FineTuningJob

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

미세 조정 작업 다시 시작

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/resume?api-version=2025-11-15-preview

일시 중지된 미세 조정 작업을 다시 시작합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
fine_tuning_job_id (미세 조정 작업 ID) 경로 문자열 다시 시작할 미세 조정 작업의 ID.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json OpenAI.FineTuningJob

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

응답 만들기 - 응답 스트림 만들기

POST {endpoint}/openai/responses?api-version=2025-11-15-preview

모델 응답을 만듭니다. 모델 응답(스트리밍 응답)을 만듭니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 아니오 문자열 이 작업에 사용할 API 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
agent AgentReference 응답을 생성하는 데 사용할 에이전트입니다. 아니오
background 부울 백그라운드에서 모델 응답을 실행할지 여부입니다.
배경 응답에 대해 자세히 알아봅니다.
아니오 거짓
대화 문자열 또는 개체 아니오
include array 모델 응답에 포함할 추가 출력 데이터를 지정합니다. 현재
지원되는 값은 다음과 같습니다.
- code_interpreter_call.outputs: Python 코드 실행의 출력을 포함합니다.
코드 인터프리터 도구에서 항목을 호출합니다.
- computer_call_output.output.image_url: 컴퓨터 호출 출력의 이미지 URL을 포함합니다.
- file_search_call.results: 다음의 검색 결과를 포함합니다.
파일 검색 도구 호출입니다.
- message.input_image.image_url: 입력 메시지의 이미지 URL을 포함합니다.
- message.output_text.logprobs: 도우미 메시지와 함께 logprobs를 포함합니다.
- reasoning.encrypted_content: 암호화된 버전의 추론 포함
추론 항목의 출력에 있는 토큰입니다. 이렇게 하면 추론 항목을 사용할 수 있습니다.
응답 API를 상태 없이 사용할 때 멀티 턴 대화(예:
store 매개 변수가 false로 설정되거나 조직이
데이터 보존 없음 프로그램에 등록됨).
아니오
입력 문자열 또는 배열 응답을 생성하는 데 사용되는 모델에 대한 텍스트, 이미지 또는 파일 입력입니다.

더 알아보세요:
- 텍스트 입력 및 출력
- 이미지 입력
- 파일 입력
- 대화 상태 관리
- 함수 호출
아니오
instructions 문자열 모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다.

previous_response_id와 함께 사용할 경우 이전의 지침이 적용됩니다.
응답은 다음 응답으로 전달되지 않습니다. 이렇게 하면 간단해집니다.
새 응답에서 시스템(또는 개발자) 메시지를 교환합니다.
아니오
max_output_tokens integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한 입니다. 아니오
최대_도구_호출수 integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. 아니오
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
모델 문자열 이 응답을 만드는 데 사용할 모델 배포입니다. 아니오
병렬 도구 호출 부울 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. 아니오 진실
previous_response_id 문자열 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다. 자세한 정보
대화 상태 관리
아니오
prompt OpenAI.Prompt 프롬프트 템플릿 및 해당 변수에 대한 참조입니다.
자세히알아보세요.
아니오
reasoning OpenAI.Reasoning o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.
아니오
서비스 계층 OpenAI.ServiceTier 참고: service_tier Azure OpenAI에는 적용되지 않습니다. 아니오
store 부울 를 통해 나중에 검색할 수 있도록 생성된 모델 응답을 저장할지 여부
API.
아니오 진실
스트림 부울 true로 설정하면 모델 응답 데이터가 클라이언트로 스트리밍됩니다.
서버에서 보낸 이벤트를 사용하여 생성됩니다.

참조하세요.
아니오 거짓
structured_inputs 객체 프롬프트 템플릿 대체 또는 도구 인수 바인딩에 참여할 수 있는 응답에 대한 구조적 입력입니다. 아니오
온도 숫자 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.
아니오 1
문자 메시지 객체 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반
텍스트 또는 구조적 JSON 데이터일 수 있습니다. 텍스트 입력 및 출력 참조
구조적 출력
아니오
└─ 형식 OpenAI.ResponseTextFormatConfiguration 아니오
tool_choice OpenAI.ToolChoiceOptions 또는 OpenAI.ToolChoiceObject 모델을 생성할 때 사용할 도구(또는 도구)를 선택하는 방법
응답입니다. 도구를 지정하는 방법을 알아보려면 tools 매개 변수를 참조하세요.
모델이 호출할 수 있습니다.
아니오
도구들 array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. 너
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

- 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
파일 검색과 같은 모델의 기능.
- 함수 호출(사용자 지정 도구): 사용자가 정의한 함수
모델을 사용하여 사용자 고유의 코드를 호출할 수 있습니다.
아니오
top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. 아니오
top_p (탑 피) 숫자 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.
아니오 1
truncation enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled
아니오
사용자 문자열 안전 모범 사례에 대해 자세히 알아보세요. 아니오

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json OpenAI.Response
text/event-stream OpenAI.ResponseStreamEvent

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

응답 나열

GET {endpoint}/openai/responses?api-version=2025-11-15-preview

모든 응답의 목록을 반환합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
limit query 아니오 integer 반환할 개체 수에 대한 제한입니다. 제한 범위는 1에서 100 사이이며
기본값은 20입니다.
order query 아니오 문자열
가능한 값: ascdesc
개체의 created_at 타임스탬프를 기준으로 순서를 정렬합니다. asc(오름차순의 경우), desc
(내림차순의 경우).
query 아니오 문자열 페이지 매김에 사용되는 커서입니다. after는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 다음 페이지를 가져오기 위해 after=obj_foo 포함할 수 있습니다.
before query 아니오 문자열 페이지 매김에 사용되는 커서입니다. before는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 이전 페이지를 가져오기 위해 before=obj_foo 포함할 수 있습니다.
agent_name query 아니오 문자열 상담원 이름으로 필터링합니다. 제공된 경우 지정된 에이전트와 연결된 항목만 반환됩니다.
agent_id query 아니오 문자열 에이전트 ID를 사용하여 형식으로 필터링합니다 name:version. 제공된 경우 지정된 에이전트 ID와 연결된 항목만 반환됩니다.
conversation_id query 아니오 문자열 대화 ID를 사용하여 필터링합니다. 제공된 경우 지정된 대화와 연결된 응답만 반환됩니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json 객체 요청된 항목 목록에 대한 응답 데이터입니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

응답 가져오기 - 응답 스트림 가져오기

GET {endpoint}/openai/responses/{response_id}?api-version=2025-11-15-preview

지정된 ID를 사용하여 모델 응답을 검색합니다. 지정된 ID(스트리밍 응답)를 사용하여 모델 응답을 검색합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 아니오 문자열 이 작업에 사용할 API 버전입니다.
response_id 경로 문자열
include[] query 아니오 array
스트림 query 아니오 부울
starting_after query 아니오 integer
받아들이다 머리글 아니오 문자열
가능한 값: text/event-stream

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json OpenAI.Response
text/event-stream OpenAI.ResponseStreamEvent

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

응답 삭제

DELETE {endpoint}/openai/responses/{response_id}?api-version=2025-11-15-preview

모델 응답을 삭제합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
response_id 경로 문자열 삭제할 응답의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json DeleteResponseResult

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

응답 취소

POST {endpoint}/openai/responses/{response_id}/cancel?api-version=2025-11-15-preview

모델 응답을 취소합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
response_id 경로 문자열 취소할 응답의 ID입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json OpenAI.Response

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

입력 항목 나열

GET {endpoint}/openai/responses/{response_id}/input_items?api-version=2025-11-15-preview

지정된 응답에 대한 입력 항목 목록을 반환합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
response_id 경로 문자열
limit query 아니오 integer 반환할 개체 수에 대한 제한입니다. 제한 범위는 1에서 100 사이이며
기본값은 20입니다.
order query 아니오 문자열
가능한 값: ascdesc
개체의 created_at 타임스탬프를 기준으로 순서를 정렬합니다. asc(오름차순의 경우), desc
(내림차순의 경우).
query 아니오 문자열 페이지 매김에 사용되는 커서입니다. after는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 다음 페이지를 가져오기 위해 after=obj_foo 포함할 수 있습니다.
before query 아니오 문자열 페이지 매김에 사용되는 커서입니다. before는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 이전 페이지를 가져오기 위해 before=obj_foo 포함할 수 있습니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json 객체 요청된 항목 목록에 대한 응답 데이터입니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json ApiErrorResponse

레드팀 - 목록

GET {endpoint}/redTeams/runs?api-version=2025-11-15-preview

레드팀을 이름으로 나열합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json PagedRedTeam

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

레드팀 - 받아보세요

GET {endpoint}/redTeams/runs/{name}?api-version=2025-11-15-preview

이름으로 레드팀을 가져오세요.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
이름 경로 문자열 레드 팀 런의 식별자입니다.
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json RedTeam

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

Redteams - 만들기

POST {endpoint}/redTeams/runs:run?api-version=2025-11-15-preview

레드팀 런을 생성합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
applicationScenario 문자열 시나리오별 공격을 생성하기 위한 레드 팀 작업에 대한 애플리케이션 시나리오입니다. 아니오
attackStrategies array 공격 전략 목록 또는 중첩된 공격 전략 목록입니다. 아니오
displayName 문자열 레드 팀 런의 이름입니다. 아니오
아이디 문자열 레드 팀 런의 식별자입니다.
numTurns integer 시뮬레이션 라운드 수입니다. 아니오
속성 객체 레드 팀의 속성. 태그와 달리 속성은 추가 전용입니다. 추가된 후에는 속성을 제거할 수 없습니다. 아니오
riskCategories array 공격 목표를 생성할 위험 범주 목록입니다. 아니오
simulationOnly 부울 시뮬레이션 전용 또는 시뮬레이션 + 평가. 기본값: false, true인 경우 스캔은 평가 결과가 아닌 대화를 출력합니다. 아니오 거짓
상태 문자열 레드팀의 상태입니다. 서비스에 의해 설정되며 읽기 전용입니다. 아니오
tags 객체 레드 팀의 태그. 속성과 달리 태그는 완전히 변경할 수 있습니다. 아니오
target 객체 대상 구성을 위한 추상 클래스입니다.
└─ 형식 문자열 모델 구성의 유형입니다. 아니오

응답

상태 코드: 201

설명: 요청이 성공했고 결과적으로 새 리소스가 생성되었습니다.

콘텐츠-타입 유형 설명
application/json RedTeam

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

일정 - 목록

GET {endpoint}/schedules?api-version=2025-11-15-preview

모든 일정을 나열합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json PagedSchedule

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

일정 - 삭제

DELETE {endpoint}/schedules/{id}?api-version=2025-11-15-preview

일정 삭제

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
아이디 경로 문자열 일정의 식별자입니다.
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 204

설명: 이 요청에 대해 보낼 콘텐츠는 없지만 헤더가 유용할 수 있습니다.

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

일정 - 가져오기

GET {endpoint}/schedules/{id}?api-version=2025-11-15-preview

ID로 일정을 가져옵니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
아이디 경로 문자열 일정의 식별자입니다.
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json 일정

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

일정 - 만들기 또는 업데이트

PUT {endpoint}/schedules/{id}?api-version=2025-11-15-preview

ID로 일정을 만들거나 업데이트합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
아이디 경로 문자열 일정의 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

요청 본문

Content-Type: application/json

이름 유형 Description 필수 기본값
description 문자열 일정에 대한 설명입니다. 아니오
displayName 문자열 일정의 이름입니다. 아니오
enabled 부울 일정의 사용 상태입니다.
아이디 문자열 일정의 식별자입니다.
속성 객체 Schedule의 속성입니다. 태그와 달리 속성은 추가 전용입니다. 추가된 후에는 속성을 제거할 수 없습니다. 아니오
프로비저닝 상태 객체 프로비저닝 상태를 예약합니다. 아니오
시스템 데이터 객체 리소스에 대한 시스템 메타데이터입니다.
tags 객체 일정의 태그입니다. 속성과 달리 태그는 완전히 변경할 수 있습니다. 아니오
작업 객체 일정 작업 모델.
└) 구성 객체 작업에 대한 구성입니다. 아니오
└─ 형식 ScheduleTaskType 작업의 유형입니다. 아니오
trigger 객체 일정의 트리거에 대한 기본 모델입니다.
└─ 형식 TriggerType 트리거의 유형입니다. 아니오

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json 일정

상태 코드: 201

설명: 요청이 성공했고 결과적으로 새 리소스가 생성되었습니다.

콘텐츠-타입 유형 설명
application/json 일정

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

일정 - 목록 실행

GET {endpoint}/schedules/{id}/runs?api-version=2025-11-15-preview

모든 일정 실행을 나열합니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
아이디 경로 문자열 일정의 식별자입니다.
x-ms-client-request-id 머리글 아니오 요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json PagedScheduleRun

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

일정 - 실행 가져오기

GET {endpoint}/schedules/{scheduleId}/runs/{runId}?api-version=2025-11-15-preview

id로 실행되는 일정을 가져옵니다.

URI 매개 변수

이름 In 필수 유형 Description
endpoint 경로 문자열
URL
양식 https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}의 Foundry Project 엔드포인트입니다. Foundry Hub에 하나의 프로젝트만 있거나 허브의 기본 프로젝트를 대상으로 하는 경우 양식을 사용합니다. https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API 버전 query 문자열 이 작업에 사용할 API 버전입니다.
scheduleId 경로 문자열 일정의 식별자입니다.
runId 경로 문자열 일정 실행의 식별자입니다.

요청 헤더

이름 필수 유형 Description
Authorization 진실 문자열 예:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}

Azure CLI를 사용하여 인증 토큰을 생성하려면 다음을 수행합니다. az account get-access-token --resource https://ai.azure.com/

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://ai.azure.com/.default

응답

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 유형 설명
application/json ScheduleRun

상태 코드: 기본값

설명: 예기치 않은 오류 응답입니다.

콘텐츠-타입 유형 설명
application/json Azure.Core.Foundations.ErrorResponse

구성 요소

A2ATool

A2A 프로토콜을 구현하는 에이전트입니다.

이름 유형 Description 필수 기본값
agent_card_path 문자열 를 기준으로 한 에이전트 카드의 경로입니다.base_url
제공되지 않으면 기본값은 /.well-known/agent-card.json
아니오
base_url 문자열 에이전트의 기본 URL입니다. 아니오
project_connection_id 문자열 A2A 서버에 대한 프로젝트의 연결 ID입니다.
연결은 A2A 서버에 연결하는 데 필요한 인증 및 기타 연결 세부 정보를 저장합니다.
아니오
type enum 도구의 종류입니다. 항상 a2a입니다.
가능한 값: a2a_preview

AISearchIndexResource

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

이름 유형 Description 필수 기본값
filter 문자열 검색 리소스에 대한 필터 문자열입니다. 여기에서 자세히 알아보세요. 아니오
index_asset_id 문자열 검색 리소스의 인덱스 자산 ID입니다. 아니오
인덱스_이름 문자열 이 에이전트에 연결된 IndexResource의 인덱스 이름입니다. 아니오
project_connection_id 문자열 이 에이전트에 연결된 IndexResource의 인덱스 연결 ID입니다. 아니오
쿼리_유형 객체 Azure AI Search 도구에 사용할 수 있는 쿼리 유형입니다. 아니오
top_k integer 검색에서 검색하여 모델에 표시할 문서 수입니다. 아니오

AgentClusterInsightResult

에이전트 클러스터 분석의 인사이트입니다.

이름 유형 Description 필수 기본값
clusterInsight ClusterInsightResult 클러스터 분석에서 얻은 통찰력.
type enum 인사이트 결과의 유형입니다.
가능한 값: AgentClusterInsight

AgentClusterInsightsRequest

에이전트 평가 결과 세트에 대한 통찰력

이름 유형 Description 필수 기본값
에이전트 이름 문자열 에이전트의 식별자입니다.
모델 구성 객체 인사이트 생성에 사용되는 모델의 구성입니다. 아니오
└) modelDeploymentName 문자열 평가할 모델 배포입니다. 배포 이름만 허용하거나 연결 이름을 로 허용 {connectionName}/<modelDeploymentName>합니다. 아니오
type enum 요청의 유형입니다.
가능한 값: AgentClusterInsight

AgentContainerObject

특정 버전의 에이전트 컨테이너에 대한 세부 정보입니다.

이름 유형 Description 필수 기본값
생성_시간 문자열 컨테이너의 생성 시간입니다.
error_message 문자열 컨테이너가 작동하지 않는 경우 오류 메시지입니다( 있는 경우). 아니오
max_replicas integer 컨테이너의 최대 복제본 수입니다. 기본값은 1입니다. 아니오
min_replicas integer 컨테이너에 대한 최소 복제본 수입니다. 기본값은 1입니다. 아니오
객체 enum 항상 'agent.container'인 개체 형식입니다.
가능한 값: agent.container
상태 객체 특정 버전의 에이전트 컨테이너 상태입니다.
updated_at 문자열 컨테이너의 마지막 업데이트 시간입니다.

AgentContainerOperationError

컨테이너 작업의 오류 세부 정보(있는 경우)입니다.

이름 유형 Description 필수 기본값
코드 문자열 컨테이너 작업의 오류 코드(있는 경우)입니다.
메시지 문자열 컨테이너 작업의 오류 메시지(있는 경우)입니다.
type 문자열 컨테이너 작업의 오류 유형(있는 경우)입니다.

AgentContainerOperationObject

특정 버전의 에이전트에 대한 컨테이너 작업입니다.

이름 유형 Description 필수 기본값
agent_id 문자열 에이전트의 ID입니다.
agent_version_id 문자열 에이전트 버전의 ID입니다.
container 객체 특정 버전의 에이전트 컨테이너에 대한 세부 정보입니다. 아니오
└─ 생성일시 문자열 컨테이너의 생성 시간입니다. 아니오
└error_message 문자열 컨테이너가 작동하지 않는 경우 오류 메시지입니다( 있는 경우). 아니오
└max_replicas integer 컨테이너의 최대 복제본 수입니다. 기본값은 1입니다. 아니오
└min_replicas integer 컨테이너에 대한 최소 복제본 수입니다. 기본값은 1입니다. 아니오
└─ 개체 enum 항상 'agent.container'인 개체 형식입니다.
가능한 값: agent.container
아니오
└─ 상태 AgentContainerStatus 특정 버전의 에이전트 컨테이너 상태입니다. 아니오
└updated_at 문자열 컨테이너의 마지막 업데이트 시간입니다. 아니오
오류 객체 컨테이너 작업의 오류 세부 정보(있는 경우)입니다. 아니오
└) 코드 문자열 컨테이너 작업의 오류 코드(있는 경우)입니다. 아니오
└) 메시지 문자열 컨테이너 작업의 오류 메시지(있는 경우)입니다. 아니오
└─ 형식 문자열 컨테이너 작업의 오류 유형(있는 경우)입니다. 아니오
아이디 문자열 컨테이너 작업의 ID입니다. 이 ID는 시스템 전체의 고유 식별자입니다.
상태 객체 특정 버전의 에이전트에 대한 컨테이너 작업의 상태입니다.

AgentContainerOperationStatus

특정 버전의 에이전트에 대한 컨테이너 작업의 상태입니다.

재산 가치
설명 특정 버전의 에이전트에 대한 컨테이너 작업의 상태입니다.
유형 문자열
NotStarted
InProgress
Succeeded
Failed

AgentContainerStatus

특정 버전의 에이전트 컨테이너 상태입니다.

재산 가치
설명 특정 버전의 에이전트 컨테이너 상태입니다.
유형 문자열
Starting
Running
Stopping
Stopped
Failed
Deleting
Deleted
Updating

AgentDefinition

AgentDefinition에 대한 판별자

이 구성 요소는 속성을 kind 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
workflow WorkflowAgentDefinition
hosted HostedAgentDefinition
container_app ContainerAppAgentDefinition
prompt PromptAgentDefinition
이름 유형 Description 필수 기본값
친절한 AgentKind
rai_config 객체 책임 있는 AI(RAI) 콘텐츠 필터링 및 안전 기능에 대한 구성입니다. 아니오
└rai_policy_name 문자열 적용할 RAI 정책의 이름입니다. 아니오

AgentId

이름 유형 Description 필수 기본값
이름 문자열 에이전트의 이름입니다.
type enum
가능한 값: agent_id
버전 문자열 에이전트의 버전 식별자입니다.

AgentKind

재산 가치
유형 문자열
prompt
hosted
container_app
workflow

AgentObject

이름 유형 Description 필수 기본값
아이디 문자열 에이전트의 고유 식별자입니다.
이름 문자열 에이전트의 이름입니다.
객체 enum 항상 'agent'인 객체 유형입니다.
가능한 값: agent
versions 객체 에이전트의 최신 버전입니다.
└최신 AgentVersionObject 아니오

AgentProtocol

재산 가치
유형 문자열
activity_protocol
responses

에이전트 참조

이름 유형 Description 필수 기본값
이름 문자열 에이전트의 이름입니다.
type enum
가능한 값: agent_reference
버전 문자열 에이전트의 버전 식별자입니다. 아니오

AgentTaxonomyInput

입력 유형이 에이전트인 경우 평가 분류에 대한 입력 구성입니다.

이름 유형 Description 필수 기본값
riskCategories array 평가할 위험 범주 목록입니다.
target 객체 Azure AI 에이전트를 지정하는 대상을 나타냅니다.
└) 이름 문자열 Azure AI 에이전트의 고유 식별자입니다. 아니오
└tool_descriptions array 텍스트 생성 중에 에이전트의 샘플링 동작을 제어하는 데 사용되는 매개변수입니다. 아니오
└─ 형식 enum 대상 유형(항상 azure_ai_agent).
가능한 값: azure_ai_agent
아니오
└─ 버전 문자열 Azure AI 에이전트의 버전입니다. 아니오
type enum 평가 분류의 입력 유형입니다.
가능한 값: agent

AgentTaxonomyInputUpdate

입력 유형이 에이전트인 경우 평가 분류에 대한 입력 구성입니다.

이름 유형 Description 필수 기본값
riskCategories array 평가할 위험 범주 목록입니다. 아니오
target 객체 Azure AI 에이전트를 지정하는 대상을 나타냅니다. 아니오
└) 이름 문자열 Azure AI 에이전트의 고유 식별자입니다. 아니오
└tool_descriptions array 텍스트 생성 중에 에이전트의 샘플링 동작을 제어하는 데 사용되는 매개변수입니다. 아니오
└─ 형식 enum 대상 유형(항상 azure_ai_agent).
가능한 값: azure_ai_agent
아니오
└─ 버전 문자열 Azure AI 에이전트의 버전입니다. 아니오
type enum 평가 분류의 입력 유형입니다.
가능한 값: agent
아니오

AgentVersionObject

이름 유형 Description 필수 기본값
생성_시간 integer 에이전트가 생성되었을 때의 Unix 타임스탬프(초)입니다.
정의 AgentDefinition
description 문자열 에이전트에 대한 사람이 읽을 수 있는 설명입니다. 아니오
아이디 문자열 에이전트 버전의 고유 식별자입니다.
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
이름 문자열 에이전트의 이름입니다. 이름은 에이전트를 검색/업데이트/삭제하는 데 사용할 수 있습니다.
객체 enum 항상 'agent.version'인 객체 유형입니다.
가능한 값: agent.version
버전 문자열 에이전트의 버전 식별자입니다. 에이전트는 변경할 수 없으며 모든 업데이트는 이름을 동일하게 유지하면서 새 버전을 만듭니다.

AgenticIdentityCredentials

에이전트 ID 자격 증명 정의

이름 유형 Description 필수 기본값
type enum 자격 증명 형식
가능한 값: AgenticIdentityToken

ApiErrorResponse

API 오류에 대한 오류 응답입니다.

이름 유형 Description 필수 기본값
오류 OpenAI.Error

ApiKeyCredentials

API 키 자격 증명 정의

이름 유형 Description 필수 기본값
key 문자열 API 키 아니오
type enum 자격 증명 형식
가능한 값: ApiKey

AssetCredentialResponse

사용할 Blob에 대한 참조를 나타냅니다.

이름 유형 Description 필수 기본값
blobReference 객체 Blob 참조 세부 정보.
└) blobUri 문자열 클라이언트가 데이터를 업로드할 수 있는 Blob URI 경로입니다. 예: https://blob.windows.core.net/Container/Path 아니오
└) 자격 증명 SasCredential 스토리지 계정에 액세스하기 위한 자격 증명 정보입니다. 아니오
└) storageAccountArmId 문자열 사용할 스토리지 계정의 ARM ID입니다. 아니오

자산ID

저장된 자산의 식별자입니다.

형식: string

AttackStrategy

공격에 대한 전략.

재산 가치
설명 공격에 대한 전략.
유형 문자열
easy
moderate
difficult
ascii_art
ascii_smuggler
atbash
base64
binary
caesar
character_space
jailbreak
ansii_attack
character_swap
suffix_append
string_join
unicode_confusable
unicode_substitution
diacritic
flip
leetspeak
rot13
morse
url
baseline
indirect_jailbreak
tense
multi_turn
crescendo

Azure.Core.Foundations.Error

오류 개체입니다.

이름 유형 Description 필수 기본값
코드 문자열 서버에서 정의한 오류 코드 집합 중 하나입니다.
details array 이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다. 아니오
innererror 객체 오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Azure REST API 지침에 따라 - https://aka.ms/AzureRestApiGuidelines#handling-errors. 아니오
└) 코드 문자열 서버에서 정의한 오류 코드 집합 중 하나입니다. 아니오
└) innererror Azure.Core.Foundations.InnerError 내부 오류입니다. 아니오
메시지 문자열 사람이 읽을 수 있는 오류 표현입니다.
target 문자열 오류의 대상입니다. 아니오

Azure.Core.Foundations.ErrorResponse

오류 세부 정보가 포함된 응답입니다.

이름 유형 Description 필수 기본값
오류 객체 오류 개체입니다.
└) 코드 문자열 서버에서 정의한 오류 코드 집합 중 하나입니다. 아니오
└) 세부 정보 array 이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다. 아니오
└) innererror Azure.Core.Foundations.InnerError 오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다. 아니오
└) 메시지 문자열 사람이 읽을 수 있는 오류 표현입니다. 아니오
└> 대상 문자열 오류의 대상입니다. 아니오

Azure.Core.Foundations.InnerError

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Azure REST API 지침에 따라 - https://aka.ms/AzureRestApiGuidelines#handling-errors.

이름 유형 Description 필수 기본값
코드 문자열 서버에서 정의한 오류 코드 집합 중 하나입니다. 아니오
innererror 객체 오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Azure REST API 지침에 따라 - https://aka.ms/AzureRestApiGuidelines#handling-errors. 아니오
└) 코드 문자열 서버에서 정의한 오류 코드 집합 중 하나입니다. 아니오
└) innererror Azure.Core.Foundations.InnerError 내부 오류입니다. 아니오

Azure.Core.Foundations.OperationState

허용된 작업 상태를 설명하는 열거형입니다.

재산 가치
유형 문자열
NotStarted
Running
Succeeded
Failed
Canceled

Azure.Core.uuid

범용 고유 식별자

형식: string

형식: uuid

AzureAIAgentTarget

Azure AI 에이전트를 지정하는 대상을 나타냅니다.

이름 유형 Description 필수 기본값
이름 문자열 Azure AI 에이전트의 고유 식별자입니다.
tool_descriptions array 텍스트 생성 중에 에이전트의 샘플링 동작을 제어하는 데 사용되는 매개변수입니다. 아니오
type enum 대상 유형(항상 azure_ai_agent).
가능한 값: azure_ai_agent
버전 문자열 Azure AI 에이전트의 버전입니다. 아니오

AzureAIAgentTargetUpdate

Azure AI 에이전트를 지정하는 대상을 나타냅니다.

이름 유형 Description 필수 기본값
이름 문자열 Azure AI 에이전트의 고유 식별자입니다. 아니오
tool_descriptions array 텍스트 생성 중에 에이전트의 샘플링 동작을 제어하는 데 사용되는 매개변수입니다. 아니오
type enum 대상 유형(항상 azure_ai_agent).
가능한 값: azure_ai_agent
아니오
버전 문자열 Azure AI 에이전트의 버전입니다. 아니오

AzureAIAssistantTarget

ID를 포함하여 Azure AI Assistant(에이전트 V1) 엔드포인트를 지정하는 대상을 나타냅니다.

이름 유형 Description 필수 기본값
아이디 문자열 Azure AI Assistant의 고유 식별자입니다. 아니오
tool_descriptions array 도우미가 사용할 수 있는 도구에 대한 설명입니다.
type enum 대상 유형(항상 azure_ai_assistant).
가능한 값: azure_ai_assistant

AzureAIAssistantTargetUpdate

ID를 포함하여 Azure AI Assistant(에이전트 V1) 엔드포인트를 지정하는 대상을 나타냅니다.

이름 유형 Description 필수 기본값
아이디 문자열 Azure AI Assistant의 고유 식별자입니다. 아니오
tool_descriptions array 도우미가 사용할 수 있는 도구에 대한 설명입니다. 아니오
type enum 대상 유형(항상 azure_ai_assistant).
가능한 값: azure_ai_assistant
아니오

AzureAIEvaluator

주조 평가자에 대한 Azure AI 평가기 정의입니다.

이름 유형 Description 필수 기본값
data_mapping 객체 평가에 사용할 모델입니다. 구조화된 출력을 지원해야 합니다. 아니오
evaluator_name 문자열 계산기의 이름입니다.
evaluator_version 문자열 평가기의 버전입니다. 아니오
initialization_parameters 객체 평가에 대한 초기화 매개 변수입니다. 구조화된 출력을 지원해야 합니다. 아니오
이름 문자열 채점자의 이름입니다.
type enum 항상 label_model인 개체 형식입니다.
가능한 값: azure_ai_evaluator

AzureAIModelTarget

모델을 선택해야 하는 작업에 Azure AI 모델을 지정하는 대상을 나타냅니다.

이름 유형 Description 필수 기본값
모델 문자열 Azure AI 모델의 고유 식별자입니다. 아니오
샘플링_파라미터 객체 텍스트를 생성하는 동안 언어 모델의 샘플링 동작을 제어하는 데 사용되는 매개 변수 집합을 나타냅니다. 아니오
└─ 최대_완료_토큰 integer 완료 시 허용되는 최대 토큰 수입니다. 아니오
└) 시드 integer 재현성을 위한 임의 시드입니다. 아니오
└> 온도 숫자 샘플링을 위한 온도 매개 변수입니다. 아니오
└ top_p 숫자 핵 샘플링을 위한 top-p 매개 변수입니다. 아니오
type enum 대상 유형(항상 azure_ai_model).
가능한 값: azure_ai_model

AzureAIModelTargetUpdate

모델을 선택해야 하는 작업에 Azure AI 모델을 지정하는 대상을 나타냅니다.

이름 유형 Description 필수 기본값
모델 문자열 Azure AI 모델의 고유 식별자입니다. 아니오
샘플링_파라미터 객체 텍스트를 생성하는 동안 언어 모델의 샘플링 동작을 제어하는 데 사용되는 매개 변수 집합을 나타냅니다. 아니오
└─ 최대_완료_토큰 integer 완료 시 허용되는 최대 토큰 수입니다. 아니오
└) 시드 integer 재현성을 위한 임의 시드입니다. 아니오
└> 온도 숫자 샘플링을 위한 온도 매개 변수입니다. 아니오
└ top_p 숫자 핵 샘플링을 위한 top-p 매개 변수입니다. 아니오
type enum 대상 유형(항상 azure_ai_model).
가능한 값: azure_ai_model
아니오

AzureAIRedTeam

이름 유형 Description 필수 기본값
item_generation_params 객체 빨간색 팀 항목 생성에 대한 매개 변수를 나타냅니다.
└attack_strategies array 사용할 공격 전략의 컬렉션입니다. 아니오
└num_turns integer 게임에서 허용되는 턴 수입니다. 아니오
└─ 형식 enum 항상 항목 생성 매개 변수 red_team의 형식입니다.
가능한 값: red_team
아니오
target 객체 판별자를 지원하는 대상의 기본 클래스입니다.
└─ 형식 문자열 대상의 형식입니다. 아니오
type enum 데이터 원본의 유형입니다. 항상 azure_ai_red_team입니다.
가능한 값: azure_ai_red_team

AzureAIResponses

연속 평가 시나리오와 관련된 평가 실행의 데이터 원본을 나타냅니다.

이름 유형 Description 필수 기본값
event_configuration_id 문자열 이 평가 실행과 연결된 이벤트 구성 이름입니다.
item_generation_params 객체 연속 평가 항목 생성에 대한 매개 변수를 나타냅니다.
└data_mapping 객체 채팅 기록을 검색하는 데 필요한 원본 필드에서 response_id 필드로 매핑합니다. 아니오
└max_num_turns integer 평가할 채팅 기록의 최대 턴 수입니다. 아니오
└) 원본 OpenAI.EvalJsonlFileContentSource 또는 OpenAI.EvalJsonlFileIdSource JSONL 콘텐츠를 읽는 원본입니다. 아니오
└─ 형식 enum 항상 항목 생성 매개 변수 ResponseRetrieval의 형식입니다.
가능한 값: response_retrieval
아니오
max_runs_hourly integer 시간당 허용되는 최대 평가 실행 수입니다.
type enum 항상 데이터 원본 AzureAIResponses의 형식입니다.
가능한 값: azure_ai_responses

AzureAISearchAgentTool

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

이름 유형 Description 필수 기본값
azure_ai_search 객체 azure_ai_search 도구에서 사용하는 인덱스 리소스 집합입니다.
└) 인덱스 array 이 에이전트에 연결된 인덱스입니다. 최대 1인덱스가 있을 수 있습니다.
에이전트에 연결된 리소스입니다.
아니오
type enum 항상 'azure_ai_search'인 객체 유형입니다.
가능한 값: azure_ai_search

AzureAI검색인덱스

Azure AI Search 인덱스 정의

이름 유형 Description 필수 기본값
type enum 인덱스 유형
가능한 값: AzureSearch

AzureAISearchIndexUpdate

Azure AI Search 인덱스 정의

이름 유형 Description 필수 기본값
type enum 인덱스 유형
가능한 값: AzureSearch

AzureAISearchQueryType

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

재산 가치
설명 Azure AI Search 도구에 사용할 수 있는 쿼리 유형입니다.
유형 문자열
simple
semantic
vector
vector_simple_hybrid
vector_semantic_hybrid

AzureAISearchToolResource

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

이름 유형 Description 필수 기본값
인덱스 array 이 에이전트에 연결된 인덱스입니다. 최대 1인덱스가 있을 수 있습니다.
에이전트에 연결된 리소스입니다.

AzureAISource

이름 유형 Description 필수 기본값
시나리오 enum 데이터 스키마 시나리오.
가능한 값: red_team, responsestraces
type enum 항상 label_model인 개체 형식입니다.
가능한 값: azure_ai_source

AzureFunctionAgentTool

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

이름 유형 Description 필수 기본값
azure_function 객체 Azure 함수의 정의입니다.
└) 함수 객체 Azure 함수 및 해당 매개 변수의 정의입니다. 아니오
└) 설명 문자열 함수를 호출하는 시기와 방법을 선택하기 위해 모델에서 사용하는 함수의 기능에 대한 설명입니다. 아니오
└) 이름 문자열 호출할 함수의 이름입니다. 아니오
└) 매개 변수 함수가 허용하는 매개 변수로, JSON 스키마 개체로 설명됩니다. 아니오
└input_binding AzureFunctionBinding 입력 스토리지 큐. 큐 스토리지 트리거는 메시지가 추가되면 함수를 실행합니다. 아니오
└output_binding AzureFunctionBinding 출력 스토리지 큐. 함수는 입력 항목이 처리될 때 이 큐에 출력을 씁니다. 아니오
type enum 항상 'browser_automation'인 개체 형식입니다.
가능한 값: azure_function

AzureFunctionBinding

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

이름 유형 Description 필수 기본값
storage_queue 객체 스토리지 큐 이름 및 URI를 유지하기 위한 구조입니다.
└queue_name 문자열 Azure 함수 스토리지 큐의 이름입니다. 아니오
└queue_service_endpoint 문자열 큐를 조작할 수 있는 Azure Storage 큐 서비스에 대한 URI입니다. 아니오
type enum 항상 'storage_queue'인 바인딩 형식입니다.
가능한 값: storage_queue

AzureFunctionDefinition

Azure 함수의 정의입니다.

이름 유형 Description 필수 기본값
기능 객체 Azure 함수 및 해당 매개 변수의 정의입니다.
└) 설명 문자열 함수를 호출하는 시기와 방법을 선택하기 위해 모델에서 사용하는 함수의 기능에 대한 설명입니다. 아니오
└) 이름 문자열 호출할 함수의 이름입니다. 아니오
└) 매개 변수 함수가 허용하는 매개 변수로, JSON 스키마 개체로 설명됩니다. 아니오
input_binding 객체 스토리지 큐 이름 및 URI를 유지하기 위한 구조입니다.
└storage_queue AzureFunctionStorageQueue 스토리지 큐. 아니오
└─ 형식 enum 항상 'storage_queue'인 바인딩 형식입니다.
가능한 값: storage_queue
아니오
output_binding 객체 스토리지 큐 이름 및 URI를 유지하기 위한 구조입니다.
└storage_queue AzureFunctionStorageQueue 스토리지 큐. 아니오
└─ 형식 enum 항상 'storage_queue'인 바인딩 형식입니다.
가능한 값: storage_queue
아니오

AzureFunctionStorageQueue

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

이름 유형 Description 필수 기본값
queue_name 문자열 Azure 함수 스토리지 큐의 이름입니다.
queue_service_endpoint 문자열 큐를 조작할 수 있는 Azure Storage 큐 서비스에 대한 URI입니다.

AzureOpenAIModelConfiguration

Azure OpenAI 모델 구성. API 버전은 모델을 쿼리하기 위해 서비스에서 선택합니다.

이름 유형 Description 필수 기본값
modelDeploymentName 문자열 AOAI 모델의 배포 이름입니다. 예: AIServices 또는 연결 기반 connection_name/deployment_name (예: my-aoai-connection/gpt-4o)에 있는 경우 gpt-4o .
type enum
가능한 값: AzureOpenAIModel

BaseCredentials

연결 자격 증명에 대한 기본 클래스

BaseCredentials에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
ApiKey ApiKeyCredentials
AAD EntraIDCredentials
CustomKeys CustomCredential
SAS SASCredentials
None NoAuthenticationCredentials
AgenticIdentityToken AgenticIdentityCredentials
이름 유형 Description 필수 기본값
type 객체 연결에서 사용하는 자격 증명 유형

BingCustomSearchAgentTool

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

이름 유형 Description 필수 기본값
bing_custom_search_preview 객체 bing 사용자 지정 검색 도구 매개 변수입니다.
└search_configurations array 이 도구에 연결된 프로젝트 연결입니다. 최대 1 연결이 있을 수 있습니다.
도구에 연결된 리소스입니다.
아니오
type enum 항상 'bing_custom_search'인 객체 유형입니다.
가능한 값: bing_custom_search_preview

BingCustomSearchConfiguration

bing 사용자 지정 검색 구성.

이름 유형 Description 필수 기본값
세다 integer bing api 응답에서 반환할 검색 결과의 수입니다 아니오
freshness 문자열 특정 시간 범위를 기준으로 검색 결과를 필터링합니다. 여기에서 허용되는 값을 참조하십시오. 아니오
instance_name 문자열 구성에 지정된 사용자 지정 구성 인스턴스의 이름입니다.
시장 문자열 결과가 나오는 시장입니다. 아니오
project_connection_id 문자열 bing 검색을 사용하여 접지를 위한 프로젝트 연결 ID
set_lang 문자열 Bing API를 호출할 때 사용자 인터페이스 문자열에 사용할 언어입니다. 아니오

BingCustomSearchToolParameters

bing 사용자 지정 검색 도구 매개 변수입니다.

이름 유형 Description 필수 기본값
search_configurations array 이 도구에 연결된 프로젝트 연결입니다. 최대 1 연결이 있을 수 있습니다.
도구에 연결된 리소스입니다.

BingGroundingAgentTool

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

이름 유형 Description 필수 기본값
bing_grounding 객체 bing 접지 검색 도구 매개 변수입니다.
└search_configurations array 이 도구에 연결된 검색 구성입니다. 최대 1이 있을 수 있습니다.
도구에 연결된 구성 리소스를 검색합니다.
아니오
type enum 항상 'bing_grounding'인 개체 형식입니다.
가능한 값: bing_grounding

BingGroundingSearchConfiguration

Bing Grounding에 대한 검색 구성

이름 유형 Description 필수 기본값
세다 integer bing api 응답에서 반환할 검색 결과의 수입니다 아니오
freshness 문자열 특정 시간 범위를 기준으로 검색 결과를 필터링합니다. 여기에서 허용되는 값을 참조하십시오. 아니오
시장 문자열 결과가 나오는 시장입니다. 아니오
project_connection_id 문자열 bing 검색을 사용하여 접지를 위한 프로젝트 연결 ID
set_lang 문자열 Bing API를 호출할 때 사용자 인터페이스 문자열에 사용할 언어입니다. 아니오

BingGroundingSearchToolParameters

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

이름 유형 Description 필수 기본값
search_configurations array 이 도구에 연결된 검색 구성입니다. 최대 1이 있을 수 있습니다.
도구에 연결된 구성 리소스를 검색합니다.

BlobReference

Blob 참조 세부 정보.

이름 유형 Description 필수 기본값
blobUri 문자열 클라이언트가 데이터를 업로드할 수 있는 Blob URI 경로입니다. 예: https://blob.windows.core.net/Container/Path
자격 증명(credential) 객체 SAS 자격 증명 정의
└) sasUri 문자열 SAS URI 아니오
└─ 형식 enum 자격 증명의 유형
가능한 값: SAS
아니오
storageAccountArmId 문자열 사용할 스토리지 계정의 ARM ID입니다.

BrowserAutomationAgentTool

에이전트를 구성하는 데 사용되는 브라우저 자동화 도구에 대한 입력 정의 정보입니다.

이름 유형 Description 필수 기본값
browser_automation_preview 객체 브라우저 자동화 도구에 대한 입력 매개변수 정의입니다.
└) 연결 BrowserAutomationToolConnectionParameters 브라우저 자동화 도구와 연결된 프로젝트 연결 매개변수입니다. 아니오
type enum 항상 'browser_automation'인 개체 형식입니다.
가능한 값: browser_automation_preview

BrowserAutomationToolConnectionParameters

브라우저 자동화 도구에서 사용하는 연결에 대한 입력 매개변수의 정의입니다.

이름 유형 Description 필수 기본값
project_connection_id 문자열 Azure Playwright 리소스에 대한 프로젝트 연결의 ID입니다.

BrowserAutomationToolParameters

브라우저 자동화 도구에 대한 입력 매개변수 정의입니다.

이름 유형 Description 필수 기본값
connection 객체 브라우저 자동화 도구에서 사용하는 연결에 대한 입력 매개변수의 정의입니다.
└project_connection_id 문자열 Azure Playwright 리소스에 대한 프로젝트 연결의 ID입니다. 아니오

CaptureStructuredOutputsTool

구조화된 출력을 캡처하기 위한 도구

이름 유형 Description 필수 기본값
출력 객체 에이전트에서 생성할 수 있는 구조화된 출력입니다.
└) 설명 문자열 내보낼 출력에 대한 설명입니다. 모델에서 출력을 내보낼 시기를 결정하는 데 사용됩니다. 아니오
└) 이름 문자열 구조화된 출력의 이름입니다. 아니오
└─ 스키마 구조화된 출력에 대한 JSON 스키마입니다. 아니오
└─ 엄격한 부울 엄격한 유효성 검사를 적용할지 여부입니다. 기본값 true. 아니오
type enum 도구의 종류입니다. 항상 capture_structured_outputs입니다.
가능한 값: capture_structured_outputs

ChartCoordinate

분석 차트의 좌표입니다.

이름 유형 Description 필수 기본값
크기 integer 차트 요소의 크기입니다.
x integer X축 좌표입니다.
y integer Y축 좌표.

ChatSummaryMemoryItem

대화에서 추출된 요약이 포함된 메모리 항목입니다.

이름 유형 Description 필수 기본값
친절한 enum 메모리 아이템의 종류입니다.
가능한 값: chat_summary

ClusterInsightResult

클러스터 분석에서 얻은 통찰력.

이름 유형 Description 필수 기본값
클러스터 array 인사이트에서 식별된 클러스터 목록입니다.
좌표 객체 시각화를 위해 UX에서 사용하는 2D 좌표에 대한 ID의 선택적 매핑입니다.

맵 키는 문자열 식별자(예: 클러스터 ID 또는 샘플 ID)입니다.
값은 2D 차트에서 렌더링하기 위한 좌표 및 시각적 크기입니다.

클라이언트가 좌표를 요청하지 않는 한 이 속성은 생략됩니다(예:
쿼리 매개 변수로 전달 includeCoordinates=true ).

예제:
<br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br>

좌표는 클라이언트 쪽 시각화에만 사용되며,
는 정식 인사이트 결과를 수정합니다.
아니오
summary 객체 오류 클러스터 분석의 요약입니다.
└) 메서드 문자열 클러스터링에 사용되는 방법입니다. 아니오
└) sampleCount integer 분석된 총 샘플 수입니다. 아니오
└> uniqueClusterCount integer 고유 클러스터의 총 수입니다. 아니오
└) uniqueSubclusterCount integer 고유한 하위 클러스터 레이블의 총 수입니다. 아니오
└) 사용량 ClusterTokenUsage 클러스터링 분석을 수행하는 동안 토큰 사용량 아니오

ClusterTokenUsage

클러스터 분석을 위한 토큰 사용량

이름 유형 Description 필수 기본값
inputTokenUsage integer 입력 토큰 사용량
outputTokenUsage integer 출력 토큰 사용량
totalTokenUsage integer 총 토큰 사용량

CodeBasedEvaluatorDefinition

Python 코드를 사용한 코드 기반 평가자 정의

이름 유형 Description 필수 기본값
code_text 문자열 평가자에 대한 인라인 코드 텍스트
type enum
가능한 값: code

연결

목록의 응답 및 연결 가져오기 작업

이름 유형 Description 필수 기본값
credentials 객체 연결 자격 증명에 대한 기본 클래스
└─ 형식 CredentialType 연결에서 사용하는 자격 증명의 유형입니다 아니오
아이디 문자열 서비스에 의해 생성된 연결의 고유 식별자입니다
isDefault 부울 연결이 해당 유형의 기본 연결로 태그가 지정되었는지 여부
metadata 객체 연결의 메타데이터
이름 문자열 사용자가 제공한 연결의 이름입니다.
target 문자열 이 서비스에 사용할 연결 URL
type 객체 연결의 형식(또는 범주)입니다.

연결 유형

연결의 형식(또는 범주)입니다.

재산 가치
설명 연결의 형식(또는 범주)입니다.
유형 문자열
AzureOpenAI
AzureBlob
AzureStorageAccount
CognitiveSearch
CosmosDB
ApiKey
AppConfig
AppInsights
CustomKeys
RemoteTool

ContainerAppAgentDefinition

컨테이너 앱 에이전트 정의입니다.

이름 유형 Description 필수 기본값
container_app_resource_id 문자열 이 에이전트를 호스트하는 Azure Container App의 리소스 ID입니다. 버전 간에 변경할 수 없습니다.
container_protocol_versions array 에이전트가 컨테이너의 수신 통신을 위해 지원하는 프로토콜입니다.
ingress_subdomain_suffix 문자열 에이전트에 수신을 보낼 때 앱 하위 도메인에 적용할 접미사입니다. 레이블(예: '---current'), 특정 수정 버전(예: '--0000001') 또는 컨테이너 앱의 기본 엔드포인트를 사용하기 위해 비어 있을 수 있습니다.
친절한 enum
가능한 값: container_app

ContinuousEvalItemGenerationParams

연속 평가 항목 생성에 대한 매개 변수를 나타냅니다.

이름 유형 Description 필수 기본값
data_mapping 객체 채팅 기록을 검색하는 데 필요한 원본 필드에서 response_id 필드로 매핑합니다.
max_num_turns integer 평가할 채팅 기록의 최대 턴 수입니다.
source 객체
└─ 콘텐츠 array jsonl 파일의 내용입니다. 아니오
└─ ID 문자열 파일의 식별자입니다. 아니오
└─ 형식 enum jsonl 원본의 형식입니다. 항상 file_id입니다.
가능한 값: file_id
아니오
type enum 항상 항목 생성 매개 변수 ResponseRetrieval의 형식입니다.
가능한 값: response_retrieval

ContinuousEvaluationRuleAction

지속적인 평가를 위한 평가 규칙 작업입니다.

이름 유형 Description 필수 기본값
evalId 문자열 지속적인 평가 실행을 추가할 평가 ID입니다.
maxHourlyRuns integer 시간당 허용되는 최대 평가 실행 수입니다. 아니오
type enum
가능한 값: continuousEvaluation

코스모스 DB 인덱스

CosmosDB 벡터 저장소 인덱스 정의

이름 유형 Description 필수 기본값
type enum 인덱스 유형
가능한 값: CosmosDBNoSqlVectorStore

CosmosDBIndexUpdate

CosmosDB 벡터 저장소 인덱스 정의

이름 유형 Description 필수 기본값
type enum 인덱스 유형
가능한 값: CosmosDBNoSqlVectorStore

CreateAgentFromManifestRequest

이름 유형 Description 필수 기본값
description 문자열 에이전트에 대한 사람이 읽을 수 있는 설명입니다. 아니오
manifest_id 문자열 에이전트 버전을 가져올 매니페스트 ID입니다.
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
이름 문자열 에이전트를 식별하는 고유 이름입니다. 이름은 에이전트를 검색/업데이트/삭제하는 데 사용할 수 있습니다.
- 영숫자로 시작하고 끝나야 합니다.
- 중간에 하이픈을 포함할 수 있습니다.
- 63자를 초과하지 않아야 합니다.
parameter_values 객체 완전히 구체화된 에이전트를 생성할 매니페스트에 대한 입력입니다.

CreateAgentRequest

이름 유형 Description 필수 기본값
정의 객체
└) 종류 AgentKind 아니오
└rai_config RaiConfig 책임 있는 AI(RAI) 콘텐츠 필터링 및 안전 기능에 대한 구성입니다. 아니오
description 문자열 에이전트에 대한 사람이 읽을 수 있는 설명입니다. 아니오
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
이름 문자열 에이전트를 식별하는 고유 이름입니다. 이름은 에이전트를 검색/업데이트/삭제하는 데 사용할 수 있습니다.
- 영숫자로 시작하고 끝나야 합니다.
- 중간에 하이픈을 포함할 수 있습니다.
- 63자를 초과하지 않아야 합니다.

CreateAgentVersionFromManifestRequest

이름 유형 Description 필수 기본값
description 문자열 에이전트에 대한 사람이 읽을 수 있는 설명입니다. 아니오
manifest_id 문자열 에이전트 버전을 가져올 매니페스트 ID입니다.
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
parameter_values 객체 완전히 구체화된 에이전트를 생성할 매니페스트에 대한 입력입니다.

CreateAgentVersionRequest

이름 유형 Description 필수 기본값
정의 객체
└) 종류 AgentKind 아니오
└rai_config RaiConfig 책임 있는 AI(RAI) 콘텐츠 필터링 및 안전 기능에 대한 구성입니다. 아니오
description 문자열 에이전트에 대한 사람이 읽을 수 있는 설명입니다. 아니오
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오

평가요청생성

이름 유형 Description 필수 기본값
데이터 소스 구성 객체 평가 실행에 사용되는 데이터 원본에 대한 스키마를 정의하는 CustomDataSourceConfig 개체입니다.
이 스키마는 다음과 같은 데이터의 모양을 정의하는 데 사용됩니다.
- 테스트 조건을 정의하는 데 사용되며
- 실행을 만들 때 필요한 데이터
└─ include_sample_schema (샘플 스키마 포함) 부울 eval이 샘플 네임스페이스를 채울 것으로 예상해야 하는지 여부(예: 데이터 원본에서 응답을 생성하여) 아니오
└item_schema 객체 데이터 원본의 각 행에 대한 json 스키마입니다. 아니오
└) 메타데이터 객체 저장된 완료 데이터 원본에 대한 메타데이터 필터입니다. 아니오
└) 시나리오 enum 데이터 스키마 시나리오.
가능한 값: red_team, responsestraces
아니오
└─ 형식 enum 항상 label_model인 개체 형식입니다.
가능한 값: azure_ai_source
아니오
metadata OpenAI.Metadata 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
이름 문자열 평가의 이름입니다. 아니오
속성 객체 추가 정보를 저장하기 위해 개체에 연결할 수 있는 변경할 수 없는 16개의 키-값 쌍 집합입니다.
키는 최대 길이가 64자인 문자열입니다. 값은 최대 길이가 512자인 문자열입니다.
아니오
테스트 기준 array 이 그룹의 모든 eval 실행에 대한 채점자 목록입니다. 채점자는 다음과 같이 {{item.variable_name}}이중 중괄호 표기법을 사용하여 데이터 원본의 변수를 참조할 수 있습니다. 모델의 출력을 참조하려면 네임스페이 sample 스(예: {{sample.output_text}})를 사용합니다.

평가 실행 요청 생성

이름 유형 Description 필수 기본값
데이터_소스 객체 eval과 일치하는 JSONL 파일을 지정하는 JsonlRunDataSource 개체
└input_messages OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate 또는 OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference 모델에서 샘플링할 때 사용됩니다. 모델에 전달된 메시지의 구조를 지정합니다. 미리 빌드된 궤적(즉, item.input_trajectory)에 대한 참조이거나 네임스페이스에 대한 변수 참조가 있는 템플릿일 수 item 있습니다. 아니오
└item_generation_params RedTeamItemGenerationParams 항목 생성에 대한 매개 변수입니다. 아니오
└─ 모델 문자열 완성을 생성하는 데 사용할 모델의 이름입니다(예: "o3-mini"). 아니오
└─ 샘플링_파라미터 OpenAI.CreateEvalResponsesRunDataSourceSamplingParams 아니오
└) 원본 OpenAI.EvalJsonlFileContentSource 또는 OpenAI.EvalJsonlFileIdSource 또는 OpenAI.EvalResponsesSource 이 실행의 데이터 원본에서 item 네임스페이스를 채우는 내용을 결정합니다. 아니오
└> 대상 대상 평가 대상 구성입니다. 아니오
└─ 형식 문자열 데이터 원본 형식 판별자입니다. 아니오
metadata OpenAI.Metadata 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
이름 문자열 실행의 이름입니다. 아니오
속성 객체 추가 정보를 저장하기 위해 개체에 연결할 수 있는 변경할 수 없는 16개의 키-값 쌍 집합입니다.
키는 최대 길이가 64자인 문자열입니다. 값은 최대 길이가 512자인 문자열입니다.
아니오

CreatedBy

이름 유형 Description 필수 기본값
agent 객체 아니오
└) 이름 문자열 에이전트의 이름입니다. 아니오
└─ 형식 enum
가능한 값: agent_id
아니오
└─ 버전 문자열 에이전트의 버전 식별자입니다. 아니오
response_id 문자열 항목이 만들어지는 응답입니다. 아니오

CredentialType

연결에서 사용하는 자격 증명 유형

재산 가치
설명 연결에서 사용하는 자격 증명 유형
유형 문자열
ApiKey
AAD
SAS
CustomKeys
None
AgenticIdentityToken

CronTrigger

Cron 기반 트리거.

이름 유형 Description 필수 기본값
endTime 문자열 ISO 8601 형식의 cron 일정의 종료 시간입니다. 아니오
expression 문자열 일정 빈도를 정의하는 Cron 표현식입니다.
startTime 문자열 ISO 8601 형식의 cron 일정의 시작 시간입니다. 아니오
timeZone 문자열 cron 일정의 시간대입니다. 아니오 UTC
type enum
가능한 값: Cron

CustomCredential

사용자 지정 자격 증명 정의

이름 유형 Description 필수 기본값
type enum 자격 증명 형식
가능한 값: CustomKeys

DailyRecurrenceSchedule

일일 되풀이 일정.

이름 유형 Description 필수 기본값
시간 array 되풀이 일정의 시간입니다.
type enum 일일 되풀이 유형입니다.
가능한 값: Daily

DatasetType

데이터 형식을 결정하는 열거형입니다.

재산 가치
설명 데이터 형식을 결정하는 열거형입니다.
유형 문자열
uri_file
uri_folder

DatasetVersion

DatasetVersion 정의

DatasetVersion에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
uri_file FileDatasetVersion
uri_folder FolderDatasetVersion
이름 유형 Description 필수 기본값
연결 이름 문자열 Azure Storage 계정 연결 이름입니다. 데이터 세트를 만들기 전에 startPendingUploadVersion을 호출하지 않은 경우 필요합니다. 아니오
dataUri 문자열 데이터의 URI()
아이디 문자열 자산 ID: 자산의 고유 식별자입니다. 아니오
isReference 부울 데이터 세트에 스토리지에 대한 참조가 있는지 또는 데이터 세트가 스토리지 자체를 관리하는지 여부를 나타냅니다. true인 경우 데이터 세트 버전이 삭제될 때 기본 데이터가 삭제되지 않습니다 아니오
이름 문자열 리소스의 이름
type 객체 데이터 형식을 결정하는 열거형입니다.
버전 문자열 리소스의 버전입니다

DatasetVersionUpdate

DatasetVersion 정의

DatasetVersionUpdate에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
uri_file FileDatasetVersionUpdate
uri_folder FolderDatasetVersionUpdate
이름 유형 Description 필수 기본값
description 문자열 자산 설명 텍스트입니다. 아니오
tags 객체 태그 사전입니다. 태그를 추가, 제거 및 업데이트할 수 있습니다. 아니오
type 객체 데이터 형식을 결정하는 열거형입니다.

요일

되풀이 일정에 대한 요일입니다.

재산 가치
설명 되풀이 일정에 대한 요일입니다.
유형 문자열
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

DeleteAgentResponse

삭제된 에이전트 개체

이름 유형 Description 필수 기본값
삭제됨 부울 에이전트가 성공적으로 삭제되었는지 여부입니다.
이름 문자열 에이전트의 이름입니다.
객체 enum 개체 유형 항상 'agent.deleted'입니다.
가능한 값: agent.deleted

DeleteAgentVersionResponse

삭제된 에이전트 버전 개체

이름 유형 Description 필수 기본값
삭제됨 부울 에이전트가 성공적으로 삭제되었는지 여부입니다.
이름 문자열 에이전트의 이름입니다.
객체 enum 개체 유형 항상 'agent.deleted'입니다.
가능한 값: agent.version.deleted
버전 문자열 에이전트의 버전 식별자입니다.

DeleteEvalResponse

삭제된 평가 개체

이름 유형 Description 필수 기본값
삭제됨 부울 eval이 성공적으로 삭제되었는지 여부입니다.
eval_id 문자열 eval의 ID입니다.
객체 enum 개체 유형 항상 'eval.deleted'입니다.
가능한 값: eval.deleted

DeleteEvalRunResponse

삭제된 평가 실행 개체입니다.

이름 유형 Description 필수 기본값
삭제됨 부울 eval이 성공적으로 삭제되었는지 여부입니다. 아니오
객체 enum 개체 유형 항상 'eval.deleted'입니다.
가능한 값: eval.deleted
아니오
run_id 문자열 eval의 ID입니다. 아니오

DeleteMemoryStoreResponse

이름 유형 Description 필수 기본값
삭제됨 부울 메모리 저장소가 성공적으로 삭제되었는지 여부입니다.
이름 문자열 메모리 저장소의 이름입니다.
객체 enum 개체 유형 항상 'memory_store.deleted'입니다.
가능한 값: memory_store.deleted

DeleteResponseResult

응답 삭제 작업의 결과입니다.

이름 유형 Description 필수 기본값
삭제됨 enum 항상 true를 반환합니다.
가능한 값: True
아이디 문자열 작업 ID입니다.
객체 enum 항상 '응답'을 반환합니다.
가능한 값: response

배치

모델 배포 정의

배포에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
ModelDeployment ModelDeployment
이름 유형 Description 필수 기본값
이름 문자열 배포의 이름입니다
type 객체

DeploymentType

재산 가치
유형 문자열
ModelDeployment

EntraIDCredentials

Entra ID 자격 증명 정의

이름 유형 Description 필수 기본값
type enum 자격 증명 형식
가능한 값: AAD

Eval

데이터 원본 구성 및 테스트 조건이 있는 Eval 개체입니다. Eval은 LLM 통합을 위해 수행할 작업을 나타냅니다. 결과는 다음과 같습니다.

  • 내 챗봇의 품질 향상
  • 내 챗봇이 고객 지원을 얼마나 잘 처리하는지 확인합니다.
  • gpt-4o보다 사용 시 o4-mini가 더 나은지 확인합니다.
이름 유형 Description 필수 기본값
생성_시간 객체
작성자 문자열 실행을 만든 사람의 이름입니다. 아니오
데이터 소스 구성 객체 평가 실행에 사용되는 데이터 원본에 대한 스키마를 정의하는 CustomDataSourceConfig 개체입니다.
이 스키마는 다음과 같은 데이터의 모양을 정의하는 데 사용됩니다.
- 테스트 조건을 정의하는 데 사용되며
- 실행을 만들 때 필요한 데이터
└─ include_sample_schema (샘플 스키마 포함) 부울 eval이 샘플 네임스페이스를 채울 것으로 예상해야 하는지 여부(예: 데이터 원본에서 응답을 생성하여) 아니오
└item_schema 객체 데이터 원본의 각 행에 대한 json 스키마입니다. 아니오
└) 메타데이터 객체 저장된 완료 데이터 원본에 대한 메타데이터 필터입니다. 아니오
└) 시나리오 enum 데이터 스키마 시나리오.
가능한 값: red_team, responsestraces
아니오
└─ 형식 enum 항상 label_model인 개체 형식입니다.
가능한 값: azure_ai_source
아니오
아이디 문자열 평가에 대한 고유 식별자입니다.
metadata OpenAI.Metadata 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
modified_at 객체 아니오
이름 문자열 평가의 이름입니다.
객체 enum 개체 유형
가능한 값: eval
속성 객체 추가 정보를 저장하기 위해 개체에 연결할 수 있는 변경할 수 없는 16개의 키-값 쌍 집합입니다.
키는 최대 길이가 64자인 문자열입니다. 값은 최대 길이가 512자인 문자열입니다.
아니오
테스트 기준 array 테스트 조건 목록입니다.

EvalCompareReport

평가 비교에서 얻은 통찰력.

이름 유형 Description 필수 기본값
비교 array 기준선에 대한 각 치료 실행에 대한 비교 결과입니다.
method 문자열 비교에 사용되는 통계적 방법입니다.
type enum 인사이트 결과의 유형입니다.
가능한 값: EvaluationComparison

EvalResult

평가 결과.

이름 유형 Description 필수 기본값
이름 문자열 수표 이름
전달 부울 검사가 통과했는지 또는 실패했는지 나타냅니다.
score 숫자 score
type 문자열 수표 유형

EvalRun

평가 실행을 나타내는 스키마입니다.

이름 유형 Description 필수 기본값
생성_시간 객체
작성자 문자열 실행을 만든 사람의 이름입니다. 아니오
데이터_소스 객체 eval과 일치하는 JSONL 파일을 지정하는 JsonlRunDataSource 개체
└input_messages OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate 또는 OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference 모델에서 샘플링할 때 사용됩니다. 모델에 전달된 메시지의 구조를 지정합니다. 미리 빌드된 궤적(즉, item.input_trajectory)에 대한 참조이거나 네임스페이스에 대한 변수 참조가 있는 템플릿일 수 item 있습니다. 아니오
└item_generation_params RedTeamItemGenerationParams 항목 생성에 대한 매개 변수입니다. 아니오
└─ 모델 문자열 완성을 생성하는 데 사용할 모델의 이름입니다(예: "o3-mini"). 아니오
└─ 샘플링_파라미터 OpenAI.CreateEvalResponsesRunDataSourceSamplingParams 아니오
└) 원본 OpenAI.EvalJsonlFileContentSource 또는 OpenAI.EvalJsonlFileIdSource 또는 OpenAI.EvalResponsesSource 이 실행의 데이터 원본에서 item 네임스페이스를 채우는 내용을 결정합니다. 아니오
└> 대상 대상 평가 대상 구성입니다. 아니오
└─ 형식 문자열 데이터 원본 형식 판별자입니다. 아니오
오류 OpenAI.EvalApiError Eval API의 오류 응답을 나타내는 개체입니다.
eval_id 문자열 연결된 평가의 식별자입니다.
아이디 문자열 평가 작업에 대한 고유 식별자입니다.
metadata OpenAI.Metadata 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
모델 문자열 해당하는 경우 평가되는 모델입니다.
modified_at 객체 아니오
이름 문자열 평가 실행의 이름입니다.
객체 enum 개체의 유형입니다. 항상 "eval.run"입니다.
가능한 값: eval.run
모델별 사용량 array 평가 실행 중 각 모델에 대한 사용 통계입니다.
테스트 기준별 결과 array 평가 실행 중에 적용된 테스트 조건당 결과입니다.
속성 객체 추가 정보를 저장하기 위해 개체에 연결할 수 있는 변경할 수 없는 16개의 키-값 쌍 집합입니다.
키는 최대 길이가 64자인 문자열입니다. 값은 최대 길이가 512자인 문자열입니다.
아니오
보고서_주소 문자열 UI 대시보드에서 렌더링된 평가 실행 보고서의 URL입니다.
결과_수량 객체
└) 오류가 발생했습니다. OpenAI.integer 아니오
└> 실패 OpenAI.integer 아니오
└─ 통과함 OpenAI.integer 아니오
└합계 OpenAI.integer 아니오
상태 문자열 평가 작업의 상태입니다.

EvalRunDataSource

판별자 지원이 있는 실행 데이터 원본에 대한 기본 클래스입니다.

EvalRunDataSource에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
azure_ai_traces TracesEvalRunDataSource
azure_ai_responses AzureAIResponses
azure_ai_target_completions TargetCompletions
이름 유형 Description 필수 기본값
type 문자열 데이터 원본 형식 판별자입니다.

EvalRunOutputItem

평가 실행 출력 항목을 나타내는 스키마입니다.

이름 유형 Description 필수 기본값
생성_시간 객체
데이터 소스 항목 객체 입력 데이터 원본 항목의 세부 정보입니다.
데이터소스_아이템_ID 객체
eval_id 문자열 평가 그룹의 식별자입니다.
아이디 문자열 평가 실행 출력 항목에 대한 고유 식별자입니다.
객체 enum 개체의 유형입니다. 항상 "eval.run.output_item".
가능한 값: eval.run.output_item
results array 이 출력 항목에 대한 채점자 결과 목록입니다.
run_id 문자열 이 출력 항목과 연결된 평가 실행의 식별자입니다.
견본 객체
└) 오류 OpenAI.EvalApiError Eval API의 오류 응답을 나타내는 개체입니다. 아니오
└완료_사유 문자열 아니오
└─ 입력 array 아니오
└─ 최대_완료_토큰 OpenAI.integer 아니오
└─ 모델 문자열 아니오
└─ 출력 array 아니오
└) 시드 OpenAI.integer 아니오
└> 온도 OpenAI.numeric 아니오
└ top_p OpenAI.numeric 아니오
└) 사용량 OpenAI.EvalRunOutputItemSampleUsage 아니오
상태 문자열 평가 작업의 상태입니다.

EvalRunOutputItemResult

평가 실행 출력 항목에 대한 단일 채점자 결과입니다.

이름 유형 Description 필수 기본값
label 문자열 테스트 조건 메트릭과 연결된 레이블입니다(예: "pass", "fail", "good", "bad"). 아니오
메트릭 문자열 메트릭의 이름입니다(예: "fluency", "f1_score"). 아니오
이름 문자열 채점자의 이름입니다.
전달 부울 채점기가 출력을 통과로 고려했는지 여부입니다.
속성 객체 테스트 조건 메트릭에 대한 추가 세부 정보입니다. 아니오
이유 문자열 테스트 조건 메트릭의 이유입니다. 아니오
견본 객체 채점자에서 생성된 선택적 샘플 또는 중간 데이터입니다. 아니오
score 객체
threshold 숫자 숫자인 경우 이 테스트 조건의 통과/실패를 결정하는 데 사용되는 임계값입니다. 아니오
type 문자열 채점자 형식(예: "string-check-grader")입니다. 아니오

EvalRunResultCompareItem

기준선에 대한 치료에 대한 메트릭 비교.

이름 유형 Description 필수 기본값
deltaEstimate 숫자 치료와 기준선 간의 예상 차이.
pValue 숫자 치료 효과에 대한 P-값입니다.
treatmentEffect 객체 치료 효과 유형.
treatmentRunId 문자열 치료 실행 ID입니다.
treatmentRunSummary 객체 평가 실행에서 메트릭의 요약 통계입니다.
└평균 숫자 평가 실행에서 메트릭의 평균값입니다. 아니오
└) runId 문자열 평가 실행 ID입니다. 아니오
└) sampleCount integer 평가 실행의 샘플 수입니다. 아니오
└> standardDeviation 숫자 평가 실행에서 메트릭의 표준 편차입니다. 아니오

EvalRunResultComparison

기준선에 대한 치료 실행에 대한 비교 결과.

이름 유형 Description 필수 기본값
baselineRunSummary 객체 평가 실행에서 메트릭의 요약 통계입니다.
└평균 숫자 평가 실행에서 메트릭의 평균값입니다. 아니오
└) runId 문자열 평가 실행 ID입니다. 아니오
└) sampleCount integer 평가 실행의 샘플 수입니다. 아니오
└> standardDeviation 숫자 평가 실행에서 메트릭의 표준 편차입니다. 아니오
compareItems array 각 치료 실행에 대한 비교 결과 목록입니다.
계산기 문자열 이 테스트 기준에 대한 평가자의 이름입니다.
메트릭 문자열 평가 중인 메트릭입니다.
testingCriteria 문자열 테스트 기준의 이름입니다.

EvalRunResultSummary

평가 실행에서 메트릭의 요약 통계입니다.

이름 유형 Description 필수 기본값
평균 숫자 평가 실행에서 메트릭의 평균값입니다.
runId 문자열 평가 실행 ID입니다.
sampleCount integer 평가 실행의 샘플 수입니다.
standardDeviation 숫자 평가 실행에서 메트릭의 표준 편차입니다.

EvaluationComparisonRequest

평가 비교 요청

이름 유형 Description 필수 기본값
baselineRunId 문자열 비교를 위한 기준선 실행 ID입니다.
evalId 문자열 평가에 대한 식별자입니다.
treatmentRunIds array 비교를 위한 치료 실행 ID 목록입니다.
type enum 요청의 유형입니다.
가능한 값: EvaluationComparison

EvaluationResultSample

평가 결과의 샘플입니다.

이름 유형 Description 필수 기본값
evaluationResult 객체 평가 결과.
└) 이름 문자열 수표 이름 아니오
└─ 통과함 부울 검사가 통과했는지 또는 실패했는지 나타냅니다. 아니오
└) 점수 숫자 score 아니오
└─ 형식 문자열 수표 유형 아니오
type enum 평가 결과 샘플 유형
가능한 값: EvaluationResultSample

평가 규칙

평가 규칙 모델.

이름 유형 Description 필수 기본값
조치 객체 평가 작업 모델.
└─ 형식 EvaluationRuleActionType 평가 작업의 유형입니다. 아니오
description 문자열 평가 규칙에 대한 설명입니다. 아니오
displayName 문자열 평가 규칙의 표시 이름입니다. 아니오
enabled 부울 평가 규칙이 사용하도록 설정되었는지 여부를 나타냅니다. 기본값은 true입니다.
eventType 객체 평가 규칙 이벤트의 유형입니다.
filter 객체 평가 필터 모델. 아니오
└> agentName 문자열 상담원 이름으로 필터링합니다. 아니오
아이디 문자열 평가 규칙의 고유 식별자입니다.
시스템 데이터 객체 평가 규칙에 대한 시스템 메타데이터입니다.

EvaluationRuleAction

평가 작업 모델.

EvaluationRuleAction에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
continuousEvaluation ContinuousEvaluationRuleAction
humanEvaluation HumanEvaluationRuleAction
이름 유형 Description 필수 기본값
type 객체 평가 작업의 유형입니다.

EvaluationRuleActionType

평가 작업의 유형입니다.

재산 가치
설명 평가 작업의 유형입니다.
유형 문자열
continuousEvaluation
humanEvaluation

EvaluationRuleEventType

평가 규칙 이벤트의 유형입니다.

재산 가치
설명 평가 규칙 이벤트의 유형입니다.
유형 문자열
responseCompleted
manual

EvaluationRuleFilter

평가 필터 모델.

이름 유형 Description 필수 기본값
에이전트 이름 문자열 상담원 이름으로 필터링합니다.

EvaluationRunClusterInsightResult

평가에서 얻은 인사이트는 클러스터 분석을 실행합니다.

이름 유형 Description 필수 기본값
clusterInsight ClusterInsightResult 클러스터 분석에서 얻은 통찰력.
type enum 인사이트 결과의 유형입니다.
가능한 값: EvaluationRunClusterInsight

EvaluationRunClusterInsightsRequest

평가 결과 세트에 대한 통찰력

이름 유형 Description 필수 기본값
evalId 문자열 인사이트에 대한 평가 ID입니다.
모델 구성 객체 인사이트 생성에 사용되는 모델의 구성입니다. 아니오
└) modelDeploymentName 문자열 평가할 모델 배포입니다. 배포 이름만 허용하거나 연결 이름을 로 허용 {connectionName}/<modelDeploymentName>합니다. 아니오
runIds array 인사이트에 대한 평가 실행 ID 목록입니다.
type enum 인사이트 요청의 유형입니다.
가능한 값: EvaluationRunClusterInsight

EvaluationScheduleTask

일정에 대한 평가 작업입니다.

이름 유형 Description 필수 기본값
evalId 문자열 평가 그룹의 식별자입니다.
evalRun 객체 평가 실행 페이로드입니다.
type enum
가능한 값: Evaluation

EvaluationTaxonomy

평가 분류 정의

이름 유형 Description 필수 기본값
아이디 문자열 자산 ID: 자산의 고유 식별자입니다. 아니오
이름 문자열 리소스의 이름
속성 객체 평가 분류에 대한 추가 속성입니다. 아니오
taxonomyCategories array 분류 범주 목록. 아니오
taxonomyInput 객체 평가 분류에 대한 입력 구성입니다.
└─ 형식 EvaluationTaxonomyInputType 평가 분류의 입력 유형입니다. 아니오
버전 문자열 리소스의 버전입니다

EvaluationTaxonomyCreateOrUpdate

평가 분류 정의

이름 유형 Description 필수 기본값
description 문자열 자산 설명 텍스트입니다. 아니오
속성 객체 평가 분류에 대한 추가 속성입니다. 아니오
tags 객체 태그 사전입니다. 태그를 추가, 제거 및 업데이트할 수 있습니다. 아니오
taxonomyCategories array 분류 범주 목록. 아니오
taxonomyInput 객체 평가 분류에 대한 입력 구성입니다.
└─ 형식 EvaluationTaxonomyInputType 평가 분류의 입력 유형입니다. 아니오

EvaluationTaxonomyInput

평가 분류에 대한 입력 구성입니다.

EvaluationTaxonomyInput에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
agent AgentTaxonomyInput
이름 유형 Description 필수 기본값
type 객체 평가 분류 입력의 유형입니다.

EvaluationTaxonomyInputType

평가 분류 입력의 유형입니다.

재산 가치
설명 평가 분류 입력의 유형입니다.
유형 문자열
agent
policy

EvaluationTaxonomyInputUpdate

평가 분류에 대한 입력 구성입니다.

EvaluationTaxonomyInputUpdate에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
agent AgentTaxonomyInputUpdate
이름 유형 Description 필수 기본값
type 객체 평가 분류 입력의 유형입니다.

EvaluationTaxonomyUpdate

평가 분류 정의

이름 유형 Description 필수 기본값
description 문자열 자산 설명 텍스트입니다. 아니오
속성 객체 평가 분류에 대한 추가 속성입니다. 아니오
tags 객체 태그 사전입니다. 태그를 추가, 제거 및 업데이트할 수 있습니다. 아니오
taxonomyCategories array 분류 범주 목록. 아니오
taxonomyInput 객체 평가 분류에 대한 입력 구성입니다. 아니오
└─ 형식 EvaluationTaxonomyInputType 평가 분류의 입력 유형입니다. 아니오

EvaluatorCategory

평가자의 범주

재산 가치
설명 평가자의 범주
유형 문자열
quality
safety
agents

EvaluatorDefinition

판별자를 사용한 기본 평가자 구성

EvaluatorDefinition에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
code CodeBasedEvaluatorDefinition
prompt PromptBasedEvaluatorDefinition
이름 유형 Description 필수 기본값
data_schema 평가자의 입력 데이터에 대한 JSON 스키마(초안 2020-12)입니다. 여기에는 유형, 속성, 필수와 같은 매개변수가 포함됩니다. 아니오
init_parameters 평가자의 입력 매개 변수에 대한 JSON 스키마(초안 2020-12)입니다. 여기에는 유형, 속성, 필수와 같은 매개변수가 포함됩니다. 아니오
metrics 객체 이 평가자가 생성한 출력 메트릭 목록 아니오
type 객체 평가자 정의 유형

EvaluatorDefinitionType

평가자 정의 유형

재산 가치
설명 평가자 정의 유형
유형 문자열
prompt
code
prompt_and_code
service
openai_graders

EvaluatorMetric

평가자 메트릭

이름 유형 Description 필수 기본값
desirable_direction 객체 값이 높을수록 좋은지, 낮은 값이 더 좋은지, 중립적인지를 나타내는 지표의 방향입니다 아니오
is_primary 부울 여러 메트릭이 있는 경우 이 메트릭이 기본인지 여부를 나타냅니다. 아니오
max_value 숫자 지표의 최대값입니다. 지정하지 않으면 무제한으로 간주됩니다. 아니오
min_value 숫자 메트릭의 최소값 아니오
type 객체 평가자의 유형 아니오

EvaluatorMetricDirection

값이 높을수록 좋은지, 낮은 값이 더 좋은지, 중립적인지를 나타내는 지표의 방향입니다

재산 가치
설명 값이 높을수록 좋은지, 낮은 값이 더 좋은지, 중립적인지를 나타내는 지표의 방향입니다
유형 문자열
increase
decrease
neutral

EvaluatorMetricType

평가자의 유형

재산 가치
설명 평가자의 유형
유형 문자열
ordinal
continuous
boolean

EvaluatorType

평가자의 유형

재산 가치
설명 평가자의 유형
유형 문자열
builtin
custom

EvaluatorVersion

평가자 정의

이름 유형 Description 필수 기본값
categories array 평가자의 범주
생성_시간 integer 평가자의 생성 날짜/시간
작성자 문자열 평가자의 작성자
정의 객체 판별자를 사용한 기본 평가자 구성
└data_schema 평가자의 입력 데이터에 대한 JSON 스키마(초안 2020-12)입니다. 여기에는 유형, 속성, 필수와 같은 매개변수가 포함됩니다. 아니오
└init_parameters 평가자의 입력 매개 변수에 대한 JSON 스키마(초안 2020-12)입니다. 여기에는 유형, 속성, 필수와 같은 매개변수가 포함됩니다. 아니오
└) 메트릭 객체 이 평가자가 생성한 출력 메트릭 목록 아니오
└─ 형식 EvaluatorDefinitionType 평가자 정의 유형 아니오
display_name 문자열 평가자의 표시 이름입니다. Foundry에서 계산기를 쉽게 찾을 수 있습니다. 고유할 필요는 없습니다. 아니오
evaluator_type 객체 평가자의 유형
아이디 문자열 자산 ID: 자산의 고유 식별자입니다. 아니오
metadata 객체 평가자에 대한 메타데이터 아니오
modified_at integer 평가자의 마지막 수정 날짜/시간
이름 문자열 리소스의 이름
버전 문자열 리소스의 버전입니다

EvaluatorVersionCreate

평가자 정의

이름 유형 Description 필수 기본값
categories array 평가자의 범주
정의 객체 판별자를 사용한 기본 평가자 구성
└data_schema 평가자의 입력 데이터에 대한 JSON 스키마(초안 2020-12)입니다. 여기에는 유형, 속성, 필수와 같은 매개변수가 포함됩니다. 아니오
└init_parameters 평가자의 입력 매개 변수에 대한 JSON 스키마(초안 2020-12)입니다. 여기에는 유형, 속성, 필수와 같은 매개변수가 포함됩니다. 아니오
└) 메트릭 객체 이 평가자가 생성한 출력 메트릭 목록 아니오
└─ 형식 EvaluatorDefinitionType 평가자 정의 유형 아니오
description 문자열 자산 설명 텍스트입니다. 아니오
display_name 문자열 평가자의 표시 이름입니다. Foundry에서 계산기를 쉽게 찾을 수 있습니다. 고유할 필요는 없습니다. 아니오
evaluator_type 객체 평가자의 유형
metadata 객체 평가자에 대한 메타데이터 아니오
tags 객체 태그 사전입니다. 태그를 추가, 제거 및 업데이트할 수 있습니다. 아니오

EvaluatorVersionUpdate

평가자 정의

이름 유형 Description 필수 기본값
categories array 평가자의 범주 아니오
description 문자열 자산 설명 텍스트입니다. 아니오
display_name 문자열 평가자의 표시 이름입니다. Foundry에서 계산기를 쉽게 찾을 수 있습니다. 고유할 필요는 없습니다. 아니오
metadata 객체 평가자에 대한 메타데이터 아니오
tags 객체 태그 사전입니다. 태그를 추가, 제거 및 업데이트할 수 있습니다. 아니오

FabricDataAgentToolParameters

패브릭 데이터 에이전트 도구 매개 변수입니다.

이름 유형 Description 필수 기본값
project_connections array 이 도구에 연결된 프로젝트 연결입니다. 최대 1 연결이 있을 수 있습니다.
도구에 연결된 리소스입니다.
아니오

FileDatasetVersion

FileDatasetVersion 정의

이름 유형 Description 필수 기본값
type enum 데이터 세트 형식
가능한 값: uri_file

FileDatasetVersionUpdate

FileDatasetVersion 정의

이름 유형 Description 필수 기본값
type enum 데이터 세트 형식
가능한 값: uri_file

FolderDatasetVersion

FileDatasetVersion 정의

이름 유형 Description 필수 기본값
type enum 데이터 세트 형식
가능한 값: uri_folder

FolderDatasetVersionUpdate

FileDatasetVersion 정의

이름 유형 Description 필수 기본값
type enum 데이터 세트 형식
가능한 값: uri_folder

HostedAgentDefinition

호스팅된 에이전트 정의입니다.

HostedAgentDefinition에 대한 판별자

이 구성 요소는 속성을 kind 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
hosted ImageBasedHostedAgentDefinition
이름 유형 Description 필수 기본값
container_protocol_versions array 에이전트가 컨테이너의 수신 통신을 위해 지원하는 프로토콜입니다.
cpu 문자열 호스팅된 에이전트의 CPU 구성입니다.
environment_variables 객체 호스팅된 에이전트 컨테이너에 설정할 환경 변수입니다. 아니오
친절한 enum
가능한 값: hosted
메모리 문자열 호스팅된 에이전트의 메모리 구성입니다.
도구들 array 호스팅된 에이전트의 모델이 응답을 생성하는 동안 호출할 수 있는 도구 배열입니다. 당신
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.
아니오

HourlyRecurrenceSchedule

시간별 되풀이 일정.

이름 유형 Description 필수 기본값
type enum
가능한 값: Hourly

HumanEvaluationRuleAction

사용자 평가를 위한 평가 규칙 작업입니다.

이름 유형 Description 필수 기본값
템플릿ID 객체 저장된 자산의 식별자입니다.
type enum
가능한 값: humanEvaluation

ImageBasedHostedAgentDefinition

호스팅된 에이전트에 대한 이미지 기반 배포 정의입니다.

이름 유형 Description 필수 기본값
이미지 문자열 호스팅된 에이전트의 이미지입니다.
친절한 enum
가능한 값: hosted

Index

인덱스 리소스 정의

인덱스 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
AzureSearch AzureAISearchIndex
ManagedAzureSearch ManagedAzureAISearchIndex
CosmosDBNoSqlVectorStore CosmosDBIndex
이름 유형 Description 필수 기본값
아이디 문자열 자산 ID: 자산의 고유 식별자입니다. 아니오
이름 문자열 리소스의 이름
type 객체
버전 문자열 리소스의 버전입니다

IndexType

재산 가치
유형 문자열
AzureSearch
CosmosDBNoSqlVectorStore
ManagedAzureSearch

IndexUpdate

인덱스 리소스 정의

IndexUpdate에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
AzureSearch AzureAISearchIndexUpdate
ManagedAzureSearch ManagedAzureAISearchIndexUpdate
CosmosDBNoSqlVectorStore CosmosDBIndexUpdate
이름 유형 Description 필수 기본값
description 문자열 자산 설명 텍스트입니다. 아니오
tags 객체 태그 사전입니다. 태그를 추가, 제거 및 업데이트할 수 있습니다. 아니오
type 객체

인사이트

클러스터 인사이트에 대한 응답 본문입니다.

이름 유형 Description 필수 기본값
displayName 문자열 인사이트에 대한 사용자에게 친숙한 표시 이름입니다.
아이디 문자열 인사이트 보고서의 고유 식별자입니다.
metadata 객체 인사이트에 대한 메타데이터입니다.
└> completedAt 문자열 인사이트가 완료된 타임스탬프입니다. 아니오
└) createdAt 문자열 인사이트가 생성된 타임스탬프입니다. 아니오
request 객체 인사이트 보고서의 요청입니다.
└─ 형식 InsightType 요청의 유형입니다. 아니오
결과 객체 통찰력의 결과. 아니오
└─ 형식 InsightType 인사이트 결과의 유형입니다. 아니오
객체 허용된 작업 상태를 설명하는 열거형입니다.

InsightCluster

분석 샘플의 클러스터입니다.

이름 유형 Description 필수 기본값
description 문자열 분석 클러스터에 대한 설명입니다.
아이디 문자열 분석 클러스터의 ID입니다.
label 문자열 클러스터의 레이블
샘플 array 이 클러스터에 속하는 샘플 목록입니다. 샘플이 부분군집의 일부인 경우 비어 있습니다. 아니오
하위 클러스터 array 이 클러스터 내의 하위 클러스터 목록입니다. 하위 클러스터가 없으면 비어 있습니다. 아니오
제안 문자열 클러스터에 대한 제안
suggestionTitle 문자열 클러스터에 대한 제안의 제목
무게 integer 분석 클러스터의 가중치입니다. 이는 클러스터의 샘플 수를 나타냅니다.

InsightModelConfiguration

인사이트 생성에 사용되는 모델의 구성입니다.

이름 유형 Description 필수 기본값
modelDeploymentName 문자열 평가할 모델 배포입니다. 배포 이름만 허용하거나 연결 이름을 로 허용 {connectionName}/<modelDeploymentName>합니다.

InsightRequest

인사이트 보고서의 요청입니다.

InsightRequest에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
EvaluationRunClusterInsight EvaluationRunClusterInsightsRequest
AgentClusterInsight AgentClusterInsightsRequest
EvaluationComparison EvaluationComparisonRequest
이름 유형 Description 필수 기본값
type 객체 통찰력의 요청.

InsightResult

통찰력의 결과.

InsightResult에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
EvaluationComparison EvalCompareReport
EvaluationRunClusterInsight EvaluationRunClusterInsightResult
AgentClusterInsight AgentClusterInsightResult
이름 유형 Description 필수 기본값
type 객체 통찰력의 요청.

InsightSample

분석의 샘플입니다.

InsightSample에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
EvaluationResultSample EvaluationResultSample
이름 유형 Description 필수 기본값
correlationInfo 객체 분석 샘플의 상관 관계에 대한 정보입니다.
features 객체 UX에서 데이터를 추가로 필터링하는 데 도움이 되는 기능입니다.
아이디 문자열 분석 샘플의 고유 식별자입니다.
type 객체 분석에 사용된 샘플의 유형입니다.

InsightScheduleTask

일정에 대한 인사이트 작업입니다.

이름 유형 Description 필수 기본값
인사이트 객체 클러스터 인사이트에 대한 응답 본문입니다.
└> displayName 문자열 인사이트에 대한 사용자에게 친숙한 표시 이름입니다. 아니오
└─ ID 문자열 인사이트 보고서의 고유 식별자입니다. 아니오
└) 메타데이터 InsightsMetadata 인사이트 보고서에 대한 메타데이터입니다. 아니오
└) 요청 InsightRequest 인사이트 분석을 요청합니다. 아니오
└> 결과 InsightResult 인사이트 보고서의 결과입니다. 아니오
└) 상태 Azure.Core.Foundations.OperationState 인사이트의 현재 상태입니다. 아니오
type enum
가능한 값: Insight

InsightSummary

오류 클러스터 분석의 요약입니다.

이름 유형 Description 필수 기본값
method 문자열 클러스터링에 사용되는 방법입니다.
sampleCount integer 분석된 총 샘플 수입니다.
uniqueClusterCount integer 고유 클러스터의 총 수입니다.
uniqueSubclusterCount integer 고유한 하위 클러스터 레이블의 총 수입니다.
usage 객체 클러스터 분석을 위한 토큰 사용량
└) inputTokenUsage integer 입력 토큰 사용량 아니오
└> outputTokenUsage integer 출력 토큰 사용량 아니오
└) totalTokenUsage integer 총 토큰 사용량 아니오

InsightType

통찰력의 요청.

재산 가치
유형 문자열
EvaluationRunClusterInsight
AgentClusterInsight
EvaluationComparison

InsightsMetadata

인사이트에 대한 메타데이터입니다.

이름 유형 Description 필수 기본값
completedAt 문자열 인사이트가 완료된 타임스탬프입니다. 아니오
생성일시 문자열 인사이트가 생성된 타임스탬프입니다.

ItemGenerationParams

항목 생성 작업을 제어하는 데 사용되는 매개 변수 집합을 나타냅니다.

ItemGenerationParams에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
이름 유형 Description 필수 기본값
type 문자열 사용할 항목 생성 매개 변수의 형식입니다.

ManagedAzureAISearchIndex

관리형 Azure AI Search 인덱스 정의

이름 유형 Description 필수 기본값
type enum 인덱스 유형
가능한 값: ManagedAzureSearch

ManagedAzureAISearchIndexUpdate

관리형 Azure AI Search 인덱스 정의

이름 유형 Description 필수 기본값
type enum 인덱스 유형
가능한 값: ManagedAzureSearch

MemoryItem

콘텐츠 및 메타데이터를 포함하는 메모리 저장소에 저장된 단일 메모리 항목입니다.

MemoryItem에 대한 판별자

이 구성 요소는 속성을 kind 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
user_profile UserProfileMemoryItem
chat_summary ChatSummaryMemoryItem
이름 유형 Description 필수 기본값
내용 문자열 메모리의 내용입니다.
친절한 객체 메모리 아이템 종류입니다.
memory_id 문자열 메모리 항목의 고유 ID입니다.
scope 문자열 사용자 ID와 같은 메모리를 논리적으로 그룹화하고 격리하는 네임스페이스입니다.
updated_at integer 메모리 항목의 마지막 업데이트 시간입니다.

MemoryItemKind

메모리 아이템 종류입니다.

재산 가치
설명 메모리 아이템 종류입니다.
유형 문자열
user_profile
chat_summary

MemoryOperation

메모리 항목에 대해 수행되는 단일 메모리 작업(만들기, 업데이트 또는 삭제)을 나타냅니다.

이름 유형 Description 필수 기본값
친절한 객체 메모리 작업 종류입니다.
memory_item 객체 콘텐츠 및 메타데이터를 포함하는 메모리 저장소에 저장된 단일 메모리 항목입니다.
└─ 콘텐츠 문자열 메모리의 내용입니다. 아니오
└) 종류 MemoryItemKind 메모리 아이템의 종류입니다. 아니오
└memory_id 문자열 메모리 항목의 고유 ID입니다. 아니오
└) 범위 문자열 사용자 ID와 같은 메모리를 논리적으로 그룹화하고 격리하는 네임스페이스입니다. 아니오
└updated_at integer 메모리 항목의 마지막 업데이트 시간입니다. 아니오

MemoryOperationKind

메모리 작업 종류입니다.

재산 가치
설명 메모리 작업 종류입니다.
유형 문자열
create
update
delete

MemorySearchItem

메모리 검색에서 검색된 메모리 항목입니다.

이름 유형 Description 필수 기본값
memory_item 객체 콘텐츠 및 메타데이터를 포함하는 메모리 저장소에 저장된 단일 메모리 항목입니다.
└─ 콘텐츠 문자열 메모리의 내용입니다. 아니오
└) 종류 MemoryItemKind 메모리 아이템의 종류입니다. 아니오
└memory_id 문자열 메모리 항목의 고유 ID입니다. 아니오
└) 범위 문자열 사용자 ID와 같은 메모리를 논리적으로 그룹화하고 격리하는 네임스페이스입니다. 아니오
└updated_at integer 메모리 항목의 마지막 업데이트 시간입니다. 아니오

MemorySearchOptions

메모리 검색 옵션.

이름 유형 Description 필수 기본값
max_memories integer 반환할 최대 메모리 항목 수입니다. 아니오

MemorySearchTool

기억을 에이전트에 통합하는 도구입니다.

이름 유형 Description 필수 기본값
memory_store_name 문자열 사용할 메모리 저장소의 이름입니다.
scope 문자열 사용자 ID와 같은 메모리를 그룹화하고 격리하는 데 사용되는 네임스페이스입니다.
검색하거나 업데이트할 수 있는 메모리를 제한합니다.
특수 변수 {{$userId}} 를 사용하여 현재 로그인한 사용자로 메모리 범위를 지정합니다.
search_options 객체 메모리 검색 옵션. 아니오
└max_memories integer 반환할 최대 메모리 항목 수입니다. 아니오
type enum 도구의 종류입니다. 항상 memory_search입니다.
가능한 값: memory_search
update_delay integer 비활성 후 메모리를 업데이트하기 전에 기다리는 시간(초)입니다. 기본값은 300입니다. 아니오 300

MemorySearchToolCallItemParam

이름 유형 Description 필수 기본값
results array 메모리 검색에서 반환된 결과입니다. 아니오
type enum
가능한 값: memory_search_call

MemorySearchToolCallItemResource

이름 유형 Description 필수 기본값
results array 메모리 검색에서 반환된 결과입니다. 아니오
상태 enum 메모리 검색 도구 호출의 상태입니다. 다음 중 하나입니다. in_progress
searching, completed또는 incompletefailed,
가능한 값: in_progress, searching, completed, incompletefailed
type enum
가능한 값: memory_search_call

MemoryStoreDefaultDefinition

기본 메모리 저장소 구현입니다.

이름 유형 Description 필수 기본값
chat_model 문자열 메모리 처리에 사용되는 채팅 완료 모델 배포의 이름 또는 식별자입니다.
embedding_model 문자열 메모리 처리에 사용되는 임베딩 모델 배포의 이름 또는 식별자입니다.
친절한 enum 메모리 저장소의 종류입니다.
가능한 값: default
options 객체 기본 메모리 저장소 구성입니다. 아니오
└chat_summary_enabled 부울 채팅 요약 추출 및 저장을 사용하도록 설정할지 여부입니다. 기본값은 true입니다. 아니오 진실
└user_profile_details 문자열 추출하고 저장할 사용자 프로필 정보의 특정 범주 또는 유형입니다. 아니오
└user_profile_enabled 부울 사용자 프로필 추출 및 저장을 사용하도록 설정할지 여부입니다. 기본값은 true입니다. 아니오 진실

MemoryStoreDefaultOptions

기본 메모리 저장소 구성입니다.

이름 유형 Description 필수 기본값
chat_summary_enabled 부울 채팅 요약 추출 및 저장을 사용하도록 설정할지 여부입니다. 기본값은 true입니다. 진실
user_profile_details 문자열 추출하고 저장할 사용자 프로필 정보의 특정 범주 또는 유형입니다. 아니오
user_profile_enabled 부울 사용자 프로필 추출 및 저장을 사용하도록 설정할지 여부입니다. 기본값은 true입니다. 진실

MemoryStoreDefinition

메모리 저장소 구성에 대한 기본 정의입니다.

MemoryStoreDefinition에 대한 판별자

이 구성 요소는 속성을 kind 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
default MemoryStoreDefaultDefinition
이름 유형 Description 필수 기본값
친절한 객체 사용할 메모리 저장소 구현의 유형입니다.

MemoryStoreDeleteScopeResponse

범위에서 메모리를 삭제하기 위한 응답입니다.

이름 유형 Description 필수 기본값
삭제됨 부울 삭제 작업이 성공했는지 여부입니다.
이름 문자열 메모리 저장소의 이름입니다.
객체 enum 개체 유형 항상 'memory_store.scope.deleted'입니다.
가능한 값: memory_store.scope.deleted
scope 문자열 메모리가 삭제된 범위입니다.

MemoryStoreKind

사용할 메모리 저장소 구현의 유형입니다.

재산 가치
설명 사용할 메모리 저장소 구현의 유형입니다.
유형 문자열
default

MemoryStoreObject

사용자 메모리를 저장하고 검색할 수 있는 메모리 저장소입니다.

이름 유형 Description 필수 기본값
생성_시간 integer 메모리 저장소가 생성되었을 때의 Unix 타임스탬프(초)입니다.
정의 객체 메모리 저장소 구성에 대한 기본 정의입니다.
└) 종류 MemoryStoreKind 메모리 저장소의 종류입니다. 아니오
description 문자열 메모리 저장소에 대한 사람이 읽을 수 있는 설명입니다. 아니오
아이디 문자열 메모리 저장소의 고유 식별자입니다.
metadata 객체 메모리 저장소와 연결할 임의의 키-값 메타데이터입니다. 아니오
이름 문자열 메모리 저장소의 이름입니다.
객체 enum 항상 'memory_store'인 객체 유형입니다.
가능한 값: memory_store
updated_at integer 메모리 저장소가 마지막으로 업데이트된 Unix 타임스탬프(초)입니다.

MemoryStoreOperationUsage

메모리 저장소 작업의 사용 통계입니다.

이름 유형 Description 필수 기본값
embedding_tokens integer 임베딩 토큰의 수입니다.
input_tokens integer 입력 토큰의 수입니다.
input_tokens_details 객체 입력 토큰에 대한 자세한 분석입니다.
└─ 캐시된_토큰 (cached_tokens) integer 캐시에서 검색된 토큰 수입니다.
프롬프트 캐싱에 대해 자세히 알아보세요.
아니오
output_tokens integer 출력 토큰의 수입니다.
output_tokens_details 객체 출력 토큰에 대한 자세한 분석입니다.
└─ 추론_토큰 integer 추론 토큰의 수입니다. 아니오
total_tokens integer 사용된 총 토큰 수입니다.

MemoryStoreSearchResponse

메모리 검색 응답.

이름 유형 Description 필수 기본값
추억 array 검색 작업 중에 발견된 관련 메모리 항목입니다.
search_id 문자열 이 검색 요청의 고유 ID입니다. 이 값을 후속 요청에서 previous_search_id 사용하여 증분 검색을 수행합니다.
usage 객체 메모리 저장소 작업의 사용 통계입니다.
└embedding_tokens integer 임베딩 토큰의 수입니다. 아니오
└input_tokens integer 입력 토큰의 수입니다. 아니오
입력 토큰 세부정보 └input_tokens_details 객체 입력 토큰에 대한 자세한 분석입니다. 아니오
└─ 캐시된_토큰 (cached_tokens) integer 캐시에서 검색된 토큰 수입니다.
프롬프트 캐싱에 대해 자세히 알아보세요.
아니오
└─ 출력 토큰 (output_tokens) integer 출력 토큰의 수입니다. 아니오
└output_tokens_details 객체 출력 토큰에 대한 자세한 분석입니다. 아니오
└─ 추론_토큰 integer 추론 토큰의 수입니다. 아니오
└total_tokens integer 사용된 총 토큰 수입니다. 아니오

MemoryStoreUpdateCompletedResult

메모리 업데이트 결과입니다.

이름 유형 Description 필수 기본값
memory_operations array 업데이트 중에 수행된 개별 메모리 작업 목록입니다.
usage 객체 메모리 저장소 작업의 사용 통계입니다.
└embedding_tokens integer 임베딩 토큰의 수입니다. 아니오
└input_tokens integer 입력 토큰의 수입니다. 아니오
입력 토큰 세부정보 └input_tokens_details 객체 입력 토큰에 대한 자세한 분석입니다. 아니오
└─ 캐시된_토큰 (cached_tokens) integer 캐시에서 검색된 토큰 수입니다.
프롬프트 캐싱에 대해 자세히 알아보세요.
아니오
└─ 출력 토큰 (output_tokens) integer 출력 토큰의 수입니다. 아니오
└output_tokens_details 객체 출력 토큰에 대한 자세한 분석입니다. 아니오
└─ 추론_토큰 integer 추론 토큰의 수입니다. 아니오
└total_tokens integer 사용된 총 토큰 수입니다. 아니오

MemoryStoreUpdateResponse

메모리 저장소 업데이트 작업의 상태를 제공합니다.

이름 유형 Description 필수 기본값
오류 객체 아니오
└) additionalInfo 객체 아니오
└) 코드 문자열 아니오
└) debugInfo 객체 아니오
└) 세부 정보 array 아니오
└) 메시지 문자열 아니오
└─ 매개 변수 문자열 아니오
└─ 형식 문자열 아니오
결과 객체 메모리 업데이트 결과입니다. 아니오
└memory_operations array 업데이트 중에 수행된 개별 메모리 작업 목록입니다. 아니오
└) 사용량 MemoryStoreOperationUsage 메모리 업데이트 작업과 관련된 사용 통계입니다. 아니오
상태 객체 메모리 저장소 업데이트 작업의 상태입니다.
superseded_by 문자열 상태가 "대체됨"인 경우 작업이 대체된 update_id입니다. 아니오
update_id 문자열 이 업데이트 요청의 고유 ID입니다. 이 값을 후속 요청에서 previous_update_id 사용하여 증분 업데이트를 수행합니다.

MemoryStoreUpdateStatus

메모리 저장소 업데이트 작업의 상태입니다.

재산 가치
설명 메모리 저장소 업데이트 작업의 상태입니다.
유형 문자열
queued
in_progress
completed
failed
superseded

MicrosoftFabricAgentTool

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

이름 유형 Description 필수 기본값
fabric_dataagent_preview 객체 패브릭 데이터 에이전트 도구 매개 변수입니다.
└project_connections array 이 도구에 연결된 프로젝트 연결입니다. 최대 1 연결이 있을 수 있습니다.
도구에 연결된 리소스입니다.
아니오
type enum 항상 'fabric_dataagent'인 개체 형식입니다.
가능한 값: fabric_dataagent_preview

ModelDeployment

모델 배포 정의

이름 유형 Description 필수 기본값
capabilities 객체 배포된 모델의 기능
연결 이름 문자열 배포가 시작되는 연결의 이름입니다 아니오
modelName 문자열 배포된 모델의 게시자별 이름
modelPublisher 문자열 배포된 모델의 게시자 이름입니다
모델 버전 문자열 배포된 모델의 게시자별 버전
sku 객체 SKU 정보
└량 integer SKU 용량 아니오
└) 제품군 문자열 Sku 제품군 아니오
└) 이름 문자열 Sku 이름 아니오
└량 문자열 SKU 크기 아니오
└) 계층 문자열 Sku 계층 아니오
type enum 배포의 유형입니다
가능한 값: ModelDeployment

ModelSamplingParams

텍스트를 생성하는 동안 언어 모델의 샘플링 동작을 제어하는 데 사용되는 매개 변수 집합을 나타냅니다.

이름 유형 Description 필수 기본값
max_completion_tokens integer 완료 시 허용되는 최대 토큰 수입니다.
seed integer 재현성을 위한 임의 시드입니다.
온도 숫자 샘플링을 위한 온도 매개 변수입니다.
top_p (탑 피) 숫자 핵 샘플링을 위한 top-p 매개 변수입니다.

ModelSamplingParamsUpdate

텍스트를 생성하는 동안 언어 모델의 샘플링 동작을 제어하는 데 사용되는 매개 변수 집합을 나타냅니다.

이름 유형 Description 필수 기본값
max_completion_tokens integer 완료 시 허용되는 최대 토큰 수입니다. 아니오
seed integer 재현성을 위한 임의 시드입니다. 아니오
온도 숫자 샘플링을 위한 온도 매개 변수입니다. 아니오
top_p (탑 피) 숫자 핵 샘플링을 위한 top-p 매개 변수입니다. 아니오

MonthlyRecurrenceSchedule

월별 되풀이 일정.

이름 유형 Description 필수 기본값
daysOfMonth array 되풀이 일정에 대한 월의 요일입니다.
type enum 월별 되풀이 유형입니다.
가능한 값: Monthly

NoAuthenticationCredentials

인증이 필요하지 않은 자격 증명

이름 유형 Description 필수 기본값
type enum 자격 증명 형식
가능한 값: None

OAuthConsentRequestItemResource

사용자가 OAuth 동의를 수행하도록 서비스에서 요청합니다.

이름 유형 Description 필수 기본값
consent_link 문자열 사용자가 OAuth 동의를 수행하는 데 사용할 수 있는 링크입니다.
아이디 문자열
서버 레이블 문자열 OAuth 동의 요청에 대한 서버 레이블입니다.
type enum
가능한 값: oauth_consent_request

OneTimeTrigger

일회성 트리거.

이름 유형 Description 필수 기본값
timeZone 문자열 일회성 트리거의 표준 시간대입니다. 아니오 UTC
triggerAt 문자열 ISO 8601 형식의 일회성 트리거에 대한 날짜 및 시간입니다.
type enum
가능한 값: OneTime

OpenAI.Annotation

OpenAI.Annotation에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
file_citation OpenAI.AnnotationFileCitation
url_citation OpenAI.AnnotationUrlCitation
file_path OpenAI.AnnotationFilePath
이름 유형 Description 필수 기본값
type OpenAI.AnnotationType

OpenAI.AnnotationFileCitation

파일에 대한 인용입니다.

이름 유형 Description 필수 기본값
file_id 문자열 파일의 ID입니다.
filename 문자열 인용된 파일의 파일 이름입니다.
index integer 파일 목록에 있는 파일의 인덱스입니다.
type enum 파일 인용의 형식입니다. 항상 file_citation입니다.
가능한 값: file_citation

OpenAI.AnnotationFilePath

파일의 경로입니다.

이름 유형 Description 필수 기본값
file_id 문자열 파일의 ID입니다.
index integer 파일 목록에 있는 파일의 인덱스입니다.
type enum 파일 경로의 형식입니다. 항상 file_path입니다.
가능한 값: file_path

OpenAI.AnnotationType

재산 가치
유형 문자열
file_citation
url_citation
file_path
container_file_citation

OpenAI.AnnotationUrlCitation

모델 응답을 생성하는 데 사용되는 웹 리소스에 대한 인용입니다.

이름 유형 Description 필수 기본값
end_index integer 메시지에서 URL 인용의 마지막 문자 인덱스입니다.
start_index integer 메시지에서 URL 인용의 첫 번째 문자 인덱스입니다.
title 문자열 웹 리소스의 제목입니다.
type enum URL 인용의 형식입니다. 항상 url_citation입니다.
가능한 값: url_citation
URL 문자열 웹 리소스의 URL입니다.

OpenAI.ApproximateLocation (대략적인 위치)

이름 유형 Description 필수 기본값
city 문자열 아니오
country 문자열 아니오
region 문자열 아니오
시간대 문자열 아니오
type enum
가능한 값: approximate

OpenAI.ChatCompletionTool (챗 완성 도구)

응답을 생성하는 데 사용할 수 있는 함수 도구입니다.

이름 유형 Description 필수 기본값
기능 OpenAI.FunctionObject
type enum 도구의 종류입니다. 현재는 function만 지원됩니다.
가능한 값: function

OpenAI 코드 해석기 출력

OpenAI.CodeInterpreterOutput에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
image OpenAI.CodeInterpreterOutputImage
logs OpenAI.CodeInterpreterOutputLogs
이름 유형 Description 필수 기본값
type OpenAI.CodeInterpreterOutputType

OpenAI.CodeInterpreterOutputImage

코드 인터프리터의 이미지 출력입니다.

이름 유형 Description 필수 기본값
type enum 출력의 형식입니다. 항상 '이미지'입니다.
가능한 값: image
URL 문자열 코드 인터프리터에서 이미지 출력의 URL입니다.

OpenAI.CodeInterpreterOutputLogs

코드 인터프리터의 로그 출력입니다.

이름 유형 Description 필수 기본값
logs 문자열 코드 인터프리터의 로그 출력입니다.
type enum 출력의 형식입니다. 항상 'logs'입니다.
가능한 값: logs

OpenAI.CodeInterpreterOutputType

재산 가치
유형 문자열
logs
image

OpenAI.CodeInterpreterTool

프롬프트에 대한 응답을 생성하는 데 도움이 되는 Python 코드를 실행하는 도구입니다.

이름 유형 Description 필수 기본값
container 객체 코드 인터프리터 컨테이너에 대한 구성입니다. 필요에 따라 ID 지정
파일에서 코드를 실행하는 데 필요한 것입니다.
└ file_ids array 코드에서 사용할 수 있도록 업로드된 파일의 선택적 목록입니다. 아니오
└─ 형식 enum 항상 auto입니다.
가능한 값: auto
아니오
type enum 코드 인터프리터 도구의 형식입니다. 항상 code_interpreter입니다.
가능한 값: code_interpreter

OpenAI.CodeInterpreterToolAuto

코드 인터프리터 컨테이너에 대한 구성입니다. 필요에 따라 코드를 실행할 파일의 ID를 지정합니다.

이름 유형 Description 필수 기본값
파일_아이디 array 코드에서 사용할 수 있도록 업로드된 파일의 선택적 목록입니다. 아니오
type enum 항상 auto입니다.
가능한 값: auto

OpenAI.CodeInterpreterToolCallItemParam

코드를 실행하는 도구 호출입니다.

이름 유형 Description 필수 기본값
코드 문자열 실행할 코드이거나, 사용할 수 없는 경우 null입니다.
container_id 문자열 코드를 실행하는 데 사용되는 컨테이너의 ID입니다.
출력 array 코드 인터프리터에서 생성된 출력(예: 로그 또는 이미지)입니다.
사용할 수 있는 출력이 없으면 null일 수 있습니다.
type enum
가능한 값: code_interpreter_call

OpenAI.CodeInterpreterToolCallItemResource

코드를 실행하는 도구 호출입니다.

이름 유형 Description 필수 기본값
코드 문자열 실행할 코드이거나, 사용할 수 없는 경우 null입니다.
container_id 문자열 코드를 실행하는 데 사용되는 컨테이너의 ID입니다.
출력 array 코드 인터프리터에서 생성된 출력(예: 로그 또는 이미지)입니다.
사용할 수 있는 출력이 없으면 null일 수 있습니다.
상태 enum
가능한 값: in_progress, completed, incomplete, interpretingfailed
type enum
가능한 값: code_interpreter_call

OpenAI.ComparisonFilter (비교 필터)

정의된 비교 작업을 사용하여 지정된 특성 키를 지정된 값과 비교하는 데 사용되는 필터입니다.

이름 유형 Description 필수 기본값
key 문자열 값과 비교할 키입니다.
type enum 비교 연산자를 지정합니다.
eq (같음), ne (같지 않음), gt (보다 크거나 같음), gte (보다 크거나 같음), lt (보다 작음), lte (작거나 같음).
가능한 값: eq, ne, gtgte, ltlte
value 문자열 또는 숫자 또는 불리언

OpenAI.복합필터

and 또는 or를 사용하여 여러 필터를 결합합니다.

이름 유형 Description 필수 기본값
filters array 결합할 필터의 배열입니다. 항목은 ComparisonFilter 또는 CompoundFilter일 수 있습니다.
type enum 작업 유형: and 또는 or.
가능한 값: andor

OpenAI.ComputerAction

OpenAI.ComputerAction에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
click OpenAI.ComputerActionClick
double_click OpenAI.ComputerActionDoubleClick
drag OpenAI.ComputerActionDrag
move OpenAI.ComputerActionMove
screenshot OpenAI.ComputerActionScreenshot
scroll OpenAI.ComputerActionScroll
type OpenAI.ComputerActionTypeKeys
wait OpenAI.ComputerActionWait
keypress OpenAI.ComputerActionKeyPress
이름 유형 Description 필수 기본값
type OpenAI.ComputerActionType

OpenAI.ComputerActionClick

클릭 동작입니다.

이름 유형 Description 필수 기본값
단추 enum 클릭하는 동안 누른 마우스 단추를 나타냅니다. left, right, wheel, back, forward 중 하나입니다.
가능한 값: left, right, wheel, backforward
type enum 이벤트 유형을 지정합니다. 클릭 작업의 경우 이 속성은
항상 click로 설정합니다.
가능한 값: click
x integer 클릭이 발생한 x 좌표입니다.
y integer 클릭이 발생한 y 좌표입니다.

OpenAI.ComputerActionDoubleClick

두 번 클릭 동작입니다.

이름 유형 Description 필수 기본값
type enum 이벤트 유형을 지정합니다. 두 번 클릭 작업의 경우 이 속성은
항상 double_click로 설정합니다.
가능한 값: double_click
x integer 두 번 클릭이 발생한 x 좌표입니다.
y integer 이중 클릭이 발생한 y 좌표입니다.

OpenAI.ComputerActionDrag

끌기 작업입니다.

이름 유형 Description 필수 기본값
경로 array 끌기 동작의 경로를 나타내는 좌표 배열입니다. 좌표가 배열로 표시됩니다.
예를 들어, 개체의
<br>[<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br>]<br>
type enum 이벤트 유형을 지정합니다. 끌기 작업의 경우 이 속성은 다음과 같습니다.
항상 drag로 설정합니다.
가능한 값: drag

OpenAI.ComputerActionKeyPress

모델이 수행하려는 키 프레스의 컬렉션입니다.

이름 유형 Description 필수 기본값
열쇠 array 모델이 누르도록 요청하는 키 조합입니다. 이는
각각 키를 나타내는 문자열 배열입니다.
type enum 이벤트 유형을 지정합니다. 키 입력 작업의 경우 이 속성은 다음과 같습니다.
항상 keypress로 설정합니다.
가능한 값: keypress

OpenAI.ComputerActionMove

마우스 이동 동작입니다.

이름 유형 Description 필수 기본값
type enum 이벤트 유형을 지정합니다. 이동 작업의 경우 이 속성은
항상 move로 설정합니다.
가능한 값: move
x integer 이동할 x 좌표입니다.
y integer 이동할 y 좌표입니다.

OpenAI.ComputerActionScreenshot

스크린샷 작업입니다.

이름 유형 Description 필수 기본값
type enum 이벤트 유형을 지정합니다. 스크린샷 작업의 경우 이 속성은 다음과 같습니다.
항상 screenshot로 설정합니다.
가능한 값: screenshot

OpenAI.ComputerActionScroll

스크롤 동작입니다.

이름 유형 Description 필수 기본값
scroll_x integer 가로 스크롤 거리입니다.
scroll_y integer 세로 스크롤 거리입니다.
type enum 이벤트 유형을 지정합니다. 스크롤 작업의 경우 이 속성은
항상 scroll로 설정합니다.
가능한 값: scroll
x integer 스크롤이 발생한 x 좌표입니다.
y integer 스크롤이 발생한 y 좌표입니다.

OpenAI.ComputerActionType

재산 가치
유형 문자열
screenshot
click
double_click
scroll
type
wait
keypress
drag
move

OpenAI.ComputerActionTypeKeys

텍스트에 입력할 작업입니다.

이름 유형 Description 필수 기본값
문자 메시지 문자열 입력할 텍스트입니다.
type enum 이벤트 유형을 지정합니다. 형식 작업의 경우 이 속성은
항상 type로 설정합니다.
가능한 값: type

OpenAI.ComputerActionWait

대기 작업입니다.

이름 유형 Description 필수 기본값
type enum 이벤트 유형을 지정합니다. 대기 작업의 경우 이 속성은
항상 wait로 설정합니다.
가능한 값: wait

OpenAI.ComputerToolCallItemParam

컴퓨터 사용 도구에 대한 도구 호출입니다. 자세한 내용은 컴퓨터 사용 설명서 를 참조하십시오.

이름 유형 Description 필수 기본값
조치 OpenAI.ComputerAction
call_id 문자열 출력을 사용하여 도구 호출에 응답할 때 사용되는 식별자입니다.
pending_safety_checks array 보류 중인 보안 검사에서 컴퓨터 호출을 확인합니다.
type enum
가능한 값: computer_call

OpenAI.ComputerToolCallItemResource

컴퓨터 사용 도구에 대한 도구 호출입니다. 자세한 내용은 컴퓨터 사용 설명서 를 참조하십시오.

이름 유형 Description 필수 기본값
조치 OpenAI.ComputerAction
call_id 문자열 출력을 사용하여 도구 호출에 응답할 때 사용되는 식별자입니다.
pending_safety_checks array 보류 중인 보안 검사에서 컴퓨터 호출을 확인합니다.
상태 enum 항목의 상태입니다. in_progress, completed 또는 하나
incomplete; 항목이 API를 통해 반환될 때 채워집니다.
가능한 값: in_progress, completedincomplete
type enum
가능한 값: computer_call

OpenAI.ComputerToolCallOutputItemOutput

OpenAI.ComputerToolCallOutputItemOutput에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
computer_screenshot OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot
이름 유형 Description 필수 기본값
type OpenAI.ComputerToolCallOutputItemOutputType 컴퓨터 사용 도구와 함께 사용되는 컴퓨터 스크린샷 이미지입니다.

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

이름 유형 Description 필수 기본값
file_id 문자열 아니오
image_url 문자열 아니오
type enum
가능한 값: computer_screenshot

OpenAI.ComputerToolCallOutputItemOutputType

컴퓨터 사용 도구와 함께 사용되는 컴퓨터 스크린샷 이미지입니다.

재산 가치
설명 컴퓨터 사용 도구와 함께 사용되는 컴퓨터 스크린샷 이미지입니다.
유형 문자열
computer_screenshot

OpenAI.ComputerToolCallOutputItemParam

컴퓨터 도구 호출의 출력입니다.

이름 유형 Description 필수 기본값
acknowledged_safety_checks array API에서 보고한 안전 검사는 다음에서 확인되었습니다.
개발자.
아니오
call_id 문자열 출력을 생성한 컴퓨터 도구 호출의 ID입니다.
output OpenAI.ComputerToolCallOutputItemOutput
type enum
가능한 값: computer_call_output

OpenAI.ComputerToolCallOutputItemResource

컴퓨터 도구 호출의 출력입니다.

이름 유형 Description 필수 기본값
acknowledged_safety_checks array API에서 보고한 안전 검사는 다음에서 확인되었습니다.
개발자.
아니오
call_id 문자열 출력을 생성한 컴퓨터 도구 호출의 ID입니다.
output OpenAI.ComputerToolCallOutputItemOutput
상태 enum 항목의 상태입니다. in_progress, completed 또는 하나
incomplete; 항목이 API를 통해 반환될 때 채워집니다.
가능한 값: in_progress, completedincomplete
type enum
가능한 값: computer_call_output

OpenAI.ComputerToolCallSafetyCheck

컴퓨터 호출에 대한 보류 중인 안전 검사입니다.

이름 유형 Description 필수 기본값
코드 문자열 보류 중인 안전 검사의 유형입니다.
아이디 문자열 보류 중인 안전 검사의 ID입니다.
메시지 문자열 보류 중인 안전 검사에 대한 세부 정보입니다.

OpenAI.컴퓨터사용미리보기도구

가상 컴퓨터를 제어하는 도구입니다.

이름 유형 Description 필수 기본값
디스플레이 높이 integer 컴퓨터 디스플레이의 높이입니다.
디스플레이 너비 integer 컴퓨터 표시의 너비입니다.
environment enum 제어할 컴퓨터 환경의 유형입니다.
가능한 값: windows, mac, linux, ubuntubrowser
type enum 컴퓨터 사용 도구의 유형입니다. 항상 computer_use_preview입니다.
가능한 값: computer_use_preview

OpenAI.ConversationItemList

이름 유형 Description 필수 기본값
데이터 array
첫번째_아이디 문자열
더_있음 부울
마지막 아이디 문자열
객체 enum
가능한 값: list

OpenAI.ConversationResource

이름 유형 Description 필수 기본값
생성_시간 integer
아이디 문자열 대화의 고유 ID입니다.
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
객체 enum 항상 '대화'인 개체 형식입니다.
가능한 값: conversation

OpenAI.Coordinate

x/y 좌표 쌍(예: { x: 100, y: 200 }

이름 유형 Description 필수 기본값
x integer X 좌표입니다.
y integer Y 좌표입니다.

OpenAI.CreateConversationRequest

대화 만들기

이름 유형 Description 필수 기본값
items array 대화 컨텍스트를 포함할 초기 항목입니다.
한 번에 최대 20개 항목을 추가할 수 있습니다.
아니오
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오

OpenAI.CreateEvalCompletionsRunDataSource

모델 샘플링 구성을 설명하는 CompletionsRunDataSource 개체입니다.

이름 유형 Description 필수 기본값
입력 메시지 객체 아니오
└─ 항목_참조 문자열 아니오
└) 템플릿 array 아니오
└─ 형식 enum
가능한 값: item_reference
아니오
모델 문자열 완성을 생성하는 데 사용할 모델의 이름입니다(예: "o3-mini"). 아니오
샘플링_파라미터 OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams 아니오
source 객체
└─ 콘텐츠 array jsonl 파일의 내용입니다. 아니오
└ 만들어진_후에 (created_after) OpenAI.integer 아니오
└created_before OpenAI.integer 아니오
└─ ID 문자열 파일의 식별자입니다. 아니오
└─ 제한 OpenAI.integer 아니오
└) 메타데이터 OpenAI.Metadata 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
└─ 모델 문자열 아니오
└─ 형식 enum 원본의 형식입니다. 항상 stored_completions입니다.
가능한 값: stored_completions
아니오
type enum 실행 데이터 원본의 형식입니다. 항상 completions입니다.
가능한 값: completions

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

이름 유형 Description 필수 기본값
item_reference 문자열
type enum
가능한 값: item_reference

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

이름 유형 Description 필수 기본값
템플릿 array
type enum
가능한 값: template

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

이름 유형 Description 필수 기본값
max_completion_tokens OpenAI.integer 아니오
추론 노력 OpenAI.추론노력 추론 모델에서 추론 작업을 제한합니다.

현재 지원되는 값은 없음, 최소, 낮음, 중간 및 높음입니다.

추론 작업을 줄이면 응답 속도가 빨라지고 응답에서 추론에 사용되는 토큰이 줄어들 수 있습니다.

gpt-5.1은 기본적으로 none으로 설정되며 추론을 수행하지 않습니다. gpt-5.1에 대해 지원되는 추론 값은 없음, 낮음, 중간 및 높음입니다. 도구 호출은 gpt-5.1의 모든 추론 값에 대해 지원됩니다.

gpt-5.1 이전의 모든 모델은 기본적으로 중간 추론 작업으로 설정되며, 없음을 지원하지 않습니다.

gpt-5-pro 모델은 기본적으로 높은 추론 작업만 지원합니다.
아니오
응답_형식 객체 기본 응답 형식입니다. 텍스트 응답을 생성하는 데 사용됩니다. 아니오
└json_schema 객체 JSON 스키마를 비롯한 구조적 출력 구성 옵션입니다. 아니오
└) 설명 문자열 이 응답 형식이 모델에서 어떻게 사용되는지에 대한 설명입니다.
형식에 맞춰 응답하는 방법을 결정합니다.
아니오
└) 이름 문자열 응답 형식의 이름입니다. a-z, A-Z, 0-9 또는 포함해야 합니다.
최대 길이가 64인 경우, 밑줄과 대시를 사용하세요.
아니오
└─ 스키마 객체 아니오
└─ 엄격한 부울 출력을 생성할 때 엄격한 스키마 준수를 사용하도록 설정할지 여부입니다.
true로 설정하면 모델은 항상 정의된 정확한 스키마를 따릅니다.
schema 필드에 있습니다. JSON 스키마의 하위 집합만 지원되는 경우
stricttrue입니다. 자세한 내용은 구조적 출력
가이드
를 읽어보세요.
아니오 거짓
└─ 형식 enum 정의되는 응답 형식의 유형입니다. 항상 json_object입니다.
가능한 값: json_object
아니오
seed 객체 아니오
온도 객체 아니오
도구들 array 아니오
top_p (탑 피) 객체 아니오

OpenAI.CreateEvalCustomDataSourceConfig

평가 실행에 사용되는 데이터 원본에 대한 스키마를 정의하는 CustomDataSourceConfig 개체입니다. 이 스키마는 다음과 같은 데이터의 모양을 정의하는 데 사용됩니다.

  • 테스트 조건을 정의하는 데 사용되며
  • 실행을 만들 때 필요한 데이터
이름 유형 Description 필수 기본값
샘플 스키마 포함 부울 eval이 샘플 네임스페이스를 채울 것으로 예상해야 하는지 여부(예: 데이터 원본에서 응답을 생성하여) 아니오
아이템_스키마 객체 데이터 원본의 각 행에 대한 json 스키마입니다.
type enum 데이터 원본의 유형입니다. 항상 custom입니다.
가능한 값: custom

OpenAI.CreateEvalJsonlRunDataSource

eval과 일치하는 JSONL 파일을 지정하는 JsonlRunDataSource 개체

이름 유형 Description 필수 기본값
source 객체
└─ 콘텐츠 array jsonl 파일의 내용입니다. 아니오
└─ ID 문자열 파일의 식별자입니다. 아니오
└─ 형식 enum jsonl 원본의 형식입니다. 항상 file_id입니다.
가능한 값: file_id
아니오
type enum 데이터 원본의 유형입니다. 항상 jsonl입니다.
가능한 값: jsonl

OpenAI.CreateEvalLogsDataSourceConfig

로그 쿼리의 메타데이터 속성을 지정하는 데이터 원본 구성입니다. 일반적으로 이러한 메타데이터는 다음과 같 usecase=chatbot 거나 prompt-version=v2같은 메타데이터입니다.

이름 유형 Description 필수 기본값
metadata 객체 로그 데이터 원본에 대한 메타데이터 필터입니다. 아니오
type enum 데이터 원본의 유형입니다. 항상 logs입니다.
가능한 값: logs

OpenAI.CreateEvalResponsesRunDataSource

모델 샘플링 구성을 설명하는 ResponsesRunDataSource 개체입니다.

이름 유형 Description 필수 기본값
입력 메시지 객체 아니오
└─ 항목_참조 문자열 아니오
└) 템플릿 array 아니오
└─ 형식 enum
가능한 값: item_reference
아니오
모델 문자열 완성을 생성하는 데 사용할 모델의 이름입니다(예: "o3-mini"). 아니오
샘플링_파라미터 OpenAI.CreateEvalResponsesRunDataSourceSamplingParams 아니오
source 객체
└─ 콘텐츠 array jsonl 파일의 내용입니다. 아니오
└ 만들어진_후에 (created_after) OpenAI.integer 아니오
└created_before OpenAI.integer 아니오
└─ ID 문자열 파일의 식별자입니다. 아니오
└─ 지침_검색 문자열 아니오
└) 메타데이터 객체 아니오
└─ 모델 문자열 아니오
└─ 추론_노력 OpenAI.추론노력 추론 모델에서 추론 작업을 제한합니다.

현재 지원되는 값은 없음, 최소, 낮음, 중간 및 높음입니다.

추론 작업을 줄이면 응답 속도가 빨라지고 응답에서 추론에 사용되는 토큰이 줄어들 수 있습니다.

gpt-5.1은 기본적으로 none으로 설정되며 추론을 수행하지 않습니다. gpt-5.1에 대해 지원되는 추론 값은 없음, 낮음, 중간 및 높음입니다. 도구 호출은 gpt-5.1의 모든 추론 값에 대해 지원됩니다.

gpt-5.1 이전의 모든 모델은 기본적으로 중간 추론 작업으로 설정되며, 없음을 지원하지 않습니다.

gpt-5-pro 모델은 기본적으로 높은 추론 작업만 지원합니다.
아니오
└> 온도 OpenAI.numeric 아니오
└도구 array 아니오
└ top_p OpenAI.numeric 아니오
└─ 형식 enum 실행 데이터 원본의 형식입니다. 항상 responses입니다.
가능한 값: responses
아니오
└─ 사용자 array 아니오
type enum 실행 데이터 원본의 형식입니다. 항상 responses입니다.
가능한 값: responses

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

이름 유형 Description 필수 기본값
item_reference 문자열
type enum
가능한 값: item_reference

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

이름 유형 Description 필수 기본값
템플릿 array
type enum
가능한 값: template

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

이름 유형 Description 필수 기본값
max_completion_tokens OpenAI.integer 아니오
추론 노력 OpenAI.추론노력 추론 모델에서 추론 작업을 제한합니다.

현재 지원되는 값은 없음, 최소, 낮음, 중간 및 높음입니다.

추론 작업을 줄이면 응답 속도가 빨라지고 응답에서 추론에 사용되는 토큰이 줄어들 수 있습니다.

gpt-5.1은 기본적으로 none으로 설정되며 추론을 수행하지 않습니다. gpt-5.1에 대해 지원되는 추론 값은 없음, 낮음, 중간 및 높음입니다. 도구 호출은 gpt-5.1의 모든 추론 값에 대해 지원됩니다.

gpt-5.1 이전의 모든 모델은 기본적으로 중간 추론 작업으로 설정되며, 없음을 지원하지 않습니다.

gpt-5-pro 모델은 기본적으로 높은 추론 작업만 지원합니다.
아니오
seed 객체 아니오
온도 객체 아니오
문자 메시지 OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText 아니오
도구들 array 아니오
top_p (탑 피) 객체 아니오

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

이름 유형 Description 필수 기본값
format OpenAI.TextResponseFormatConfiguration 모델이 출력해야 하는 형식을 지정하는 개체입니다.

구성 { "type": "json_schema" } 을 통해 구조적 출력을 사용할 수 있습니다.
모델이 제공된 JSON 스키마와 일치하도록 합니다. 자세한 내용은


기본 형식은 { "type": "text" } 추가 옵션이 없습니다.

*gpt-4o 및 최신 모델에는 권장되지 않습니다.**

{ "type": "json_object" }을 활성화하면 이전 JSON 모드를 사용할 수 있습니다.
는 모델이 생성하는 메시지가 유효한 JSON인지 확인합니다. json_schema 사용하기
지원하는 모델에서는 선호됩니다.
아니오

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

더 이상 사용되지 않고 LogsDataSourceConfig로 대체되었습니다.

이름 유형 Description 필수 기본값
metadata 객체 저장된 완료 데이터 원본에 대한 메타데이터 필터입니다. 아니오
type enum 데이터 원본의 유형입니다. 항상 stored_completions입니다.
가능한 값: stored_completions

OpenAI.CreateFineTuningJobRequest

유효한 모델:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini
이름 유형 Description 필수 기본값
하이퍼 매개 변수 객체 미세 조정 작업에 사용되는 하이퍼 매개 변수입니다.
이 값은 method 대신 사용되지 않으며, method 매개 변수로 전달해야 합니다.
아니오
└ batch_size enum
가능한 값: auto
아니오
└ 학습률 배수기 enum
가능한 값: auto
아니오
└n_epochs enum
가능한 값: auto
아니오
통합 array 미세 조정 작업에 사용할 수 있는 통합 목록입니다. 아니오
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
method OpenAI.FineTuneMethod 미세 조정에 사용되는 메서드입니다. 아니오
모델 string(아래 유효한 모델 참조) 미세 조정할 모델의 이름입니다. 다음 중 하나를 선택할 수 있습니다.
지원되는 모델.
seed integer 시드는 작업의 재현성을 제어합니다. 동일한 시드 및 작업 매개 변수를 전달하면 동일한 결과가 생성되지만 드문 경우에 다를 수 있습니다.
시드를 지정하지 않으면 시드가 생성됩니다.
아니오
suffix 문자열 미세 조정된 모델 이름에 추가될 최대 64자의 문자열입니다.

예를 들어 suffix "custom-model-name"은 다음과 같은 ft:gpt-4o-mini:openai:custom-model-name:7p4lURel모델 이름을 생성합니다.
아니오 None
교육 파일 문자열 학습 데이터가 포함된 업로드된 파일의 ID입니다.



데이터 세트의 형식을 JSONL 파일로 지정해야 합니다. 또한 용도 fine-tune로 파일을 업로드해야 합니다.

파일의 내용은 모델에서 채팅, 완료 형식을 사용하는지 또는 미세 조정 메서드에서 기본 설정 형식을 사용하는지에 따라 달라야 합니다.

자세한 내용은 미세 조정 가이드를 참조하세요.
검증_파일 문자열 유효성 검사 데이터를 포함하는 업로드된 파일의 ID입니다.

이 파일을 제공하는 경우 데이터는 유효성 검사를 생성하는 데 사용됩니다.
미세 조정 중에 메트릭을 주기적으로 측정합니다. 이러한 메트릭은 다음에서 볼 수 있습니다.
미세 조정 결과 파일입니다.
학습 파일과 유효성 검사 파일 모두에 동일한 데이터가 있으면 안 됩니다.

데이터 세트의 형식을 JSONL 파일로 지정해야 합니다. 용도 fine-tune로 파일을 업로드해야 합니다.

자세한 내용은 미세 조정 가이드를 참조하세요.
아니오

OpenAI.CreateFineTuningJobRequestIntegration

OpenAI.CreateFineTuningJobRequestIntegration에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
wandb OpenAI.CreateFineTuningJobRequestWandbIntegration
이름 유형 Description 필수 기본값
type string(아래 유효한 모델 참조)

OpenAI.CreateFineTuningJobRequestWandbIntegration

이름 유형 Description 필수 기본값
type enum
가능한 값: wandb
wandb 객체
└) 엔터티 문자열 아니오
└) 이름 문자열 아니오
└) 프로젝트 문자열 아니오
└─ 태그 array 아니오

OpenAI.CreateResponse

이름 유형 Description 필수 기본값
agent 객체 아니오
└) 이름 문자열 에이전트의 이름입니다. 아니오
└─ 형식 enum
가능한 값: agent_reference
아니오
└─ 버전 문자열 에이전트의 버전 식별자입니다. 아니오
background 부울 백그라운드에서 모델 응답을 실행할지 여부입니다.
배경 응답에 대해 자세히 알아봅니다.
아니오 거짓
대화 객체 아니오
└─ ID 문자열 아니오
include array 모델 응답에 포함할 추가 출력 데이터를 지정합니다. 현재
지원되는 값은 다음과 같습니다.
- code_interpreter_call.outputs: Python 코드 실행의 출력을 포함합니다.
코드 인터프리터 도구에서 항목을 호출합니다.
- computer_call_output.output.image_url: 컴퓨터 호출 출력의 이미지 URL을 포함합니다.
- file_search_call.results: 다음의 검색 결과를 포함합니다.
파일 검색 도구 호출입니다.
- message.input_image.image_url: 입력 메시지의 이미지 URL을 포함합니다.
- message.output_text.logprobs: 도우미 메시지와 함께 logprobs를 포함합니다.
- reasoning.encrypted_content: 암호화된 버전의 추론 포함
추론 항목의 출력에 있는 토큰입니다. 이렇게 하면 추론 항목을 사용할 수 있습니다.
응답 API를 상태 없이 사용할 때 멀티 턴 대화(예:
store 매개 변수가 false로 설정되거나 조직이
데이터 보존 없음 프로그램에 등록됨).
아니오
입력 문자열 또는 배열 아니오
instructions 문자열 모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다.

previous_response_id와 함께 사용할 경우 이전의 지침이 적용됩니다.
응답은 다음 응답으로 전달되지 않습니다. 이렇게 하면 간단해집니다.
새 응답에서 시스템(또는 개발자) 메시지를 교환합니다.
아니오
max_output_tokens integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한 입니다. 아니오
최대_도구_호출수 integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. 아니오
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
모델 문자열 이 응답을 만드는 데 사용할 모델 배포입니다. 아니오
병렬 도구 호출 부울 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. 아니오 진실
previous_response_id 문자열 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다. 자세한 정보
대화 상태 관리
아니오
prompt 객체 프롬프트 템플릿 및 해당 변수에 대한 참조입니다.
자세히알아보세요.
아니오
└─ ID 문자열 사용할 프롬프트 템플릿의 고유 식별자입니다. 아니오
└) 변수 OpenAI.ResponsePromptVariables 프롬프트에서 변수를 대체할 값의 선택적
맵입니다. 대체 값은 문자열이거나 다른 값일 수 있습니다.
이미지 또는 파일과 같은 응답 입력 형식입니다.
아니오
└─ 버전 문자열 프롬프트 템플릿의 선택적 버전입니다. 아니오
reasoning 객체 o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.
아니오
└) 노력 OpenAI.추론노력 추론 모델에서 추론 작업을 제한합니다.

현재 지원되는 값은 없음, 최소, 낮음, 중간 및 높음입니다.

추론 작업을 줄이면 응답 속도가 빨라지고 응답에서 추론에 사용되는 토큰이 줄어들 수 있습니다.

gpt-5.1은 기본적으로 none으로 설정되며 추론을 수행하지 않습니다. gpt-5.1에 대해 지원되는 추론 값은 없음, 낮음, 중간 및 높음입니다. 도구 호출은 gpt-5.1의 모든 추론 값에 대해 지원됩니다.

gpt-5.1 이전의 모든 모델은 기본적으로 중간 추론 작업으로 설정되며, 없음을 지원하지 않습니다.

gpt-5-pro 모델은 기본적으로 높은 추론 작업만 지원합니다.
아니오
└─ 요약_생성하기 (generate_summary) enum 더 이상 사용되지 않음: 대신 사용하십시오 summary . 모델에서 수행하는 추론에 대한 요약입니다. 이는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용할 수 있습니다. auto, concise 또는 detailed 중 하나입니다.
가능한 값: auto, concisedetailed
아니오
└) 요약 enum 모델에서 수행하는 추론에 대한 요약입니다. 다음과 같을 수 있습니다.
는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용합니다.
auto, concise 또는 detailed 중 하나입니다.
가능한 값: auto, concisedetailed
아니오
서비스 계층 객체 요청을 처리하는 데 사용되는 처리 유형을 지정합니다.
* 'auto'로 설정하면 요청이 서비스 계층으로 처리됩니다.
프로젝트 설정에서 구성됩니다. 달리 구성하지 않는 한 프로젝트는 '기본값'을 사용합니다.
* 'default'로 설정하면 요청이 표준으로 처리됩니다.
선택한 모델의 가격 책정 및 성능
* 'flex'로 설정된 경우
또는 'priority'이면 요청이 해당 서비스로 처리됩니다.
계층. 우선 순위 처리에 대해 자세히 알아보려면 영업 담당자에게 문의하세요.
* 설정하지 않으면 기본 동작은 'auto'입니다.

매개 변수가 service_tier 설정되면 응답 본문에 다음이 포함됩니다. service_tier
실제로 요청을 처리하는 데 사용되는 처리 모드를 기반으로 하는 값입니다. 이 응답 값
는 매개 변수에 설정된 값과 다를 수 있습니다.
아니오
store 부울 를 통해 나중에 검색할 수 있도록 생성된 모델 응답을 저장할지 여부
API.
아니오 진실
스트림 부울 true로 설정하면 모델 응답 데이터가 클라이언트로 스트리밍됩니다.
서버에서 보낸 이벤트를 사용하여 생성됩니다.

참조하세요.
아니오 거짓
structured_inputs 객체 프롬프트 템플릿 대체 또는 도구 인수 바인딩에 참여할 수 있는 응답에 대한 구조적 입력입니다. 아니오
온도 숫자 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.
아니오 1
문자 메시지 객체 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반
텍스트 또는 구조적 JSON 데이터일 수 있습니다. 텍스트 입력 및 출력 참조
구조적 출력
아니오
└─ 형식 OpenAI.ResponseTextFormatConfiguration 아니오
tool_choice 객체 모델이 호출하는 도구(있는 경우)를 제어합니다.

none 는 모델이 도구를 호출하지 않고 대신 메시지를 생성한다는 의미입니다.

auto 는 모델이 메시지를 생성하거나 메시지를 호출하는 중에서 선택할 수 있습니다.
더 많은 도구.

required는 모델이 하나 이상의 도구를 호출해야 함을 의미합니다.
아니오
└─ 형식 OpenAI.ToolChoiceObjectType 모델이 기본 제공 도구를 사용하여 응답을 생성해야 임을 나타냅니다.
기본 제공 도구에 대해 자세히 알아봅니다.
아니오
도구들 array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. 너
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

- 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
파일 검색과 같은 모델의 기능.
- 함수 호출(사용자 지정 도구): 사용자가 정의한 함수
모델을 사용하여 사용자 고유의 코드를 호출할 수 있습니다.
아니오
top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. 아니오
top_p (탑 피) 숫자 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.
아니오 1
truncation enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled
아니오
사용자 문자열 안전 모범 사례에 대해 자세히 알아보세요. 아니오

OpenAI.DeletedConversationResource

이름 유형 Description 필수 기본값
삭제됨 부울
아이디 문자열
객체 enum
가능한 값: conversation.deleted

OpenAI.EasyInputMessage

이름 유형 Description 필수 기본값
내용 문자열 또는 배열
역할 문자열

OpenAI.Error

이름 유형 Description 필수 기본값
추가 정보 객체 아니오
코드 문자열
디버그 정보 객체 아니오
details array 아니오
메시지 문자열
param 문자열
type 문자열

OpenAI.EvalApiError

Eval API의 오류 응답을 나타내는 개체입니다.

이름 유형 Description 필수 기본값
코드 문자열 오류 코드입니다.
메시지 문자열 오류 메시지입니다.

OpenAI.EvalGraderLabelModel

이름 유형 Description 필수 기본값
입력 array
labels array 평가에서 각 항목에 할당할 레이블입니다.
모델 문자열 평가에 사용할 모델입니다. 구조화된 출력을 지원해야 합니다.
이름 문자열 채점자의 이름입니다.
전달되는 레이블 array 합격 결과를 나타내는 레이블입니다. 레이블의 하위 집합이어야 합니다.
type enum 항상 label_model인 개체 형식입니다.
가능한 값: label_model

OpenAI.EvalGraderPython

이름 유형 Description 필수 기본값
image_tag 문자열 Python 스크립트에 사용할 이미지 태그입니다. 아니오
이름 문자열 채점자의 이름입니다.
통과 임계값 객체 아니오
source 문자열 Python 스크립트의 소스 코드입니다.
type enum 항상 python인 개체 형식입니다.
가능한 값: python

OpenAI.EvalGraderScoreModel

이름 유형 Description 필수 기본값
입력 array 입력 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다.
모델 문자열 평가에 사용할 모델입니다.
이름 문자열 채점자의 이름입니다.
통과 임계값 객체 아니오
범위 array 점수의 범위입니다. 기본값은 [0, 1]입니다. 아니오
샘플링_파라미터 객체 아니오
└max_completions_tokens OpenAI.integer 아니오
└─ 추론_노력 OpenAI.추론노력 추론 모델에서 추론 작업을 제한합니다.

현재 지원되는 값은 없음, 최소, 낮음, 중간 및 높음입니다.

추론 작업을 줄이면 응답 속도가 빨라지고 응답에서 추론에 사용되는 토큰이 줄어들 수 있습니다.

gpt-5.1은 기본적으로 none으로 설정되며 추론을 수행하지 않습니다. gpt-5.1에 대해 지원되는 추론 값은 없음, 낮음, 중간 및 높음입니다. 도구 호출은 gpt-5.1의 모든 추론 값에 대해 지원됩니다.

gpt-5.1 이전의 모든 모델은 기본적으로 중간 추론 작업으로 설정되며, 없음을 지원하지 않습니다.

gpt-5-pro 모델은 기본적으로 높은 추론 작업만 지원합니다.
아니오
└) 시드 OpenAI.integer 아니오
└> 온도 OpenAI.numeric 아니오
└ top_p OpenAI.numeric 아니오
type enum 항상 score_model인 개체 형식입니다.
가능한 값: score_model

OpenAI.EvalGraderScoreModelSamplingParams

이름 유형 Description 필수 기본값
max_completions_tokens 객체 아니오
추론 노력 OpenAI.추론노력 추론 모델에서 추론 작업을 제한합니다.

현재 지원되는 값은 없음, 최소, 낮음, 중간 및 높음입니다.

추론 작업을 줄이면 응답 속도가 빨라지고 응답에서 추론에 사용되는 토큰이 줄어들 수 있습니다.

gpt-5.1은 기본적으로 none으로 설정되며 추론을 수행하지 않습니다. gpt-5.1에 대해 지원되는 추론 값은 없음, 낮음, 중간 및 높음입니다. 도구 호출은 gpt-5.1의 모든 추론 값에 대해 지원됩니다.

gpt-5.1 이전의 모든 모델은 기본적으로 중간 추론 작업으로 설정되며, 없음을 지원하지 않습니다.

gpt-5-pro 모델은 기본적으로 높은 추론 작업만 지원합니다.
아니오
seed 객체 아니오
온도 객체 아니오
top_p (탑 피) 객체 아니오

OpenAI.EvalGraderStringCheck

이름 유형 Description 필수 기본값
입력 문자열 입력 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다.
이름 문자열 채점자의 이름입니다.
수술 enum 수행할 문자열 검사 작업입니다. eq, ne, like 또는 ilike 중 하나입니다.
가능한 값: eq, ne, likeilike
참조 문자열 참조 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다.
type enum 항상 string_check인 개체 형식입니다.
가능한 값: string_check

OpenAI.EvalGraderTextSimilarity

이름 유형 Description 필수 기본값
평가 지표 enum 사용할 평가 메트릭입니다. cosine, fuzzy_match, bleu 중 하나입니다.
gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5
또는 rouge_l.
가능한 값: cosine,, fuzzy_match,bleugleu, meteorrouge_1, rouge_2, rouge_3rouge_4, rouge_5rouge_l
입력 문자열 채점되는 텍스트입니다.
이름 문자열 채점자의 이름입니다.
통과 임계값 객체
참조 문자열 채점 기준이 되는 텍스트입니다.
type enum 채점자의 유형입니다.
가능한 값: text_similarity

OpenAI.EvalItem

계층 구조 다음 명령을 나타내는 역할이 있는 모델에 대한 메시지 입력입니다. developer 역할 또는 system 역할과 함께 제공된 지침은 user 역할과 함께 제공된 지침보다 우선합니다. 역할이 있는 assistant 메시지는 이전 상호 작용에서 모델에 의해 생성된 것으로 추정됩니다.

이름 유형 Description 필수 기본값
내용 객체 모델에 대한 텍스트 입력입니다.
└) 데이터 문자열 Base64로 인코딩된 오디오 데이터입니다. 아니오
└) 세부 정보 문자열 아니오
└─ 형식 enum 오디오 데이터의 형식입니다. 현재 지원되는 형식은 다음과 같습니다 mp3 .
wav;
가능한 값: mp3wav
아니오
└image_url 문자열 아니오
└) 텍스트 문자열 아니오
└─ 형식 enum 입력 항목의 형식입니다. 항상 input_audio입니다.
가능한 값: input_audio
아니오
역할 enum 메시지 입력의 역할입니다. user, assistant, system 중 하나 또는
developer;
가능한 값: user, assistant, systemdeveloper
type enum 메시지 입력의 형식입니다. 항상 message입니다.
가능한 값: message
아니오

OpenAI.EvalItemContentInputImage

이름 유형 Description 필수 기본값
detail 문자열 아니오
image_url 문자열
type enum
가능한 값: input_image

OpenAI.EvalItemContentOutputText

이름 유형 Description 필수 기본값
문자 메시지 문자열
type enum
가능한 값: output_text

OpenAI.EvalJsonlFileContentSource

이름 유형 Description 필수 기본값
내용 array jsonl 파일의 내용입니다.
type enum jsonl 원본의 형식입니다. 항상 file_content입니다.
가능한 값: file_content

OpenAI.EvalJsonlFileContentSourceContent

이름 유형 Description 필수 기본값
물품 객체
견본 객체 아니오

OpenAI.EvalJsonlFileIdSource

이름 유형 Description 필수 기본값
아이디 문자열 파일의 식별자입니다.
type enum jsonl 원본의 형식입니다. 항상 file_id입니다.
가능한 값: file_id

OpenAI.EvalResponsesSource

실행 데이터 원본 구성을 설명하는 EvalResponsesSource 개체입니다.

이름 유형 Description 필수 기본값
이후 생성됨 객체 아니오
이전에 생성됨 객체 아니오
instructions_search 문자열 아니오
metadata 객체 아니오
모델 문자열 아니오
추론 노력 객체 추론 모델에서 추론 작업을 제한합니다.

현재 지원되는 값은 없음, 최소, 낮음, 중간 및 높음입니다.

추론 작업을 줄이면 응답 속도가 빨라지고 응답에서 추론에 사용되는 토큰이 줄어들 수 있습니다.

gpt-5.1은 기본적으로 none으로 설정되며 추론을 수행하지 않습니다. gpt-5.1에 대해 지원되는 추론 값은 없음, 낮음, 중간 및 높음입니다. 도구 호출은 gpt-5.1의 모든 추론 값에 대해 지원됩니다.

gpt-5.1 이전의 모든 모델은 기본적으로 중간 추론 작업으로 설정되며, 없음을 지원하지 않습니다.

gpt-5-pro 모델은 기본적으로 높은 추론 작업만 지원합니다.
아니오
온도 객체 아니오
도구들 array 아니오
top_p (탑 피) 객체 아니오
type enum 실행 데이터 원본의 형식입니다. 항상 responses입니다.
가능한 값: responses
users array 아니오

OpenAI.EvalRunOutputItemSample

이름 유형 Description 필수 기본값
오류 OpenAI.EvalApiError Eval API의 오류 응답을 나타내는 개체입니다.
완료_이유 문자열
입력 array
max_completion_tokens OpenAI.integer
모델 문자열
output array
seed OpenAI.integer
온도 OpenAI.numeric
top_p (탑 피) OpenAI.numeric
usage OpenAI.EvalRunOutputItemSampleUsage

OpenAI.EvalRunOutputItemSampleInput

이름 유형 Description 필수 기본값
내용 문자열
역할 문자열

OpenAI.EvalRunOutputItemSampleOutput

이름 유형 Description 필수 기본값
내용 문자열 아니오
역할 문자열 아니오

OpenAI.EvalRunOutputItemSampleUsage

이름 유형 Description 필수 기본값
cached_tokens OpenAI.integer
completion_tokens OpenAI.integer
prompt_tokens OpenAI.integer
total_tokens OpenAI.integer

OpenAI.EvalRunPerModelUsage

이름 유형 Description 필수 기본값
cached_tokens OpenAI.integer
completion_tokens OpenAI.integer
invocation_count OpenAI.integer
model_name 문자열
prompt_tokens OpenAI.integer
total_tokens OpenAI.integer

OpenAI.EvalRunPerTestingCriteriaResults

이름 유형 Description 필수 기본값
실패 OpenAI.integer
전달 OpenAI.integer
테스트 기준 문자열

OpenAI.EvalRunResultCounts

이름 유형 Description 필수 기본값
오류 발생 OpenAI.integer
실패 OpenAI.integer
전달 OpenAI.integer
합계 OpenAI.integer

OpenAI.EvalStoredCompletionsSource

필터 집합을 설명하는 StoredCompletionsRunDataSource 구성

이름 유형 Description 필수 기본값
이후 생성됨 객체 아니오
이전에 생성됨 객체 아니오
limit 객체 아니오
metadata OpenAI.Metadata 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
모델 문자열 아니오
type enum 원본의 형식입니다. 항상 stored_completions입니다.
가능한 값: stored_completions

OpenAI.FileSearchTool

업로드된 파일에서 관련 콘텐츠를 검색하는 도구입니다.

이름 유형 Description 필수 기본값
filters 객체 아니오
결과_최대수량 (max_num_results) integer 반환할 결과의 최대 수입니다. 이 숫자는 1에서 50 사이여야 합니다. 아니오
랭킹 옵션 객체 아니오
└─ 랭커 enum 파일 검색에 사용할 순위입니다.
가능한 값: autodefault-2024-11-15
아니오
└점수 임계값 숫자 파일 검색의 점수 임계값으로, 0에서 1 사이의 숫자입니다. 1에 가까운 숫자는 가장 관련성이 큰 결과만 반환하려고 시도하지만 더 적은 결과를 반환할 수 있습니다. 아니오
type enum 파일 검색 도구의 형식입니다. 항상 file_search입니다.
가능한 값: file_search
벡터 저장소 ID array 검색할 벡터 저장소의 ID입니다.

OpenAI.FileSearchToolCallItemParam

파일 검색 도구 호출의 결과입니다. 자세한 내용은 파일 검색 가이드 를 참조하십시오.

이름 유형 Description 필수 기본값
queries array 파일을 검색하는 데 사용되는 쿼리입니다.
results array 파일 검색 도구 호출의 결과입니다. 아니오
type enum
가능한 값: file_search_call

OpenAI.FileSearchToolCallItemResource

파일 검색 도구 호출의 결과입니다. 자세한 내용은 파일 검색 가이드 를 참조하십시오.

이름 유형 Description 필수 기본값
queries array 파일을 검색하는 데 사용되는 쿼리입니다.
results array 파일 검색 도구 호출의 결과입니다. 아니오
상태 enum 파일 검색 도구 호출의 상태입니다. 다음 중 하나입니다. in_progress
searching, incomplete또는 failed
가능한 값: in_progress, searching, completed, incompletefailed
type enum
가능한 값: file_search_call

OpenAI 필터

이름 유형 Description 필수 기본값
filters array 결합할 필터의 배열입니다. 항목은 ComparisonFilter 또는 CompoundFilter일 수 있습니다.
key 문자열 값과 비교할 키입니다.
type enum 작업 유형: and 또는 or.
가능한 값: andor
value 문자열 또는 숫자 또는 불리언 특성 키와 비교할 값입니다. 문자열, 숫자 또는 부울 유형을 지원합니다.

OpenAI.FineTuneDPOHyperparameters

DPO 미세 조정 작업에 사용되는 하이퍼 매개 변수입니다.

이름 유형 Description 필수 기본값
배치 크기 enum
가능한 값: auto
아니오
beta enum
가능한 값: auto
아니오
learning_rate_multiplier enum
가능한 값: auto
아니오
n_epochs (에포크 수) enum
가능한 값: auto
아니오

OpenAI.FineTuneDPOMethod

DPO 미세 조정 메서드에 대한 구성입니다.

이름 유형 Description 필수 기본값
하이퍼 매개 변수 OpenAI.FineTuneDPOHyperparameters DPO 미세 조정 작업에 사용되는 하이퍼 매개 변수입니다. 아니오

OpenAI.FineTuneMethod

미세 조정에 사용되는 메서드입니다.

이름 유형 Description 필수 기본값
데이터 보호 책임자 (dpo) OpenAI.FineTuneDPOMethod DPO 미세 조정 메서드에 대한 구성입니다. 아니오
보충 OpenAI.FineTuneReinforcementMethod 강화 미세 조정 방법에 대한 구성입니다. 아니오
지도된 OpenAI.FineTuneSupervisedMethod 감독된 미세 조정 방법에 대한 구성입니다. 아니오
type enum 메서드의 형식입니다. supervised, dpo또는 reinforcement.입니다.
가능한 값: supervised, dporeinforcement

OpenAI.FineTuneReinforcementHyperparameters

강화 미세 조정 작업에 사용되는 하이퍼 매개 변수입니다.

이름 유형 Description 필수 기본값
배치 크기 enum
가능한 값: auto
아니오
compute_multiplier enum
가능한 값: auto
아니오
평가 간격 enum
가능한 값: auto
아니오
eval_samples (이밸 샘플즈) enum
가능한 값: auto
아니오
learning_rate_multiplier enum
가능한 값: auto
아니오
n_epochs (에포크 수) enum
가능한 값: auto
아니오
추론 노력 enum 추론 노력의 수준입니다.
가능한 값: default, low, mediumhigh
아니오

OpenAI.FineTuneReinforcementMethod

강화 미세 조정 방법에 대한 구성입니다.

이름 유형 Description 필수 기본값
채점자 객체 지정된 작업을 사용하여 입력과 참조 간의 문자열 비교를 수행하는 StringCheckGrader 개체입니다.
└─calculate_output 문자열 채점자 결과에 따라 출력을 계산하는 수식. 아니오
└─ 평가_기준 enum 사용할 평가 메트릭입니다. cosine, fuzzy_match, bleu 중 하나입니다.
gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5
또는 rouge_l.
가능한 값: cosine,, fuzzy_match,bleugleu, meteorrouge_1, rouge_2, rouge_3rouge_4, rouge_5rouge_l
아니오
└─ 채점자 OpenAI.GraderStringCheck 또는 OpenAI.GraderTextSimilarity 또는 OpenAI.GraderPython 또는 OpenAI.GraderScoreModel 또는 OpenAI.GraderLabelModel 지정된 작업을 사용하여 입력과 참조 간의 문자열 비교를 수행하는 StringCheckGrader 개체입니다. 아니오
└ image_tag 문자열 Python 스크립트에 사용할 이미지 태그입니다. 아니오
└─ 입력 array 입력 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다. 아니오
└─ 모델 문자열 평가에 사용할 모델입니다. 아니오
└) 이름 문자열 채점자의 이름입니다. 아니오
└작업 enum 수행할 문자열 검사 작업입니다. eq, ne, like 또는 ilike 중 하나입니다.
가능한 값: eq, ne, likeilike
아니오
└─ 범위 array 점수의 범위입니다. 기본값은 [0, 1]입니다. 아니오
└─ 참조 문자열 채점 기준이 되는 텍스트입니다. 아니오
└─ 샘플링_파라미터 OpenAI.EvalGraderScoreModelSamplingParams 모델의 샘플링 매개 변수입니다. 아니오
└) 원본 문자열 Python 스크립트의 소스 코드입니다. 아니오
└─ 형식 enum 항상 multi인 개체 형식입니다.
가능한 값: multi
아니오
하이퍼 매개 변수 OpenAI.FineTuneReinforcementHyperparameters 강화 미세 조정 작업에 사용되는 하이퍼 매개 변수입니다. 아니오

OpenAI.FineTuneSupervisedHyperparameters

미세 조정 작업에 사용되는 하이퍼 매개 변수입니다.

이름 유형 Description 필수 기본값
배치 크기 enum
가능한 값: auto
아니오
learning_rate_multiplier enum
가능한 값: auto
아니오
n_epochs (에포크 수) enum
가능한 값: auto
아니오

OpenAI.FineTuneSupervisedMethod

감독된 미세 조정 방법에 대한 구성입니다.

이름 유형 Description 필수 기본값
하이퍼 매개 변수 OpenAI.FineTuneSupervisedHyperparameters 미세 조정 작업에 사용되는 하이퍼 매개 변수입니다. 아니오

OpenAI.FineTuningIntegration

OpenAI.FineTuningIntegration의 분류기

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
wandb OpenAI.FineTuningIntegrationWandb
이름 유형 Description 필수 기본값
type string(아래 유효한 모델 참조)

OpenAI.FineTuningIntegrationWandb

이름 유형 Description 필수 기본값
type enum 미세 조정 작업에 사용할 통합 유형
가능한 값: wandb
wandb 객체 가중치 및 바이어스와 통합하기 위한 설정입니다. 이 페이로드는 다음 프로젝트를 지정합니다.
메트릭이 전송됩니다. 필요에 따라 실행에 대한 명시적 표시 이름을 설정하고 태그를 추가할 수 있습니다.
실행에 앞서 실행과 연관될 기본 엔터티(팀, 사용자 이름 등)를 설정합니다.
└) 엔터티 문자열 실행에 사용할 엔터티입니다. 이렇게 하면 WandB 사용자의 팀 또는 사용자 이름을 설정할 수 있습니다.
실행과 관련된 것과 같습니다. 설정하지 않으면 등록된 WandB API 키의 기본 엔터티가 사용됩니다.
아니오
└) 이름 문자열 실행에 대해 설정할 표시 이름입니다. 설정하지 않으면 작업 ID를 이름으로 사용합니다. 아니오
└) 프로젝트 문자열 새 실행을 만들 프로젝트의 이름입니다. 아니오
└─ 태그 array 새로 만든 실행에 연결할 태그 목록입니다. 이러한 태그는 WandB에 직접 전달됩니다. Some
기본 태그는 OpenAI에 의해 생성됩니다. "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".
아니오

OpenAI.FineTuningJob

개체는 fine_tuning.job API를 통해 만들어진 미세 조정 작업을 나타냅니다.

이름 유형 Description 필수 기본값
생성_시간 integer 미세 조정 작업이 만들어진 시간에 대한 Unix 타임스탬프(초)입니다.
오류 객체 failed가 포함된 미세 조정 작업의 경우, 오류의 원인에 대한 더욱 자세한 정보가 포함됩니다.
└) 코드 문자열 컴퓨터에서 읽을 수 있는 오류 코드입니다. 아니오
└) 메시지 문자열 사람이 읽을 수 있는 오류 메시지 아니오
└─ 매개 변수 문자열 유효하지 않은 매개 변수입니다(일반적으로 training_file 또는 validation_file.). 실패가 매개 변수 특정이 아닌 경우 이 필드는 null이 됩니다. 아니오
예상 완료 integer 미세 조정 작업이 완료될 것으로 예상되는 Unix 타임스탬프(초)입니다. 미세 조정 작업이 실행 중이 아니면 값은 null이 됩니다. 아니오
fine_tuned_model 문자열 생성되는 미세 조정된 모델의 이름입니다. 미세 조정 작업이 계속 실행 중인 경우 값은 null이 됩니다.
완료 시각 integer 미세 조정 작업이 완료된 시간에 대한 Unix 타임스탬프(초)입니다. 미세 조정 작업이 계속 실행 중인 경우 값은 null이 됩니다.
하이퍼 매개 변수 객체 미세 조정 작업에 사용되는 하이퍼 매개 변수입니다. 이 값은 작업을 실행할 supervised 때만 반환됩니다.
└ batch_size enum
가능한 값: auto
아니오
└ 학습률 배수기 enum
가능한 값: auto
아니오
└n_epochs enum
가능한 값: auto
아니오
아이디 문자열 API 엔드포인트에서 참조할 수 있는 개체 식별자입니다.
통합 array 이 미세 조정 작업에 사용할 통합 목록입니다. 아니오
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
method OpenAI.FineTuneMethod 미세 조정에 사용되는 메서드입니다. 아니오
모델 문자열 미세 조정되는 기본 모델입니다.
객체 enum 항상 "fine_tuning.job"인 오브젝트 타입입니다.
가능한 값: fine_tuning.job
organization_id 문자열 미세 조정 작업을 수행하는 조직입니다.
결과 파일 array 미세 조정 작업에 대한 컴파일된 결과 파일 ID입니다. 파일 API를 사용하여 결과를 검색할 수 있습니다.
seed integer 미세 조정 작업에 사용하는 시드입니다.
상태 enum 미세 조정 작업의 현재 상태는 validating_files, queued, running, succeeded, failed, 또는 cancelled 중 하나일 수 있습니다.
가능한 값: validating_files, queued, runningsucceeded, failedcancelled
훈련된_토큰 integer 이 미세 조정 작업에서 처리한 청구 가능 토큰의 총 수입니다. 미세 조정 작업이 계속 실행 중인 경우 값은 null이 됩니다.
교육 파일 문자열 학습에 사용되는 파일 ID입니다. 파일 API를 사용하여 학습 데이터를 검색할 수 있습니다.
user_provided_suffix 문자열 작업 만들기 요청에 지정된 대로 작업에 적용되는 설명 접미사입니다. 아니오
검증_파일 문자열 유효성 검사에 사용되는 파일 ID입니다. 파일 API를 사용하여 유효성 검사 결과를 검색할 수 있습니다.

OpenAI.FineTuningJobCheckpoint

fine_tuning.job.checkpoint 객체는 사용 준비가 된 미세 조정 작업의 모델 검사점을 나타냅니다.

이름 유형 Description 필수 기본값
생성_시간 integer 검사점이 만들어진 Unix 타임스탬프(초)입니다.
미세 조정된 모델 체크포인트 문자열 만들어진 미세 조정 검사점 모델의 이름입니다.
fine_tuning_job_id (미세 조정 작업 ID) 문자열 이 검사점에서 만든 미세 조정 작업의 이름입니다.
아이디 문자열 API 엔드포인트에서 참조할 수 있는 검사점 식별자입니다.
metrics 객체 미세 조정 작업 중 단계 수에 대한 메트릭입니다.
└full_valid_loss 숫자 아니오
└─ 전체_유효_평균_토큰_정확도 숫자 아니오
└─ 단계 숫자 아니오
└train_loss 숫자 아니오
└ train_mean_token_accuracy (학습 평균 토큰 정확도) 숫자 아니오
└valid_loss 숫자 아니오
└─ valid_mean_token_accuracy (유효 평균 토큰 정확도) 숫자 아니오
객체 enum 항상 "fine_tuning.job.checkpoint"인 개체 형식입니다.
가능한 값: fine_tuning.job.checkpoint
단계_번호 integer 검사점이 만들어진 단계 번호입니다.

OpenAI.FineTuningJobEvent

작업 이벤트 개체 미세 조정

이름 유형 Description 필수 기본값
생성_시간 integer 미세 조정 작업이 만들어진 시간에 대한 Unix 타임스탬프(초)입니다.
데이터 이벤트와 연결된 데이터입니다. 아니오
아이디 문자열 개체 식별자입니다.
레벨 enum 이벤트의 로그 수준입니다.
가능한 값: info, warnerror
메시지 문자열 이벤트의 메시지입니다.
객체 enum 개체 형식으로는 항상 "fine_tuning.job.event"이 사용됩니다.
가능한 값: fine_tuning.job.event
type enum 이벤트의 유형입니다.
가능한 값: messagemetrics
아니오

OpenAI.FunctionObject

이름 유형 Description 필수 기본값
description 문자열 함수를 호출하는 시기와 방법을 선택하기 위해 모델에서 사용하는 함수의 기능에 대한 설명입니다. 아니오
이름 문자열 호출할 함수의 이름입니다. a~z, A~Z, 0~9 또는 밑줄과 대시를 포함해야 하며 최대 길이는 64자여야 합니다.
매개 변수 함수가 허용하는 매개 변수로, JSON 스키마 개체로 설명됩니다. 예제를 보려면 가이드를 참조하고, 형식에 대한 설명서는 JSON 스키마 참조를 참조하세요.

parameters를 생략하면 빈 매개 변수 목록이 있는 함수가 정의됩니다.
아니오
엄격한 부울 함수 호출을 생성할 때 엄격한 스키마 준수를 사용하도록 설정할지 여부입니다. true로 설정하면 모델은 parameters 필드에 정의된 정확한 스키마를 따릅니다. stricttrue인 경우 JSON 스키마의 하위 집합만 지원됩니다. 의 구조적 출력에 대해 자세히 알아보기 아니오 거짓

OpenAI.FunctionTool

모델에서 호출하도록 선택할 수 있는 함수를 사용자 고유의 코드로 정의합니다.

이름 유형 Description 필수 기본값
description 문자열 함수에 대한 설명입니다. 모델에서 함수를 호출할지 여부를 결정하는 데 사용됩니다. 아니오
이름 문자열 호출할 함수의 이름입니다.
매개 변수 함수의 매개 변수를 설명하는 JSON 스키마 개체입니다.
엄격한 부울 엄격한 매개 변수 유효성 검사를 적용할지 여부입니다. 기본값 true.
type enum 함수 도구의 종류입니다. 항상 function입니다.
가능한 값: function

OpenAI.FunctionToolCallItemParam

함수를 실행하는 도구 호출입니다. 자세한 내용은 함수 호출 가이드를 참조하세요.

이름 유형 Description 필수 기본값
arguments 문자열 함수에 전달할 인수의 JSON 문자열입니다.
call_id 문자열 모델에서 생성된 함수 도구 호출의 고유 ID입니다.
이름 문자열 실행할 함수의 이름입니다.
type enum
가능한 값: function_call

OpenAI.FunctionToolCallItemResource

함수를 실행하는 도구 호출입니다. 자세한 내용은 함수 호출 가이드를 참조하세요.

이름 유형 Description 필수 기본값
arguments 문자열 함수에 전달할 인수의 JSON 문자열입니다.
call_id 문자열 모델에서 생성된 함수 도구 호출의 고유 ID입니다.
이름 문자열 실행할 함수의 이름입니다.
상태 enum 항목의 상태입니다. in_progress, completed 또는 하나
incomplete; 항목이 API를 통해 반환될 때 채워집니다.
가능한 값: in_progress, completedincomplete
type enum
가능한 값: function_call

OpenAI.FunctionToolCallOutputItemParam

함수 도구 호출의 출력입니다.

이름 유형 Description 필수 기본값
call_id 문자열 모델에서 생성된 함수 도구 호출의 고유 ID입니다.
output 문자열 함수 도구 호출 출력의 JSON 문자열입니다.
type enum
가능한 값: function_call_output

OpenAI.FunctionToolCallOutputItemResource

함수 도구 호출의 출력입니다.

이름 유형 Description 필수 기본값
call_id 문자열 모델에서 생성된 함수 도구 호출의 고유 ID입니다.
output 문자열 함수 도구 호출 출력의 JSON 문자열입니다.
상태 enum 항목의 상태입니다. in_progress, completed 또는 하나
incomplete; 항목이 API를 통해 반환될 때 채워집니다.
가능한 값: in_progress, completedincomplete
type enum
가능한 값: function_call_output

OpenAI.GraderLabelModel

모델을 사용하여 평가의 각 항목에 레이블을 할당하는 LabelModelGrader 개체입니다.

이름 유형 Description 필수 기본값
입력 array
labels array 평가에서 각 항목에 할당할 레이블입니다.
모델 문자열 평가에 사용할 모델입니다. 구조화된 출력을 지원해야 합니다.
이름 문자열 채점자의 이름입니다.
전달되는 레이블 array 합격 결과를 나타내는 레이블입니다. 레이블의 하위 집합이어야 합니다.
type enum 항상 label_model인 개체 형식입니다.
가능한 값: label_model

OpenAI.GraderMulti

MultiGrader 개체는 여러 채점자의 출력을 결합하여 단일 점수를 생성합니다.

이름 유형 Description 필수 기본값
출력_계산 문자열 채점자 결과에 따라 출력을 계산하는 수식.
채점자 객체 지정된 작업을 사용하여 입력과 참조 간의 문자열 비교를 수행하는 StringCheckGrader 개체입니다.
└─ 평가_기준 enum 사용할 평가 메트릭입니다. cosine, fuzzy_match, bleu 중 하나입니다.
gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5
또는 rouge_l.
가능한 값: cosine,, fuzzy_match,bleugleu, meteorrouge_1, rouge_2, rouge_3rouge_4, rouge_5rouge_l
아니오
└ image_tag 문자열 Python 스크립트에 사용할 이미지 태그입니다. 아니오
└─ 입력 array 아니오
└) 레이블 array 평가에서 각 항목에 할당할 레이블입니다. 아니오
└─ 모델 문자열 평가에 사용할 모델입니다. 구조화된 출력을 지원해야 합니다. 아니오
└) 이름 문자열 채점자의 이름입니다. 아니오
└작업 enum 수행할 문자열 검사 작업입니다. eq, ne, like 또는 ilike 중 하나입니다.
가능한 값: eq, ne, likeilike
아니오
└passing_labels array 합격 결과를 나타내는 레이블입니다. 레이블의 하위 집합이어야 합니다. 아니오
└─ 범위 array 점수의 범위입니다. 기본값은 [0, 1]입니다. 아니오
└─ 참조 문자열 채점 기준이 되는 텍스트입니다. 아니오
└─ 샘플링_파라미터 OpenAI.EvalGraderScoreModelSamplingParams 모델의 샘플링 매개 변수입니다. 아니오
└) 원본 문자열 Python 스크립트의 소스 코드입니다. 아니오
└─ 형식 enum 항상 label_model인 개체 형식입니다.
가능한 값: label_model
아니오
이름 문자열 채점자의 이름입니다.
type enum 항상 multi인 개체 형식입니다.
가능한 값: multi

OpenAI.GraderPython

입력에서 Python 스크립트를 실행하는 PythonGrader 개체입니다.

이름 유형 Description 필수 기본값
image_tag 문자열 Python 스크립트에 사용할 이미지 태그입니다. 아니오
이름 문자열 채점자의 이름입니다.
source 문자열 Python 스크립트의 소스 코드입니다.
type enum 항상 python인 개체 형식입니다.
가능한 값: python

OpenAI.GraderScoreModel

모델을 사용하여 입력에 점수를 할당하는 ScoreModelGrader 개체입니다.

이름 유형 Description 필수 기본값
입력 array 입력 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다.
모델 문자열 평가에 사용할 모델입니다.
이름 문자열 채점자의 이름입니다.
범위 array 점수의 범위입니다. 기본값은 [0, 1]입니다. 아니오
샘플링_파라미터 객체 아니오
└max_completions_tokens OpenAI.integer 아니오
└─ 추론_노력 OpenAI.추론노력 추론 모델에서 추론 작업을 제한합니다.

현재 지원되는 값은 없음, 최소, 낮음, 중간 및 높음입니다.

추론 작업을 줄이면 응답 속도가 빨라지고 응답에서 추론에 사용되는 토큰이 줄어들 수 있습니다.

gpt-5.1은 기본적으로 none으로 설정되며 추론을 수행하지 않습니다. gpt-5.1에 대해 지원되는 추론 값은 없음, 낮음, 중간 및 높음입니다. 도구 호출은 gpt-5.1의 모든 추론 값에 대해 지원됩니다.

gpt-5.1 이전의 모든 모델은 기본적으로 중간 추론 작업으로 설정되며, 없음을 지원하지 않습니다.

gpt-5-pro 모델은 기본적으로 높은 추론 작업만 지원합니다.
아니오
└) 시드 OpenAI.integer 아니오
└> 온도 OpenAI.numeric 아니오
└ top_p OpenAI.numeric 아니오
type enum 항상 score_model인 개체 형식입니다.
가능한 값: score_model

OpenAI.GraderStringCheck

지정된 작업을 사용하여 입력과 참조 간의 문자열 비교를 수행하는 StringCheckGrader 개체입니다.

이름 유형 Description 필수 기본값
입력 문자열 입력 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다.
이름 문자열 채점자의 이름입니다.
수술 enum 수행할 문자열 검사 작업입니다. eq, ne, like 또는 ilike 중 하나입니다.
가능한 값: eq, ne, likeilike
참조 문자열 참조 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다.
type enum 항상 string_check인 개체 형식입니다.
가능한 값: string_check

OpenAI.GraderTextSimilarity

유사성 메트릭에 따라 텍스트를 채점하는 TextSimilarityGrader 개체입니다.

이름 유형 Description 필수 기본값
평가 지표 enum 사용할 평가 메트릭입니다. cosine, fuzzy_match, bleu 중 하나입니다.
gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5
또는 rouge_l.
가능한 값: cosine,, fuzzy_match,bleugleu, meteorrouge_1, rouge_2, rouge_3rouge_4, rouge_5rouge_l
입력 문자열 채점되는 텍스트입니다.
이름 문자열 채점자의 이름입니다.
참조 문자열 채점 기준이 되는 텍스트입니다.
type enum 채점자의 유형입니다.
가능한 값: text_similarity

OpenAI.ImageGenTool

와 같은 gpt-image-1모델을 사용하여 이미지를 생성하는 도구입니다.

이름 유형 Description 필수 기본값
background enum 생성된 이미지의 배경 형식입니다. 다음 중 하나입니다. transparent
opaque 또는 auto입니다. 기본값: auto.
가능한 값: transparent, opaqueauto
아니오
입력_이미지_마스크 객체 인페인팅을 위한 선택적 마스크입니다. image_url를 포함하고 있습니다.
(string, optional) 및 file_id (string, optional).
아니오
└ file_id 문자열 마스크 이미지의 파일 ID입니다. 아니오
└image_url 문자열 Base64로 인코딩된 마스크 이미지입니다. 아니오
모델 enum 사용할 이미지 생성 모델입니다. 기본값: gpt-image-1.
가능한 값: gpt-image-1
아니오
moderation enum 생성된 이미지에 대한 조정 수준입니다. 기본값: auto.
가능한 값: autolow
아니오
출력 압축 integer 출력 이미지의 압축 수준입니다. 기본값은 100입니다. 아니오 100
출력 형식 enum 생성된 이미지의 출력 형식입니다. png, webp 또는 하나
jpeg; 기본값: png.
가능한 값: png, webpjpeg
아니오
부분 이미지 integer 스트리밍 모드에서 생성할 부분 이미지의 수(기본값) 0에서 3까지입니다. 아니오 0
enum 생성된 이미지의 품질입니다. low, medium, high 중 하나입니다.
또는 auto. 기본값: auto.
가능한 값: low, medium, highauto
아니오
크기 enum 생성된 이미지의 크기입니다. 다음 중 하나인 1024x1024, 1024x1536
1536x1024 또는 auto입니다. 기본값: auto.
가능한 값: 1024x1024, 1024x1536, 1536x1024auto
아니오
type enum 이미지 생성 도구의 형식입니다. 항상 image_generation입니다.
가능한 값: image_generation

OpenAI.ImageGenToolCallItemParam

모델에서 만든 이미지 생성 요청입니다.

이름 유형 Description 필수 기본값
결과 문자열 base64로 인코딩된 생성된 이미지입니다.
type enum
가능한 값: image_generation_call

OpenAI.ImageGenToolCallItemResource

모델에서 만든 이미지 생성 요청입니다.

이름 유형 Description 필수 기본값
결과 문자열 base64로 인코딩된 생성된 이미지입니다.
상태 enum
가능한 값: in_progress, completed, generatingfailed
type enum
가능한 값: image_generation_call

OpenAI.Includable

모델 응답에 포함할 추가 출력 데이터를 지정합니다. 현재 지원되는 값은 다음과 같습니다.

  • code_interpreter_call.outputs: 코드 인터프리터 도구 호출 항목에 Python 코드 실행의 출력을 포함합니다.
  • computer_call_output.output.image_url: 컴퓨터 호출 출력의 이미지 URL을 포함합니다.
  • file_search_call.results: 파일 검색 도구 호출의 검색 결과를 포함합니다.
  • message.input_image.image_url: 입력 메시지의 이미지 URL을 포함합니다.
  • message.output_text.logprobs: 도우미 메시지와 함께 logprobs를 포함합니다.
  • reasoning.encrypted_content: 추론 항목 출력에 암호화된 버전의 추론 토큰을 포함합니다. 이렇게 하면 store 매개 변수가 false로 설정된 경우나 조직이 데이터 보존 제로 프로그램에 등록된 경우처럼 응답 API를 무상태로 사용할 때 다중 턴 대화에서 추론 항목을 사용할 수 있습니다.
재산 가치
설명 모델 응답에 포함할 추가 출력 데이터를 지정합니다. 현재
지원되는 값은 다음과 같습니다.
- code_interpreter_call.outputs: Python 코드 실행의 출력을 포함합니다.
코드 인터프리터 도구에서 항목을 호출합니다.
- computer_call_output.output.image_url: 컴퓨터 호출 출력의 이미지 URL을 포함합니다.
- file_search_call.results: 다음의 검색 결과를 포함합니다.
파일 검색 도구 호출입니다.
- message.input_image.image_url: 입력 메시지의 이미지 URL을 포함합니다.
- message.output_text.logprobs: 도우미 메시지와 함께 logprobs를 포함합니다.
- reasoning.encrypted_content: 암호화된 버전의 추론 포함
추론 항목의 출력에 있는 토큰입니다. 이렇게 하면 추론 항목을 사용할 수 있습니다.
응답 API를 상태 없이 사용할 때 멀티 턴 대화(예:
store 매개 변수가 false로 설정되거나 조직이
데이터 보존 없음 프로그램에 등록됨).
유형 문자열
code_interpreter_call.outputs
computer_call_output.output.image_url
file_search_call.results
message.input_image.image_url
message.output_text.logprobs
reasoning.encrypted_content
web_search_call.results
web_search_call.action.sources
memory_search_call.results

OpenAI.ItemContent

OpenAI.ItemContent에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
input_audio OpenAI.ItemContentInputAudio
output_audio OpenAI.ItemContentOutputAudio
refusal OpenAI.ItemContentRefusal
input_text OpenAI.ItemContentInputText
input_image OpenAI.ItemContentInputImage
input_file OpenAI.ItemContentInputFile
output_text OpenAI.ItemContentOutputText
이름 유형 Description 필수 기본값
type OpenAI.ItemContentType 다중 모달 입력 및 출력 콘텐츠입니다.

OpenAI.ItemContentInputAudio

모델에 대한 오디오 입력입니다.

이름 유형 Description 필수 기본값
데이터 문자열 Base64로 인코딩된 오디오 데이터입니다.
format enum 오디오 데이터의 형식입니다. 현재 지원되는 형식은 다음과 같습니다 mp3 .
wav;
가능한 값: mp3wav
type enum 입력 항목의 형식입니다. 항상 input_audio입니다.
가능한 값: input_audio

OpenAI.ItemContentInputFile

모델에 대한 파일 입력입니다.

이름 유형 Description 필수 기본값
file_data 문자열 모델로 보낼 파일의 콘텐츠입니다. 아니오
file_id 문자열 모델로 보낼 파일의 ID입니다. 아니오
filename 문자열 모델로 보낼 파일의 이름입니다. 아니오
type enum 입력 항목의 형식입니다. 항상 input_file입니다.
가능한 값: input_file

OpenAI.ItemContentInputImage

모델에 대한 이미지 입력입니다. 이미지 입력에 대해 알아보세요.

이름 유형 Description 필수 기본값
detail enum 모델에 보낼 이미지의 세부 수준입니다. high, low 또는 auto 중 하나입니다. 기본값은 auto입니다.
가능한 값: low, highauto
아니오
file_id 문자열 모델로 보낼 파일의 ID입니다. 아니오
image_url 문자열 모델로 보낼 이미지의 URL입니다. 데이터 URL의 정규화된 URL 또는 base64로 인코딩된 이미지입니다. 아니오
type enum 입력 항목의 형식입니다. 항상 input_image입니다.
가능한 값: input_image

OpenAI.ItemContentInputText

모델에 대한 텍스트 입력입니다.

이름 유형 Description 필수 기본값
문자 메시지 문자열 모델에 대한 텍스트 입력입니다.
type enum 입력 항목의 형식입니다. 항상 input_text입니다.
가능한 값: input_text

OpenAI.ItemContentOutputAudio

모델의 오디오 출력입니다.

이름 유형 Description 필수 기본값
데이터 문자열 모델의 Base64로 인코딩된 오디오 데이터입니다.
대본 문자열 모델의 오디오 데이터 대본입니다.
type enum 출력 오디오의 형식입니다. 항상 output_audio입니다.
가능한 값: output_audio

OpenAI.ItemContentOutputText

모델의 텍스트 출력입니다.

이름 유형 Description 필수 기본값
주석 array 텍스트 출력의 주석입니다.
logprobs array 아니오
문자 메시지 문자열 모델의 텍스트 출력입니다.
type enum 출력 텍스트의 형식입니다. 항상 output_text입니다.
가능한 값: output_text

OpenAI.ItemContentRefusal

모델의 거부입니다.

이름 유형 Description 필수 기본값
refusal 문자열 모델로부터의 거부에 대한 설명입니다.
type enum 거부의 유형입니다. 항상 refusal입니다.
가능한 값: refusal

OpenAI.ItemContentType

다중 모달 입력 및 출력 콘텐츠입니다.

재산 가치
설명 다중 모달 입력 및 출력 콘텐츠입니다.
유형 문자열
input_text
input_audio
input_image
input_file
output_text
output_audio
refusal

OpenAI.ItemParam

응답을 생성하는 데 사용되는 콘텐츠 항목입니다.

OpenAI.ItemParam에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
message OpenAI.ResponsesMessageItemParam
function_call_output OpenAI.FunctionToolCallOutputItemParam
file_search_call OpenAI.FileSearchToolCallItemParam
computer_call OpenAI.ComputerToolCallItemParam
computer_call_output OpenAI.ComputerToolCallOutputItemParam
web_search_call OpenAI.WebSearchToolCallItemParam
function_call OpenAI.FunctionToolCallItemParam
reasoning OpenAI.ReasoningItemParam
item_reference OpenAI.ItemReferenceItemParam
image_generation_call OpenAI.ImageGenToolCallItemParam
code_interpreter_call OpenAI.CodeInterpreterToolCallItemParam
local_shell_call OpenAI.LocalShellToolCallItemParam
local_shell_call_output OpenAI.LocalShellToolCallOutputItemParam
mcp_list_tools OpenAI.MCPListToolsItemParam
mcp_approval_request OpenAI.MCPApprovalRequestItemParam
mcp_approval_response OpenAI.MCPApprovalResponseItemParam
mcp_call OpenAI.MCPCallItemParam
memory_search_call MemorySearchToolCallItemParam
이름 유형 Description 필수 기본값
type OpenAI.ItemType

OpenAI.ItemReferenceItemParam

참조할 항목의 내부 식별자입니다.

이름 유형 Description 필수 기본값
아이디 문자열 참조되는 이전에 생성된 응답 항목의 서비스 원본 ID입니다.
type enum
가능한 값: item_reference

OpenAI.ItemResource

응답을 생성하는 데 사용되는 콘텐츠 항목입니다.

OpenAI.ItemResource에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
structured_outputs StructuredOutputsItemResource
workflow_action WorkflowActionOutputItemResource
oauth_consent_request OAuthConsentRequestItemResource
message OpenAI.ResponsesMessageItemResource
computer_call_output OpenAI.ComputerToolCallOutputItemResource
function_call OpenAI.FunctionToolCallItemResource
function_call_output OpenAI.FunctionToolCallOutputItemResource
mcp_approval_response OpenAI.MCPApprovalResponseItemResource
file_search_call OpenAI.FileSearchToolCallItemResource
computer_call OpenAI.ComputerToolCallItemResource
web_search_call OpenAI.WebSearchToolCallItemResource
reasoning OpenAI.ReasoningItemResource
image_generation_call OpenAI.ImageGenToolCallItemResource
code_interpreter_call OpenAI.CodeInterpreterToolCallItemResource
local_shell_call OpenAI.LocalShellToolCallItemResource
local_shell_call_output OpenAI.LocalShellToolCallOutputItemResource
mcp_list_tools OpenAI.MCPListToolsItemResource
mcp_approval_request OpenAI.MCPApprovalRequestItemResource
mcp_call OpenAI.MCPCallItemResource
memory_search_call MemorySearchToolCallItemResource
이름 유형 Description 필수 기본값
작성자 객체 아니오
└) 에이전트 AgentId 항목을 만든 에이전트입니다. 아니오
└response_id 문자열 항목이 만들어지는 응답입니다. 아니오
아이디 문자열
type OpenAI.ItemType

OpenAI.ItemType

재산 가치
유형 문자열
message
file_search_call
function_call
function_call_output
computer_call
computer_call_output
web_search_call
reasoning
item_reference
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
structured_outputs
workflow_action
memory_search_call
oauth_consent_request

OpenAI.ListFineTuningJobCheckpointsResponse

이름 유형 Description 필수 기본값
데이터 array
첫번째_아이디 문자열 아니오
더_있음 부울
마지막 아이디 문자열 아니오
객체 enum
가능한 값: list

OpenAI.ListFineTuningJobEventsResponse

이름 유형 Description 필수 기본값
데이터 array
더_있음 부울
객체 enum
가능한 값: list

OpenAI.ListPaginatedFineTuningJobsResponse

이름 유형 Description 필수 기본값
데이터 array
더_있음 부울
객체 enum
가능한 값: list

OpenAI.LocalShellExecAction

서버에서 셸 명령을 실행합니다.

이름 유형 Description 필수 기본값
명령어 array 실행할 명령.
환경 객체 명령에 대해 설정할 환경 변수입니다.
타임아웃_밀리초 integer 명령에 대한 선택적 시간 제한(밀리초)입니다. 아니오
type enum 로컬 셸 동작의 형식입니다. 항상 exec입니다.
가능한 값: exec
사용자 문자열 명령을 실행할 때 사용할 선택적 사용자입니다. 아니오
작업 디렉토리 문자열 명령을 실행할 선택적 작업 디렉터리입니다. 아니오

OpenAI.LocalShellTool

모델이 로컬 환경에서 셸 명령을 실행할 수 있도록 하는 도구입니다.

이름 유형 Description 필수 기본값
type enum 로컬 셸 도구의 형식입니다. 항상 local_shell입니다.
가능한 값: local_shell

OpenAI.LocalShellToolCallItemParam

로컬 셸에서 명령을 실행하는 도구 호출입니다.

이름 유형 Description 필수 기본값
조치 OpenAI.LocalShellExecAction 서버에서 셸 명령을 실행합니다.
call_id 문자열 모델에서 생성된 로컬 셸 도구 호출의 고유 ID입니다.
type enum
가능한 값: local_shell_call

OpenAI.LocalShellToolCallItemResource

로컬 셸에서 명령을 실행하는 도구 호출입니다.

이름 유형 Description 필수 기본값
조치 OpenAI.LocalShellExecAction 서버에서 셸 명령을 실행합니다.
call_id 문자열 모델에서 생성된 로컬 셸 도구 호출의 고유 ID입니다.
상태 enum
가능한 값: in_progress, completedincomplete
type enum
가능한 값: local_shell_call

OpenAI.LocalShellToolCallOutputItemParam

로컬 셸 도구 호출의 출력입니다.

이름 유형 Description 필수 기본값
output 문자열 로컬 셸 도구 호출 출력의 JSON 문자열입니다.
type enum
가능한 값: local_shell_call_output

OpenAI.LocalShellToolCallOutputItemResource

로컬 셸 도구 호출의 출력입니다.

이름 유형 Description 필수 기본값
output 문자열 로컬 셸 도구 호출 출력의 JSON 문자열입니다.
상태 enum
가능한 값: in_progress, completedincomplete
type enum
가능한 값: local_shell_call_output

OpenAI.Location

OpenAI.Location에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
approximate OpenAI.ApproximateLocation
이름 유형 Description 필수 기본값
type OpenAI.LocationType

OpenAI.LocationType

재산 가치
유형 문자열
approximate

OpenAI.LogProb

토큰의 로그 확률입니다.

이름 유형 Description 필수 기본값
bytes array
logprob 숫자
token 문자열
top_logprobs array

OpenAI.MCPApprovalRequestItemParam

도구 호출에 대한 사용자 승인 요청입니다.

이름 유형 Description 필수 기본값
arguments 문자열 도구에 대한 인수의 JSON 문자열입니다.
이름 문자열 실행할 도구의 이름입니다.
서버 레이블 문자열 요청을 만드는 MCP 서버의 레이블입니다.
type enum
가능한 값: mcp_approval_request

OpenAI.MCPApprovalRequestItemResource

도구 호출에 대한 사용자 승인 요청입니다.

이름 유형 Description 필수 기본값
arguments 문자열 도구에 대한 인수의 JSON 문자열입니다.
이름 문자열 실행할 도구의 이름입니다.
서버 레이블 문자열 요청을 만드는 MCP 서버의 레이블입니다.
type enum
가능한 값: mcp_approval_request

OpenAI.MCPApprovalResponseItemParam

MCP 승인 요청에 대한 응답입니다.

이름 유형 Description 필수 기본값
approval_request_id 문자열 응답할 승인 요청의 ID입니다.
승인 부울 요청이 승인되었는지 여부입니다.
이유 문자열 결정의 선택적 이유입니다. 아니오
type enum
가능한 값: mcp_approval_response

OpenAI.MCPApprovalResponseItemResource

MCP 승인 요청에 대한 응답입니다.

이름 유형 Description 필수 기본값
approval_request_id 문자열 응답할 승인 요청의 ID입니다.
승인 부울 요청이 승인되었는지 여부입니다.
이유 문자열 결정의 선택적 이유입니다. 아니오
type enum
가능한 값: mcp_approval_response

OpenAI.MCPCallItemParam

MCP 서버에서 도구 호출입니다.

이름 유형 Description 필수 기본값
arguments 문자열 도구에 전달된 인수의 JSON 문자열입니다.
오류 문자열 도구 호출의 오류(있는 경우)입니다. 아니오
이름 문자열 실행된 도구의 이름입니다.
output 문자열 도구 호출의 출력입니다. 아니오
서버 레이블 문자열 도구를 실행하는 MCP 서버의 레이블입니다.
type enum
가능한 값: mcp_call

OpenAI.MCPCallItemResource

MCP 서버에서 도구 호출입니다.

이름 유형 Description 필수 기본값
arguments 문자열 도구에 전달된 인수의 JSON 문자열입니다.
오류 문자열 도구 호출의 오류(있는 경우)입니다. 아니오
이름 문자열 실행된 도구의 이름입니다.
output 문자열 도구 호출의 출력입니다. 아니오
서버 레이블 문자열 도구를 실행하는 MCP 서버의 레이블입니다.
type enum
가능한 값: mcp_call

OpenAI.MCPListToolsItemParam

MCP 서버에서 사용할 수 있는 도구 목록입니다.

이름 유형 Description 필수 기본값
오류 문자열 서버에서 도구를 나열할 수 없는 경우 오류 메시지입니다. 아니오
서버 레이블 문자열 MCP 서버의 레이블입니다.
도구들 array 서버에서 사용할 수 있는 도구입니다.
type enum
가능한 값: mcp_list_tools

OpenAI.MCPListToolsItemResource

MCP 서버에서 사용할 수 있는 도구 목록입니다.

이름 유형 Description 필수 기본값
오류 문자열 서버에서 도구를 나열할 수 없는 경우 오류 메시지입니다. 아니오
서버 레이블 문자열 MCP 서버의 레이블입니다.
도구들 array 서버에서 사용할 수 있는 도구입니다.
type enum
가능한 값: mcp_list_tools

OpenAI.MCPListToolsTool

MCP 서버에서 사용할 수 있는 도구입니다.

이름 유형 Description 필수 기본값
주석 도구에 대한 추가 주석입니다. 아니오
description 문자열 도구에 대한 설명입니다. 아니오
input_schema 도구의 입력을 설명하는 JSON 스키마입니다.
이름 문자열 도구의 이름입니다.

OpenAI.MCPTool

모델에서 MCP(원격 모델 컨텍스트 프로토콜) 서버를 통해 추가 도구에 액세스할 수 있도록 합니다. MCP에 대해 자세히 알아보세요.

이름 유형 Description 필수 기본값
허용된 도구 객체 아니오
└─ 도구_이름 array 허용되는 도구 이름 목록입니다. 아니오
headers 객체 MCP 서버로 보낼 선택적 HTTP 헤더입니다. 인증에 사용
또는 기타 목적.
아니오
project_connection_id 문자열 MCP 서버에 대한 프로젝트의 연결 ID입니다. 연결은 MCP 서버에 연결하는 데 필요한 인증 및 기타 연결 세부 정보를 저장합니다. 아니오
승인_필요 개체(아래 유효한 모델 참조) 승인이 필요한 MCP 서버의 도구를 지정합니다. 아니오
서버 레이블 문자열 이 MCP 서버에 대한 레이블로, 도구 호출에서 이를 식별하는 데 사용됩니다.
서버 URL 문자열 MCP 서버의 URL입니다.
type enum MCP 도구의 형식입니다. 항상 mcp입니다.
가능한 값: mcp

OpenAI.Metadata

개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 구조화된 형식으로 개체에 대한 추가 정보를 저장하고 API 또는 대시보드를 통해 개체를 쿼리하는 데 유용할 수 있습니다.

키는 최대 길이가 64자인 문자열입니다. 값은 최대 길이가 512자인 문자열입니다.

Type: 객체

OpenAI.Prompt

프롬프트 템플릿 및 해당 변수에 대한 참조입니다. 자세히알아보세요.

이름 유형 Description 필수 기본값
아이디 문자열 사용할 프롬프트 템플릿의 고유 식별자입니다.
variables 객체 프롬프트에서 변수를 대체할 값의 선택적
맵입니다. 대체 값은 문자열이거나 다른 값일 수 있습니다.
이미지 또는 파일과 같은 응답 입력 형식입니다.
아니오
버전 문자열 프롬프트 템플릿의 선택적 버전입니다. 아니오

OpenAI.랭킹옵션

이름 유형 Description 필수 기본값
순위를 매기는 사람 enum 파일 검색에 사용할 순위입니다.
가능한 값: autodefault-2024-11-15
아니오
점수 임계값 숫자 파일 검색의 점수 임계값으로, 0에서 1 사이의 숫자입니다. 1에 가까운 숫자는 가장 관련성이 큰 결과만 반환하려고 시도하지만 더 적은 결과를 반환할 수 있습니다. 아니오

OpenAI.Reasoning

o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.

이름 유형 Description 필수 기본값
effort 객체 추론 모델에서 추론 작업을 제한합니다.

현재 지원되는 값은 없음, 최소, 낮음, 중간 및 높음입니다.

추론 작업을 줄이면 응답 속도가 빨라지고 응답에서 추론에 사용되는 토큰이 줄어들 수 있습니다.

gpt-5.1은 기본적으로 none으로 설정되며 추론을 수행하지 않습니다. gpt-5.1에 대해 지원되는 추론 값은 없음, 낮음, 중간 및 높음입니다. 도구 호출은 gpt-5.1의 모든 추론 값에 대해 지원됩니다.

gpt-5.1 이전의 모든 모델은 기본적으로 중간 추론 작업으로 설정되며, 없음을 지원하지 않습니다.

gpt-5-pro 모델은 기본적으로 높은 추론 작업만 지원합니다.
아니오
generate_summary enum 더 이상 사용되지 않음: 대신 사용하십시오 summary . 모델에서 수행하는 추론에 대한 요약입니다. 이는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용할 수 있습니다. auto, concise 또는 detailed 중 하나입니다.
가능한 값: auto, concisedetailed
아니오
summary enum 모델에서 수행하는 추론에 대한 요약입니다. 다음과 같을 수 있습니다.
는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용합니다.
auto, concise 또는 detailed 중 하나입니다.
가능한 값: auto, concisedetailed
아니오

OpenAI.ReasoningEffort

추론 모델에서 추론 작업을 제한합니다.

현재 지원되는 값은 없음, 최소, 낮음, 중간 및 높음입니다.

추론 작업을 줄이면 응답 속도가 빨라지고 응답에서 추론에 사용되는 토큰이 줄어들 수 있습니다.

gpt-5.1은 기본적으로 none으로 설정되며 추론을 수행하지 않습니다. gpt-5.1에 대해 지원되는 추론 값은 없음, 낮음, 중간 및 높음입니다. 도구 호출은 gpt-5.1의 모든 추론 값에 대해 지원됩니다.

gpt-5.1 이전의 모든 모델은 기본적으로 중간 추론 작업으로 설정되며, 없음을 지원하지 않습니다.

gpt-5-pro 모델은 기본적으로 높은 추론 작업만 지원합니다.

재산 가치
설명 추론 모델에서 추론 작업을 제한합니다.

현재 지원되는 값은 없음, 최소, 낮음, 중간 및 높음입니다.

추론 작업을 줄이면 응답 속도가 빨라지고 응답에서 추론에 사용되는 토큰이 줄어들 수 있습니다.

gpt-5.1은 기본적으로 none으로 설정되며 추론을 수행하지 않습니다. gpt-5.1에 대해 지원되는 추론 값은 없음, 낮음, 중간 및 높음입니다. 도구 호출은 gpt-5.1의 모든 추론 값에 대해 지원됩니다.

gpt-5.1 이전의 모든 모델은 기본적으로 중간 추론 작업으로 설정되며, 없음을 지원하지 않습니다.

gpt-5-pro 모델은 기본적으로 높은 추론 작업만 지원합니다.
유형 문자열
none
minimal
low
medium
high

OpenAI.ReasoningItemParam

응답을 생성하는 동안 추론 모델에서 사용하는 생각 체인에 대한 설명입니다. input 경우 대화의 후속 턴을 위해 응답 API에 이러한 항목을 포함해야 합니다.

이름 유형 Description 필수 기본값
encrypted_content 문자열 응답이 일 때 채워진 추론 항목의 암호화된 콘텐츠
reasoning.encrypted_content으로 생성되어 include 매개 변수에 있습니다.
아니오
summary array 추론 텍스트 내용입니다.
type enum
가능한 값: reasoning

OpenAI.ReasoningItemResource

응답을 생성하는 동안 추론 모델에서 사용하는 생각 체인에 대한 설명입니다. input 경우 대화의 후속 턴을 위해 응답 API에 이러한 항목을 포함해야 합니다.

이름 유형 Description 필수 기본값
encrypted_content 문자열 응답이 일 때 채워진 추론 항목의 암호화된 콘텐츠
reasoning.encrypted_content으로 생성되어 include 매개 변수에 있습니다.
아니오
summary array 추론 텍스트 내용입니다.
type enum
가능한 값: reasoning

OpenAI.ReasoningItemSummaryPart

OpenAI.ReasoningItemSummaryPart에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
summary_text OpenAI.ReasoningItemSummaryTextPart
이름 유형 Description 필수 기본값
type OpenAI.ReasoningItemSummaryPartType

OpenAI.ReasoningItemSummaryPartType

재산 가치
유형 문자열
summary_text

OpenAI.ReasoningItemSummaryTextPart

이름 유형 Description 필수 기본값
문자 메시지 문자열
type enum
가능한 값: summary_text

OpenAI.Response

이름 유형 Description 필수 기본값
agent 객체 아니오
└) 이름 문자열 에이전트의 이름입니다. 아니오
└─ 형식 enum
가능한 값: agent_id
아니오
└─ 버전 문자열 에이전트의 버전 식별자입니다. 아니오
background 부울 백그라운드에서 모델 응답을 실행할지 여부입니다.
배경 응답에 대해 자세히 알아봅니다.
아니오 거짓
대화 객체
└─ ID 문자열 아니오
생성_시간 integer 이 응답을 만든 시점의 Unix 타임스탬프(초)입니다.
오류 객체 모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다.
└) 코드 OpenAI.ResponseErrorCode 응답에 대한 오류 코드입니다. 아니오
└) 메시지 문자열 사람이 읽을 수 있는 오류 설명입니다. 아니오
아이디 문자열 이 응답의 고유 식별자입니다.
incomplete_details 객체 응답이 불완전한 이유에 대한 세부 정보입니다.
└) 이유 enum 응답이 불완전한 이유입니다.
가능한 값: max_output_tokenscontent_filter
아니오
instructions 문자열 또는 배열
max_output_tokens integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한 입니다. 아니오
최대_도구_호출수 integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. 아니오
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
모델 문자열 이 응답을 만드는 데 사용할 모델 배포입니다. 아니오
객체 enum 이 리소스의 개체 유형은 항상 response로 설정됩니다.
가능한 값: response
output array 모델에서 생성된 콘텐츠 항목의 배열입니다.

- 배열에 있는 항목의 길이와 순서가 output 종속됩니다.
모델의 응답에 따라.
- output 배열의 첫 번째 항목에 액세스하고
생성된 콘텐츠가 있는 assistant 메시지라고 가정하는 것보다
모델에서 output_text 속성을 사용하는 것을 고려해 볼 수 있습니다.
SDK에서 지원됩니다.
output_text 문자열 집계된 텍스트 출력을 포함하는 SDK 전용 편의 속성
output_text 배열에 있는 모든 output 항목(있는 경우)에서.
Python 및 JavaScript SDK에서 지원됩니다.
아니오
병렬 도구 호출 부울 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. 진실
previous_response_id 문자열 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다. 자세한 정보
대화 상태 관리
아니오
prompt 객체 프롬프트 템플릿 및 해당 변수에 대한 참조입니다.
자세히알아보세요.
아니오
└─ ID 문자열 사용할 프롬프트 템플릿의 고유 식별자입니다. 아니오
└) 변수 OpenAI.ResponsePromptVariables 프롬프트에서 변수를 대체할 값의 선택적
맵입니다. 대체 값은 문자열이거나 다른 값일 수 있습니다.
이미지 또는 파일과 같은 응답 입력 형식입니다.
아니오
└─ 버전 문자열 프롬프트 템플릿의 선택적 버전입니다. 아니오
reasoning 객체 o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.
아니오
└) 노력 OpenAI.추론노력 추론 모델에서 추론 작업을 제한합니다.

현재 지원되는 값은 없음, 최소, 낮음, 중간 및 높음입니다.

추론 작업을 줄이면 응답 속도가 빨라지고 응답에서 추론에 사용되는 토큰이 줄어들 수 있습니다.

gpt-5.1은 기본적으로 none으로 설정되며 추론을 수행하지 않습니다. gpt-5.1에 대해 지원되는 추론 값은 없음, 낮음, 중간 및 높음입니다. 도구 호출은 gpt-5.1의 모든 추론 값에 대해 지원됩니다.

gpt-5.1 이전의 모든 모델은 기본적으로 중간 추론 작업으로 설정되며, 없음을 지원하지 않습니다.

gpt-5-pro 모델은 기본적으로 높은 추론 작업만 지원합니다.
아니오
└─ 요약_생성하기 (generate_summary) enum 더 이상 사용되지 않음: 대신 사용하십시오 summary . 모델에서 수행하는 추론에 대한 요약입니다. 이는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용할 수 있습니다. auto, concise 또는 detailed 중 하나입니다.
가능한 값: auto, concisedetailed
아니오
└) 요약 enum 모델에서 수행하는 추론에 대한 요약입니다. 다음과 같을 수 있습니다.
는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용합니다.
auto, concise 또는 detailed 중 하나입니다.
가능한 값: auto, concisedetailed
아니오
서비스 계층 객체 요청을 처리하는 데 사용되는 처리 유형을 지정합니다.
* 'auto'로 설정하면 요청이 서비스 계층으로 처리됩니다.
프로젝트 설정에서 구성됩니다. 달리 구성하지 않는 한 프로젝트는 '기본값'을 사용합니다.
* 'default'로 설정하면 요청이 표준으로 처리됩니다.
선택한 모델의 가격 책정 및 성능
* 'flex'로 설정된 경우
또는 'priority'이면 요청이 해당 서비스로 처리됩니다.
계층. 우선 순위 처리에 대해 자세히 알아보려면 영업 담당자에게 문의하세요.
* 설정하지 않으면 기본 동작은 'auto'입니다.

매개 변수가 service_tier 설정되면 응답 본문에 다음이 포함됩니다. service_tier
실제로 요청을 처리하는 데 사용되는 처리 모드를 기반으로 하는 값입니다. 이 응답 값
는 매개 변수에 설정된 값과 다를 수 있습니다.
아니오
상태 enum 응답 생성의 상태입니다. 다음 중 하나인 completed, failed
in_progress, cancelled, queued 또는 incomplete.
가능한 값: completed, failed, in_progresscancelled, queuedincomplete
아니오
structured_inputs 객체 프롬프트 템플릿 대체 또는 도구 인수 바인딩에 참여할 수 있는 응답에 대한 구조적 입력입니다. 아니오
온도 숫자 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.
문자 메시지 객체 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반
텍스트 또는 구조적 JSON 데이터일 수 있습니다. 텍스트 입력 및 출력 참조
구조적 출력
아니오
└─ 형식 OpenAI.ResponseTextFormatConfiguration 아니오
tool_choice 객체 모델이 호출하는 도구(있는 경우)를 제어합니다.

none 는 모델이 도구를 호출하지 않고 대신 메시지를 생성한다는 의미입니다.

auto 는 모델이 메시지를 생성하거나 메시지를 호출하는 중에서 선택할 수 있습니다.
더 많은 도구.

required는 모델이 하나 이상의 도구를 호출해야 함을 의미합니다.
아니오
└─ 형식 OpenAI.ToolChoiceObjectType 모델이 기본 제공 도구를 사용하여 응답을 생성해야 임을 나타냅니다.
기본 제공 도구에 대해 자세히 알아봅니다.
아니오
도구들 array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. 당신
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

* 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
웹 검색과 같은 모델의 기능
또는 파일 검색 자세한 정보
기본 제공 도구입니다.
* 함수 호출(사용자 지정 도구): 사용자가 정의한 함수
모델을 사용하여 사용자 고유의 코드를 호출할 수 있습니다. 자세한 정보
함수 호출입니다.
아니오
top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. 아니오
top_p (탑 피) 숫자 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.
truncation enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled
아니오
usage OpenAI.ResponseUsage 입력 토큰, 출력 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다.
출력 토큰 및 사용된 총 토큰의 분석입니다.
아니오
사용자 문자열 안전 모범 사례에 대해 자세히 알아보세요.

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

부분 코드 조각이 코드 인터프리터에 의해 스트리밍될 때 내보내집니다.

이름 유형 Description 필수 기본값
delta 문자열 코드 인터프리터가 스트리밍하는 부분 코드 조각입니다.
item_id 문자열 코드 인터프리터 도구 호출 항목의 고유 식별자입니다.
output_index integer 코드가 스트리밍되는 응답의 출력 항목 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.code_interpreter_call_code.delta입니다.
가능한 값: response.code_interpreter_call_code.delta

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

코드 조각이 코드 인터프리터에 의해 종료될 때 내보내집니다.

이름 유형 Description 필수 기본값
코드 문자열 코드 인터프리터의 최종 코드 조각 출력입니다.
item_id 문자열 코드 인터프리터 도구 호출 항목의 고유 식별자입니다.
output_index integer 코드가 종료되는 응답의 출력 항목 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.code_interpreter_call_code.done입니다.
가능한 값: response.code_interpreter_call_code.done

OpenAI.ResponseCodeInterpreterCallCompletedEvent

코드 인터프리터 호출이 완료되면 내보내집니다.

이름 유형 Description 필수 기본값
item_id 문자열 코드 인터프리터 도구 호출 항목의 고유 식별자입니다.
output_index integer 코드 인터프리터 호출이 완료된 응답의 출력 항목 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.code_interpreter_call.completed입니다.
가능한 값: response.code_interpreter_call.completed

OpenAI.ResponseCodeInterpreterCallInProgressEvent

코드 인터프리터 호출이 진행 중일 때 내보내집니다.

이름 유형 Description 필수 기본값
item_id 문자열 코드 인터프리터 도구 호출 항목의 고유 식별자입니다.
output_index integer 코드 인터프리터 호출이 진행 중인 응답의 출력 항목 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.code_interpreter_call.in_progress입니다.
가능한 값: response.code_interpreter_call.in_progress

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

코드 인터프리터가 코드 조각을 적극적으로 해석할 때 내보내집니다.

이름 유형 Description 필수 기본값
item_id 문자열 코드 인터프리터 도구 호출 항목의 고유 식별자입니다.
output_index integer 코드 인터프리터가 코드를 해석하는 응답에서 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.code_interpreter_call.interpreting입니다.
가능한 값: response.code_interpreter_call.interpreting

OpenAI.ResponseCompletedEvent

모델 응답이 완료되면 내보내집니다.

이름 유형 Description 필수 기본값
response 객체
└) 에이전트 AgentId 이 응답에 사용되는 에이전트 아니오
└) 배경 부울 백그라운드에서 모델 응답을 실행할지 여부입니다.
배경 응답에 대해 자세히 알아봅니다.
아니오 거짓
└) 대화 객체 아니오
└─ ID 문자열 아니오
└─ 생성일시 integer 이 응답을 만든 시점의 Unix 타임스탬프(초)입니다. 아니오
└) 오류 OpenAI.ResponseError 모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다. 아니오
└─ ID 문자열 이 응답의 고유 식별자입니다. 아니오
└─ 불완전한 세부사항 객체 응답이 불완전한 이유에 대한 세부 정보입니다. 아니오
└) 이유 enum 응답이 불완전한 이유입니다.
가능한 값: max_output_tokenscontent_filter
아니오
└) 지침 문자열 또는 배열 모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다.

previous_response_id와 함께 사용할 경우 이전의 지침이 적용됩니다.
응답은 다음 응답으로 전달되지 않습니다. 이렇게 하면 간단해집니다.
새 응답에서 시스템(또는 개발자) 메시지를 교환합니다.
아니오
└ 최대_출력_토큰 integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한 입니다. 아니오
└max_tool_calls integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. 아니오
└) 메타데이터 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
└─ 모델 문자열 이 응답을 만드는 데 사용할 모델 배포입니다. 아니오
└─ 개체 enum 이 리소스의 개체 유형은 항상 response로 설정됩니다.
가능한 값: response
아니오
└─ 출력 array 모델에서 생성된 콘텐츠 항목의 배열입니다.

- 배열에 있는 항목의 길이와 순서가 output 종속됩니다.
모델의 응답에 따라.
- output 배열의 첫 번째 항목에 액세스하고
생성된 콘텐츠가 있는 assistant 메시지라고 가정하는 것보다
모델에서 output_text 속성을 사용하는 것을 고려해 볼 수 있습니다.
SDK에서 지원됩니다.
아니오
└output_text 문자열 집계된 텍스트 출력을 포함하는 SDK 전용 편의 속성
output_text 배열에 있는 모든 output 항목(있는 경우)에서.
Python 및 JavaScript SDK에서 지원됩니다.
아니오
└ 병렬_도구_호출 부울 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. 아니오 진실
└이전_응답_아이디 문자열 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다. 자세한 정보
대화 상태 관리
아니오
└) 프롬프트 OpenAI.Prompt 프롬프트 템플릿 및 해당 변수에 대한 참조입니다.
자세히알아보세요.
아니오
└) 추론 OpenAI.Reasoning o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.
아니오
└service_tier OpenAI.ServiceTier 참고: service_tier Azure OpenAI에는 적용되지 않습니다. 아니오
└─ 상태 enum 응답 생성의 상태입니다. 다음 중 하나인 completed, failed
in_progress, cancelled, queued 또는 incomplete.
가능한 값: completed, failed, in_progresscancelled, queuedincomplete
아니오
└structured_inputs 객체 프롬프트 템플릿 대체 또는 도구 인수 바인딩에 참여할 수 있는 응답에 대한 구조적 입력입니다. 아니오
└> 온도 숫자 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.
아니오
└) 텍스트 객체 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반
텍스트 또는 구조적 JSON 데이터일 수 있습니다. 텍스트 입력 및 출력 참조
구조적 출력
아니오
└─ 형식 OpenAI.ResponseTextFormatConfiguration 아니오
└─ 도구_선택 OpenAI.ToolChoiceOptions 또는 OpenAI.ToolChoiceObject 모델을 생성할 때 사용할 도구(또는 도구)를 선택하는 방법
응답입니다. 도구를 지정하는 방법을 알아보려면 tools 매개 변수를 참조하세요.
모델이 호출할 수 있습니다.
아니오
└도구 array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. 당신
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

* 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
웹 검색과 같은 모델의 기능
또는 파일 검색 자세한 정보
기본 제공 도구입니다.
* 함수 호출(사용자 지정 도구): 사용자가 정의한 함수
모델을 사용하여 사용자 고유의 코드를 호출할 수 있습니다. 자세한 정보
함수 호출입니다.
아니오
└ top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. 아니오
└ top_p 숫자 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.
아니오
└─ 잘림 enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled
아니오
└) 사용량 OpenAI.ResponseUsage 입력 토큰, 출력 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다.
출력 토큰 및 사용된 총 토큰의 분석입니다.
아니오
└─ 사용자 문자열 안전 모범 사례에 대해 자세히 알아보세요. 아니오
type enum 이벤트의 형식입니다. 항상 response.completed입니다.
가능한 값: response.completed

OpenAI.ResponseContentPartAddedEvent

새 콘텐츠 파트가 추가될 때 내보내집니다.

이름 유형 Description 필수 기본값
content_index integer 추가된 콘텐츠 파트의 인덱스입니다.
item_id 문자열 콘텐츠 파트가 추가된 출력 항목의 ID입니다.
output_index integer 콘텐츠 파트가 추가된 출력 항목의 인덱스입니다.
part 객체
└─ 형식 OpenAI.ItemContentType 다중 모달 입력 및 출력 콘텐츠입니다. 아니오
type enum 이벤트의 형식입니다. 항상 response.content_part.added입니다.
가능한 값: response.content_part.added

OpenAI.ResponseContentPartDoneEvent

콘텐츠 파트가 완료되면 내보내집니다.

이름 유형 Description 필수 기본값
content_index integer 완료된 콘텐츠 파트의 인덱스입니다.
item_id 문자열 콘텐츠 파트가 추가된 출력 항목의 ID입니다.
output_index integer 콘텐츠 파트가 추가된 출력 항목의 인덱스입니다.
part 객체
└─ 형식 OpenAI.ItemContentType 다중 모달 입력 및 출력 콘텐츠입니다. 아니오
type enum 이벤트의 형식입니다. 항상 response.content_part.done입니다.
가능한 값: response.content_part.done

OpenAI.ResponseCreatedEvent

응답을 만들 때 내보내는 이벤트입니다.

이름 유형 Description 필수 기본값
response 객체
└) 에이전트 AgentId 이 응답에 사용되는 에이전트 아니오
└) 배경 부울 백그라운드에서 모델 응답을 실행할지 여부입니다.
배경 응답에 대해 자세히 알아봅니다.
아니오 거짓
└) 대화 객체 아니오
└─ ID 문자열 아니오
└─ 생성일시 integer 이 응답을 만든 시점의 Unix 타임스탬프(초)입니다. 아니오
└) 오류 OpenAI.ResponseError 모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다. 아니오
└─ ID 문자열 이 응답의 고유 식별자입니다. 아니오
└─ 불완전한 세부사항 객체 응답이 불완전한 이유에 대한 세부 정보입니다. 아니오
└) 이유 enum 응답이 불완전한 이유입니다.
가능한 값: max_output_tokenscontent_filter
아니오
└) 지침 문자열 또는 배열 모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다.

previous_response_id와 함께 사용할 경우 이전의 지침이 적용됩니다.
응답은 다음 응답으로 전달되지 않습니다. 이렇게 하면 간단해집니다.
새 응답에서 시스템(또는 개발자) 메시지를 교환합니다.
아니오
└ 최대_출력_토큰 integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한 입니다. 아니오
└max_tool_calls integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. 아니오
└) 메타데이터 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
└─ 모델 문자열 이 응답을 만드는 데 사용할 모델 배포입니다. 아니오
└─ 개체 enum 이 리소스의 개체 유형은 항상 response로 설정됩니다.
가능한 값: response
아니오
└─ 출력 array 모델에서 생성된 콘텐츠 항목의 배열입니다.

- 배열에 있는 항목의 길이와 순서가 output 종속됩니다.
모델의 응답에 따라.
- output 배열의 첫 번째 항목에 액세스하고
생성된 콘텐츠가 있는 assistant 메시지라고 가정하는 것보다
모델에서 output_text 속성을 사용하는 것을 고려해 볼 수 있습니다.
SDK에서 지원됩니다.
아니오
└output_text 문자열 집계된 텍스트 출력을 포함하는 SDK 전용 편의 속성
output_text 배열에 있는 모든 output 항목(있는 경우)에서.
Python 및 JavaScript SDK에서 지원됩니다.
아니오
└ 병렬_도구_호출 부울 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. 아니오 진실
└이전_응답_아이디 문자열 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다. 자세한 정보
대화 상태 관리
아니오
└) 프롬프트 OpenAI.Prompt 프롬프트 템플릿 및 해당 변수에 대한 참조입니다.
자세히알아보세요.
아니오
└) 추론 OpenAI.Reasoning o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.
아니오
└service_tier OpenAI.ServiceTier 참고: service_tier Azure OpenAI에는 적용되지 않습니다. 아니오
└─ 상태 enum 응답 생성의 상태입니다. 다음 중 하나인 completed, failed
in_progress, cancelled, queued 또는 incomplete.
가능한 값: completed, failed, in_progresscancelled, queuedincomplete
아니오
└structured_inputs 객체 프롬프트 템플릿 대체 또는 도구 인수 바인딩에 참여할 수 있는 응답에 대한 구조적 입력입니다. 아니오
└> 온도 숫자 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.
아니오
└) 텍스트 객체 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반
텍스트 또는 구조적 JSON 데이터일 수 있습니다. 텍스트 입력 및 출력 참조
구조적 출력
아니오
└─ 형식 OpenAI.ResponseTextFormatConfiguration 아니오
└─ 도구_선택 OpenAI.ToolChoiceOptions 또는 OpenAI.ToolChoiceObject 모델을 생성할 때 사용할 도구(또는 도구)를 선택하는 방법
응답입니다. 도구를 지정하는 방법을 알아보려면 tools 매개 변수를 참조하세요.
모델이 호출할 수 있습니다.
아니오
└도구 array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. 당신
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

* 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
웹 검색과 같은 모델의 기능
또는 파일 검색 자세한 정보
기본 제공 도구입니다.
* 함수 호출(사용자 지정 도구): 사용자가 정의한 함수
모델을 사용하여 사용자 고유의 코드를 호출할 수 있습니다. 자세한 정보
함수 호출입니다.
아니오
└ top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. 아니오
└ top_p 숫자 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.
아니오
└─ 잘림 enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled
아니오
└) 사용량 OpenAI.ResponseUsage 입력 토큰, 출력 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다.
출력 토큰 및 사용된 총 토큰의 분석입니다.
아니오
└─ 사용자 문자열 안전 모범 사례에 대해 자세히 알아보세요. 아니오
type enum 이벤트의 형식입니다. 항상 response.created입니다.
가능한 값: response.created

OpenAI.ResponseError

모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다.

이름 유형 Description 필수 기본값
코드 OpenAI.ResponseErrorCode 응답에 대한 오류 코드입니다.
메시지 문자열 사람이 읽을 수 있는 오류 설명입니다.

OpenAI.ResponseErrorCode

응답에 대한 오류 코드입니다.

재산 가치
설명 응답에 대한 오류 코드입니다.
유형 문자열
server_error
rate_limit_exceeded
invalid_prompt
vector_store_timeout
invalid_image
invalid_image_format
invalid_base64_image
invalid_image_url
image_too_large
image_too_small
image_parse_error
image_content_policy_violation
invalid_image_mode
image_file_too_large
unsupported_image_media_type
empty_image_file
failed_to_download_image
image_file_not_found

OpenAI.ResponseErrorEvent

오류가 발생할 때 내보냅니다.

이름 유형 Description 필수 기본값
코드 문자열 오류 코드입니다.
메시지 문자열 오류 메시지입니다.
param 문자열 오류 매개 변수입니다.
type enum 이벤트의 형식입니다. 항상 error입니다.
가능한 값: error

OpenAI.ResponseFailedEvent

응답이 실패할 때 내보내는 이벤트입니다.

이름 유형 Description 필수 기본값
response 객체
└) 에이전트 AgentId 이 응답에 사용되는 에이전트 아니오
└) 배경 부울 백그라운드에서 모델 응답을 실행할지 여부입니다.
배경 응답에 대해 자세히 알아봅니다.
아니오 거짓
└) 대화 객체 아니오
└─ ID 문자열 아니오
└─ 생성일시 integer 이 응답을 만든 시점의 Unix 타임스탬프(초)입니다. 아니오
└) 오류 OpenAI.ResponseError 모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다. 아니오
└─ ID 문자열 이 응답의 고유 식별자입니다. 아니오
└─ 불완전한 세부사항 객체 응답이 불완전한 이유에 대한 세부 정보입니다. 아니오
└) 이유 enum 응답이 불완전한 이유입니다.
가능한 값: max_output_tokenscontent_filter
아니오
└) 지침 문자열 또는 배열 모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다.

previous_response_id와 함께 사용할 경우 이전의 지침이 적용됩니다.
응답은 다음 응답으로 전달되지 않습니다. 이렇게 하면 간단해집니다.
새 응답에서 시스템(또는 개발자) 메시지를 교환합니다.
아니오
└ 최대_출력_토큰 integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한 입니다. 아니오
└max_tool_calls integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. 아니오
└) 메타데이터 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
└─ 모델 문자열 이 응답을 만드는 데 사용할 모델 배포입니다. 아니오
└─ 개체 enum 이 리소스의 개체 유형은 항상 response로 설정됩니다.
가능한 값: response
아니오
└─ 출력 array 모델에서 생성된 콘텐츠 항목의 배열입니다.

- 배열에 있는 항목의 길이와 순서가 output 종속됩니다.
모델의 응답에 따라.
- output 배열의 첫 번째 항목에 액세스하고
생성된 콘텐츠가 있는 assistant 메시지라고 가정하는 것보다
모델에서 output_text 속성을 사용하는 것을 고려해 볼 수 있습니다.
SDK에서 지원됩니다.
아니오
└output_text 문자열 집계된 텍스트 출력을 포함하는 SDK 전용 편의 속성
output_text 배열에 있는 모든 output 항목(있는 경우)에서.
Python 및 JavaScript SDK에서 지원됩니다.
아니오
└ 병렬_도구_호출 부울 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. 아니오 진실
└이전_응답_아이디 문자열 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다. 자세한 정보
대화 상태 관리
아니오
└) 프롬프트 OpenAI.Prompt 프롬프트 템플릿 및 해당 변수에 대한 참조입니다.
자세히알아보세요.
아니오
└) 추론 OpenAI.Reasoning o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.
아니오
└service_tier OpenAI.ServiceTier 참고: service_tier Azure OpenAI에는 적용되지 않습니다. 아니오
└─ 상태 enum 응답 생성의 상태입니다. 다음 중 하나인 completed, failed
in_progress, cancelled, queued 또는 incomplete.
가능한 값: completed, failed, in_progresscancelled, queuedincomplete
아니오
└structured_inputs 객체 프롬프트 템플릿 대체 또는 도구 인수 바인딩에 참여할 수 있는 응답에 대한 구조적 입력입니다. 아니오
└> 온도 숫자 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.
아니오
└) 텍스트 객체 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반
텍스트 또는 구조적 JSON 데이터일 수 있습니다. 텍스트 입력 및 출력 참조
구조적 출력
아니오
└─ 형식 OpenAI.ResponseTextFormatConfiguration 아니오
└─ 도구_선택 OpenAI.ToolChoiceOptions 또는 OpenAI.ToolChoiceObject 모델을 생성할 때 사용할 도구(또는 도구)를 선택하는 방법
응답입니다. 도구를 지정하는 방법을 알아보려면 tools 매개 변수를 참조하세요.
모델이 호출할 수 있습니다.
아니오
└도구 array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. 당신
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

* 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
웹 검색과 같은 모델의 기능
또는 파일 검색 자세한 정보
기본 제공 도구입니다.
* 함수 호출(사용자 지정 도구): 사용자가 정의한 함수
모델을 사용하여 사용자 고유의 코드를 호출할 수 있습니다. 자세한 정보
함수 호출입니다.
아니오
└ top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. 아니오
└ top_p 숫자 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.
아니오
└─ 잘림 enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled
아니오
└) 사용량 OpenAI.ResponseUsage 입력 토큰, 출력 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다.
출력 토큰 및 사용된 총 토큰의 분석입니다.
아니오
└─ 사용자 문자열 안전 모범 사례에 대해 자세히 알아보세요. 아니오
type enum 이벤트의 형식입니다. 항상 response.failed입니다.
가능한 값: response.failed

OpenAI.ResponseFileSearchCallCompletedEvent

파일 검색 호출이 완료될 때 내보내집니다(결과를 찾은 경우).

이름 유형 Description 필수 기본값
item_id 문자열 파일 검색 호출이 시작되는 출력 항목의 ID입니다.
output_index integer 파일 검색 호출이 시작되는 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.file_search_call.completed입니다.
가능한 값: response.file_search_call.completed

OpenAI.ResponseFileSearchCallInProgressEvent

파일 검색 호출이 시작될 때 내보내집니다.

이름 유형 Description 필수 기본값
item_id 문자열 파일 검색 호출이 시작되는 출력 항목의 ID입니다.
output_index integer 파일 검색 호출이 시작되는 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.file_search_call.in_progress입니다.
가능한 값: response.file_search_call.in_progress

OpenAI.ResponseFileSearchCallSearchingEvent

파일 검색이 현재 검색 중일 때 내보내집니다.

이름 유형 Description 필수 기본값
item_id 문자열 파일 검색 호출이 시작되는 출력 항목의 ID입니다.
output_index integer 파일 검색 호출에서 검색하는 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.file_search_call.searching입니다.
가능한 값: response.file_search_call.searching

OpenAI.ResponseFormat

OpenAI.ResponseFormat에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
json_object OpenAI.ResponseFormatJsonObject
json_schema OpenAI.ResponseFormatJsonSchema
이름 유형 Description 필수 기본값
type enum
가능한 값: text, json_objectjson_schema

OpenAI.ResponseFormatJsonObject

JSON 개체 응답 형식입니다. JSON 응답을 생성하는 이전 메서드입니다. 이를 지원하는 모델에는 사용하는 json_schema 것이 좋습니다. 모델에서 JSON을 생성하도록 지시하는 시스템 또는 사용자 메시지 없이는 JSON을 생성하지 않습니다.

이름 유형 Description 필수 기본값
type enum 정의되는 응답 형식의 유형입니다. 항상 json_object입니다.
가능한 값: json_object

OpenAI.ResponseFormatJsonSchema

JSON 스키마 개체로 설명되는 응답 형식에 대한 스키마입니다. 여기에서 JSON 스키마를 빌드하는 방법을 알아봅니 . JSON 스키마 응답 형식입니다. 구조적 JSON 응답을 생성하는 데 사용됩니다. 구조적 출력에 대해 자세히 알아보세요.

이름 유형 Description 필수 기본값
JSON 스키마 객체 JSON 스키마를 비롯한 구조적 출력 구성 옵션입니다.
└) 설명 문자열 이 응답 형식이 모델에서 어떻게 사용되는지에 대한 설명입니다.
형식에 맞춰 응답하는 방법을 결정합니다.
아니오
└) 이름 문자열 응답 형식의 이름입니다. a-z, A-Z, 0-9 또는 포함해야 합니다.
최대 길이가 64인 경우, 밑줄과 대시를 사용하세요.
아니오
└─ 스키마 객체 아니오
└─ 엄격한 부울 출력을 생성할 때 엄격한 스키마 준수를 사용하도록 설정할지 여부입니다.
true로 설정하면 모델은 항상 정의된 정확한 스키마를 따릅니다.
schema 필드에 있습니다. JSON 스키마의 하위 집합만 지원되는 경우
stricttrue입니다. 자세한 내용은 구조적 출력
가이드
를 읽어보세요.
아니오 거짓
type enum 정의되는 응답 형식의 유형입니다. 항상 json_schema입니다.
가능한 값: json_schema

OpenAI.ResponseFormatText

기본 응답 형식입니다. 텍스트 응답을 생성하는 데 사용됩니다.

이름 유형 Description 필수 기본값
type enum 정의되는 응답 형식의 유형입니다. 항상 text입니다.
가능한 값: text

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

부분 함수 호출 인수 델타가 있을 때 내보내집니다.

이름 유형 Description 필수 기본값
delta 문자열 추가되는 함수 호출 인수 델타입니다.
item_id 문자열 함수 호출 인수 델타가 추가되는 출력 항목의 ID입니다.
output_index integer 함수 호출 인수 델타가 추가되는 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.function_call_arguments.delta입니다.
가능한 값: response.function_call_arguments.delta

OpenAI.ResponseFunctionCallArgumentsDoneEvent

함수 호출 인수가 종료될 때 내보내집니다.

이름 유형 Description 필수 기본값
arguments 문자열 함수 호출 인수입니다.
item_id 문자열 항목의 ID입니다.
output_index integer 출력 항목의 인덱스입니다.
type enum
가능한 값: response.function_call_arguments.done

OpenAI.ResponseImageGenCallCompletedEvent

이미지 생성 도구 호출이 완료되고 최종 이미지를 사용할 수 있을 때 내보내집니다.

이름 유형 Description 필수 기본값
item_id 문자열 처리 중인 이미지 생성 항목의 고유 식별자입니다.
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 언제나 'response.image_generation_call.completed'로 표시됩니다.
가능한 값: response.image_generation_call.completed

OpenAI.ResponseImageGenCallGeneratingEvent

이미지 생성 도구 호출이 이미지(중간 상태)를 적극적으로 생성할 때 내보내집니다.

이름 유형 Description 필수 기본값
item_id 문자열 처리 중인 이미지 생성 항목의 고유 식별자입니다.
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 'response.image_generation_call.generating'입니다.
가능한 값: response.image_generation_call.generating

OpenAI.ResponseImageGenCallInProgressEvent

이미지 생성 도구 호출이 진행 중일 때 내보내집니다.

이름 유형 Description 필수 기본값
item_id 문자열 처리 중인 이미지 생성 항목의 고유 식별자입니다.
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 'response.image_generation_call.in_progress'입니다.
가능한 값: response.image_generation_call.in_progress

OpenAI.ResponseImageGenCallPartialImageEvent

이미지 생성 스트리밍 중에 부분 이미지를 사용할 수 있을 때 내보내집니다.

이름 유형 Description 필수 기본값
item_id 문자열 처리 중인 이미지 생성 항목의 고유 식별자입니다.
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다.
partial_image_b64 문자열 Base64로 인코딩된 부분 이미지 데이터로, 이미지로 렌더링하는 데 적합합니다.
partial_image_index integer 부분 이미지에 대한 0부터 시작하는 인덱스입니다(백 엔드는 1 기반이지만 사용자의 경우 0 기반).
type enum 이벤트의 형식입니다. 항상 'response.image_generation_call.partial_image'입니다.
가능한 값: response.image_generation_call.partial_image

OpenAI.ResponseInProgressEvent

응답이 진행 중일 때 내보내집니다.

이름 유형 Description 필수 기본값
response 객체
└) 에이전트 AgentId 이 응답에 사용되는 에이전트 아니오
└) 배경 부울 백그라운드에서 모델 응답을 실행할지 여부입니다.
배경 응답에 대해 자세히 알아봅니다.
아니오 거짓
└) 대화 객체 아니오
└─ ID 문자열 아니오
└─ 생성일시 integer 이 응답을 만든 시점의 Unix 타임스탬프(초)입니다. 아니오
└) 오류 OpenAI.ResponseError 모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다. 아니오
└─ ID 문자열 이 응답의 고유 식별자입니다. 아니오
└─ 불완전한 세부사항 객체 응답이 불완전한 이유에 대한 세부 정보입니다. 아니오
└) 이유 enum 응답이 불완전한 이유입니다.
가능한 값: max_output_tokenscontent_filter
아니오
└) 지침 문자열 또는 배열 모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다.

previous_response_id와 함께 사용할 경우 이전의 지침이 적용됩니다.
응답은 다음 응답으로 전달되지 않습니다. 이렇게 하면 간단해집니다.
새 응답에서 시스템(또는 개발자) 메시지를 교환합니다.
아니오
└ 최대_출력_토큰 integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한 입니다. 아니오
└max_tool_calls integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. 아니오
└) 메타데이터 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
└─ 모델 문자열 이 응답을 만드는 데 사용할 모델 배포입니다. 아니오
└─ 개체 enum 이 리소스의 개체 유형은 항상 response로 설정됩니다.
가능한 값: response
아니오
└─ 출력 array 모델에서 생성된 콘텐츠 항목의 배열입니다.

- 배열에 있는 항목의 길이와 순서가 output 종속됩니다.
모델의 응답에 따라.
- output 배열의 첫 번째 항목에 액세스하고
생성된 콘텐츠가 있는 assistant 메시지라고 가정하는 것보다
모델에서 output_text 속성을 사용하는 것을 고려해 볼 수 있습니다.
SDK에서 지원됩니다.
아니오
└output_text 문자열 집계된 텍스트 출력을 포함하는 SDK 전용 편의 속성
output_text 배열에 있는 모든 output 항목(있는 경우)에서.
Python 및 JavaScript SDK에서 지원됩니다.
아니오
└ 병렬_도구_호출 부울 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. 아니오 진실
└이전_응답_아이디 문자열 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다. 자세한 정보
대화 상태 관리
아니오
└) 프롬프트 OpenAI.Prompt 프롬프트 템플릿 및 해당 변수에 대한 참조입니다.
자세히알아보세요.
아니오
└) 추론 OpenAI.Reasoning o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.
아니오
└service_tier OpenAI.ServiceTier 참고: service_tier Azure OpenAI에는 적용되지 않습니다. 아니오
└─ 상태 enum 응답 생성의 상태입니다. 다음 중 하나인 completed, failed
in_progress, cancelled, queued 또는 incomplete.
가능한 값: completed, failed, in_progresscancelled, queuedincomplete
아니오
└structured_inputs 객체 프롬프트 템플릿 대체 또는 도구 인수 바인딩에 참여할 수 있는 응답에 대한 구조적 입력입니다. 아니오
└> 온도 숫자 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.
아니오
└) 텍스트 객체 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반
텍스트 또는 구조적 JSON 데이터일 수 있습니다. 텍스트 입력 및 출력 참조
구조적 출력
아니오
└─ 형식 OpenAI.ResponseTextFormatConfiguration 아니오
└─ 도구_선택 OpenAI.ToolChoiceOptions 또는 OpenAI.ToolChoiceObject 모델을 생성할 때 사용할 도구(또는 도구)를 선택하는 방법
응답입니다. 도구를 지정하는 방법을 알아보려면 tools 매개 변수를 참조하세요.
모델이 호출할 수 있습니다.
아니오
└도구 array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. 당신
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

* 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
웹 검색과 같은 모델의 기능
또는 파일 검색 자세한 정보
기본 제공 도구입니다.
* 함수 호출(사용자 지정 도구): 사용자가 정의한 함수
모델을 사용하여 사용자 고유의 코드를 호출할 수 있습니다. 자세한 정보
함수 호출입니다.
아니오
└ top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. 아니오
└ top_p 숫자 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.
아니오
└─ 잘림 enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled
아니오
└) 사용량 OpenAI.ResponseUsage 입력 토큰, 출력 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다.
출력 토큰 및 사용된 총 토큰의 분석입니다.
아니오
└─ 사용자 문자열 안전 모범 사례에 대해 자세히 알아보세요. 아니오
type enum 이벤트의 형식입니다. 항상 response.in_progress입니다.
가능한 값: response.in_progress

OpenAI.ResponseIncompleteEvent

응답이 완료되지 않은 것으로 완료될 때 내보내지는 이벤트입니다.

이름 유형 Description 필수 기본값
response 객체
└) 에이전트 AgentId 이 응답에 사용되는 에이전트 아니오
└) 배경 부울 백그라운드에서 모델 응답을 실행할지 여부입니다.
배경 응답에 대해 자세히 알아봅니다.
아니오 거짓
└) 대화 객체 아니오
└─ ID 문자열 아니오
└─ 생성일시 integer 이 응답을 만든 시점의 Unix 타임스탬프(초)입니다. 아니오
└) 오류 OpenAI.ResponseError 모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다. 아니오
└─ ID 문자열 이 응답의 고유 식별자입니다. 아니오
└─ 불완전한 세부사항 객체 응답이 불완전한 이유에 대한 세부 정보입니다. 아니오
└) 이유 enum 응답이 불완전한 이유입니다.
가능한 값: max_output_tokenscontent_filter
아니오
└) 지침 문자열 또는 배열 모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다.

previous_response_id와 함께 사용할 경우 이전의 지침이 적용됩니다.
응답은 다음 응답으로 전달되지 않습니다. 이렇게 하면 간단해집니다.
새 응답에서 시스템(또는 개발자) 메시지를 교환합니다.
아니오
└ 최대_출력_토큰 integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한 입니다. 아니오
└max_tool_calls integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. 아니오
└) 메타데이터 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
└─ 모델 문자열 이 응답을 만드는 데 사용할 모델 배포입니다. 아니오
└─ 개체 enum 이 리소스의 개체 유형은 항상 response로 설정됩니다.
가능한 값: response
아니오
└─ 출력 array 모델에서 생성된 콘텐츠 항목의 배열입니다.

- 배열에 있는 항목의 길이와 순서가 output 종속됩니다.
모델의 응답에 따라.
- output 배열의 첫 번째 항목에 액세스하고
생성된 콘텐츠가 있는 assistant 메시지라고 가정하는 것보다
모델에서 output_text 속성을 사용하는 것을 고려해 볼 수 있습니다.
SDK에서 지원됩니다.
아니오
└output_text 문자열 집계된 텍스트 출력을 포함하는 SDK 전용 편의 속성
output_text 배열에 있는 모든 output 항목(있는 경우)에서.
Python 및 JavaScript SDK에서 지원됩니다.
아니오
└ 병렬_도구_호출 부울 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. 아니오 진실
└이전_응답_아이디 문자열 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다. 자세한 정보
대화 상태 관리
아니오
└) 프롬프트 OpenAI.Prompt 프롬프트 템플릿 및 해당 변수에 대한 참조입니다.
자세히알아보세요.
아니오
└) 추론 OpenAI.Reasoning o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.
아니오
└service_tier OpenAI.ServiceTier 참고: service_tier Azure OpenAI에는 적용되지 않습니다. 아니오
└─ 상태 enum 응답 생성의 상태입니다. 다음 중 하나인 completed, failed
in_progress, cancelled, queued 또는 incomplete.
가능한 값: completed, failed, in_progresscancelled, queuedincomplete
아니오
└structured_inputs 객체 프롬프트 템플릿 대체 또는 도구 인수 바인딩에 참여할 수 있는 응답에 대한 구조적 입력입니다. 아니오
└> 온도 숫자 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.
아니오
└) 텍스트 객체 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반
텍스트 또는 구조적 JSON 데이터일 수 있습니다. 텍스트 입력 및 출력 참조
구조적 출력
아니오
└─ 형식 OpenAI.ResponseTextFormatConfiguration 아니오
└─ 도구_선택 OpenAI.ToolChoiceOptions 또는 OpenAI.ToolChoiceObject 모델을 생성할 때 사용할 도구(또는 도구)를 선택하는 방법
응답입니다. 도구를 지정하는 방법을 알아보려면 tools 매개 변수를 참조하세요.
모델이 호출할 수 있습니다.
아니오
└도구 array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. 당신
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

* 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
웹 검색과 같은 모델의 기능
또는 파일 검색 자세한 정보
기본 제공 도구입니다.
* 함수 호출(사용자 지정 도구): 사용자가 정의한 함수
모델을 사용하여 사용자 고유의 코드를 호출할 수 있습니다. 자세한 정보
함수 호출입니다.
아니오
└ top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. 아니오
└ top_p 숫자 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.
아니오
└─ 잘림 enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled
아니오
└) 사용량 OpenAI.ResponseUsage 입력 토큰, 출력 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다.
출력 토큰 및 사용된 총 토큰의 분석입니다.
아니오
└─ 사용자 문자열 안전 모범 사례에 대해 자세히 알아보세요. 아니오
type enum 이벤트의 형식입니다. 항상 response.incomplete입니다.
가능한 값: response.incomplete

OpenAI.ResponseMCPCallArgumentsDeltaEvent

MCP 도구 호출의 인수에 대한 델타(부분 업데이트)가 있을 때 내보내집니다.

이름 유형 Description 필수 기본값
delta MCP 도구 호출에 대한 인수에 대한 부분 업데이트입니다.
item_id 문자열 처리 중인 MCP 도구 호출 항목의 고유 식별자입니다.
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 해당 값은 항상 'response.mcp_call.arguments_delta'입니다.
가능한 값: response.mcp_call.arguments_delta

OpenAI.ResponseMCPCallArgumentsDoneEvent

MCP 도구 호출에 대한 인수가 종료될 때 내보내집니다.

이름 유형 Description 필수 기본값
arguments MCP 도구 호출에 대한 최종 인수입니다.
item_id 문자열 처리 중인 MCP 도구 호출 항목의 고유 식별자입니다.
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 'response.mcp_call.arguments_done'입니다.
가능한 값: response.mcp_call.arguments_done

OpenAI.ResponseMCPCallCompletedEvent

MCP 도구 호출이 성공적으로 완료되면 내보냅니다.

이름 유형 Description 필수 기본값
type enum 이벤트의 형식입니다. 항상 'response.mcp_call.completed'입니다.
가능한 값: response.mcp_call.completed

OpenAI.ResponseMCPCallFailedEvent

MCP 도구 호출이 실패했을 때 내보냅니다.

이름 유형 Description 필수 기본값
type enum 이벤트의 형식입니다. 항상 'response.mcp_call.failed'입니다.
가능한 값: response.mcp_call.failed

OpenAI.ResponseMCPCallInProgressEvent

MCP 도구 호출이 진행 중일 때 내보내집니다.

이름 유형 Description 필수 기본값
item_id 문자열 처리 중인 MCP 도구 호출 항목의 고유 식별자입니다.
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 'response.mcp_call.in_progress'입니다.
가능한 값: response.mcp_call.in_progress

OpenAI.ResponseMCPListToolsCompletedEvent

사용 가능한 MCP 도구 목록을 성공적으로 검색한 경우 내보냅니다.

이름 유형 Description 필수 기본값
type enum 이벤트의 형식입니다. 항상 'response.mcp_list_tools.completed'입니다.
가능한 값: response.mcp_list_tools.completed

OpenAI.ResponseMCPListToolsFailedEvent

사용 가능한 MCP 도구를 나열하지 못한 경우 내보냅니다.

이름 유형 Description 필수 기본값
type enum 이벤트의 형식입니다. 항상 'response.mcp_list_tools.failed'입니다.
가능한 값: response.mcp_list_tools.failed

OpenAI.ResponseMCPListToolsInProgressEvent

시스템이 사용 가능한 MCP 도구 목록을 검색하는 중일 때 내보내집니다.

이름 유형 Description 필수 기본값
type enum 이벤트의 형식입니다. 항상 'response.mcp_list_tools.in_progress'입니다.
가능한 값: response.mcp_list_tools.in_progress

OpenAI.ResponseOutputItemAddedEvent

새 출력 항목이 추가될 때 내보내집니다.

이름 유형 Description 필수 기본값
물품 객체 응답을 생성하는 데 사용되는 콘텐츠 항목입니다.
└created_by 만든 사람 항목 작성자에 대한 정보 아니오
└─ ID 문자열 아니오
└─ 형식 OpenAI.ItemType 아니오
output_index integer 추가된 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.output_item.added입니다.
가능한 값: response.output_item.added

OpenAI.ResponseOutputItemDoneEvent

출력 항목이 완료된 것으로 표시될 때 내보내집니다.

이름 유형 Description 필수 기본값
물품 객체 응답을 생성하는 데 사용되는 콘텐츠 항목입니다.
└created_by 만든 사람 항목 작성자에 대한 정보 아니오
└─ ID 문자열 아니오
└─ 형식 OpenAI.ItemType 아니오
output_index integer 완료된 것으로 표시된 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.output_item.done입니다.
가능한 값: response.output_item.done

OpenAI.ResponsePromptVariables

프롬프트에서 변수를 대체할 값의 선택적 맵입니다. 대체 값은 문자열이거나 이미지 또는 파일과 같은 다른 응답 입력 형식일 수 있습니다.

Type: 객체

OpenAI.ResponseQueuedEvent

응답이 큐에 대기되고 처리되기를 기다리는 경우 내보내집니다.

이름 유형 Description 필수 기본값
response 객체
└) 에이전트 AgentId 이 응답에 사용되는 에이전트 아니오
└) 배경 부울 백그라운드에서 모델 응답을 실행할지 여부입니다.
배경 응답에 대해 자세히 알아봅니다.
아니오 거짓
└) 대화 객체 아니오
└─ ID 문자열 아니오
└─ 생성일시 integer 이 응답을 만든 시점의 Unix 타임스탬프(초)입니다. 아니오
└) 오류 OpenAI.ResponseError 모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다. 아니오
└─ ID 문자열 이 응답의 고유 식별자입니다. 아니오
└─ 불완전한 세부사항 객체 응답이 불완전한 이유에 대한 세부 정보입니다. 아니오
└) 이유 enum 응답이 불완전한 이유입니다.
가능한 값: max_output_tokenscontent_filter
아니오
└) 지침 문자열 또는 배열 모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다.

previous_response_id와 함께 사용할 경우 이전의 지침이 적용됩니다.
응답은 다음 응답으로 전달되지 않습니다. 이렇게 하면 간단해집니다.
새 응답에서 시스템(또는 개발자) 메시지를 교환합니다.
아니오
└ 최대_출력_토큰 integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한 입니다. 아니오
└max_tool_calls integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. 아니오
└) 메타데이터 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
└─ 모델 문자열 이 응답을 만드는 데 사용할 모델 배포입니다. 아니오
└─ 개체 enum 이 리소스의 개체 유형은 항상 response로 설정됩니다.
가능한 값: response
아니오
└─ 출력 array 모델에서 생성된 콘텐츠 항목의 배열입니다.

- 배열에 있는 항목의 길이와 순서가 output 종속됩니다.
모델의 응답에 따라.
- output 배열의 첫 번째 항목에 액세스하고
생성된 콘텐츠가 있는 assistant 메시지라고 가정하는 것보다
모델에서 output_text 속성을 사용하는 것을 고려해 볼 수 있습니다.
SDK에서 지원됩니다.
아니오
└output_text 문자열 집계된 텍스트 출력을 포함하는 SDK 전용 편의 속성
output_text 배열에 있는 모든 output 항목(있는 경우)에서.
Python 및 JavaScript SDK에서 지원됩니다.
아니오
└ 병렬_도구_호출 부울 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. 아니오 진실
└이전_응답_아이디 문자열 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다. 자세한 정보
대화 상태 관리
아니오
└) 프롬프트 OpenAI.Prompt 프롬프트 템플릿 및 해당 변수에 대한 참조입니다.
자세히알아보세요.
아니오
└) 추론 OpenAI.Reasoning o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.
아니오
└service_tier OpenAI.ServiceTier 참고: service_tier Azure OpenAI에는 적용되지 않습니다. 아니오
└─ 상태 enum 응답 생성의 상태입니다. 다음 중 하나인 completed, failed
in_progress, cancelled, queued 또는 incomplete.
가능한 값: completed, failed, in_progresscancelled, queuedincomplete
아니오
└structured_inputs 객체 프롬프트 템플릿 대체 또는 도구 인수 바인딩에 참여할 수 있는 응답에 대한 구조적 입력입니다. 아니오
└> 온도 숫자 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.
아니오
└) 텍스트 객체 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반
텍스트 또는 구조적 JSON 데이터일 수 있습니다. 텍스트 입력 및 출력 참조
구조적 출력
아니오
└─ 형식 OpenAI.ResponseTextFormatConfiguration 아니오
└─ 도구_선택 OpenAI.ToolChoiceOptions 또는 OpenAI.ToolChoiceObject 모델을 생성할 때 사용할 도구(또는 도구)를 선택하는 방법
응답입니다. 도구를 지정하는 방법을 알아보려면 tools 매개 변수를 참조하세요.
모델이 호출할 수 있습니다.
아니오
└도구 array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. 당신
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

* 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
웹 검색과 같은 모델의 기능
또는 파일 검색 자세한 정보
기본 제공 도구입니다.
* 함수 호출(사용자 지정 도구): 사용자가 정의한 함수
모델을 사용하여 사용자 고유의 코드를 호출할 수 있습니다. 자세한 정보
함수 호출입니다.
아니오
└ top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. 아니오
└ top_p 숫자 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.
아니오
└─ 잘림 enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled
아니오
└) 사용량 OpenAI.ResponseUsage 입력 토큰, 출력 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다.
출력 토큰 및 사용된 총 토큰의 분석입니다.
아니오
└─ 사용자 문자열 안전 모범 사례에 대해 자세히 알아보세요. 아니오
type enum 이벤트의 형식입니다. 항상 'response.queued'입니다.
가능한 값: response.queued

OpenAI.ResponseReasoningDeltaEvent

추론 콘텐츠에 대한 델타(부분 업데이트)가 있을 때 내보내집니다.

이름 유형 Description 필수 기본값
content_index integer 출력 항목 내의 추론 콘텐츠 부분의 인덱스입니다.
delta 추론 콘텐츠에 대한 부분 업데이트입니다.
item_id 문자열 추론이 업데이트되는 항목의 고유 식별자입니다.
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 'response.reasoning.delta'입니다.
가능한 값: response.reasoning.delta

OpenAI.ResponseReasoningDoneEvent

항목에 대한 추론 콘텐츠가 종료될 때 내보내집니다.

이름 유형 Description 필수 기본값
content_index integer 출력 항목 내의 추론 콘텐츠 부분의 인덱스입니다.
item_id 문자열 추론이 완료되는 항목의 고유 식별자입니다.
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다.
문자 메시지 문자열 완료된 추론 텍스트입니다.
type enum 이벤트의 형식입니다. 항상 'response.reasoning.done'입니다.
가능한 값: response.reasoning.done

OpenAI.ResponseReasoningSummaryDeltaEvent

추론 요약 콘텐츠에 대한 델타(부분 업데이트)가 있을 때 내보내집니다.

이름 유형 Description 필수 기본값
delta 추론 요약 콘텐츠에 대한 부분 업데이트입니다.
item_id 문자열 추론 요약이 업데이트되는 항목의 고유 식별자입니다.
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다.
summary_index integer 출력 항목 내의 요약 부분 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 'response.reasoning_summary.delta'입니다.
가능한 값: response.reasoning_summary.delta

OpenAI.ResponseReasoningSummaryDoneEvent

항목에 대한 추론 요약 콘텐츠가 완료될 때 내보내집니다.

이름 유형 Description 필수 기본값
item_id 문자열 추론 요약이 완료되는 항목의 고유 식별자입니다.
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다.
summary_index integer 출력 항목 내의 요약 부분 인덱스입니다.
문자 메시지 문자열 완료된 추론 요약 텍스트입니다.
type enum 이벤트의 형식입니다. 항상 'response.reasoning_summary.done'.
가능한 값: response.reasoning_summary.done

OpenAI.ResponseReasoningSummaryPartAddedEvent

새 추론 요약 부분이 추가될 때 내보내집니다.

이름 유형 Description 필수 기본값
item_id 문자열 이 요약 파트가 연결된 항목의 ID입니다.
output_index integer 이 요약 부분이 연결된 출력 항목의 인덱스입니다.
part 객체
└─ 형식 OpenAI.ReasoningItemSummaryPartType 아니오
summary_index integer 추론 요약 내의 요약 부분 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.reasoning_summary_part.added입니다.
가능한 값: response.reasoning_summary_part.added

OpenAI.ResponseReasoningSummaryPartDoneEvent

추론 요약 부분이 완료될 때 내보내집니다.

이름 유형 Description 필수 기본값
item_id 문자열 이 요약 파트가 연결된 항목의 ID입니다.
output_index integer 이 요약 부분이 연결된 출력 항목의 인덱스입니다.
part 객체
└─ 형식 OpenAI.ReasoningItemSummaryPartType 아니오
summary_index integer 추론 요약 내의 요약 부분 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.reasoning_summary_part.done입니다.
가능한 값: response.reasoning_summary_part.done

OpenAI.ResponseReasoningSummaryTextDeltaEvent

추론 요약 텍스트에 델타가 추가될 때 내보내집니다.

이름 유형 Description 필수 기본값
delta 문자열 요약에 추가된 텍스트 델타입니다.
item_id 문자열 이 요약 텍스트 델타가 연결된 항목의 ID입니다.
output_index integer 이 요약 텍스트 델타와 관련된 출력 항목의 인덱스입니다.
summary_index integer 추론 요약 내의 요약 부분 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.reasoning_summary_text.delta입니다.
가능한 값: response.reasoning_summary_text.delta

OpenAI.ResponseReasoningSummaryTextDoneEvent

추론 요약 텍스트가 완료될 때 내보내집니다.

이름 유형 Description 필수 기본값
item_id 문자열 이 요약 텍스트가 연결된 항목의 ID입니다.
output_index integer 이 요약 텍스트가 연결된 출력 항목의 인덱스입니다.
summary_index integer 추론 요약 내의 요약 부분 인덱스입니다.
문자 메시지 문자열 완료된 추론 요약의 전체 텍스트입니다.
type enum 이벤트의 형식입니다. 항상 response.reasoning_summary_text.done입니다.
가능한 값: response.reasoning_summary_text.done

OpenAI.ResponseRefusalDeltaEvent

부분 거부 텍스트가 있을 때 내보냅니다.

이름 유형 Description 필수 기본값
content_index integer 거부 텍스트가 추가되는 콘텐츠 부분의 인덱스입니다.
delta 문자열 추가되는 거부 텍스트입니다.
item_id 문자열 거부 텍스트가 추가되는 출력 항목의 ID입니다.
output_index integer 거부 텍스트가 추가되는 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.refusal.delta입니다.
가능한 값: response.refusal.delta

OpenAI.ResponseRefusalDoneEvent

거부 텍스트가 종료될 때 내보내집니다.

이름 유형 Description 필수 기본값
content_index integer 거부 텍스트가 완료된 콘텐츠 부분의 인덱스입니다.
item_id 문자열 거부 텍스트가 완료된 출력 항목의 ID입니다.
output_index integer 거부 텍스트가 완료된 출력 항목의 인덱스입니다.
refusal 문자열 최종 거부 텍스트입니다.
type enum 이벤트의 형식입니다. 항상 response.refusal.done입니다.
가능한 값: response.refusal.done

OpenAI.ResponseStreamEvent

OpenAI.ResponseStreamEvent에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
response.completed OpenAI.ResponseCompletedEvent
response.content_part.added OpenAI.ResponseContentPartAddedEvent
response.content_part.done OpenAI.ResponseContentPartDoneEvent
response.created OpenAI.ResponseCreatedEvent
error OpenAI.ResponseErrorEvent
response.file_search_call.completed OpenAI.ResponseFileSearchCallCompletedEvent
response.file_search_call.in_progress OpenAI.ResponseFileSearchCallInProgressEvent
response.file_search_call.searching OpenAI.ResponseFileSearchCallSearchingEvent
response.function_call_arguments.delta OpenAI.ResponseFunctionCallArgumentsDeltaEvent
response.function_call_arguments.done OpenAI.ResponseFunctionCallArgumentsDoneEvent
response.in_progress OpenAI.ResponseInProgressEvent
response.failed OpenAI.ResponseFailedEvent
response.incomplete OpenAI.ResponseIncompleteEvent
response.output_item.added OpenAI.ResponseOutputItemAddedEvent
response.output_item.done OpenAI.ResponseOutputItemDoneEvent
response.refusal.delta OpenAI.ResponseRefusalDeltaEvent
response.refusal.done OpenAI.ResponseRefusalDoneEvent
response.output_text.delta OpenAI.ResponseTextDeltaEvent
response.output_text.done OpenAI.ResponseTextDoneEvent
response.reasoning_summary_part.added OpenAI.ResponseReasoningSummaryPartAddedEvent
response.reasoning_summary_part.done OpenAI.ResponseReasoningSummaryPartDoneEvent
response.reasoning_summary_text.delta OpenAI.ResponseReasoningSummaryTextDeltaEvent
response.reasoning_summary_text.done OpenAI.ResponseReasoningSummaryTextDoneEvent
response.web_search_call.completed OpenAI.ResponseWebSearchCallCompletedEvent
response.web_search_call.in_progress OpenAI.ResponseWebSearchCallInProgressEvent
response.web_search_call.searching OpenAI.ResponseWebSearchCallSearchingEvent
response.image_generation_call.completed OpenAI.ResponseImageGenCallCompletedEvent
response.image_generation_call.generating OpenAI.ResponseImageGenCallGeneratingEvent
response.image_generation_call.in_progress OpenAI.ResponseImageGenCallInProgressEvent
response.image_generation_call.partial_image OpenAI.ResponseImageGenCallPartialImageEvent
response.mcp_call.arguments_delta OpenAI.ResponseMCPCallArgumentsDeltaEvent
response.mcp_call.arguments_done OpenAI.ResponseMCPCallArgumentsDoneEvent
response.mcp_call.completed OpenAI.ResponseMCPCallCompletedEvent
response.mcp_call.failed OpenAI.ResponseMCPCallFailedEvent
response.mcp_call.in_progress OpenAI.ResponseMCPCallInProgressEvent
response.mcp_list_tools.completed OpenAI.ResponseMCPListToolsCompletedEvent
response.mcp_list_tools.failed OpenAI.ResponseMCPListToolsFailedEvent
response.mcp_list_tools.in_progress OpenAI.ResponseMCPListToolsInProgressEvent
response.queued OpenAI.ResponseQueuedEvent
response.reasoning.delta OpenAI.ResponseReasoningDeltaEvent
response.reasoning.done OpenAI.ResponseReasoningDoneEvent
response.reasoning_summary.delta OpenAI.ResponseReasoningSummaryDeltaEvent
response.reasoning_summary.done OpenAI.ResponseReasoningSummaryDoneEvent
response.code_interpreter_call_code.delta OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
response.code_interpreter_call_code.done OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
response.code_interpreter_call.completed OpenAI.ResponseCodeInterpreterCallCompletedEvent
response.code_interpreter_call.in_progress OpenAI.ResponseCodeInterpreterCallInProgressEvent
response.code_interpreter_call.interpreting OpenAI.ResponseCodeInterpreterCallInterpretingEvent
이름 유형 Description 필수 기본값
sequence_number integer 이 이벤트의 시퀀스 번호입니다.
type OpenAI.ResponseStreamEventType

OpenAI.ResponseStreamEventType

재산 가치
유형 문자열
response.audio.delta
response.audio.done
response.audio_transcript.delta
response.audio_transcript.done
response.code_interpreter_call_code.delta
response.code_interpreter_call_code.done
response.code_interpreter_call.completed
response.code_interpreter_call.in_progress
response.code_interpreter_call.interpreting
response.completed
response.content_part.added
response.content_part.done
response.created
error
response.file_search_call.completed
response.file_search_call.in_progress
response.file_search_call.searching
response.function_call_arguments.delta
response.function_call_arguments.done
response.in_progress
response.failed
response.incomplete
response.output_item.added
response.output_item.done
response.refusal.delta
response.refusal.done
response.output_text.annotation.added
response.output_text.delta
response.output_text.done
response.reasoning_summary_part.added
response.reasoning_summary_part.done
response.reasoning_summary_text.delta
response.reasoning_summary_text.done
response.web_search_call.completed
response.web_search_call.in_progress
response.web_search_call.searching
response.image_generation_call.completed
response.image_generation_call.generating
response.image_generation_call.in_progress
response.image_generation_call.partial_image
response.mcp_call.arguments_delta
response.mcp_call.arguments_done
response.mcp_call.completed
response.mcp_call.failed
response.mcp_call.in_progress
response.mcp_list_tools.completed
response.mcp_list_tools.failed
response.mcp_list_tools.in_progress
response.queued
response.reasoning.delta
response.reasoning.done
response.reasoning_summary.delta
response.reasoning_summary.done

OpenAI.ResponseTextDeltaEvent

추가 텍스트 델타가 있을 때 내보냅니다.

이름 유형 Description 필수 기본값
content_index integer 텍스트 델타가 추가된 콘텐츠 부분의 인덱스입니다.
delta 문자열 추가된 텍스트 델타입니다.
item_id 문자열 텍스트 델타가 추가된 출력 항목의 ID입니다.
output_index integer 텍스트 델타가 추가된 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.output_text.delta입니다.
가능한 값: response.output_text.delta

OpenAI.ResponseTextDoneEvent

텍스트 콘텐츠가 종료될 때 내보내집니다.

이름 유형 Description 필수 기본값
content_index integer 텍스트 콘텐츠가 종료되는 콘텐츠 부분의 인덱스입니다.
item_id 문자열 텍스트 콘텐츠가 최종 확정된 출력 항목의 ID입니다.
output_index integer 텍스트가 완성될 때의 출력 항목 인덱스입니다.
문자 메시지 문자열 최종 확정된 텍스트 콘텐츠입니다.
type enum 이벤트의 형식입니다. 항상 response.output_text.done입니다.
가능한 값: response.output_text.done

OpenAI.ResponseTextFormatConfiguration (응답 텍스트 형식 구성)

OpenAI.ResponseTextFormatConfiguration에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
text OpenAI.응답텍스트형식구성텍스트
json_object OpenAI.응답텍스트형식구성Json객체
json_schema OpenAI.ResponseTextFormatConfigurationJsonSchema
이름 유형 Description 필수 기본값
type OpenAI.ResponseTextFormatConfigurationType (OpenAI 응답 텍스트 형식 구성 유형) 모델이 출력해야 하는 형식을 지정하는 개체입니다.

구성 { "type": "json_schema" } 을 통해 구조적 출력을 사용할 수 있습니다.
모델이 제공된 JSON 스키마와 일치하도록 합니다. 자세한 내용은


기본 형식은 { "type": "text" } 추가 옵션이 없습니다.

gpt-4o 및 최신 모델에는 권장되지 않습니다.

{ "type": "json_object" }을 활성화하면 이전 JSON 모드를 사용할 수 있습니다.
는 모델이 생성하는 메시지가 유효한 JSON인지 확인합니다. json_schema 사용하기
지원하는 모델에서는 선호됩니다.

OpenAI.ResponseTextFormatConfigurationJsonObject

이름 유형 Description 필수 기본값
type enum
가능한 값: json_object

OpenAI.ResponseTextFormatConfigurationJsonSchema

JSON 스키마 응답 형식입니다. 구조적 JSON 응답을 생성하는 데 사용됩니다. 구조적 출력에 대해 자세히 알아보세요.

이름 유형 Description 필수 기본값
description 문자열 이 응답 형식이 모델에서 어떻게 사용되는지에 대한 설명입니다.
형식에 맞춰 응답하는 방법을 결정합니다.
아니오
이름 문자열 응답 형식의 이름입니다. a-z, A-Z, 0-9 또는 포함해야 합니다.
최대 길이가 64인 경우, 밑줄과 대시를 사용하세요.
schema(스키마) 객체
엄격한 부울 출력을 생성할 때 엄격한 스키마 준수를 사용하도록 설정할지 여부입니다.
true로 설정하면 모델은 항상 정의된 정확한 스키마를 따릅니다.
schema 필드에 있습니다. JSON 스키마의 하위 집합만 지원되는 경우
stricttrue입니다. 자세한 내용은 구조적 출력
가이드
를 읽어보세요.
아니오 거짓
type enum 정의되는 응답 형식의 유형입니다. 항상 json_schema입니다.
가능한 값: json_schema

OpenAI.ResponseTextFormatConfigurationText

이름 유형 Description 필수 기본값
type enum
가능한 값: text

오픈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 것이 좋습니다. | | 형식 | string | | | text
json_schema
json_object |

OpenAI.ResponseUsage

입력 토큰, 출력 토큰, 출력 토큰 분석 및 사용된 총 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다.

이름 유형 Description 필수 기본값
input_tokens integer 입력 토큰의 수입니다.
input_tokens_details 객체 입력 토큰에 대한 자세한 분석입니다.
└─ 캐시된_토큰 (cached_tokens) integer 캐시에서 검색된 토큰 수입니다.
프롬프트 캐싱에 대해 자세히 알아보세요.
아니오
output_tokens integer 출력 토큰의 수입니다.
output_tokens_details 객체 출력 토큰에 대한 자세한 분석입니다.
└─ 추론_토큰 integer 추론 토큰의 수입니다. 아니오
total_tokens integer 사용된 총 토큰 수입니다.

OpenAI.ResponseWebSearchCallCompletedEvent

참고: web_search 아직 Azure OpenAI를 통해 사용할 수 없습니다.

이름 유형 Description 필수 기본값
item_id 문자열 웹 검색 호출과 연결된 출력 항목의 고유 ID입니다.
output_index integer 웹 검색 호출이 연결된 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.web_search_call.completed입니다.
가능한 값: response.web_search_call.completed

OpenAI.ResponseWebSearchCallInProgressEvent

참고: web_search 아직 Azure OpenAI를 통해 사용할 수 없습니다.

이름 유형 Description 필수 기본값
item_id 문자열 웹 검색 호출과 연결된 출력 항목의 고유 ID입니다.
output_index integer 웹 검색 호출이 연결된 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.web_search_call.in_progress입니다.
가능한 값: response.web_search_call.in_progress

OpenAI.ResponseWebSearchCallSearchingEvent

참고: web_search 아직 Azure OpenAI를 통해 사용할 수 없습니다.

이름 유형 Description 필수 기본값
item_id 문자열 웹 검색 호출과 연결된 출력 항목의 고유 ID입니다.
output_index integer 웹 검색 호출이 연결된 출력 항목의 인덱스입니다.
type enum 이벤트의 형식입니다. 항상 response.web_search_call.searching입니다.
가능한 값: response.web_search_call.searching

OpenAI.ResponsesAssistantMessageItemParam

역할이 있는 메시지 매개 변수 항목입니다 assistant .

이름 유형 Description 필수 기본값
내용 문자열 또는 배열
역할 enum 메시지의 역할은 항상 assistant입니다.
가능한 값: assistant

OpenAI.ResponsesAssistantMessageItemResource

assistant 역할이 있는 메시지 리소스 항목입니다.

이름 유형 Description 필수 기본값
내용 array 메시지와 연결된 콘텐츠입니다.
역할 enum 메시지의 역할은 항상 assistant입니다.
가능한 값: assistant

OpenAI.ResponsesDeveloperMessageItemParam

역할이 있는 메시지 매개 변수 항목입니다 developer .

이름 유형 Description 필수 기본값
내용 문자열 또는 배열
역할 enum 메시지의 역할은 항상 developer입니다.
가능한 값: developer

OpenAI.ResponsesDeveloperMessageItemResource

developer 역할이 있는 메시지 리소스 항목입니다.

이름 유형 Description 필수 기본값
내용 array 메시지와 연결된 콘텐츠입니다.
역할 enum 메시지의 역할은 항상 developer입니다.
가능한 값: developer

OpenAI.ResponsesMessageItemParam

클라이언트 요청 매개 변수로 제공된 역할 및 콘텐츠를 나타내는 응답 메시지 항목입니다.

OpenAI.ResponsesMessageItemParam에 대한 판별자

이 구성 요소는 속성을 role 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
user OpenAI.ResponsesUserMessageItemParam
system OpenAI.ResponsesSystemMessageItemParam
developer OpenAI.ResponsesDeveloperMessageItemParam
assistant OpenAI.ResponsesAssistantMessageItemParam
이름 유형 Description 필수 기본값
역할 객체 응답 메시지 항목에 대한 유효한 역할의 컬렉션입니다.
type enum 항상 '메시지'인 응답 항목의 형식입니다.
가능한 값: message

OpenAI.ResponsesMessageItemResource

서비스 응답에 제공된 역할 및 콘텐츠를 나타내는 응답 메시지 리소스 항목입니다.

OpenAI.ResponsesMessageItemResource에 대한 판별자

이 구성 요소는 속성을 role 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
user OpenAI.ResponsesUserMessageItemResource
system OpenAI.ResponsesSystemMessageItemResource
developer OpenAI.ResponsesDeveloperMessageItemResource
assistant OpenAI.ResponsesAssistantMessageItemResource
이름 유형 Description 필수 기본값
역할 객체 응답 메시지 항목에 대한 유효한 역할의 컬렉션입니다.
상태 enum 항목의 상태입니다. in_progress, completed 또는 하나
incomplete; 항목이 API를 통해 반환될 때 채워집니다.
가능한 값: in_progress, completedincomplete
type enum 항상 '메시지'인 응답 항목의 형식입니다.
가능한 값: message

OpenAI.ResponsesMessageRole

응답 메시지 항목에 대한 유효한 역할의 컬렉션입니다.

재산 가치
설명 응답 메시지 항목에 대한 유효한 역할의 컬렉션입니다.
유형 문자열
system
developer
user
assistant

OpenAI.ResponsesSystemMessageItemParam

역할이 있는 메시지 매개 변수 항목입니다 system .

이름 유형 Description 필수 기본값
내용 문자열 또는 배열
역할 enum 메시지의 역할은 항상 system입니다.
가능한 값: system

OpenAI.ResponsesSystemMessageItemResource

system 역할이 있는 메시지 리소스 항목입니다.

이름 유형 Description 필수 기본값
내용 array 메시지와 연결된 콘텐츠입니다.
역할 enum 메시지의 역할은 항상 system입니다.
가능한 값: system

OpenAI.ResponsesUserMessageItemParam

역할이 있는 메시지 매개 변수 항목입니다 user .

이름 유형 Description 필수 기본값
내용 문자열 또는 배열
역할 enum 메시지의 역할은 항상 user입니다.
가능한 값: user

OpenAI.ResponsesUserMessageItemResource

user 역할이 있는 메시지 리소스 항목입니다.

이름 유형 Description 필수 기본값
내용 array 메시지와 연결된 콘텐츠입니다.
역할 enum 메시지의 역할은 항상 user입니다.
가능한 값: user

OpenAI.ServiceTier

요청을 처리하는 데 사용되는 처리 유형을 지정합니다.

  • 'auto'로 설정하면 요청이 프로젝트 설정에 구성된 서비스 계층으로 처리됩니다. 달리 구성하지 않는 한 프로젝트는 '기본값'을 사용합니다.
  • 'default'로 설정하면 선택한 모델의 표준 가격 책정 및 성능으로 요청이 처리됩니다.
  • 'flex' 또는 'priority'로 설정하면 해당 서비스 계층으로 요청이 처리됩니다. 우선 순위 처리에 대해 자세히 알아보려면 영업 담당자에게 문의하세요.
  • 설정하지 않으면 기본 동작은 'auto'입니다.

매개 변수가 service_tier 설정되면 응답 본문에는 요청을 처리하는 데 실제로 사용되는 처리 모드를 기반으로 하는 값이 포함 service_tier 됩니다. 이 응답 값은 매개 변수에 설정된 값과 다를 수 있습니다.

재산 가치
설명 요청을 처리하는 데 사용되는 처리 유형을 지정합니다.
* 'auto'로 설정하면 요청이 서비스 계층으로 처리됩니다.
프로젝트 설정에서 구성됩니다. 달리 구성하지 않는 한 프로젝트는 '기본값'을 사용합니다.
* 'default'로 설정하면 요청이 표준으로 처리됩니다.
선택한 모델의 가격 책정 및 성능
* 'flex'로 설정된 경우
또는 'priority'이면 요청이 해당 서비스로 처리됩니다.
계층. 우선 순위 처리에 대해 자세히 알아보려면 영업 담당자에게 문의하세요.
* 설정하지 않으면 기본 동작은 'auto'입니다.

매개 변수가 service_tier 설정되면 응답 본문에 다음이 포함됩니다. service_tier
실제로 요청을 처리하는 데 사용되는 처리 모드를 기반으로 하는 값입니다. 이 응답 값
는 매개 변수에 설정된 값과 다를 수 있습니다.
유형 문자열
auto
default
flex
scale
priority

OpenAI.TextResponseFormatConfiguration

모델이 출력해야 하는 형식을 지정하는 개체입니다.

구성 { "type": "json_schema" } 은 구조적 출력을 사용하도록 설정하여 모델이 제공된 JSON 스키마와 일치하도록 합니다. 자세한 내용은

기본 형식은 { "type": "text" } 추가 옵션이 없습니다.

gpt-4o 및 최신 모델에는 권장되지 않습니다.*

{ "type": "json_object" } 이전 JSON 모드를 사용하도록 설정하면 모델이 생성하는 메시지가 유효한 JSON인지 확인합니다. 이를 지원하는 모델에는 사용하는 json_schema 것이 좋습니다.

OpenAI.TextResponseFormatConfiguration에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
이름 유형 Description 필수 기본값
type 문자열

OpenAI.Tool

OpenAI.Tool의 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
function OpenAI.FunctionTool
file_search OpenAI.FileSearchTool
computer_use_preview OpenAI.ComputerUsePreviewTool
web_search_preview OpenAI.WebSearchPreviewTool
code_interpreter OpenAI.CodeInterpreterTool
image_generation OpenAI.ImageGenTool
local_shell OpenAI.LocalShellTool
mcp OpenAI.MCPTool
bing_grounding BingGroundingAgentTool
fabric_dataagent_preview MicrosoftFabricAgentTool
sharepoint_grounding_preview SharepointAgentTool
azure_ai_search AzureAISearchAgentTool
openapi OpenApiAgentTool
bing_custom_search_preview BingCustomSearchAgentTool
browser_automation_preview BrowserAutomationAgentTool
azure_function AzureFunctionAgentTool
capture_structured_outputs CaptureStructuredOutputsTool
a2a_preview A2ATool
memory_search MemorySearchTool
이름 유형 Description 필수 기본값
type OpenAI.ToolType 응답을 생성하는 데 사용할 수 있는 도구입니다.

OpenAI.ToolChoiceObject

OpenAI.ToolChoiceObject에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
file_search OpenAI.ToolChoiceObjectFileSearch
computer_use_preview OpenAI.ToolChoiceObjectComputer
web_search_preview OpenAI.ToolChoiceObjectWebSearch
image_generation OpenAI.ToolChoiceObjectImageGen
code_interpreter OpenAI.ToolChoiceObjectCodeInterpreter
function OpenAI.ToolChoiceObjectFunction
mcp OpenAI.ToolChoiceObjectMCP
이름 유형 Description 필수 기본값
type OpenAI.ToolChoiceObjectType 모델이 기본 제공 도구를 사용하여 응답을 생성해야 임을 나타냅니다.
기본 제공 도구에 대해 자세히 알아봅니다.

OpenAI.ToolChoiceObjectCodeInterpreter

이름 유형 Description 필수 기본값
type enum
가능한 값: code_interpreter

OpenAI.ToolChoiceObjectComputer

이름 유형 Description 필수 기본값
type enum
가능한 값: computer_use_preview

OpenAI.ToolChoiceObjectFileSearch

이름 유형 Description 필수 기본값
type enum
가능한 값: file_search

OpenAI.ToolChoiceObjectFunction

모델을 강제로 특정 함수를 호출하려면 이 옵션을 사용합니다.

이름 유형 Description 필수 기본값
이름 문자열 호출할 함수의 이름입니다.
type enum 함수 호출의 경우 형식은 항상 function.입니다.
가능한 값: function

OpenAI.ToolChoiceObjectImageGen

이름 유형 Description 필수 기본값
type enum
가능한 값: image_generation

OpenAI.ToolChoiceObjectMCP

이 옵션을 사용하여 모델이 원격 MCP 서버에서 특정 도구를 호출하도록 합니다.

이름 유형 Description 필수 기본값
이름 문자열 서버에서 호출할 도구의 이름입니다. 아니오
서버 레이블 문자열 사용할 MCP 서버의 레이블입니다.
type enum MCP 도구의 경우 형식은 항상 mcp.입니다.
가능한 값: mcp

OpenAI.ToolChoiceObjectType

모델이 기본 제공 도구를 사용하여 응답을 생성해야 임을 나타냅니다. 기본 제공 도구에 대해 자세히 알아봅니다.

재산 가치
설명 모델이 기본 제공 도구를 사용하여 응답을 생성해야 임을 나타냅니다.
기본 제공 도구에 대해 자세히 알아봅니다.
유형 문자열
file_search
function
computer_use_preview
web_search_preview
image_generation
code_interpreter
mcp

OpenAI.ToolChoiceObjectWebSearch

참고: web_search 아직 Azure OpenAI를 통해 사용할 수 없습니다.

이름 유형 Description 필수 기본값
type enum
가능한 값: web_search_preview

OpenAI.ToolChoiceOptions

모델이 호출하는 도구(있는 경우)를 제어합니다.

none 는 모델이 도구를 호출하지 않고 대신 메시지를 생성한다는 의미입니다.

auto는 모델이 메시지 생성 또는 하나 이상의 도구 호출 중에서 선택할 수 있음을 의미합니다.

required는 모델이 하나 이상의 도구를 호출해야 함을 의미합니다.

재산 가치
설명 모델이 호출하는 도구(있는 경우)를 제어합니다.

none 는 모델이 도구를 호출하지 않고 대신 메시지를 생성한다는 의미입니다.

auto 는 모델이 메시지를 생성하거나 메시지를 호출하는 중에서 선택할 수 있습니다.
더 많은 도구.

required는 모델이 하나 이상의 도구를 호출해야 함을 의미합니다.
유형 문자열
none
auto
required

OpenAI 툴 타입

응답을 생성하는 데 사용할 수 있는 도구입니다.

재산 가치
설명 응답을 생성하는 데 사용할 수 있는 도구입니다.
유형 문자열
file_search
function
computer_use_preview
web_search_preview
mcp
code_interpreter
image_generation
local_shell
bing_grounding
browser_automation_preview
fabric_dataagent_preview
sharepoint_grounding_preview
azure_ai_search
openapi
bing_custom_search_preview
capture_structured_outputs
a2a_preview
azure_function
memory_search

OpenAI.TopLogProb

토큰의 상위 로그 확률입니다.

이름 유형 Description 필수 기본값
bytes array
logprob 숫자
token 문자열

OpenAI.UpdateConversationRequest

대화 업데이트

이름 유형 Description 필수 기본값
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오

OpenAI.VectorStoreFileAttributes

개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 구조화된 형식으로 개체에 대한 추가 정보를 저장하고 API 또는 대시보드를 통해 개체를 쿼리하는 데 유용할 수 있습니다. 키는 최대 길이가 64자인 문자열입니다. 값은 최대 길이가 512자이고 부울 또는 숫자인 문자열입니다.

Type: 객체

OpenAI.WebSearchAction

OpenAI.WebSearchAction에 대한 디스크리미네이터

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
find OpenAI.WebSearchActionFind
open_page OpenAI.WebSearchActionOpenPage
search OpenAI.WebSearchActionSearch
이름 유형 Description 필수 기본값
type OpenAI.WebSearchActionType

OpenAI.WebSearchActionFind

작업 유형 "find": 로드된 페이지 내에서 패턴을 검색합니다.

이름 유형 Description 필수 기본값
패턴 문자열 페이지 내에서 검색할 패턴 또는 텍스트입니다.
type enum 작업 형식입니다.
가능한 값: find
URL 문자열 패턴을 검색한 페이지의 URL입니다.

OpenAI.WebSearchActionOpenPage

작업 유형 "open_page" - 검색 결과에서 특정 URL을 엽니다.

이름 유형 Description 필수 기본값
type enum 작업 형식입니다.
가능한 값: open_page
URL 문자열 모델에서 연 URL입니다.

OpenAI.WebSearchActionSearch

작업 유형 "search" - 웹 검색 쿼리를 수행합니다.

이름 유형 Description 필수 기본값
query 문자열 검색 쿼리.
소스 array 검색에 사용된 소스입니다. 아니오
type enum 작업 형식입니다.
가능한 값: search

OpenAI.WebSearchActionSearchSources

이름 유형 Description 필수 기본값
type enum
가능한 값: url
URL 문자열

OpenAI.WebSearchActionType

재산 가치
유형 문자열
search
open_page
find

OpenAI.WebSearchPreviewTool

참고: web_search 아직 Azure OpenAI를 통해 사용할 수 없습니다.

이름 유형 Description 필수 기본값
검색_컨텍스트_크기 enum 검색에 사용할 컨텍스트 창 공간의 양에 대한 높은 수준의 지침입니다. low, medium 또는 high 중 하나입니다. medium 기본값입니다.
가능한 값: low, mediumhigh
아니오
type enum 웹 검색 도구의 형식입니다. web_search_preview 또는 web_search_preview_2025_03_11중 하나입니다.
가능한 값: web_search_preview
사용자 위치 객체 아니오
└─ 형식 OpenAI.LocationType 아니오

OpenAI.WebSearchToolCallItemParam

웹 검색 도구 호출의 결과입니다. 자세한 내용은 웹 검색 가이드 를 참조하십시오.

이름 유형 Description 필수 기본값
조치 객체
└─ 형식 OpenAI.WebSearchActionType 아니오
type enum
가능한 값: web_search_call

OpenAI.WebSearchToolCallItemResource

웹 검색 도구 호출의 결과입니다. 자세한 내용은 웹 검색 가이드 를 참조하십시오.

이름 유형 Description 필수 기본값
조치 객체
└─ 형식 OpenAI.WebSearchActionType 아니오
상태 enum 웹 검색 도구 호출의 상태입니다.
가능한 값: in_progress, searching, completedfailed
type enum
가능한 값: web_search_call

OpenAI.integer

형식: 정수

형식: int64

OpenAI.numeric

형식: number

형식: double

OpenApiAgentTool

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

이름 유형 Description 필수 기본값
openapi 객체 openapi 함수에 대한 입력 정의 정보입니다.
└) 인증 OpenApiAuthDetails API 인증 세부 정보 열기 아니오
└default_params array 사용자가 제공한 기본값을 사용하는 OpenAPI 사양 매개 변수 목록 아니오
└) 설명 문자열 함수를 호출하는 시기와 방법을 선택하기 위해 모델에서 사용하는 함수의 기능에 대한 설명입니다. 아니오
└) 함수 array OpenApi 도구에서 사용하는 함수 정의 목록 아니오
└) 이름 문자열 호출할 함수의 이름입니다. 아니오
└) 사양 JSON 스키마 개체로 설명된 openapi 함수 셰이프입니다. 아니오
type enum 항상 'openapi'인 객체 유형입니다.
가능한 값: openapi

OpenApiAnonymousAuthDetails

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

이름 유형 Description 필수 기본값
type enum 항상 'anonymous'인 개체 형식입니다.
가능한 값: anonymous

OpenApiAuthDetails

OpenApiFunctionDefinition에 대한 인증 세부 정보

OpenApiAuthDetails에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
anonymous OpenApiAnonymousAuthDetails
project_connection OpenApiProjectConnectionAuthDetails
managed_identity OpenApiManagedAuthDetails
이름 유형 Description 필수 기본값
type 객체 OpenApi 엔드포인트에 대한 인증 유형입니다. 허용되는 형식은 다음과 같습니다.
- 익명(인증 필요 없음)
- 프로젝트 연결(Foundry의 설정으로 엔드포인트에 project_connection_id 필요)
- Managed_Identity(ID 기반 인증을 위해 대상 그룹 필요)

OpenApiAuthType

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

  • 익명(인증 필요 없음)
  • 프로젝트 연결(Foundry의 설정으로 엔드포인트에 project_connection_id 필요)
  • Managed_Identity(ID 기반 인증을 위한 대상 그룹 필요)
재산 가치
유형 문자열
anonymous
project_connection
managed_identity

OpenApiFunctionDefinition

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

이름 유형 Description 필수 기본값
auth 객체 OpenApiFunctionDefinition에 대한 인증 세부 정보
└─ 형식 OpenApiAuthType 인증 유형은 익명/project_connection/managed_identity 아니오
default_params array 사용자가 제공한 기본값을 사용하는 OpenAPI 사양 매개 변수 목록 아니오
description 문자열 함수를 호출하는 시기와 방법을 선택하기 위해 모델에서 사용하는 함수의 기능에 대한 설명입니다. 아니오
functions array OpenApi 도구에서 사용하는 함수 정의 목록 아니오
이름 문자열 호출할 함수의 이름입니다.
spec JSON 스키마 개체로 설명된 openapi 함수 셰이프입니다.

OpenApiManagedAuthDetails

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

이름 유형 Description 필수 기본값
security_scheme 객체 OpenApi managed_identity 인증에 대한 보안 체계
└) 대상 그룹 문자열 managed_identity 인증 유형에 대한 인증 범위 아니오
type enum 항상 'managed_identity'인 개체 형식입니다.
가능한 값: managed_identity

OpenApiManagedSecurityScheme

OpenApi managed_identity 인증에 대한 보안 체계

이름 유형 Description 필수 기본값
audience 문자열 managed_identity 인증 유형에 대한 인증 범위

OpenApiProjectConnectionAuthDetails

OpenApi 프로젝트 연결 인증에 대한 보안 세부 정보

이름 유형 Description 필수 기본값
security_scheme 객체 OpenApi managed_identity 인증에 대한 보안 체계
└project_connection_id 문자열 프로젝트 연결 인증 유형에 대한 프로젝트 연결 ID 아니오
type enum 항상 'project_connection'인 객체 유형입니다.
가능한 값: project_connection

OpenApiProjectConnectionSecurityScheme

OpenApi managed_identity 인증에 대한 보안 체계

이름 유형 Description 필수 기본값
project_connection_id 문자열 프로젝트 연결 인증 유형에 대한 프로젝트 연결 ID

PagedConnection

Connection 항목의 페이징된 컬렉션

이름 유형 Description 필수 기본값
넥스트링크 문자열 항목의 다음 페이지에 대한 링크 아니오
value array 이 페이지의 연결 항목

PagedDatasetVersion

DatasetVersion 항목의 페이징된 컬렉션

이름 유형 Description 필수 기본값
넥스트링크 문자열 항목의 다음 페이지에 대한 링크 아니오
value array 이 페이지의 DatasetVersion 항목

PagedDeployment

배포 항목의 페이징된 컬렉션

이름 유형 Description 필수 기본값
넥스트링크 문자열 항목의 다음 페이지에 대한 링크 아니오
value array 이 페이지의 배포 항목

PagedEvaluationRule

EvaluationRule 항목의 페이징된 컬렉션

이름 유형 Description 필수 기본값
넥스트링크 문자열 항목의 다음 페이지에 대한 링크 아니오
value array 이 페이지의 EvaluationRule 항목

PagedEvaluationTaxonomy

EvaluationTaxonomy 항목의 페이징된 컬렉션

이름 유형 Description 필수 기본값
넥스트링크 문자열 항목의 다음 페이지에 대한 링크 아니오
value array 이 페이지의 EvaluationTaxonomy 항목

PagedEvaluatorVersion

EvaluatorVersion 항목의 페이징된 컬렉션

이름 유형 Description 필수 기본값
넥스트링크 문자열 항목의 다음 페이지에 대한 링크 아니오
value array 이 페이지의 EvaluatorVersion 항목

PagedIndex

인덱스 항목의 페이징된 컬렉션

이름 유형 Description 필수 기본값
넥스트링크 문자열 항목의 다음 페이지에 대한 링크 아니오
value array 이 페이지의 인덱스 항목

PagedInsight

인사이트 항목의 페이징된 컬렉션

이름 유형 Description 필수 기본값
넥스트링크 문자열 항목의 다음 페이지에 대한 링크 아니오
value array 이 페이지의 인사이트 항목

PagedRedTeam

RedTeam 항목의 페이징된 컬렉션

이름 유형 Description 필수 기본값
넥스트링크 문자열 항목의 다음 페이지에 대한 링크 아니오
value array 이 페이지의 RedTeam 항목

PagedSchedule

스케줄 항목의 페이징된 컬렉션

이름 유형 Description 필수 기본값
넥스트링크 문자열 항목의 다음 페이지에 대한 링크 아니오
value array 이 페이지의 일정 항목

PagedScheduleRun

ScheduleRun 항목의 페이징된 컬렉션

이름 유형 Description 필수 기본값
넥스트링크 문자열 항목의 다음 페이지에 대한 링크 아니오
value array 이 페이지의 ScheduleRun 항목

PendingUploadRequest

보류 중인 업로드에 대한 요청을 나타냅니다.

이름 유형 Description 필수 기본값
연결 이름 문자열 임시 SAS 토큰을 생성하는 데 사용할 Azure Storage 계정 연결 이름 아니오
pendingUploadId 문자열 PendingUploadId를 제공하지 않으면 임의의 GUID가 사용됩니다. 아니오
pendingUploadType enum BlobReference는 유일하게 지원되는 형식입니다.
가능한 값: BlobReference

PendingUploadResponse

보류 중인 업로드 요청에 대한 응답을 나타냅니다.

이름 유형 Description 필수 기본값
blobReference 객체 Blob 참조 세부 정보.
└) blobUri 문자열 클라이언트가 데이터를 업로드할 수 있는 Blob URI 경로입니다. 예: https://blob.windows.core.net/Container/Path 아니오
└) 자격 증명 SasCredential 스토리지 계정에 액세스하기 위한 자격 증명 정보입니다. 아니오
└) storageAccountArmId 문자열 사용할 스토리지 계정의 ARM ID입니다. 아니오
pendingUploadId 문자열 이 업로드 요청의 ID입니다.
pendingUploadType enum BlobReference는 유일하게 지원되는 형식입니다
가능한 값: BlobReference
버전 문자열 사용자가 업로드를 처음 생성할 때 버전을 지정하지 않은 경우 생성할 자산의 버전입니다. 아니오

PromptAgentDefinition

프롬프트 에이전트 정의

이름 유형 Description 필수 기본값
instructions 문자열 모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다. 아니오
친절한 enum
가능한 값: prompt
모델 문자열 이 에이전트에 사용할 모델 배포입니다.
reasoning 객체 o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.
아니오
└) 노력 OpenAI.추론노력 추론 모델에서 추론 작업을 제한합니다.

현재 지원되는 값은 없음, 최소, 낮음, 중간 및 높음입니다.

추론 작업을 줄이면 응답 속도가 빨라지고 응답에서 추론에 사용되는 토큰이 줄어들 수 있습니다.

gpt-5.1은 기본적으로 none으로 설정되며 추론을 수행하지 않습니다. gpt-5.1에 대해 지원되는 추론 값은 없음, 낮음, 중간 및 높음입니다. 도구 호출은 gpt-5.1의 모든 추론 값에 대해 지원됩니다.

gpt-5.1 이전의 모든 모델은 기본적으로 중간 추론 작업으로 설정되며, 없음을 지원하지 않습니다.

gpt-5-pro 모델은 기본적으로 높은 추론 작업만 지원합니다.
아니오
└─ 요약_생성하기 (generate_summary) enum 더 이상 사용되지 않음: 대신 사용하십시오 summary . 모델에서 수행하는 추론에 대한 요약입니다. 이는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용할 수 있습니다. auto, concise 또는 detailed 중 하나입니다.
가능한 값: auto, concisedetailed
아니오
└) 요약 enum 모델에서 수행하는 추론에 대한 요약입니다. 다음과 같을 수 있습니다.
는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용합니다.
auto, concise 또는 detailed 중 하나입니다.
가능한 값: auto, concisedetailed
아니오
structured_inputs 객체 프롬프트 템플릿 대체 또는 도구 인수 바인딩에 참여할 수 있는 구조화된 입력 집합입니다. 아니오
온도 숫자 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.
아니오 1
문자 메시지 객체 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반 텍스트 또는 구조화된 JSON 데이터일 수 있습니다. 아니오
└─ 형식 OpenAI.ResponseTextFormatConfiguration 아니오
도구들 array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. 당신
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.
아니오
top_p (탑 피) 숫자 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.
아니오 1

PromptBasedEvaluatorDefinition

프롬프트 기반 평가자

이름 유형 Description 필수 기본값
prompt_text 문자열 평가에 사용되는 프롬프트 텍스트
type enum
가능한 값: prompt

ProtocolVersionRecord

단일 프로토콜 및 해당 버전에 대한 레코드 매핑입니다.

이름 유형 Description 필수 기본값
프로토콜 객체
버전 문자열 프로토콜의 버전 문자열(예: 'v0.1.1').

RaiConfig

책임 있는 AI(RAI) 콘텐츠 필터링 및 안전 기능에 대한 구성입니다.

이름 유형 Description 필수 기본값
rai_policy_name 문자열 적용할 RAI 정책의 이름입니다.

RecurrenceSchedule

되풀이 일정 모델.

RecurrenceSchedule에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
Hourly HourlyRecurrenceSchedule
Daily DailyRecurrenceSchedule
Weekly WeeklyRecurrenceSchedule
Monthly MonthlyRecurrenceSchedule
이름 유형 Description 필수 기본값
type 객체 되풀이 유형입니다.

RecurrenceTrigger

되풀이 기반 트리거.

이름 유형 Description 필수 기본값
endTime 문자열 ISO 8601 형식의 되풀이 일정의 종료 시간입니다. 아니오
interval integer 되풀이 일정의 간격입니다.
일정 객체 되풀이 일정 모델.
└─ 형식 RecurrenceType 되풀이 일정의 되풀이 유형입니다. 아니오
startTime 문자열 ISO 8601 형식의 되풀이 일정의 시작 시간입니다. 아니오
timeZone 문자열 되풀이 일정의 표준 시간대입니다. 아니오 UTC
type enum 트리거의 유형입니다.
가능한 값: Recurrence

RecurrenceType

되풀이 유형입니다.

재산 가치
설명 되풀이 유형입니다.
유형 문자열
Hourly
Daily
Weekly
Monthly

RedTeam

레드 팀 세부 정보.

이름 유형 Description 필수 기본값
applicationScenario 문자열 시나리오별 공격을 생성하기 위한 레드 팀 작업에 대한 애플리케이션 시나리오입니다. 아니오
attackStrategies array 공격 전략 목록 또는 중첩된 공격 전략 목록입니다. 아니오
displayName 문자열 레드 팀 런의 이름입니다. 아니오
아이디 문자열 레드 팀 런의 식별자입니다.
numTurns integer 시뮬레이션 라운드 수입니다. 아니오
속성 객체 레드 팀의 속성. 태그와 달리 속성은 추가 전용입니다. 추가된 후에는 속성을 제거할 수 없습니다. 아니오
riskCategories array 공격 목표를 생성할 위험 범주 목록입니다. 아니오
simulationOnly 부울 시뮬레이션 전용 또는 시뮬레이션 + 평가. 기본값: false, true인 경우 스캔은 평가 결과가 아닌 대화를 출력합니다. 아니오 거짓
상태 문자열 레드팀의 상태입니다. 서비스에 의해 설정되며 읽기 전용입니다. 아니오
tags 객체 레드 팀의 태그. 속성과 달리 태그는 완전히 변경할 수 있습니다. 아니오
target 객체 대상 구성을 위한 추상 클래스입니다.
└─ 형식 문자열 모델 구성의 유형입니다. 아니오

RedTeamItemGenerationParams

빨간색 팀 항목 생성에 대한 매개 변수를 나타냅니다.

이름 유형 Description 필수 기본값
attack_strategies array 사용할 공격 전략의 컬렉션입니다.
num_turns integer 게임에서 허용되는 턴 수입니다.
type enum 항상 항목 생성 매개 변수 red_team의 형식입니다.
가능한 값: red_team

RiskCategory

공격 대상에 대한 위험 범주입니다.

재산 가치
설명 공격 대상에 대한 위험 범주입니다.
유형 문자열
HateUnfairness
Violence
Sexual
SelfHarm
ProtectedMaterial
CodeVulnerability
UngroundedAttributes
ProhibitedActions
SensitiveDataLeakage
TaskAdherence

SASCredentials

SAS(공유 액세스 서명) 자격 증명 정의

이름 유형 Description 필수 기본값
SAS 문자열 SAS 토큰 아니오
type enum 자격 증명 형식
가능한 값: SAS

SampleType

분석에 사용된 샘플의 유형입니다.

재산 가치
유형 문자열
EvaluationResultSample

사스크리덴셜

SAS 자격 증명 정의

이름 유형 Description 필수 기본값
sasUri 문자열 SAS URI
type enum 자격 증명의 유형
가능한 값: SAS

일정

일정 모델.

이름 유형 Description 필수 기본값
description 문자열 일정에 대한 설명입니다. 아니오
displayName 문자열 일정의 이름입니다. 아니오
enabled 부울 일정의 사용 상태입니다.
아이디 문자열 일정의 식별자입니다.
속성 객체 Schedule의 속성입니다. 태그와 달리 속성은 추가 전용입니다. 추가된 후에는 속성을 제거할 수 없습니다. 아니오
프로비저닝 상태 객체 프로비저닝 상태를 예약합니다. 아니오
시스템 데이터 객체 리소스에 대한 시스템 메타데이터입니다.
tags 객체 일정의 태그입니다. 속성과 달리 태그는 완전히 변경할 수 있습니다. 아니오
작업 객체 일정 작업 모델.
└) 구성 객체 작업에 대한 구성입니다. 아니오
└─ 형식 ScheduleTaskType 작업의 유형입니다. 아니오
trigger 객체 일정의 트리거에 대한 기본 모델입니다.
└─ 형식 TriggerType 트리거의 유형입니다. 아니오

ScheduleProvisioningStatus

프로비저닝 상태를 예약합니다.

재산 가치
설명 프로비저닝 상태를 예약합니다.
유형 문자열
Creating
Updating
Deleting
Succeeded
Failed

ScheduleRun

실행 모델을 예약합니다.

이름 유형 Description 필수 기본값
오류 문자열 스케줄 실행에 대한 오류 정보입니다. 아니오
아이디 문자열 일정 실행의 식별자입니다.
속성 객체 일정 실행의 속성입니다.
scheduleId 문자열 일정의 식별자입니다.
성공 부울 일정 실행의 트리거 성공 상태입니다.
triggerTime 문자열 일정 실행의 트리거 시간입니다. 아니오

작업 일정

일정 작업 모델.

ScheduleTask에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
Evaluation EvaluationScheduleTask
Insight InsightScheduleTask
이름 유형 Description 필수 기본값
configuration 객체 작업에 대한 구성입니다. 아니오
type 객체 작업의 유형입니다.

ScheduleTaskType

작업의 유형입니다.

재산 가치
설명 작업의 유형입니다.
유형 문자열
Evaluation
Insight

SeedPromptsRedTeamItemGenerationParams

시드 프롬프트가 있는 빨간색 팀 항목 생성에 대한 매개 변수를 나타냅니다.

이름 유형 Description 필수 기본값
attack_strategies array 사용할 공격 전략의 컬렉션입니다.
num_turns integer 게임에서 허용되는 턴 수입니다.
source 객체
└─ 콘텐츠 array jsonl 파일의 내용입니다. 아니오
└─ ID 문자열 파일의 식별자입니다. 아니오
└─ 형식 enum jsonl 원본의 형식입니다. 항상 file_id입니다.
가능한 값: file_id
아니오
type enum 항상 항목 생성 매개 변수 red_team의 형식입니다.
가능한 값: red_team_seed_prompts

SharepointAgentTool

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

이름 유형 Description 필수 기본값
sharepoint_grounding_preview 객체 SharePoint 접지 도구 매개 변수입니다.
└project_connections array 이 도구에 연결된 프로젝트 연결입니다. 최대 1 연결이 있을 수 있습니다.
도구에 연결된 리소스입니다.
아니오
type enum 항상 'sharepoint_grounding'인 개체 형식입니다.
가능한 값: sharepoint_grounding_preview

SharepointGroundingToolParameters

SharePoint 접지 도구 매개 변수입니다.

이름 유형 Description 필수 기본값
project_connections array 이 도구에 연결된 프로젝트 연결입니다. 최대 1 연결이 있을 수 있습니다.
도구에 연결된 리소스입니다.
아니오

Sku

SKU 정보

이름 유형 Description 필수 기본값
capacity integer SKU 용량
family 문자열 Sku 제품군
이름 문자열 Sku 이름
크기 문자열 SKU 크기
tier 문자열 Sku 계층

StructuredInputDefinition

프롬프트 템플릿 대체 및 도구 인수 바인딩에 참여할 수 있는 구조화된 입력입니다.

이름 유형 Description 필수 기본값
default_value 런타임 값이 제공되지 않은 경우 입력의 기본값입니다. 아니오
description 문자열 입력에 대한 사람이 읽을 수 있는 설명입니다. 아니오
필수 부울 에이전트가 호출될 때 입력 속성이 필요한지 여부입니다. 아니오 거짓
schema(스키마) 구조화된 입력에 대한 JSON 스키마(선택 사항). 아니오

StructuredOutputDefinition

에이전트에서 생성할 수 있는 구조화된 출력입니다.

이름 유형 Description 필수 기본값
description 문자열 내보낼 출력에 대한 설명입니다. 모델에서 출력을 내보낼 시기를 결정하는 데 사용됩니다.
이름 문자열 구조화된 출력의 이름입니다.
schema(스키마) 구조화된 출력에 대한 JSON 스키마입니다.
엄격한 부울 엄격한 유효성 검사를 적용할지 여부입니다. 기본값 true.

StructuredOutputsItemResource

이름 유형 Description 필수 기본값
output 응답 중에 캡처된 구조적 출력입니다.
type enum
가능한 값: structured_outputs

목표/타겟

판별자를 지원하는 대상의 기본 클래스입니다.

대상에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
azure_ai_model AzureAIModelTarget
azure_ai_agent AzureAIAgentTarget
azure_ai_assistant AzureAIAssistantTarget
이름 유형 Description 필수 기본값
type 문자열 대상의 형식입니다.

TargetCompletions

대상 기반 완료 평가 구성에 대한 데이터 원본을 나타냅니다.

이름 유형 Description 필수 기본값
입력 메시지 객체 아니오
└─ 항목_참조 문자열 아니오
└─ 형식 enum
가능한 값: item_reference
아니오
source 객체
└─ 콘텐츠 array jsonl 파일의 내용입니다. 아니오
└─ ID 문자열 파일의 식별자입니다. 아니오
└─ 형식 enum jsonl 원본의 형식입니다. 항상 file_id입니다.
가능한 값: file_id
아니오
target 객체 판별자를 지원하는 대상의 기본 클래스입니다.
└─ 형식 문자열 대상의 형식입니다. 아니오
type enum 항상 데이터 원본 TargetCompletions의 형식입니다.
가능한 값: azure_ai_target_completions

TargetConfig

대상 구성을 위한 추상 클래스입니다.

TargetConfig에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
AzureOpenAIModel AzureOpenAIModelConfiguration
이름 유형 Description 필수 기본값
type 문자열 모델 구성의 유형입니다.

TargetUpdate

판별자를 지원하는 대상의 기본 클래스입니다.

TargetUpdate에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
azure_ai_model AzureAIModelTargetUpdate
azure_ai_assistant AzureAIAssistantTargetUpdate
이름 유형 Description 필수 기본값
type 문자열 대상의 형식입니다.

TaxonomyCategory

분류 범주 정의.

이름 유형 Description 필수 기본값
description 문자열 분류 범주에 대한 설명입니다. 아니오
아이디 문자열 분류 범주의 고유 식별자입니다.
이름 문자열 분류 범주의 이름입니다.
속성 객체 분류 범주에 대한 추가 속성입니다. 아니오
riskCategory 객체 공격 대상에 대한 위험 범주입니다.
하위 범주 array 분류 하위 범주 목록.

TaxonomyRedTeamItemGenerationParams

시드 프롬프트가 있는 빨간색 팀 항목 생성에 대한 매개 변수를 나타냅니다.

이름 유형 Description 필수 기본값
attack_strategies array 사용할 공격 전략의 컬렉션입니다.
num_turns integer 게임에서 허용되는 턴 수입니다.
source 객체
└─ 콘텐츠 array jsonl 파일의 내용입니다. 아니오
└─ ID 문자열 파일의 식별자입니다. 아니오
└─ 형식 enum jsonl 원본의 형식입니다. 항상 file_id입니다.
가능한 값: file_id
아니오
type enum 항상 항목 생성 매개 변수 red_team의 형식입니다.
가능한 값: red_team_taxonomy

TaxonomySubCategory

분류 하위 범주 정의.

이름 유형 Description 필수 기본값
description 문자열 분류 하위 범주에 대한 설명입니다. 아니오
enabled 부울 이 하위 범주 아래의 분류 항목 목록입니다.
아이디 문자열 분류 하위 범주의 고유 식별자입니다.
이름 문자열 분류 하위 범주의 이름입니다.
속성 객체 분류 하위 범주에 대한 추가 속성입니다. 아니오

ToolDescription

에이전트가 사용할 수 있는 도구에 대한 설명입니다.

이름 유형 Description 필수 기본값
description 문자열 도구의 목적에 대한 간략한 설명입니다. 아니오
이름 문자열 도구의 이름입니다. 아니오

ToolProjectConnection

프로젝트 연결 리소스입니다.

이름 유형 Description 필수 기본값
project_connection_id 문자열 이 도구에 연결된 ToolProjectConnectionList의 프로젝트 연결입니다.

TracesEvalRunDataSource

Application Insights에 저장된 에이전트 추적을 통해 작동하는 평가 실행의 데이터 원본을 나타냅니다.

이름 유형 Description 필수 기본값
lookback_hours integer Application Insights에서 추적을 검색할 때 적용된 조회 창(시간)입니다. 아니오 168
trace_ids array 평가해야 하는 에이전트 추적 식별자의 컬렉션입니다.
type enum 항상 데이터 원본 azure_ai_traces의 형식입니다.
가능한 값: azure_ai_traces

TreatmentEffectType

치료 효과 유형.

재산 가치
유형 문자열
TooFewSamples
Inconclusive
Changed
Improved
Degraded

Trigger

일정의 트리거에 대한 기본 모델입니다.

트리거에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
Cron 크론트리거
Recurrence 되풀이 트리거
OneTime OneTimeTrigger
이름 유형 Description 필수 기본값
type 객체 트리거의 유형입니다.

TriggerType

트리거의 유형입니다.

재산 가치
설명 트리거의 유형입니다.
유형 문자열
Cron
Recurrence
OneTime

UpdateAgentFromManifestRequest

이름 유형 Description 필수 기본값
description 문자열 에이전트에 대한 사람이 읽을 수 있는 설명입니다. 아니오
manifest_id 문자열 에이전트 버전을 가져올 매니페스트 ID입니다.
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
parameter_values 객체 완전히 구체화된 에이전트를 생성할 매니페스트에 대한 입력입니다.

UpdateAgentRequest

이름 유형 Description 필수 기본값
정의 객체
└) 종류 AgentKind 아니오
└rai_config RaiConfig 책임 있는 AI(RAI) 콘텐츠 필터링 및 안전 기능에 대한 구성입니다. 아니오
description 문자열 에이전트에 대한 사람이 읽을 수 있는 설명입니다. 아니오
metadata 객체 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오

UpdateEvalParametersBody

이름 유형 Description 필수 기본값
metadata OpenAI.Metadata 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.
아니오
이름 문자열 아니오
속성 객체 추가 정보를 저장하기 위해 개체에 연결할 수 있는 변경할 수 없는 16개의 키-값 쌍 집합입니다.
키는 최대 길이가 64자인 문자열입니다. 값은 최대 길이가 512자인 문자열입니다.
아니오

UserProfileMemoryItem

대화에서 추출한 사용자 프로필 정보(예: 기본 설정, 관심사 및 개인 정보)를 구체적으로 포함하는 메모리 항목입니다.

이름 유형 Description 필수 기본값
친절한 enum 메모리 아이템의 종류입니다.
가능한 값: user_profile

WeeklyRecurrenceSchedule

주간 되풀이 일정.

이름 유형 Description 필수 기본값
daysOfWeek array 되풀이 일정의 요일입니다.
type enum 주간 되풀이 유형입니다.
가능한 값: Weekly

WorkflowActionOutputItemResource

이름 유형 Description 필수 기본값
action_id 문자열 작업에 대한 고유 식별자입니다.
친절한 문자열 CSDL 작업의 종류입니다(예: 'SetVariable', 'InvokeAzureAgent').
parent_action_id 문자열 중첩된 작업인 경우 부모 작업의 ID입니다. 아니오
previous_action_id 문자열 이 작업이 다른 작업을 따르는 경우 이전 작업의 ID입니다. 아니오
상태 enum 작업의 상태(예: 'in_progress', '완료됨', '실패', '취소됨')
가능한 값: completed, failed, in_progresscancelled
type enum
가능한 값: workflow_action

WorkflowAgentDefinition

워크플로 에이전트 정의입니다.

이름 유형 Description 필수 기본값
친절한 enum
가능한 값: workflow
작업 흐름 문자열 워크플로의 CSDL YAML 정의입니다. 아니오

integer

형식: 정수

형식: int64