다음을 통해 공유

Azure AI 파운드리 Models REST API v1 미리 보기 참조의 Azure OpenAI

이 문서에서는 Azure OpenAI에 대한 유추 REST API 엔드포인트에 대한 세부 정보를 제공합니다.

데이터 평면 유추

이 문서의 나머지 부분에는 Azure OpenAI 데이터 평면 유추 사양의 새 v1 미리 보기 API 릴리스가 설명되어 있습니다. API 수명 주기 가이드에서 자세히 알아보세요.

최신 v1 GA API 릴리스에 대한 설명서를 찾는 경우 최신 GA 데이터 평면 유추 API를 참조하세요.

음성 만들기

POST {endpoint}/openai/v1/audio/speech?api-version=preview

입력 텍스트에서 텍스트 음성 변환 오디오를 생성합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

콘텐츠 형식: multipart/form-data

Name Type Description Required Default
input string 오디오를 생성하기 위한 텍스트입니다. 최대 길이는 4096자입니다. Yes
instructions string 추가 지침으로 생성된 오디오의 음성을 제어합니다. tts-1 또는 tts-1-hd와 함께 작동하지 않습니다. No
model string 이 텍스트 음성 변환 요청에 사용할 모델입니다. Yes
response_format object 텍스트 음성 변환에 지원되는 오디오 출력 형식입니다. No
speed number 생성된 오디오의 음성 속도입니다. 값은 0.25에서 4.0까지의 범위에서 유효하며, 기본값은 1.0이고 더 빠른 음성에 해당하는 값은 더 높습니다. No 1
스트림_포맷 enum 오디오를 스트리밍할 형식입니다. 지원되는 형식은 다음과 같습니다 sseaudio. sse는 tts-1 또는 tts-1-hd에 대해 지원되지 않습니다.
가능한 값: sseaudio		 No
voice object Yes

Responses

상태 코드: 200

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

Content-Type Type Description
application/octet-stream string

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

제공된 텍스트에서 오디오를 합성합니다.

POST {endpoint}/openai/v1/audio/speech?api-version=preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3",
 "model": "tts-1"
}

응답: 상태 코드: 200

{
  "body": "101010101"
}

전사 만들기

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

오디오를 입력 언어로 전사합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

콘텐츠 형식: multipart/form-data

Name Type Description Required Default
chunking_strategy object No
└prefix_padding_ms integer VAD가 음성을 감지하기 전에 포함할 오디오 양()
밀리초).		 No 300
└침묵 지속 시간(ms) silence_duration_ms integer 음성 중지를 감지하는 무음 기간(밀리초)입니다.
값이 짧으면 모델이 더 빠르게 응답합니다.
하지만 사용자가 잠깐 멈추면 개입할 수도 있습니다.		 No 200
└) 임계값 number 음성 활동 감지의 민감도 임계값(0.0~1.0)입니다. A
임계값이 높을수록 모델이 활성화되도록 더 큰 소리의 오디오가 필요하고
따라서 시끄러운 환경에서 더 나은 성능을 발휘할 수 있습니다.		 No 0.5
└─ 형식 enum 서버 쪽 VAD를 사용하여 수동 청크를 사용하도록 설정하려면 server_vad로 설정해야 합니다.
가능한 값: server_vad		 No
file string Yes
filename string 오디오 데이터와 연결할 선택적 파일 이름 또는 설명 식별자입니다. No
include[] array 전사 응답에 포함해야 할 추가 정보입니다.
logprobs 에서 토큰의 로그 확률을 반환합니다.
모델의 대화 내용 기록에 대한 신뢰도를 파악하기 위한 응답입니다.
logprobs에서는 오직 response_format이 json로 설정되었을 때만 작동합니다.
모델 gpt-4o-transcribe 및 gpt-4o-mini-transcribe.		 No
language string 입력 오디오의 언어입니다. ISO-639-1(예: en형식)로 입력 언어를 제공하면 정확도와 대기 시간이 향상됩니다. No
model string 이 대화 내용 기록 요청에 사용할 모델입니다. No
prompt string 모델 스타일을 안내하거나 이전 오디오 세그먼트를 계속 진행하기 위한 선택적 텍스트입니다. 프롬프트는 오디오 언어와 일치해야 합니다. No
response_format object No
stream boolean true로 설정하면 모델 응답 데이터가 클라이언트로 스트리밍됩니다.
서버에서 보낸 이벤트를 사용하여 생성됩니다. 참고: whisper-1 모델에서는 스트리밍이 지원되지 않으므로 무시됩니다.		 No False
temperature number 샘플링 온도(0에서 1 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 더 낮은 값을 지정하면 출력이 더욱 집중되고 결정적이게 됩니다. 0으로 설정하면 모델은 로그 확률 을 사용하여 특정 임계값에 도달할 때까지 온도를 자동으로 높입니다. No 0
timestamp_granularities[] array 이 전사를 위해 채울 타임스탬프 세분성입니다. 타임스탬프 세분성을 사용하려면 response_format을 verbose_json으로 설정해야 합니다. word 또는 segment 옵션 중 하나 또는 둘 다 지원됩니다. 참고: 세그먼트 타임스탬프에 대한 추가 대기 시간은 없지만 단어 타임스탬프를 생성하면 추가 대기 시간이 발생합니다. No ['segment']

Responses

상태 코드: 200

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

Content-Type Type Description
application/json AzureAudioTranscriptionResponse
text/plain string

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

제공된 음성 오디오 데이터에서 전사된 텍스트 및 관련 메타데이터를 가져옵니다.

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

응답: 상태 코드: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

번역 만들기

POST {endpoint}/openai/v1/audio/translations?api-version=preview

제공된 음성 오디오 데이터에서 영어 전사 텍스트 및 관련 메타데이터를 가져옵니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

콘텐츠 형식: multipart/form-data

Name Type Description Required Default
file string Yes
filename string 오디오 데이터와 연결할 선택적 파일 이름 또는 설명 식별자입니다. No
model string 이 번역 요청에 사용할 모델입니다. No
prompt string 모델 스타일을 안내하거나 이전 오디오 세그먼트를 계속 진행하기 위한 선택적 텍스트입니다. 프롬프트는 영어로 되어 있어야 합니다. No
response_format object No
temperature number 샘플링 온도(0에서 1 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 더 낮은 값을 지정하면 출력이 더욱 집중되고 결정적이게 됩니다. 0으로 설정하면 모델은 로그 확률 을 사용하여 특정 임계값에 도달할 때까지 온도를 자동으로 높입니다. No 0

Responses

상태 코드: 200

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

Content-Type Type Description
application/json AzureAudioTranslationResponse
text/plain string

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

제공된 음성 오디오 데이터에서 영어 전사 텍스트 및 관련 메타데이터를 가져옵니다.

POST {endpoint}/openai/v1/audio/translations?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

응답: 상태 코드: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

채팅 자동완성 만들기

POST {endpoint}/openai/v1/chat/completions?api-version=preview

채팅 완료를 만듭니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

Content-Type: application/json

Name Type Description Required Default
audio object 오디오 출력에 대한 매개 변수입니다. 오디오 출력이 요청되는 경우 필요합니다.
modalities: ["audio"];		 No
└─ 형식 enum 출력 오디오 형식을 지정합니다. wav, mp3, flac 중 하나여야 합니다.
opus 또는 pcm16입니다.
가능한 값: wav, aac, mp3flac, opuspcm16		 No
└─ 음성 object No
data_sources array Azure OpenAI 전용인 On Your Data 기능에 사용할 데이터 원본입니다. No
frequency_penalty number -2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트에서 발생한 빈도에 따라
새 토큰에 페널티를 부여하여 모델의 토크나이저를 감소시켜
동일한 줄을 그대로 반복할 가능성이 있습니다.		 No 0
function_call enum {"name": "my_function"}을 통해 특정 함수를 지정하면 모델이 해당 함수를 호출하게 됩니다.
가능한 값: noneauto		 No
functions array tools에는 더 이상 사용되지 않습니다.

모델이 JSON 입력을 생성할 수 있는 함수 목록입니다.		 No
logit_bias object 지정된 토큰이 완성에 나타날 가능성을 수정합니다.

토큰을 매핑하는 JSON 개체를 허용합니다(다음의 토큰 ID로 지정됨)
연관된 바이어스 값을 -100에서 100으로 낮춥니다. 수학적으로
바이어스는 샘플링 전에 모델에서 생성된 로그에 추가됩니다.
정확한 효과는 모델마다 다르지만 -1과 1 사이의 값은 다음과 같습니다.
선택 가능성을 줄이거나 늘입니다. -100 또는 100과 같은 값
는 관련 토큰의 금지 또는 배타적 선택으로 이루어져야 합니다.		 No None
logprobs boolean 출력 토큰의 로그 확률을 반환할지 여부를 나타냅니다. true인 경우,
는 에서 반환된 각 출력 토큰의 로그 확률을 반환합니다.
content의 message.		 No False
max_completion_tokens integer 에 대해 생성할 수 있는 토큰 수에 대한 상한
완료에는 표시되는 출력 토큰 및 추론 토큰이 포함됩니다.		 No
max_tokens integer 채팅 완성 시 생성할 수 있는 최대 토큰 수입니다.
이 값은 API를 통해 생성된 텍스트의 비용을 제어하는 데 사용할 수 있습니다.

이 값은 max_completion_tokens를 선호하여 이제 더 이상 사용되지 않습니다.
o1 시리즈 모델과 호환되지 않습니다.		 No
messages array 지금까지의 대화를 구성하는 메시지 목록입니다. 다음에 따라
사용하는 모델, 다양한 메시지 유형(형식)이 지원됩니다.
텍스트, 이미지 및 오디오와 같습니다.		 Yes
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
modalities object 모델이 생성하도록 할 출력 형식.
대부분의 모델은 기본값인 텍스트를 생성할 수 있습니다.

["text"]

gpt-4o-audio-preview 모델을 사용하여 오디오를 생성할 수도 있습니다. 이 모델이 생성하도록 요청하려면
텍스트 및 오디오 응답 모두 다음을 사용할 수 있습니다.

["text", "audio"]		 No
model string 채팅 완료 요청에 사용할 모델 배포 식별자입니다. Yes
n integer 각 입력 메시지에 대해 생성할 채팅 완성 선택 항목 수입니다. 모든 선택 항목에 걸쳐 생성된 토큰 수에 따라 요금이 부과됩니다. 비용을 최소화하려면 n을 1로 유지합니다. No 1
parallel_tool_calls object 도구를 사용하는 동안 병렬 함수 호출을 사용하도록 설정할지 여부입니다. No
prediction object 모델에서 예측된 출력의 기본 표현입니다. No
└─ 형식 OpenAI.ChatOutputPredictionType No
presence_penalty number -2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트에서 발생한 빈도에 따라
텍스트에 지금까지 나타났는지 여부, 모델의 가능성을 높이는지 여부
새로운 주제를 이야기하다.		 No 0
reasoning_effort object o 시리즈 모델만

추론 모델에서 추론 작업을 제한합니다.
현재 지원되는 값은 low, medium 및 high입니다. 줄이는
추론 작업으로 인해 응답 속도가 빨라지고 사용된 토큰 수가 줄어들 수 있습니다.
응답에서의 추론에 관하여		 No
response_format object No
└─ 형식 enum
가능한 값: text, json_objectjson_schema		 No
seed integer 이 기능은 베타 버전으로 제공됩니다.
지정된 경우 시스템은 결정론적으로 샘플링하기 위해 최선을 다하므로 동일한 seed 및 매개 변수를 사용하는 반복 요청이 동일한 결과를 반환해야 합니다.
결정성은 보장되지 않으며 백 엔드의 변경 내용을 모니터링하려면 system_fingerprint 응답 매개 변수를 참조해야 합니다.		 No
stop object 최신 추론 모델 o3 및 o4-mini에서는 지원되지 않습니다.

API가 추가 토큰 생성을 중지하는 최대 4개의 시퀀스입니다. 이
반환된 텍스트는 중지 시퀀스를 포함하지 않습니다.		 No
store boolean 에 대한 이 채팅 완료 요청의 출력을 저장할지 여부
모델 증류나 제품 평가에 사용합니다.		 No False
stream boolean true로 설정하면 모델 응답 데이터가 클라이언트로 스트리밍됩니다.
서버에서 보낸 이벤트를 사용하여 생성됩니다.		 No False
stream_options object 스트리밍 응답에 대한 옵션입니다. stream: true를 설정할 때만 설정합니다. No
└include_usage boolean 설정된 경우 추가 청크가 data: [DONE] 전에 스트리밍됩니다.
메시지가 표시됩니다. 이 청크의 필드에는 usage 토큰 사용 통계가 표시됩니다.
전체 요청에 대해, 해당 choices 필드는 항상 비어 있습니다.
배열.

다른 모든 청크에도 usage 필드가 포함되지만, 그 필드는 null입니다.
값. 메모: 스트림이 중단되면 다음을 수신하지 못할 수 있습니다.
요청에 대한 총 토큰 사용량을 포함하는 최종 사용량 청크입니다.		 No
temperature number 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 더 낮은 값을 지정하면 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.		 No 1
tool_choice OpenAI.ChatCompletionToolChoiceOption 모델이 호출하는 도구(있는 경우)를 제어합니다.
none 는 모델이 도구를 호출하지 않고 대신 메시지를 생성한다는 의미입니다.
auto는 모델이 메시지 생성 또는 하나 이상의 도구 호출 중에서 선택할 수 있음을 의미합니다.
required는 모델이 하나 이상의 도구를 호출해야 함을 의미합니다.
{"type": "function", "function": {"name": "my_function"}}을 사용하여 특정 도구를 지정하면 모델이 해당 도구를 강제 호출하게 됩니다.

none은 도구가 없는 경우 기본값입니다. auto는 도구가 있는 경우 기본값입니다.		 No
tools array 모델이 호출할 수 있는 도구 목록입니다. 현재 함수만 도구로 지원됩니다. 모델이 JSON 입력을 생성할 수 있는 함수 목록을 제공하려면 이를 사용합니다. 최대 128개의 함수가 지원됩니다. No
top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. No
top_p number 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.		 No 1
user string 최종 사용자를 나타내는 고유 식별자이며, 다음에 도움이 될 수 있습니다.
남용을 모니터링하고 감지합니다.		 No
user_security_context AzureUserSecurityContext 사용자 보안 컨텍스트에는 애플리케이션 자체를 설명하는 몇 가지 매개 변수와 애플리케이션과 상호 작용하는 최종 사용자가 포함됩니다. 이러한 필드는 AI 애플리케이션을 보호하는 포괄적인 접근 방식을 제공하여 보안 운영 팀이 보안 인시던트를 조사하고 완화할 수 있도록 지원합니다. 클라우드용 Microsoft Defender를 사용하여 AI 애플리케이션을 보호하는 방법에 대해 자세히 알아봅니다. No

Responses

상태 코드: 200

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

Content-Type Type Description
application/json AzureCreateChatCompletionResponse
text/event-stream AzureCreateChatCompletionStreamResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

제공된 프롬프트, 매개 변수 및 선택한 모델에 대한 완성을 만듭니다.

POST {endpoint}/openai/v1/chat/completions?api-version=preview

{
 "model": "gpt-4o-mini",
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

응답: 상태 코드: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh?..."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

포함 만들기

POST {endpoint}/openai/v1/embeddings?api-version=preview

입력 텍스트를 나타내는 포함 벡터를 만듭니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

Content-Type: application/json

Name Type Description Required Default
dimensions integer 결과 출력 포함에 있어야 하는 차원의 수입니다. text-embedding-3 이상 모델에서만 지원됩니다. No
encoding_format enum 반환할 포함의 형식입니다. float 또는 base64일 수 있습니다.
가능한 값: floatbase64		 No
input 문자열 또는 배열 Yes
model string 포함 요청에 사용할 모델입니다. Yes
user string 최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. No

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.CreateEmbeddingResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

지정된 프롬프트에 대한 포함을 반환합니다.

POST {endpoint}/openai/v1/embeddings?api-version=preview

{
 "model": "text-embedding-ada-002",
 "input": [
  "this is a test"
 ]
}

응답: 상태 코드: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05,
          0.0032178196,
          -0.020365695,
          -0.009631885,
          -0.007647093,
          0.0033837722,
          -0.026764825,
          -0.010501476,
          0.020219658,
          0.024640633,
          -0.0066912062,
          -0.036456455,
          -0.0040923897,
          -0.013966565,
          0.017816665,
          0.005366905,
          0.022835068,
          0.0103488,
          -0.0010811808,
          -0.028942121,
          0.0074280356,
          -0.017033368,
          0.0074877786,
          0.021640211,
          0.002499245,
          0.013316032,
          0.0021524043,
          0.010129742,
          0.0054731146,
          0.03143805,
          0.014856071,
          0.0023366117,
          -0.0008243692,
          0.022781964,
          0.003038591,
          -0.017617522,
          0.0013309394,
          0.0022154662,
          0.00097414135,
          0.012041516,
          -0.027906578,
          -0.023817508,
          0.013302756,
          -0.003003741,
          -0.006890349,
          0.0016744611
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

목록 평가

GET {endpoint}/openai/v1/evals?api-version=preview

프로젝트에 대한 평가를 나열합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
aoai-evals header Yes string
가능한 값: preview		 미리 보기 기능인 AOAI Evals에 액세스할 수 있습니다.
이 기능을 사용하려면 'aoai-evals' 헤더를 '미리 보기'로 설정해야 합니다.
after query No string 이전 페이지 요청의 마지막 평가에 대한 식별자입니다.
limit query No integer 단일 페이지네이션 응답에서 반환될 평가 수에 대한 제한입니다.
order query No string
가능한 값: ascdesc		 평가를 타임스탬프별로 정렬합니다. asc 오름차순으로 정렬하거나
desc 내림차순으로 지정합니다.
order_by query No string
가능한 값: created_atupdated_at		 생성 시간 또는 마지막으로 업데이트된 시간별로 Evals를 정렬할 수 있습니다. 사용
created_at 생성 시간 또는 updated_at 마지막으로 업데이트된 경우
시간.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.EvalList

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

Createeval

POST {endpoint}/openai/v1/evals?api-version=preview

모델의 성능을 테스트하는 데 사용할 수 있는 평가 구조를 만듭니다.

평가는 테스트 조건 및 데이터 원본 집합입니다. 평가를 만든 후 다른 모델 및 모델 매개 변수에서 실행할 수 있습니다. 여러 유형의 채점자 및 데이터 원본을 지원합니다.

참고: 이 Azure OpenAI API는 미리 보기로 제공되며 변경될 수 있습니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
aoai-evals header Yes string
가능한 값: preview		 미리 보기 기능인 AOAI Evals에 액세스할 수 있습니다.
이 기능을 사용하려면 'aoai-evals' 헤더를 '미리 보기'로 설정해야 합니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

Content-Type: application/json

Name Type Description Required Default
데이터 소스 구성 object Yes
└─ 형식 OpenAI.EvalDataSourceConfigType No
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
name string 평가의 이름입니다. No
statusCode enum
가능한 값: 201		 Yes
테스트 기준 array 이 그룹의 모든 평가 실행에 대한 채점자 목록입니다. 채점자는 다음과 같이 {{item.variable_name}}이중 중괄호 표기법을 사용하여 데이터 원본의 변수를 참조할 수 있습니다. 모델의 출력을 참조하려면 네임스페이 sample 스(예: {{sample.output_text}})를 사용합니다. Yes

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.Eval

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

eval 가져오기

GET {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

ID로 평가를 검색합니다. ID로 평가를 검색합니다.

참고: 이 Azure OpenAI API는 미리 보기로 제공되며 변경될 수 있습니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
aoai-evals header Yes string
가능한 값: preview		 미리 보기 기능인 AOAI Evals에 액세스할 수 있습니다.
이 기능을 사용하려면 'aoai-evals' 헤더를 '미리 보기'로 설정해야 합니다.
eval_id path Yes string

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.Eval

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

평가 업데이트

POST {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

지정된 평가의 변경 가능한 선택 속성을 업데이트합니다.

참고: 이 Azure OpenAI API는 미리 보기로 제공되며 변경될 수 있습니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
aoai-evals header Yes string
가능한 값: preview		 미리 보기 기능인 AOAI Evals에 액세스할 수 있습니다.
이 기능을 사용하려면 'aoai-evals' 헤더를 '미리 보기'로 설정해야 합니다.
eval_id path Yes string

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

Content-Type: application/json

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

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
name string No

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.Eval

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

eval을 삭제하세요

DELETE {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

지정된 평가를 삭제합니다.

참고: 이 Azure OpenAI API는 미리 보기로 제공되며 변경될 수 있습니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
aoai-evals header Yes string
가능한 값: preview		 미리 보기 기능인 AOAI Evals에 액세스할 수 있습니다.
이 기능을 사용하려면 'aoai-evals' 헤더를 '미리 보기'로 설정해야 합니다.
eval_id path Yes string

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json object

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

평가 실행 가져오기

GET {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

지정된 평가에 대한 실행 목록을 검색합니다.

참고: 이 Azure OpenAI API는 미리 보기로 제공되며 변경될 수 있습니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
aoai-evals header Yes string
가능한 값: preview		 미리 보기 기능인 AOAI Evals에 액세스할 수 있습니다.
이 기능을 사용하려면 'aoai-evals' 헤더를 '미리 보기'로 설정해야 합니다.
eval_id path Yes string
after query No string
limit query No integer
order query No string
가능한 값: ascdesc
status query No string
가능한 값: queued, in_progress, completed, canceledfailed

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.EvalRunList

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

eval 실행 생성

POST {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

새 평가 실행을 만들어 채점 프로세스를 시작합니다.

참고: 이 Azure OpenAI API는 미리 보기로 제공되며 변경될 수 있습니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
aoai-evals header Yes string
가능한 값: preview		 미리 보기 기능인 AOAI Evals에 액세스할 수 있습니다.
이 기능을 사용하려면 'aoai-evals' 헤더를 '미리 보기'로 설정해야 합니다.
eval_id path Yes string

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

Content-Type: application/json

Name Type Description Required Default
데이터_소스 object Yes
└─ 형식 OpenAI.EvalRunDataSourceType No
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
name string 런의 이름입니다. No

Responses

상태 코드: 201

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

Content-Type Type Description
application/json OpenAI.EvalRun

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

평가 실행 결과 가져오기

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

ID로 실행되는 특정 평가를 검색합니다.

참고: 이 Azure OpenAI API는 미리 보기로 제공되며 변경될 수 있습니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
aoai-evals header Yes string
가능한 값: preview		 미리 보기 기능인 AOAI Evals에 액세스할 수 있습니다.
이 기능을 사용하려면 'aoai-evals' 헤더를 '미리 보기'로 설정해야 합니다.
eval_id path Yes string
run_id path Yes string

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.EvalRun

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

eval 실행 취소

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

ID로 실행되는 특정 평가를 취소합니다.

참고: 이 Azure OpenAI API는 미리 보기로 제공되며 변경될 수 있습니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
aoai-evals header Yes string
가능한 값: preview		 미리 보기 기능인 AOAI Evals에 액세스할 수 있습니다.
이 기능을 사용하려면 'aoai-evals' 헤더를 '미리 보기'로 설정해야 합니다.
eval_id path Yes string
run_id path Yes string

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.EvalRun

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

Deleteevalrun

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

ID로 실행되는 특정 평가를 삭제합니다.

참고: 이 Azure OpenAI API는 미리 보기로 제공되며 변경될 수 있습니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
aoai-evals header Yes string
가능한 값: preview		 미리 보기 기능인 AOAI Evals에 액세스할 수 있습니다.
이 기능을 사용하려면 'aoai-evals' 헤더를 '미리 보기'로 설정해야 합니다.
eval_id path Yes string
run_id path Yes string

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json object

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

eval 실행 출력 항목 가져오기

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items?api-version=preview

지정된 평가 실행에 대한 출력 항목 목록을 가져옵니다.

참고: 이 Azure OpenAI API는 미리 보기로 제공되며 변경될 수 있습니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
aoai-evals header Yes string
가능한 값: preview		 미리 보기 기능인 AOAI Evals에 액세스할 수 있습니다.
이 기능을 사용하려면 'aoai-evals' 헤더를 '미리 보기'로 설정해야 합니다.
eval_id path Yes string
run_id path Yes string
after query No string
limit query No integer
status query No string
가능한 값: failpass
order query No string
가능한 값: ascdesc

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.EvalRunOutputItemList

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

eval 실행 출력 항목 가져오기

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}?api-version=preview

ID로 실행되는 평가에서 특정 출력 항목을 검색합니다.

참고: 이 Azure OpenAI API는 미리 보기로 제공되며 변경될 수 있습니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
aoai-evals header Yes string
가능한 값: preview		 미리 보기 기능인 AOAI Evals에 액세스할 수 있습니다.
이 기능을 사용하려면 'aoai-evals' 헤더를 '미리 보기'로 설정해야 합니다.
eval_id path Yes string
run_id path Yes string
output_item_id path Yes string

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.EvalRunOutputItem

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

파일 만들기

POST {endpoint}/openai/v1/files?api-version=preview

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

콘텐츠 형식: multipart/form-data

Name Type Description Required Default
expires_after object Yes
└) 앵커 AzureFileExpiryAnchor No
└( 초) integer No
file string Yes
목적 enum 업로드된 파일의 의도된 목적. 다음 중 하나: - assistantsAssistants API에서 사용 - batch: Batch API에서 사용됨 - fine-tune: 미세 조정에 사용됨 - evals: eval 데이터 집합에 사용됨
가능한 값: assistants, batch, fine-tuneevals		 Yes

Responses

상태 코드: 200

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

Content-Type Type Description
application/json AzureOpenAIFile

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

POST {endpoint}/openai/v1/files?api-version=preview

파일 나열

GET {endpoint}/openai/v1/files?api-version=preview

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
목적 query No string

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json AzureListFilesResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

파일 검색

GET {endpoint}/openai/v1/files/{file_id}?api-version=preview

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
file_id path Yes string 이 요청에 사용할 파일의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json AzureOpenAIFile

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

파일 삭제

DELETE {endpoint}/openai/v1/files/{file_id}?api-version=preview

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
file_id path Yes string 이 요청에 사용할 파일의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.DeleteFileResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

파일 다운로드

GET {endpoint}/openai/v1/files/{file_id}/content?api-version=preview

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
file_id path Yes string 이 요청에 사용할 파일의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/octet-stream string

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

Rungrader

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run?api-version=preview

채점자를 실행합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

Content-Type: application/json

Name Type Description Required Default
채점자 object 지정된 작업을 사용하여 입력과 참조 간의 문자열 비교를 수행하는 StringCheckGrader 개체입니다. Yes
└calculate_output string 채점자 결과에 따라 출력을 계산하는 수식. No
└─ 평가_기준 enum 사용할 평가 메트릭입니다. fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, 또는 rouge_l 중 하나입니다.
가능한 값: fuzzy_match,, bleu,gleumeteor, rouge_1rouge_2, rouge_3rouge_4, rouge_5rouge_l		 No
└> 채점자 object No
└image_tag string Python 스크립트에 사용할 이미지 태그입니다. No
└─ 입력 array 입력 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다. No
└─ 모델 string 평가에 사용할 모델입니다. No
└) 이름 string 등급자의 이름입니다. No
└작업 enum 수행할 문자열 검사 작업입니다. eq, ne, like 또는 ilike 중 하나입니다.
가능한 값: eq, ne, likeilike		 No
└─ 범위 array 점수의 범위입니다. 기본값은 [0, 1]입니다. No
└─ 참조 string 채점 기준이 되는 텍스트입니다. No
└─ 샘플링_파라미터 모델의 샘플링 매개 변수입니다. No
└) 원본 string Python 스크립트의 소스 코드입니다. No
└─ 형식 enum 항상 multi인 개체 형식입니다.
가능한 값: multi		 No
item 채점자에게 제공되는 데이터 세트 항목입니다. 내용을 채우기 위해 사용됩니다.
네임스페이스입니다 item .		 No
model_sample string 평가할 모델 샘플입니다. 이 값은 채우기 위해 사용됩니다.
네임스페이스입니다 sample .
output_json 모델 샘플이 인 경우 변수가 채워집니다.
유효한 JSON 문자열입니다.		 Yes

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.RunGraderResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

채점자 유효성 검사

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/validate?api-version=preview

채점자의 유효성을 확인하세요.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

Content-Type: application/json

Name Type Description Required Default
채점자 object 지정된 작업을 사용하여 입력과 참조 간의 문자열 비교를 수행하는 StringCheckGrader 개체입니다. Yes
└calculate_output string 채점자 결과에 따라 출력을 계산하는 수식. No
└─ 평가_기준 enum 사용할 평가 메트릭입니다. fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, 또는 rouge_l 중 하나입니다.
가능한 값: fuzzy_match,, bleu,gleumeteor, rouge_1rouge_2, rouge_3rouge_4, rouge_5rouge_l		 No
└> 채점자 object No
└image_tag string Python 스크립트에 사용할 이미지 태그입니다. No
└─ 입력 array 입력 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다. No
└─ 모델 string 평가에 사용할 모델입니다. No
└) 이름 string 등급자의 이름입니다. No
└작업 enum 수행할 문자열 검사 작업입니다. eq, ne, like 또는 ilike 중 하나입니다.
가능한 값: eq, ne, likeilike		 No
└─ 범위 array 점수의 범위입니다. 기본값은 [0, 1]입니다. No
└─ 참조 string 채점 기준이 되는 텍스트입니다. No
└─ 샘플링_파라미터 모델의 샘플링 매개 변수입니다. No
└) 원본 string Python 스크립트의 소스 코드입니다. No
└─ 형식 enum 항상 multi인 개체 형식입니다.
가능한 값: multi		 No

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.ValidateGraderResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

미세 조정 작업을 생성하기

POST {endpoint}/openai/v1/fine_tuning/jobs?api-version=preview

지정된 데이터 세트에서 새 모델을 만드는 프로세스를 시작하는 미세 조정 작업을 만듭니다.

응답에는 작업 상태와 작업이 완료되면 미세 조정된 모델의 이름을 포함한 큐에 있는 작업의 세부 정보가 포함됩니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

Content-Type: application/json

Name Type Description Required Default
하이퍼 매개 변수 object 미세 조정 작업에 사용되는 하이퍼 매개 변수입니다.
이 값은 method 대신 사용되지 않으며, method 매개 변수로 전달해야 합니다.		 No
└batch_size enum
가능한 값: auto		 No
└learning_rate_multiplier enum
가능한 값: auto		 No
└n_epochs enum
가능한 값: auto		 No
통합 array 미세 조정 작업에 사용할 수 있는 통합 목록입니다. No
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
메서드 OpenAI.FineTuneMethod 미세 조정에 사용되는 메서드입니다. No
model string(아래 유효한 모델 참조) 미세 조정할 모델의 이름입니다. Yes
seed integer 시드는 작업의 재현성을 제어합니다. 동일한 시드 및 작업 매개 변수를 전달하면 동일한 결과가 생성되지만 드문 경우에 다를 수 있습니다.
시드를 지정하지 않으면 시드가 생성됩니다.		 No
suffix string 미세 조정된 모델 이름에 추가될 최대 64자의 문자열입니다.

예를 들어 suffix "custom-model-name"은 다음과 같은 ft:gpt-4o-mini:openai:custom-model-name:7p4lURel모델 이름을 생성합니다.		 No None
교육 파일 string 학습 데이터가 포함된 업로드된 파일의 ID입니다. 데이터 세트의 형식을 JSONL 파일로 지정해야 합니다. 또한 용도 fine-tune로 파일을 업로드해야 합니다.

파일의 내용은 모델에서 채팅, 완료 형식을 사용하는지 또는 미세 조정 메서드에서 기본 설정 형식을 사용하는지에 따라 달라야 합니다.		 Yes
검증_파일 string 유효성 검사 데이터를 포함하는 업로드된 파일의 ID입니다.

이 파일을 제공하는 경우 데이터는 유효성 검사를 생성하는 데 사용됩니다.
미세 조정 중에 메트릭을 주기적으로 측정합니다. 이러한 메트릭은 다음에서 볼 수 있습니다.
미세 조정 결과 파일입니다.
학습 파일과 유효성 검사 파일 모두에 동일한 데이터가 있으면 안 됩니다.

데이터 세트의 형식을 JSONL 파일로 지정해야 합니다. 용도 fine-tune로 파일을 업로드해야 합니다.		 No

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

페이지로 구분된 미세 조정 작업 나열

GET {endpoint}/openai/v1/fine_tuning/jobs?api-version=preview

조직의 미세 조정 작업 나열

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
after query No string 이전 페이지 매김 요청의 마지막 작업에 대한 식별자입니다.
limit query No integer 검색할 미세 조정 작업의 수.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.ListPaginatedFineTuningJobsResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

미세 조정 작업 검색

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}?api-version=preview

미세 조정 작업에 대한 정보를 가져옵니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
fine_tuning_job_id (미세 조정 작업 ID) path Yes string 미세 조정 작업의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

미세 조정 작업 취소

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel?api-version=preview

미세 조정 작업을 즉시 취소합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
fine_tuning_job_id (미세 조정 작업 ID) path Yes string 취소할 미세 조정 작업의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

미세 조정 작업 검사점 나열

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=preview

미세 조정 작업의 검사점을 나열합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
fine_tuning_job_id (미세 조정 작업 ID) path Yes string 검사점을 가져오기 위한 미세 조정 작업의 ID.
after query No string 이전 페이지 요청의 마지막 검사점 ID에 대한 식별자입니다.
limit query No integer 검색할 검사점의 수입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.ListFineTuningJobCheckpointsResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

미세 조정 이벤트 나열

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events?api-version=preview

미세 조정 작업에 대한 상태 업데이트를 가져옵니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
fine_tuning_job_id (미세 조정 작업 ID) path Yes string 이벤트를 가져올 미세 조정 작업의 ID.
after query No string 이전 페이지 요청의 마지막 이벤트에 대한 식별자입니다.
limit query No integer 검색할 이벤트의 수입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.ListFineTuningJobEventsResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

미세 조정 작업 일시 중지

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause?api-version=preview

미세 조정 작업을 일시 중지합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
fine_tuning_job_id (미세 조정 작업 ID) path Yes string 일시 중지할 미세 조정 작업의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

미세 조정 작업 다시 시작

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume?api-version=preview

일시 중지된 미세 조정 작업을 다시 시작합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
fine_tuning_job_id (미세 조정 작업 ID) path Yes string 다시 시작할 미세 조정 작업의 ID.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

이미지 편집 만들기

POST {endpoint}/openai/v1/images/edits?api-version=preview

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

콘텐츠 형식: multipart/form-data

Name Type Description Required Default
background enum 생성된 이미지의 배경에 대한 투명도를 설정할 수 있습니다.
이 매개 변수는 gpt-image-1에만 지원됩니다. 다음 중 하나여야 합니다.
transparent opaque 또는auto(기본값) auto가 사용될 때
모델은 이미지에 가장 적합한 배경을 자동으로 결정합니다.

transparent인 경우 출력 형식은 투명성을 지원해야 하므로
png (기본값) 또는 webp 중 하나로 설정해야 합니다.
가능한 값: transparent, opaqueauto		 No
image 문자열 또는 배열 Yes
mask string No
model string 이미지 편집 작업에 사용할 모델 배포입니다. Yes
n integer 생성할 이미지 수입니다. 1에서 10 사이여야 합니다. No 1
output_compression integer 생성된 이미지의 압축 수준(0-100%)입니다. 이 매개 변수
gpt-image-1는 webp 또는 jpeg 출력에서만 지원됩니다.
형식이며 기본값은 100입니다.		 No 100
output_format enum 생성된 이미지가 반환되는 형식입니다. 이 매개 변수는
gpt-image-1만 지원됩니다. png, jpeg, 또는 webp 중 하나여야 합니다.
기본값은 png입니다.
가능한 값: png, jpegwebp		 No
prompt string 원하는 이미지에 대한 텍스트 설명입니다. 최대 길이는 1000자 dall-e-2, 32000자입니다 gpt-image-1. Yes
quality enum 생성될 이미지의 품질입니다. high, medium 및 low는 오직 gpt-image-1에 대해서만 지원됩니다. dall-e-2는 standard 품질만 지원합니다. 기본값은 auto입니다.
가능한 값: standard, low, medium, highauto		 No
response_format enum 생성된 이미지가 반환되는 형식입니다. url 또는 b64_json 중 하나여야 합니다. URL은 이미지가 생성된 후 60분 동안만 유효합니다. 이 매개 변수는 dall-e-2에 대해서만 지원되며, gpt-image-1은 항상 base64로 인코딩된 이미지를 반환합니다.
가능한 값: urlb64_json		 No
size enum 생성된 이미지의 크기입니다. 1024x1024의 경우 1536x1024, 1024x1536(가로), auto(세로) 또는 gpt-image-1(기본값) 중 하나여야 하고, 256x256의 경우 512x512, 1024x1024 또는 dall-e-2 중 하나여야 합니다.
가능한 값: 256x256, 512x512, 1024x10241536x1024, 1024x1536auto		 No
user string 최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. No

Responses

상태 코드: 200

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

Content-Type Type Description
application/json AzureImagesResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

이미지 생성

POST {endpoint}/openai/v1/images/generations?api-version=preview

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

Content-Type: application/json

Name Type Description Required Default
background enum 생성된 이미지의 배경에 대한 투명도를 설정할 수 있습니다.
이 매개 변수는 gpt-image-1에만 지원됩니다. 다음 중 하나여야 합니다.
transparent opaque 또는auto(기본값) auto가 사용될 때
모델은 이미지에 가장 적합한 배경을 자동으로 결정합니다.

transparent인 경우 출력 형식은 투명성을 지원해야 하므로
png (기본값) 또는 webp 중 하나로 설정해야 합니다.
가능한 값: transparent, opaqueauto		 No
model string 이미지 생성에 사용할 모델 배포입니다. Yes
moderation enum 에 의해 gpt-image-1생성된 이미지의 콘텐츠 조정 수준을 제어합니다. 덜 제한적인 필터링 또는 low (기본값) 중 하나 auto 여야 합니다.
가능한 값: lowauto		 No
n integer 생성할 이미지 수입니다. 1에서 10 사이여야 합니다. dall-e-3의 경우, n=1만 지원됩니다. No 1
output_compression integer 생성된 이미지의 압축 수준(0-100%)입니다. 이 매개 변수는 gpt-image-1이 webp 또는 jpeg 출력 형식에서만 지원되며 기본값은 100입니다. No 100
output_format enum 생성된 이미지가 반환되는 형식입니다. 이 매개 변수는 gpt-image-1에만 지원됩니다. png, jpeg, 또는 webp 중 하나여야 합니다.
가능한 값: png, jpegwebp		 No
prompt string 원하는 이미지에 대한 텍스트 설명입니다. 최대 길이는 32000자 gpt-image-1, 1000자 dall-e-2 , 4000자입니다 dall-e-3. Yes
quality enum 생성될 이미지의 품질입니다.

- auto (기본값)은 지정된 모델의 최고 품질을 자동으로 선택합니다.
- high, medium 및 low는 gpt-image-1에 대해 지원됩니다.
- 및 hd는 standard에 대해 dall-e-3를 지원합니다.
- standard는 dall-e-2에 대한 유일한 옵션입니다.
가능한 값: standard, hd, lowmedium, highauto		 No
response_format enum 생성된 이미지가 dall-e-2 및 dall-e-3로 반환되는 형식입니다. url 또는 b64_json 중 하나여야 합니다. URL은 이미지가 생성된 후 60분 동안만 유효합니다. 이 매개 변수는 gpt-image-1에 대해 지원되지 않습니다. gpt-image-1는 항상 base64로 인코딩된 이미지를 반환합니다.
가능한 값: urlb64_json		 No
size enum 생성된 이미지의 크기입니다. 1024x1024의 경우 1536x1024, 1024x1536(가로), auto(세로) 또는 gpt-image-1(기본값) 중 하나여야 하고, 256x256의 경우 512x512, 1024x1024 또는 dall-e-2 중 하나여야 하며, 1024x1024의 경우 1792x1024, 1024x1792 또는 dall-e-3 중 하나여야 합니다.
가능한 값: auto,, 1024x10241536x1024, 1024x1536256x256, 512x512, 1792x10241024x1792		 No
style enum 생성된 이미지의 스타일입니다. 이 매개 변수는 dall-e-3에만 지원됩니다. vivid 또는 natural 중 하나여야 합니다. 생생함이 모델이 초현실적이고 극적인 이미지를 생성하는 쪽으로 유도합니다. 자연은 모델이 더 자연스럽고 덜 실제적인 이미지를 생성하게 합니다.
가능한 값: vividnatural		 No
user string 최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. No

Responses

상태 코드: 200

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

Content-Type Type Description
application/json AzureImagesResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

프롬프트가 지정된 이미지를 만듭니다.

POST {endpoint}/openai/v1/images/generations?api-version=preview

{
 "model": "dall-e-3",
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

응답: 상태 코드: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

모델 나열

GET {endpoint}/openai/v1/models?api-version=preview

현재 사용 가능한 모델을 나열하고 소유자 및 가용성과 같은 각 모델에 대한 기본 정보를 제공합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.ListModelsResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

모델 검색

GET {endpoint}/openai/v1/models/{model}?api-version=preview

모델 인스턴스를 검색하여 소유자 및 권한과 같은 모델에 대한 기본 정보를 제공합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
model path Yes string 이 요청에 사용할 모델의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.Model

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

응답 만들기

POST {endpoint}/openai/v1/responses?api-version=preview

모델 응답을 만듭니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

Content-Type: application/json

Name Type Description Required Default
background boolean 백그라운드에서 모델 응답을 실행할지 여부입니다. No False
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로 설정되거나 조직이
데이터 보존 없음 프로그램에 등록됨).		 No
input 문자열 또는 배열 No
instructions string 모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다.

previous_response_id와 함께 사용할 경우 이전의 지침이 적용됩니다.
응답은 다음 응답으로 전달되지 않습니다. 이렇게 하면 간단해집니다.
새 응답에서 시스템(또는 개발자) 메시지를 교환합니다.		 No
max_output_tokens integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한입니다. No
최대_도구_호출수 integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. No
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
model string 이 응답을 만드는 데 사용할 모델 배포입니다. Yes
parallel_tool_calls boolean 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. No True
previous_response_id string 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다.		 No
prompt object 프롬프트 템플릿 및 해당 변수에 대한 참조입니다. No
└─ ID string 사용할 프롬프트 템플릿의 고유 식별자입니다. No
└) 변수 OpenAI.ResponsePromptVariables 프롬프트에서 변수를 대체할 값의 선택적
맵입니다. 대체 값은 문자열이거나 다른 값일 수 있습니다.
이미지 또는 파일과 같은 응답 입력 형식입니다.		 No
└─ 버전 string 프롬프트 템플릿의 선택적 버전입니다. No
reasoning object o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.		 No
└) 노력 OpenAI.ReasoningEffort o 시리즈 모델만

추론 모델에서 추론 작업을 제한합니다.
현재 지원되는 값은 low, medium 및 high입니다. 줄이는
추론 작업으로 인해 응답 속도가 빨라지고 사용된 토큰 수가 줄어들 수 있습니다.
응답에서의 추론에 관하여		 No
└generate_summary enum 사용되지 않음: 대신 사용합니다 summary .

모델에서 수행하는 추론에 대한 요약입니다. 다음과 같을 수 있습니다.
는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용합니다.
auto, concise 또는 detailed 중 하나입니다.
가능한 값: auto, concisedetailed		 No
└) 요약 enum 모델에서 수행하는 추론에 대한 요약입니다. 다음과 같을 수 있습니다.
는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용합니다.
auto, concise 또는 detailed 중 하나입니다.
가능한 값: auto, concisedetailed		 No
store boolean 를 통해 나중에 검색할 수 있도록 생성된 모델 응답을 저장할지 여부
API.		 No True
stream boolean true로 설정하면 모델 응답 데이터가 클라이언트로 스트리밍됩니다.
서버에서 보낸 이벤트를 사용하여 생성됩니다.		 No False
temperature number 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 더 낮은 값을 지정하면 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.		 No 1
text object 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반 텍스트 또는 구조화된 JSON 데이터일 수 있습니다. No
└─ 형식 OpenAI.ResponseTextFormatConfiguration No
tool_choice object 모델이 호출하는 도구(있는 경우)를 제어합니다.

none 는 모델이 도구를 호출하지 않고 대신 메시지를 생성한다는 의미입니다.

auto 는 모델이 메시지를 생성하거나 메시지를 호출하는 중에서 선택할 수 있습니다.
더 많은 도구.

required는 모델이 하나 이상의 도구를 호출해야 함을 의미합니다.		 No
└─ 형식 OpenAI.ToolChoiceObjectType 모델이 기본 제공 도구를 사용하여 응답을 생성해야 임을 나타냅니다. No
tools array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. 너
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

- 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
파일 검색과 같은 모델의 기능.
- 함수 호출(사용자 지정 도구): 사용자가 정의한 함수
모델을 사용하여 사용자 고유의 코드를 호출할 수 있습니다.		 No
top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. No
top_p number 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.		 No 1
truncation enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled		 No
user string 최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. No

Responses

상태 코드: 200

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

Content-Type Type Description
application/json AzureResponse
text/event-stream OpenAI.ResponseStreamEvent

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

모델 응답 만들기

POST {endpoint}/openai/v1/responses?api-version=preview

응답 가져오기

GET {endpoint}/openai/v1/responses/{response_id}?api-version=preview

지정된 ID를 사용하여 모델 응답을 검색합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
response_id path Yes string
include[] query No array

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json AzureResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

응답 삭제

DELETE {endpoint}/openai/v1/responses/{response_id}?api-version=preview

ID별로 응답을 삭제합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
response_id path Yes string

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json object

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

입력 항목 나열

GET {endpoint}/openai/v1/responses/{response_id}/input_items?api-version=preview

지정된 응답에 대한 입력 항목 목록을 반환합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
response_id path Yes string
limit query No integer 반환할 개체 수에 대한 제한입니다. 제한 범위는 1에서 100 사이이며
기본값은 20입니다.
order query No string
가능한 값: ascdesc		 개체의 created_at 타임스탬프를 기준으로 순서를 정렬합니다. asc(오름차순의 경우), desc
(내림차순의 경우).
after query No string 페이지 매김에 사용되는 커서입니다. after는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 다음 페이지를 가져오기 위해 after=obj_foo 포함할 수 있습니다.
before query No string 페이지 매김에 사용되는 커서입니다. before는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 이전 페이지를 가져오기 위해 before=obj_foo 포함할 수 있습니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.ResponseItemList

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

벡터 저장소 나열

GET {endpoint}/openai/v1/vector_stores?api-version=preview

벡터 저장소 목록을 반환합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
limit query No integer 반환할 개체 수에 대한 제한입니다. 제한 범위는 1에서 100 사이이며
기본값은 20입니다.
order query No string
가능한 값: ascdesc		 개체의 created_at 타임스탬프를 기준으로 순서를 정렬합니다. asc(오름차순의 경우), desc
(내림차순의 경우).
after query No string 페이지 매김에 사용되는 커서입니다. after는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 다음 페이지를 가져오기 위해 after=obj_foo 포함할 수 있습니다.
before query No string 페이지 매김에 사용되는 커서입니다. before는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 이전 페이지를 가져오기 위해 before=obj_foo 포함할 수 있습니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.ListVectorStoresResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

벡터 저장소 만들기

POST {endpoint}/openai/v1/vector_stores?api-version=preview

벡터 저장소를 만듭니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

Content-Type: application/json

Name Type Description Required Default
chunking_strategy object 기본 전략. 이 전략은 현재 max_chunk_size_tokens의 800 및 chunk_overlap_tokens의 400을 사용합니다. No
└> static OpenAI.StaticChunkingStrategy No
└─ 형식 enum 항상 static입니다.
가능한 값: static		 No
expires_after OpenAI.VectorStoreExpirationAfter 벡터 저장소에 대한 만료 정책입니다. No
file_ids array 벡터 저장소에서 사용해야 하는 파일 ID 목록입니다. 파일에 액세스할 수 있는 file_search와 같은 도구에 유용합니다. No
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
name string 벡터 저장소의 이름입니다. No

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreObject

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

Examples

예제 파일을 찾을 수 없습니다. ./examples/vector_stores.json

벡터 저장소 가져오기

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

벡터 저장소를 검색합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
벡터 저장소 ID path Yes string 검색할 벡터 저장소의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreObject

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

벡터 저장소 수정

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

벡터 저장소를 수정합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
벡터 저장소 ID path Yes string 수정할 벡터 저장소의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

Content-Type: application/json

Name Type Description Required Default
expires_after object 벡터 저장소에 대한 만료 정책입니다. No
└) 앵커 enum 만료 정책이 적용되는 앵커 타임스탬프입니다. 지원되는 앵커: last_active_at.
가능한 값: last_active_at		 No
└요일 integer 벡터 저장소가 만료되는 앵커 시간 이후의 일 수입니다. No
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
name string 벡터 저장소의 이름입니다. No

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreObject

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

벡터 저장소 삭제

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

벡터 저장소를 삭제합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
벡터 저장소 ID path Yes string 삭제할 벡터 저장소의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.DeleteVectorStoreResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

벡터 저장소 파일 일괄 처리 만들기

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches?api-version=preview

벡터 저장소 파일 일괄 처리를 만듭니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
벡터 저장소 ID path Yes string 파일 일괄 처리를 만들 벡터 저장소의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

Content-Type: application/json

Name Type Description Required Default
특성 object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다. 키는 문자열입니다.
최대 길이는 64자입니다. 값은 최대값이 있는 문자열입니다.
최대 512자, 부울 또는 숫자.		 No
chunking_strategy OpenAI.ChunkingStrategyRequestParam 파일을 청크하는 데 사용되는 청크 전략입니다. 설정하지 않으면 auto 전략을 사용합니다. No
file_ids array 벡터 저장소에서 사용해야 하는 파일 ID 목록입니다. 파일에 액세스할 수 있는 file_search와 같은 도구에 유용합니다. Yes

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileBatchObject

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

벡터 저장소 파일 일괄 가져오기

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=preview

벡터 저장소 파일 일괄 처리를 검색합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
벡터 저장소 ID path Yes string 파일 일괄 처리가 속한 벡터 저장소의 ID입니다.
batch_id path Yes string 검색 중인 파일 일괄 처리의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileBatchObject

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

벡터 저장소 파일 일괄 처리 취소

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=preview

벡터 저장소 파일 일괄 처리를 취소합니다. 이렇게 하면 가능한 빨리 이 일괄 처리의 파일 처리를 취소하려고 시도합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
벡터 저장소 ID path Yes string 파일 일괄 처리가 속한 벡터 저장소의 ID입니다.
batch_id path Yes string 취소할 파일 일괄 처리의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileBatchObject

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

벡터 저장소에서 파일을 일괄 나열

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=preview

벡터 저장소 파일 목록을 일괄 처리로 반환합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
벡터 저장소 ID path Yes string 파일 일괄 처리가 속한 벡터 저장소의 ID입니다.
batch_id path Yes string 파일이 속한 파일 일괄 처리의 ID입니다.
limit query No integer 반환할 개체 수에 대한 제한입니다. 제한 범위는 1에서 100 사이이며
기본값은 20입니다.
order query No string
가능한 값: ascdesc		 개체의 created_at 타임스탬프를 기준으로 순서를 정렬합니다. asc(오름차순의 경우), desc
(내림차순의 경우).
after query No string 페이지 매김에 사용되는 커서입니다. after는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 다음 페이지를 가져오기 위해 after=obj_foo 포함할 수 있습니다.
before query No string 페이지 매김에 사용되는 커서입니다. before는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 이전 페이지를 가져오기 위해 before=obj_foo 포함할 수 있습니다.
필터 query No 파일 상태를 필터링합니다. in_progress, completed, failed, cancelled 중에 하나.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.ListVectorStoreFilesResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

벡터 저장소 파일 나열

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=preview

벡터 저장소 파일 목록을 반환합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
벡터 저장소 ID path Yes string 파일이 속한 벡터 저장소의 ID입니다.
limit query No integer 반환할 개체 수에 대한 제한입니다. 제한 범위는 1에서 100 사이이며
기본값은 20입니다.
order query No string
가능한 값: ascdesc		 개체의 created_at 타임스탬프를 기준으로 순서를 정렬합니다. asc(오름차순의 경우), desc
(내림차순의 경우).
after query No string 페이지 매김에 사용되는 커서입니다. after는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 다음 페이지를 가져오기 위해 after=obj_foo 포함할 수 있습니다.
before query No string 페이지 매김에 사용되는 커서입니다. before는 목록에서의 위치를 정의하는 개체 ID입니다.
예를 들어 목록 요청을 수행하여 obj_foo로 끝나는 100개의 객체를 받는 경우
후속 호출은 목록의 이전 페이지를 가져오기 위해 before=obj_foo 포함할 수 있습니다.
필터 query No 파일 상태를 필터링합니다. in_progress, completed, failed, cancelled 중에 하나.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.ListVectorStoreFilesResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

벡터 저장소 파일 만들기

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=preview

벡터 저장소에 파일을 연결하여 벡터 저장소 파일을 만듭니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
벡터 저장소 ID path Yes string 파일을 만들 벡터 저장소의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

Content-Type: application/json

Name Type Description Required Default
특성 object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다. 키는 문자열입니다.
최대 길이는 64자입니다. 값은 최대값이 있는 문자열입니다.
최대 512자, 부울 또는 숫자.		 No
chunking_strategy OpenAI.ChunkingStrategyRequestParam 파일을 청크하는 데 사용되는 청크 전략입니다. 설정하지 않으면 auto 전략을 사용합니다. No
file_id string 벡터 저장소에서 사용해야 하는 파일 ID입니다. 파일에 액세스할 수 있는 file_search와 같은 도구에 유용합니다. Yes

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileObject

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

벡터 저장소 파일 가져오기

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

벡터 저장소 파일을 검색합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
벡터 저장소 ID path Yes string 파일이 속한 벡터 저장소의 ID입니다.
file_id path Yes string 검색할 파일의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileObject

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

벡터 저장소 파일 특성 업데이트

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
벡터 저장소 ID path Yes string
file_id path Yes string

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

Content-Type: application/json

Name Type Description Required Default
특성 object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다. 키는 문자열입니다.
최대 길이는 64자입니다. 값은 최대값이 있는 문자열입니다.
최대 512자, 부울 또는 숫자.		 Yes

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileObject

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

벡터 저장소 파일 삭제

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

벡터 저장소 파일을 삭제합니다. 이렇게 하면 벡터 저장소에서 파일이 제거되지만 파일 자체는 삭제되지 않습니다. 파일을 삭제하려면 파일 삭제 엔드포인트를 사용합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
벡터 저장소 ID path Yes string 파일이 속한 벡터 저장소의 ID입니다.
file_id path Yes string 삭제할 파일의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json OpenAI.DeleteVectorStoreFileResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureErrorResponse

비디오 생성 작업 - 만들기

POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview

새 비디오 생성 작업을 만듭니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

요청 본문

Content-Type: application/json

Name Type Description Required Default
height integer 비디오의 높이입니다. 지원되는 해상도는 가로 방향과 세로 방향 모두에서 480x480, 854x480, 720x720, 1280x720, 1080x1080 및 1920x1080입니다. Yes
model string 이 요청에 사용할 배포의 이름입니다. Yes
n_seconds integer 비디오 생성 작업의 기간입니다. 1~20초 사이여야 합니다. No 5
n_variants integer 이 작업에 대한 변형으로 만들 비디오 수입니다. 1~5 사이여야 합니다. 크기가 작을수록 더 많은 변형이 허용됩니다. No 1
prompt string 이 비디오 생성 작업에 대한 프롬프트입니다. Yes
width integer 비디오의 너비입니다. 지원되는 해상도는 가로 방향과 세로 방향 모두에서 480x480, 854x480, 720x720, 1280x720, 1080x1080 및 1920x1080입니다. Yes

요청 본문

콘텐츠 형식: multipart/form-data

Name Type Description Required Default
files array Yes
height integer 비디오의 높이입니다. 지원되는 해상도는 가로 방향과 세로 방향 모두에서 480x480, 854x480, 720x720, 1280x720, 1080x1080 및 1920x1080입니다. Yes
inpaint_items array 이 동영상 생성 작업을 위한 선택적 페인팅 항목. No
model string 이 요청에 사용할 배포의 이름입니다. Yes
n_seconds integer 비디오 생성 작업의 기간입니다. 1~20초 사이여야 합니다. No 5
n_variants integer 이 작업에 대한 변형으로 만들 비디오 수입니다. 1~5 사이여야 합니다. 크기가 작을수록 더 많은 변형이 허용됩니다. No 1
prompt string 이 비디오 생성 작업에 대한 프롬프트입니다. Yes
width integer 비디오의 너비입니다. 지원되는 해상도는 가로 방향과 세로 방향 모두에서 480x480, 854x480, 720x720, 1280x720, 1080x1080 및 1920x1080입니다. Yes

Responses

상태 코드: 200

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

Content-Type Type Description
application/json VideoGenerationJob

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

예제 파일을 찾을 수 없습니다. ./examples/create_video_generation_job_simple.json

비디오 생성 작업 - 목록

GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview

비디오 생성 작업을 나열합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
before query No string
after query No string
limit query Yes integer
statuses query No array

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json VideoGenerationJobList

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

예제 파일을 찾을 수 없습니다. ./examples/get_video_generation_job_list.json

비디오 생성 작업 - 가져오기

GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

비디오 생성 작업의 속성을 검색합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
job-id path Yes string Azure OpenAI 요청에 사용할 비디오 생성 작업의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json VideoGenerationJob

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

예제 파일을 찾을 수 없습니다. ./examples/get_video_generation_job.json

비디오 생성 작업 - 삭제

DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

비디오 생성 작업을 삭제합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
job-id path Yes string Azure OpenAI 요청에 사용할 비디오 생성 작업의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 204

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

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

비디오 세대 - 가져오기

GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview

ID별로 비디오 생성을 검색합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
generation-id path Yes string Azure OpenAI 요청에 사용할 비디오 생성의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
application/json VideoGeneration

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

예제 파일을 찾을 수 없습니다. ./examples/get_video_generation.json

비디오 생성 - 썸네일 검색

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api-version=preview

생성된 비디오 콘텐츠의 썸네일을 검색합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
generation-id path Yes string Azure OpenAI 요청에 사용할 비디오 생성의 ID입니다.

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
image/jpg string

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

비디오 세대 - 비디오 콘텐츠 검색

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

생성된 비디오 콘텐츠를 검색합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
generation-id path Yes string Azure OpenAI 요청에 사용할 비디오 생성의 ID입니다.
quality query No

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

Content-Type Type Description
video/mp4 string

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

비디오 생성 - 비디오 콘텐츠 헤더만 검색

HEAD {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

생성된 비디오 콘텐츠의 헤더를 검색합니다.

URI 매개 변수

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름(예: https://aoairesource.openai.azure.com). "aoairesource"를 Azure OpenAI 리소스 이름으로 대체). https://{your-resource-name}.openai.azure.com
api-version query No 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우
generation-id path Yes string Azure OpenAI 요청에 사용할 비디오 생성의 ID입니다.
quality query No

요청 헤더

토큰 기반 인증 또는 API 키를 사용합니다. 토큰 기반 인증을 사용하여 인증하는 것이 좋습니다.

Name Required Type Description
Authorization True string 예제Authorization: Bearer {Azure_OpenAI_Auth_Token}:

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

형식: oauth2
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위: https://cognitiveservices.azure.com/.default
api-key True string 여기에서 Azure OpenAI API 키를 제공합니다.

Responses

상태 코드: 200

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

상태 코드: 기본값

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

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Components

AudioTaskLabel

사용 가능한 오디오 작업 응답에 사용할 수 있는 설명자를 정의합니다.

Property Value
Description 사용 가능한 오디오 작업 응답에 사용할 수 있는 설명자를 정의합니다.
Type string
Values transcribe
translate

오디오번역세그먼트

번역된 오디오 데이터의 단일 세그먼트에 대한 확장 정보입니다. 세그먼트는 일반적으로 약 5-10초의 음성을 나타냅니다. 세그먼트 경계는 일반적으로 단어 사이에 발생하지만 반드시 문장은 아닙니다.

Name Type Description Required Default
avg_logprob number 이 오디오 세그먼트와 연결된 평균 로그 확률입니다. Yes
compression_ratio number 이 오디오 세그먼트의 압축 비율입니다. Yes
end number 번역된 오디오의 시작을 기준으로 이 세그먼트가 종료된 시간입니다. Yes
id integer 변환 내에서 이 세그먼트의 0부터 시작하는 인덱스입니다. Yes
no_speech_prob number 이 오디오 세그먼트 내에서 음성 검출이 없을 확률입니다. Yes
seek integer 이 오디오 세그먼트의 처리와 관련된 검색 위치입니다.
탐색 위치는 백분의 초 단위로 표현됩니다.
모델은 단일 검색 위치에서 여러 세그먼트를 처리할 수 있으므로 검색 위치는 나타내지 않습니다.
세그먼트 시작 시간보다 늦은 경우 세그먼트 시작 시간은 세그먼트 시작 시간보다 상당히 늦은 시간을 나타낼 수 있습니다.
세그먼트의 연결된 검색 위치입니다.		 Yes
start number 번역된 오디오의 시작을 기준으로 이 세그먼트가 시작된 시간입니다. Yes
temperature number 이 오디오 세그먼트와 연결된 온도 점수입니다. Yes
text string 이 오디오 세그먼트의 일부인 번역된 텍스트입니다. Yes
tokens array 이 오디오 세그먼트의 번역된 텍스트와 일치하는 토큰 ID입니다. Yes

AzureAIFoundryModelsApiVersion

Property Value
Type string
Values v1
preview

AzureAudioTranscriptionResponse

음성 오디오를 쓰기 텍스트로 전사한 작업에 대한 결과 정보입니다.

Name Type Description Required Default
duration number 수반되는 대화 내용 기록 정보를 생성하기 위해 처리된 오디오의 총 길이입니다. No
language string 기록된 오디오 데이터에서 검색된 구어체 언어입니다.
이는 'en' 또는 'fr'과 같은 두 글자 ISO-639-1 언어 코드로 표현됩니다.		 No
segments array 처리된 각 오디오 세그먼트의 타이밍, 확률 및 기타 세부 정보에 대한 정보 컬렉션입니다. No
task object 사용 가능한 오디오 작업 응답에 사용할 수 있는 설명자를 정의합니다. No
text string 제공된 오디오 데이터에 대한 전사된 텍스트입니다. Yes
words array 처리된 각 단어의 타이밍에 대한 정보 컬렉션입니다. No

AzureAudioTranslationResponse

음성 오디오를 쓰기 텍스트로 번역한 작업에 대한 결과 정보입니다.

Name Type Description Required Default
duration number 함께 제공되는 번역 정보를 생성하기 위해 처리된 오디오의 총 기간입니다. No
language string 번역된 오디오 데이터에서 검색된 음성 언어입니다.
이는 'en' 또는 'fr'과 같은 두 글자 ISO-639-1 언어 코드로 표현됩니다.		 No
segments array 처리된 각 오디오 세그먼트의 타이밍, 확률 및 기타 세부 정보에 대한 정보 컬렉션입니다. No
task object 사용 가능한 오디오 작업 응답에 사용할 수 있는 설명자를 정의합니다. No
text string 제공된 오디오 데이터에 대한 번역된 텍스트입니다. Yes

AzureChatCompletionResponseMessage

Azure OpenAI 서비스의 채팅 완료 응답 메시지에 대한 확장 응답 모델 구성 요소입니다. 이 모델은 On Your Data 기능에 의해 수행된 검색 보강 생성과 관련된 의도, 인용 및 기타 정보에 사용되는 채팅 메시지 컨텍스트에 대한 지원을 추가합니다.

Name Type Description Required Default
annotations array 해당되는 경우 메시지에 대한 주석은 다음을 사용할 때와 같습니다.
웹 검색 도구.		 No
audio object 오디오 출력 모드가 요청되면 이 개체는 모델의 음성 응답에 대한
데이터를 포함합니다.		 No
└) 데이터 string 요청에 지정된 형식으로 모델에서 생성된 Base64 인코딩된
오디오 바이트입니다.		 No
└─ 만료_시간 integer 멀티 턴 대화에서 이 음성 응답에 더 이상 서버에서
액세스할 수 없게 되는 Unix
타임스탬프(초)입니다.		 No
└─ ID string 이 오디오 응답의 고유 식별자입니다. No
└) 대본 string 모델에서 생성한 오디오의 음성 텍스트입니다. No
content string 메시지의 콘텐츠입니다. Yes
context object 채팅 완료 응답 메시지에 추가된 추가 속성으로, 사용할 때 Azure OpenAI 서비스에서 생성합니다.
확장 동작입니다. 여기에는 데이터 기반 기능의 의도 및 인용 정보가 포함됩니다.		 No
└all_retrieved_documents object 데이터 검색 작업으로 검색된 문서에 대한 요약 정보입니다. No
└chunk_id string 인용의 부분 ID입니다. No
└─ 콘텐츠 string 인용의 콘텐츠입니다. No
└데이터_소스_인덱스 integer 검색에 사용되는 데이터 원본의 인덱스입니다. No
└─ 파일경로 string 인용의 파일 경로입니다. No
└필터_이유 enum 해당하는 경우 문서가 필터링된 이유를 나타냅니다.
가능한 값: scorererank		 No
└original_search_score number 검색을 위한 원래 검색 점수입니다. No
└rerank_score number 검색에 대한 다시 순위매기기 점수입니다. No
└─search_queries array 문서를 검색하기 위해 실행된 검색 쿼리입니다. No
└─ 제목 string 인용 제목입니다. No
└) url string 인용의 URL입니다. No
└) 인용 array 데이터 검색에 의해 생성된 인용입니다. No
└) 의도 string 채팅 기록에서 검색된 의도로, 상호 작용 간에 대화 컨텍스트를 전달하는 데 사용됩니다. No
function_call object 더 이상 사용되지 않으며 tool_calls로 대체되었습니다. 모델에 의해 생성된 대로 호출되어야 하는 함수의 이름과 인수입니다. No
└─ 인수 string No
└) 이름 string No
reasoning_content string 지원되는 모델에서 생성된 추론 콘텐츠를 포함하는 Azure 관련 확장 속성입니다. No
refusal string 모델이 생성한 거부 메시지입니다. Yes
role enum 이 메시지 작성자의 역할입니다.
가능한 값: assistant		 Yes
tool_calls ChatCompletionMessageToolCallsItem 함수 호출과 같이 모델에서 생성된 도구 호출입니다. No

AzureChatCompletionStreamResponseDelta

Azure OpenAI 서비스의 스트리밍 채팅 응답 메시지에 대한 확장 응답 모델입니다. 이 모델은 On Your Data 기능에 의해 수행된 검색 보강 생성과 관련된 의도, 인용 및 기타 정보에 사용되는 채팅 메시지 컨텍스트에 대한 지원을 추가합니다.

Name Type Description Required Default
audio object No
└) 데이터 string No
└─ 만료_시간 integer No
└─ ID string No
└) 대본 string No
content string 청크 메시지의 콘텐츠입니다. No
context object 채팅 완료 응답 메시지에 추가된 추가 속성으로, 사용할 때 Azure OpenAI 서비스에서 생성합니다.
확장 동작입니다. 여기에는 데이터 기반 기능의 의도 및 인용 정보가 포함됩니다.		 No
└all_retrieved_documents object 데이터 검색 작업으로 검색된 문서에 대한 요약 정보입니다. No
└chunk_id string 인용의 부분 ID입니다. No
└─ 콘텐츠 string 인용의 콘텐츠입니다. No
└데이터_소스_인덱스 integer 검색에 사용되는 데이터 원본의 인덱스입니다. No
└─ 파일경로 string 인용의 파일 경로입니다. No
└필터_이유 enum 해당하는 경우 문서가 필터링된 이유를 나타냅니다.
가능한 값: scorererank		 No
└original_search_score number 검색을 위한 원래 검색 점수입니다. No
└rerank_score number 검색에 대한 다시 순위매기기 점수입니다. No
└─search_queries array 문서를 검색하기 위해 실행된 검색 쿼리입니다. No
└─ 제목 string 인용 제목입니다. No
└) url string 인용의 URL입니다. No
└) 인용 array 데이터 검색에 의해 생성된 인용입니다. No
└) 의도 string 채팅 기록에서 검색된 의도로, 상호 작용 간에 대화 컨텍스트를 전달하는 데 사용됩니다. No
function_call object 더 이상 사용되지 않으며 tool_calls로 대체되었습니다. 모델에 의해 생성된 대로 호출되어야 하는 함수의 이름과 인수입니다. No
└─ 인수 string No
└) 이름 string No
reasoning_content string 지원되는 모델에서 생성된 추론 콘텐츠를 포함하는 Azure 관련 확장 속성입니다. No
refusal string 모델이 생성한 거부 메시지입니다. No
role object 메시지 작성자의 역할 No
tool_calls array No

AzureChatDataSource

단일 Azure OpenAI 채팅 데이터 원본에 대한 구성 데이터의 표현입니다. Azure OpenAI 채팅 확장을 사용하여 응답 동작을 보강해야 하는 채팅 완성 요청에 사용됩니다. 이 구성의 사용은 Azure OpenAI와만 호환됩니다.

AzureChatDataSource에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
azure_search AzureSearchChatDataSource
azure_cosmos_db AzureCosmosDBChatDataSource
elasticsearch ElasticsearchChatDataSource
pinecone PineconeChatDataSource
mongo_db MongoDBChatDataSource
Name Type Description Required Default
type object Yes

AzureChatDataSourceAccessTokenAuthenticationOptions

Name Type Description Required Default
access_token string Yes
type enum
가능한 값: access_token		 Yes

AzureChatDataSourceApiKeyAuthenticationOptions

Name Type Description Required Default
key string Yes
type enum
가능한 값: api_key		 Yes

AzureChatDataSourceAuthenticationOptions

AzureChatDataSourceAuthenticationOptions에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
system_assigned_managed_identity AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions
user_assigned_managed_identity AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions
access_token AzureChatDataSourceAccessTokenAuthenticationOptions
connection_string AzureChatDataSourceConnectionStringAuthenticationOptions
key_and_key_id AzureChatDataSourceKeyAndKeyIdAuthenticationOptions
encoded_api_key AzureChatDataSourceEncodedApiKeyAuthenticationOptions
username_and_password AzureChatDataSourceUsernameAndPasswordAuthenticationOptions
Name Type Description Required Default
type AzureChatDataSourceAuthenticationOptionsType Yes

AzureChatDataSourceAuthenticationOptionsType

Property Value
Type string
Values api_key
username_and_password
connection_string
key_and_key_id
encoded_api_key
access_token
system_assigned_managed_identity
user_assigned_managed_identity

AzureChatDataSourceConnectionStringAuthenticationOptions

Name Type Description Required Default
connection_string string Yes
type enum
가능한 값: connection_string		 Yes

AzureChatDataSourceDeploymentNameVectorizationSource

Azure OpenAI 임베딩 모델 배포에 대해 내부 서비스 호출을 수행하는 벡터화 소스를 나타냅니다. 엔드포인트 기반 벡터화 원본과 달리 배포 이름 기반 벡터화 원본은 동일한 Azure OpenAI 리소스의 일부여야 하지만 프라이빗 네트워크에서도 사용할 수 있습니다.

Name Type Description Required Default
deployment_name string 벡터화에 사용할 임베딩 모델 배포입니다. 이 배포는 동일한 Azure OpenAI 내에 있어야 합니다.
채팅 완료에 사용되는 모델 배포로서의 리소스.		 Yes
dimensions integer 임베딩에서 요청할 차원의 수입니다.
'text-embedding-3' 이상 모델에서만 지원됩니다.		 No
type enum 이 벡터화 원본 형식 유형에 대한 식별자는 항상 'deployment_name'입니다.
가능한 값: deployment_name		 Yes

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

Name Type Description Required Default
encoded_api_key string Yes
type enum
가능한 값: encoded_api_key		 Yes

AzureChatDataSourceEndpointVectorizationSource

Azure OpenAI 임베딩 모델 배포에 대해 공공 서비스 호출을 수행하는 벡터화 소스를 나타냅니다.

Name Type Description Required Default
authentication object Yes
└─ 엑세스_토큰 string No
└) 키 string No
└─ 형식 enum
가능한 값: access_token		 No
dimensions integer 임베딩에서 요청할 차원의 수입니다.
'text-embedding-3' 이상 모델에서만 지원됩니다.		 No
endpoint string 포함을 검색할 리소스 엔드포인트 URL을 지정합니다.
다음 형식이어야 합니다.
https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings.
api-version 쿼리 매개 변수는 허용되지 않습니다.		 Yes
type enum 이 벡터화 소스 유형의 형식 식별자는 항상 '엔드포인트'입니다.
가능한 값: endpoint		 Yes

AzureChatDataSourceIntegratedVectorizationSource

지원 검색 리소스 내에 정의된 통합 벡터화 원본을 나타냅니다.

Name Type Description Required Default
type enum 이 벡터화 원본 유형에 대해 항상 '통합'된 형식 식별자입니다.
가능한 값: integrated		 Yes

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

Name Type Description Required Default
key string Yes
key_id string Yes
type enum
가능한 값: key_and_key_id		 Yes

AzureChatDataSourceModelIdVectorizationSource

검색 서비스 모델 ID를 기반으로 서비스를 호출하는 벡터화 원본을 나타냅니다. 이 원본 형식은 현재 Elasticsearch에서만 지원됩니다.

Name Type Description Required Default
model_id string 벡터화에 사용할 포함 모델 빌드 ID입니다. Yes
type enum 이 벡터화 원본 유형에 대한 형식 식별자는 항상 'model_id'입니다.
가능한 값: model_id		 Yes

AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions

Name Type Description Required Default
type enum
가능한 값: system_assigned_managed_identity		 Yes

AzureChatDataSourceType

Property Value
Type string
Values azure_search
azure_cosmos_db
elasticsearch
pinecone
mongo_db

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

Name Type Description Required Default
managed_identity_resource_id string Yes
type enum
가능한 값: user_assigned_managed_identity		 Yes

AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Name Type Description Required Default
password string Yes
type enum
가능한 값: username_and_password		 Yes
username string Yes

AzureChatDataSourceVectorizationSource

데이터 원본을 포함하는 리소스로 사용할 수 있는 데이터 벡터화 원본의 표현입니다.

AzureChatDataSourceVectorizationSource에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
deployment_name AzureChatDataSourceDeploymentNameVectorizationSource
integrated AzureChatDataSourceIntegratedVectorizationSource
model_id AzureChatDataSourceModelIdVectorizationSource
Name Type Description Required Default
type object Yes

AzureChatDataSourceVectorizationSourceType

Property Value
Type string
Values endpoint
deployment_name
model_id
integrated

AzureChatMessageContext

확장 동작을 사용할 때 Azure OpenAI 서비스에서 생성한 채팅 완료 응답 메시지에 추가된 추가 속성입니다. 여기에는 데이터 기반 기능의 의도 및 인용 정보가 포함됩니다.

Name Type Description Required Default
all_retrieved_documents object 데이터 검색 작업으로 검색된 문서에 대한 요약 정보입니다. No
└chunk_id string 인용의 부분 ID입니다. No
└─ 콘텐츠 string 인용의 콘텐츠입니다. No
└데이터_소스_인덱스 integer 검색에 사용되는 데이터 원본의 인덱스입니다. No
└─ 파일경로 string 인용의 파일 경로입니다. No
└필터_이유 enum 해당하는 경우 문서가 필터링된 이유를 나타냅니다.
가능한 값: scorererank		 No
└original_search_score number 검색을 위한 원래 검색 점수입니다. No
└rerank_score number 검색에 대한 다시 순위매기기 점수입니다. No
└─search_queries array 문서를 검색하기 위해 실행된 검색 쿼리입니다. No
└─ 제목 string 인용 제목입니다. No
└) url string 인용의 URL입니다. No
citations array 데이터 검색에 의해 생성된 인용입니다. No
intent string 채팅 기록에서 검색된 의도로, 상호 작용 간에 대화 컨텍스트를 전달하는 데 사용됩니다. No

AzureContentFilterBlocklistResult

구성된 사용자 지정 차단 목록에 대한 true/false 필터링 결과의 컬렉션입니다.

Name Type Description Required Default
details array 개별 차단 목록 ID 쌍과 이들이 필터링 작업을 야기했는지 여부입니다. No
filtered boolean 자세한 차단 목록 중에서 필터링 작업이 발생했는지 여부를 나타내는 값입니다. Yes

AzureContentFilterCompletionTextSpan

Azure OpenAI 콘텐츠 필터 결과에서 사용하는 완료 텍스트 범위의 표현입니다.

Name Type Description Required Default
completion_end_offset integer 범위에서 제외되는 첫 번째 UTF32 코드 포인트의 오프셋입니다. 이 필드는 빈 범위에 대해 항상 completion_start_offset과 같습니다. 이 필드는 비어있지 않은 범위에 대해 항상 completion_start_offset보다 큽니다. Yes
completion_start_offset integer 범위를 시작하는 UTF32 코드 포인트의 오프셋입니다. Yes

AzureContentFilterCompletionTextSpanDetectionResult

Name Type Description Required Default
details array 검색된 완료 텍스트 범위에 대한 자세한 정보입니다. Yes
detected boolean 콘텐츠에서 레이블이 지정된 콘텐츠 범주가 검색되었는지 여부입니다. Yes
filtered boolean 콘텐츠 검색으로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. Yes

AzureContentFilterCustomTopicResult

구성된 사용자 지정 토픽에 대한 true/false 필터링 결과의 컬렉션입니다.

Name Type Description Required Default
details array 개별 토픽 ID의 쌍과 해당 쌍이 감지되는지 여부. No
filtered boolean 자세한 항목이 필터링 작업을 발생시켰는지 여부를 나타내는 값입니다. Yes

AzureContentFilterDetectionResult

콘텐츠가 검색되었는지 여부 및 콘텐츠가 필터링되었는지 여부를 나타내는 레이블이 지정된 콘텐츠 필터 결과 항목입니다.

Name Type Description Required Default
detected boolean 콘텐츠에서 레이블이 지정된 콘텐츠 범주가 검색되었는지 여부입니다. Yes
filtered boolean 콘텐츠 검색으로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. Yes

AzureContentFilterImagePromptResults

이미지 생성 작업의 입력 요청 콘텐츠에 대한 콘텐츠 필터 결과입니다.

Name Type Description Required Default
custom_blocklists object 구성된 사용자 지정 차단 목록에 대한 true/false 필터링 결과의 컬렉션입니다. No
└) 세부 정보 array 개별 차단 목록 ID 쌍과 이들이 필터링 작업을 야기했는지 여부입니다. No
└> 필터링됨 boolean 자세한 차단 목록 중에서 필터링 작업이 발생했는지 여부를 나타내는 값입니다. No
사용자 지정 주제 object 구성된 사용자 지정 토픽에 대한 true/false 필터링 결과의 컬렉션입니다. No
└) 세부 정보 array 개별 토픽 ID의 쌍과 해당 쌍이 감지되는지 여부. No
└> 필터링됨 boolean 자세한 항목이 필터링 작업을 발생시켰는지 여부를 나타내는 값입니다. No
jailbreak object 콘텐츠가 검색되었는지, 콘텐츠가 필터링되었는지 여부를 나타내는 레이블이 지정된 콘텐츠 필터 결과
항목입니다.		 Yes
└> 검색됨 boolean 콘텐츠에서 레이블이 지정된 콘텐츠 범주가 검색되었는지 여부입니다. No
└> 필터링됨 boolean 콘텐츠 검색으로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
profanity object 콘텐츠가 검색되었는지, 콘텐츠가 필터링되었는지 여부를 나타내는 레이블이 지정된 콘텐츠 필터 결과
항목입니다.		 No
└> 검색됨 boolean 콘텐츠에서 레이블이 지정된 콘텐츠 범주가 검색되었는지 여부입니다. No
└> 필터링됨 boolean 콘텐츠 검색으로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No

AzureContentFilterImageResponseResults

이미지 생성 작업의 출력 응답 콘텐츠에 대한 콘텐츠 필터 결과입니다.

Name Type Description Required Default
hate object 콘텐츠가 필터링되었는지 여부 및 정성적 항목을 나타내는 레이블이 지정된 콘텐츠 필터 결과 항목
콘텐츠의 심각도 수준은 범주에 대한 콘텐츠 필터 구성에 대해 평가된 것입니다.		 No
└> 필터링됨 boolean 콘텐츠 심각도로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
└) 심각도 enum 콘텐츠의 레이블이 지정된 심각도입니다.
가능한 값: safe, low, mediumhigh		 No
self_harm object 콘텐츠가 필터링되었는지 여부 및 정성적 항목을 나타내는 레이블이 지정된 콘텐츠 필터 결과 항목
콘텐츠의 심각도 수준은 범주에 대한 콘텐츠 필터 구성에 대해 평가된 것입니다.		 No
└> 필터링됨 boolean 콘텐츠 심각도로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
└) 심각도 enum 콘텐츠의 레이블이 지정된 심각도입니다.
가능한 값: safe, low, mediumhigh		 No
sexual object 콘텐츠가 필터링되었는지 여부 및 정성적 항목을 나타내는 레이블이 지정된 콘텐츠 필터 결과 항목
콘텐츠의 심각도 수준은 범주에 대한 콘텐츠 필터 구성에 대해 평가된 것입니다.		 No
└> 필터링됨 boolean 콘텐츠 심각도로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
└) 심각도 enum 콘텐츠의 레이블이 지정된 심각도입니다.
가능한 값: safe, low, mediumhigh		 No
violence object 콘텐츠가 필터링되었는지 여부 및 정성적 항목을 나타내는 레이블이 지정된 콘텐츠 필터 결과 항목
콘텐츠의 심각도 수준은 범주에 대한 콘텐츠 필터 구성에 대해 평가된 것입니다.		 No
└> 필터링됨 boolean 콘텐츠 심각도로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
└) 심각도 enum 콘텐츠의 레이블이 지정된 심각도입니다.
가능한 값: safe, low, mediumhigh		 No

AzureContentFilterResultForChoice

생성 AI 시스템에서 생성한 단일 응답 항목에 대한 콘텐츠 필터 결과입니다.

Name Type Description Required Default
custom_blocklists object 구성된 사용자 지정 차단 목록에 대한 true/false 필터링 결과의 컬렉션입니다. No
└) 세부 정보 array 개별 차단 목록 ID 쌍과 이들이 필터링 작업을 야기했는지 여부입니다. No
└> 필터링됨 boolean 자세한 차단 목록 중에서 필터링 작업이 발생했는지 여부를 나타내는 값입니다. No
사용자 지정 주제 object 구성된 사용자 지정 토픽에 대한 true/false 필터링 결과의 컬렉션입니다. No
└) 세부 정보 array 개별 토픽 ID의 쌍과 해당 쌍이 감지되는지 여부. No
└> 필터링됨 boolean 자세한 항목이 필터링 작업을 발생시켰는지 여부를 나타내는 값입니다. No
error object 있는 경우 콘텐츠 필터링이 평가를 완료하지 못하게 하는 오류에 대한 세부 정보입니다. No
└) 코드 integer 오류와 연결된 컴퓨터에서 읽을 수 있는 고유한 코드입니다. No
└) 메시지 string 오류와 관련된 사람이 읽을 수 있는 메시지입니다. No
hate object 콘텐츠가 필터링되었는지 여부 및 정성적 항목을 나타내는 레이블이 지정된 콘텐츠 필터 결과 항목
콘텐츠의 심각도 수준은 범주에 대한 콘텐츠 필터 구성에 대해 평가된 것입니다.		 No
└> 필터링됨 boolean 콘텐츠 심각도로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
└) 심각도 enum 콘텐츠의 레이블이 지정된 심각도입니다.
가능한 값: safe, low, mediumhigh		 No
profanity object 콘텐츠가 검색되었는지, 콘텐츠가 필터링되었는지 여부를 나타내는 레이블이 지정된 콘텐츠 필터 결과
항목입니다.		 No
└> 검색됨 boolean 콘텐츠에서 레이블이 지정된 콘텐츠 범주가 검색되었는지 여부입니다. No
└> 필터링됨 boolean 콘텐츠 검색으로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
protected_material_code object 라이선스가 부여된 코드 또는 기타 보호된 소스 자료와의 일치를 설명하는 검색 결과입니다. No
└) 인용 object 가능한 경우, 연관된 라이선스와 해당 위치를 설명하는 인용 세부 정보입니다. No
└) URL string 라이선스와 연결된 URL입니다. No
└) 라이선스 string 검색과 관련된 라이선스의 이름 또는 식별자입니다. No
└> 검색됨 boolean 콘텐츠에서 레이블이 지정된 콘텐츠 범주가 검색되었는지 여부입니다. No
└> 필터링됨 boolean 콘텐츠 검색으로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
protected_material_text object 콘텐츠가 검색되었는지, 콘텐츠가 필터링되었는지 여부를 나타내는 레이블이 지정된 콘텐츠 필터 결과
항목입니다.		 No
└> 검색됨 boolean 콘텐츠에서 레이블이 지정된 콘텐츠 범주가 검색되었는지 여부입니다. No
└> 필터링됨 boolean 콘텐츠 검색으로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
self_harm object 콘텐츠가 필터링되었는지 여부 및 정성적 항목을 나타내는 레이블이 지정된 콘텐츠 필터 결과 항목
콘텐츠의 심각도 수준은 범주에 대한 콘텐츠 필터 구성에 대해 평가된 것입니다.		 No
└> 필터링됨 boolean 콘텐츠 심각도로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
└) 심각도 enum 콘텐츠의 레이블이 지정된 심각도입니다.
가능한 값: safe, low, mediumhigh		 No
sexual object 콘텐츠가 필터링되었는지 여부 및 정성적 항목을 나타내는 레이블이 지정된 콘텐츠 필터 결과 항목
콘텐츠의 심각도 수준은 범주에 대한 콘텐츠 필터 구성에 대해 평가된 것입니다.		 No
└> 필터링됨 boolean 콘텐츠 심각도로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
└) 심각도 enum 콘텐츠의 레이블이 지정된 심각도입니다.
가능한 값: safe, low, mediumhigh		 No
ungrounded_material AzureContentFilterCompletionTextSpanDetectionResult No
violence object 콘텐츠가 필터링되었는지 여부 및 정성적 항목을 나타내는 레이블이 지정된 콘텐츠 필터 결과 항목
콘텐츠의 심각도 수준은 범주에 대한 콘텐츠 필터 구성에 대해 평가된 것입니다.		 No
└> 필터링됨 boolean 콘텐츠 심각도로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
└) 심각도 enum 콘텐츠의 레이블이 지정된 심각도입니다.
가능한 값: safe, low, mediumhigh		 No

AzureContentFilterResultForPrompt

단일 입력 프롬프트 항목에 연결된 생성형 AI 시스템의 콘텐츠 필터 결과입니다.

Name Type Description Required Default
content_filter_results object 결과에 대한 콘텐츠 필터 범주 세부 정보입니다. No
└ 사용자 정의 차단 목록 (custom_blocklists) object 구성된 사용자 지정 차단 목록에 대한 true/false 필터링 결과의 컬렉션입니다. No
└) 세부 정보 array 개별 차단 목록 ID 쌍과 이들이 필터링 작업을 야기했는지 여부입니다. No
└> 필터링됨 boolean 자세한 차단 목록 중에서 필터링 작업이 발생했는지 여부를 나타내는 값입니다. No
└custom_topics object 구성된 사용자 지정 토픽에 대한 true/false 필터링 결과의 컬렉션입니다. No
└) 세부 정보 array 개별 토픽 ID의 쌍과 해당 쌍이 감지되는지 여부. No
└> 필터링됨 boolean 자세한 항목이 필터링 작업을 발생시켰는지 여부를 나타내는 값입니다. No
└) 오류 object 있는 경우 콘텐츠 필터링이 평가를 완료하지 못하게 하는 오류에 대한 세부 정보입니다. No
└) 코드 integer 오류와 연결된 컴퓨터에서 읽을 수 있는 고유한 코드입니다. No
└) 메시지 string 오류와 관련된 사람이 읽을 수 있는 메시지입니다. No
└• 싫어 object 콘텐츠가 필터링되었는지 여부 및 정성적 항목을 나타내는 레이블이 지정된 콘텐츠 필터 결과 항목
콘텐츠의 심각도 수준은 범주에 대한 콘텐츠 필터 구성에 대해 평가된 것입니다.		 No
└> 필터링됨 boolean 콘텐츠 심각도로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
└) 심각도 enum 콘텐츠의 레이블이 지정된 심각도입니다.
가능한 값: safe, low, mediumhigh		 No
└─ 간접_공격 object 콘텐츠가 검색되었는지, 콘텐츠가 필터링되었는지 여부를 나타내는 레이블이 지정된 콘텐츠 필터 결과
항목입니다.		 No
└> 검색됨 boolean 콘텐츠에서 레이블이 지정된 콘텐츠 범주가 검색되었는지 여부입니다. No
└> 필터링됨 boolean 콘텐츠 검색으로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
└) 탈옥 object 콘텐츠가 검색되었는지, 콘텐츠가 필터링되었는지 여부를 나타내는 레이블이 지정된 콘텐츠 필터 결과
항목입니다.		 No
└> 검색됨 boolean 콘텐츠에서 레이블이 지정된 콘텐츠 범주가 검색되었는지 여부입니다. No
└> 필터링됨 boolean 콘텐츠 검색으로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
└─ 욕설 object 콘텐츠가 검색되었는지, 콘텐츠가 필터링되었는지 여부를 나타내는 레이블이 지정된 콘텐츠 필터 결과
항목입니다.		 No
└> 검색됨 boolean 콘텐츠에서 레이블이 지정된 콘텐츠 범주가 검색되었는지 여부입니다. No
└> 필터링됨 boolean 콘텐츠 검색으로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
└─ 자해 object 콘텐츠가 필터링되었는지 여부 및 정성적 항목을 나타내는 레이블이 지정된 콘텐츠 필터 결과 항목
콘텐츠의 심각도 수준은 범주에 대한 콘텐츠 필터 구성에 대해 평가된 것입니다.		 No
└> 필터링됨 boolean 콘텐츠 심각도로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
└) 심각도 enum 콘텐츠의 레이블이 지정된 심각도입니다.
가능한 값: safe, low, mediumhigh		 No
└• 성적 object 콘텐츠가 필터링되었는지 여부 및 정성적 항목을 나타내는 레이블이 지정된 콘텐츠 필터 결과 항목
콘텐츠의 심각도 수준은 범주에 대한 콘텐츠 필터 구성에 대해 평가된 것입니다.		 No
└> 필터링됨 boolean 콘텐츠 심각도로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
└) 심각도 enum 콘텐츠의 레이블이 지정된 심각도입니다.
가능한 값: safe, low, mediumhigh		 No
└) 폭력 object 콘텐츠가 필터링되었는지 여부 및 정성적 항목을 나타내는 레이블이 지정된 콘텐츠 필터 결과 항목
콘텐츠의 심각도 수준은 범주에 대한 콘텐츠 필터 구성에 대해 평가된 것입니다.		 No
└> 필터링됨 boolean 콘텐츠 심각도로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. No
└) 심각도 enum 콘텐츠의 레이블이 지정된 심각도입니다.
가능한 값: safe, low, mediumhigh		 No
prompt_index integer 함께 제공되는 콘텐츠 필터 결과 범주와 연결된 입력 프롬프트의 인덱스입니다. No

AzureContentFilterSeverityResult

범주에 대한 콘텐츠 필터 구성에 대해 평가된 대로 콘텐츠가 필터링되었는지 여부와 콘텐츠의 정성적 심각도 수준을 나타내는 레이블이 지정된 콘텐츠 필터 결과 항목입니다.

Name Type Description Required Default
filtered boolean 콘텐츠 심각도로 인해 콘텐츠 필터링 작업이 발생했는지 여부입니다. Yes
severity enum 콘텐츠의 레이블이 지정된 심각도입니다.
가능한 값: safe, low, mediumhigh		 Yes

AzureCosmosDBChatDataSource

Azure CosmosDB 리소스를 사용하는 데이터 원본 구성을 나타냅니다.

Name Type Description Required Default
parameters object Azure CosmosDB 데이터 원본의 사용을 제어하는 매개 변수 정보입니다. Yes
└─ 부분 결과 허용 boolean true로 설정하면 시스템에서 부분 검색 결과를 사용할 수 있으며 모든 검색 결과가 있으면 요청이 실패합니다.
부분 쿼리가 실패합니다. 지정하지 않거나 false로 지정하면 검색 쿼리가 실패할 경우 요청이 실패합니다.		 No False
└) 인증 AzureChatDataSourceConnectionStringAuthenticationOptions No
└ container_name string No
└database_name string No
└ 임베딩_종속성 AzureChatDataSourceVectorizationSource 데이터 원본을 포함하는 리소스로 사용할 수 있는 데이터 벡터화 원본의 표현입니다. No
└fields_mapping object No
└content_fields array No
└content_fields_separator string No
└filepath_field string No
└title_field string No
└url_field string No
└vector_fields array No
└in_scope boolean 쿼리를 인덱싱된 데이터의 사용으로 제한해야 하는지 여부입니다. No
└include_contexts array 응답에 포함할 출력 컨텍스트 속성입니다.
기본적으로 인용 및 의도가 요청됩니다.		 No ['인용', '의도']
└index_name string No
└max_search_queries integer 단일 사용자 메시지에 대해 검색 공급자에게 보내야 하는 재작성된 쿼리의 최대 수입니다.
기본적으로 시스템은 자동으로 결정합니다.		 No
└) 엄격함 integer 검색 관련성 필터링의 구성된 엄격성입니다.
높은 엄격성은 답변의 정확도를 증가시키지만, 재현율은 낮아집니다.		 No
└top_n_documents integer 쿼리에 기능할 구성된 문서 수입니다. No
type enum 항상 'azure_cosmos_db'인 구별된 형식 식별자입니다.
가능한 값: azure_cosmos_db		 Yes

AzureCreateChatCompletionRequest

Azure OpenAI 서비스에 대한 채팅 완료를 위한 확장 요청 모델입니다. 이렇게 하면 "On Your Data" 기능에 데이터 소스를 제공할 수 있는 기능이 추가됩니다.

Name Type Description Required Default
audio object 오디오 출력에 대한 매개 변수입니다. 오디오 출력이 요청되는 경우 필요합니다.
modalities: ["audio"];		 No
└─ 형식 enum 출력 오디오 형식을 지정합니다. wav, mp3, flac 중 하나여야 합니다.
opus 또는 pcm16입니다.
가능한 값: wav, aac, mp3flac, opuspcm16		 No
└─ 음성 object No
data_sources array Azure OpenAI 전용인 On Your Data 기능에 사용할 데이터 원본입니다. No
frequency_penalty number -2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트에서 발생한 빈도에 따라
새 토큰에 페널티를 부여하여 모델의 토크나이저를 감소시켜
동일한 줄을 그대로 반복할 가능성이 있습니다.		 No 0
function_call enum {"name": "my_function"}을 통해 특정 함수를 지정하면 모델이 해당 함수를 호출하게 됩니다.
가능한 값: noneauto		 No
functions array tools에는 더 이상 사용되지 않습니다.

모델이 JSON 입력을 생성할 수 있는 함수 목록입니다.		 No
logit_bias object 지정된 토큰이 완성에 나타날 가능성을 수정합니다.

토큰을 매핑하는 JSON 개체를 허용합니다(다음의 토큰 ID로 지정됨)
연관된 바이어스 값을 -100에서 100으로 낮춥니다. 수학적으로
바이어스는 샘플링 전에 모델에서 생성된 로그에 추가됩니다.
정확한 효과는 모델마다 다르지만 -1과 1 사이의 값은 다음과 같습니다.
선택 가능성을 줄이거나 늘입니다. -100 또는 100과 같은 값
는 관련 토큰의 금지 또는 배타적 선택으로 이루어져야 합니다.		 No None
logprobs boolean 출력 토큰의 로그 확률을 반환할지 여부를 나타냅니다. true인 경우,
는 에서 반환된 각 출력 토큰의 로그 확률을 반환합니다.
content의 message.		 No False
max_completion_tokens integer 에 대해 생성할 수 있는 토큰 수에 대한 상한
완료에는 표시되는 출력 토큰 및 추론 토큰이 포함됩니다.		 No
max_tokens integer 채팅 완성 시 생성할 수 있는 최대 토큰 수입니다.
이 값은 API를 통해 생성된 텍스트의 비용을 제어하는 데 사용할 수 있습니다.

이 값은 max_completion_tokens를 선호하여 이제 더 이상 사용되지 않습니다.
o1 시리즈 모델과 호환되지 않습니다.		 No
messages array 지금까지의 대화를 구성하는 메시지 목록입니다. 다음에 따라
사용하는 모델, 다양한 메시지 유형(형식)이 지원됩니다.
텍스트, 이미지 및 오디오와 같습니다.		 Yes
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
modalities object 모델이 생성하도록 할 출력 형식.
대부분의 모델은 기본값인 텍스트를 생성할 수 있습니다.

["text"]

gpt-4o-audio-preview 모델을 사용하여 오디오를 생성할 수도 있습니다. 이 모델이 생성하도록 요청하려면
텍스트 및 오디오 응답 모두 다음을 사용할 수 있습니다.

["text", "audio"]		 No
model string 채팅 완료 요청에 사용할 모델 배포 식별자입니다. Yes
n integer 각 입력 메시지에 대해 생성할 채팅 완성 선택 항목 수입니다. 모든 선택 항목에 걸쳐 생성된 토큰 수에 따라 요금이 부과됩니다. 비용을 최소화하려면 n을 1로 유지합니다. No 1
parallel_tool_calls object 도구를 사용하는 동안 병렬 함수 호출을 사용하도록 설정할지 여부입니다. No
prediction object 모델에서 예측된 출력의 기본 표현입니다. No
└─ 형식 OpenAI.ChatOutputPredictionType No
presence_penalty number -2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트에서 발생한 빈도에 따라
텍스트에 지금까지 나타났는지 여부, 모델의 가능성을 높이는지 여부
새로운 주제를 이야기하다.		 No 0
reasoning_effort object o 시리즈 모델만

추론 모델에서 추론 작업을 제한합니다.
현재 지원되는 값은 low, medium 및 high입니다. 줄이는
추론 작업으로 인해 응답 속도가 빨라지고 사용된 토큰 수가 줄어들 수 있습니다.
응답에서의 추론에 관하여		 No
response_format object No
└─ 형식 enum
가능한 값: text, json_objectjson_schema		 No
seed integer 이 기능은 베타 버전으로 제공됩니다.
지정된 경우 시스템은 결정론적으로 샘플링하기 위해 최선을 다하므로 동일한 seed 및 매개 변수를 사용하는 반복 요청이 동일한 결과를 반환해야 합니다.
결정성은 보장되지 않으며 백 엔드의 변경 내용을 모니터링하려면 system_fingerprint 응답 매개 변수를 참조해야 합니다.		 No
stop object 최신 추론 모델 o3 및 o4-mini에서는 지원되지 않습니다.

API가 추가 토큰 생성을 중지하는 최대 4개의 시퀀스입니다. 이
반환된 텍스트는 중지 시퀀스를 포함하지 않습니다.		 No
store boolean 에 대한 이 채팅 완료 요청의 출력을 저장할지 여부
모델 증류나 제품 평가에 사용합니다.		 No False
stream boolean true로 설정하면 모델 응답 데이터가 클라이언트로 스트리밍됩니다.
서버에서 보낸 이벤트를 사용하여 생성됩니다.		 No False
stream_options object 스트리밍 응답에 대한 옵션입니다. stream: true를 설정할 때만 설정합니다. No
└include_usage boolean 설정된 경우 추가 청크가 data: [DONE] 전에 스트리밍됩니다.
메시지가 표시됩니다. 이 청크의 필드에는 usage 토큰 사용 통계가 표시됩니다.
전체 요청에 대해, 해당 choices 필드는 항상 비어 있습니다.
배열.

다른 모든 청크에도 usage 필드가 포함되지만, 그 필드는 null입니다.
값. 메모: 스트림이 중단되면 다음을 수신하지 못할 수 있습니다.
요청에 대한 총 토큰 사용량을 포함하는 최종 사용량 청크입니다.		 No
temperature number 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 더 낮은 값을 지정하면 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.		 No 1
tool_choice OpenAI.ChatCompletionToolChoiceOption 모델이 호출하는 도구(있는 경우)를 제어합니다.
none 는 모델이 도구를 호출하지 않고 대신 메시지를 생성한다는 의미입니다.
auto는 모델이 메시지 생성 또는 하나 이상의 도구 호출 중에서 선택할 수 있음을 의미합니다.
required는 모델이 하나 이상의 도구를 호출해야 함을 의미합니다.
{"type": "function", "function": {"name": "my_function"}}을 사용하여 특정 도구를 지정하면 모델이 해당 도구를 강제 호출하게 됩니다.

none은 도구가 없는 경우 기본값입니다. auto는 도구가 있는 경우 기본값입니다.		 No
tools array 모델이 호출할 수 있는 도구 목록입니다. 현재 함수만 도구로 지원됩니다. 모델이 JSON 입력을 생성할 수 있는 함수 목록을 제공하려면 이를 사용합니다. 최대 128개의 함수가 지원됩니다. No
top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. No
top_p number 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.		 No 1
user string 최종 사용자를 나타내는 고유 식별자이며, 다음에 도움이 될 수 있습니다.
남용을 모니터링하고 감지합니다.		 No
user_security_context AzureUserSecurityContext 사용자 보안 컨텍스트에는 애플리케이션 자체를 설명하는 몇 가지 매개 변수와 애플리케이션과 상호 작용하는 최종 사용자가 포함됩니다. 이러한 필드는 AI 애플리케이션을 보호하는 포괄적인 접근 방식을 제공하여 보안 운영 팀이 보안 인시던트를 조사하고 완화할 수 있도록 지원합니다. 클라우드용 Microsoft Defender를 사용하여 AI 애플리케이션을 보호하는 방법에 대해 자세히 알아봅니다. No

AzureCreateChatCompletionResponse

Azure OpenAI 서비스에 대한 확장된 최상위 채팅 완료 응답 모델입니다. 이 모델은 프롬프트 입력을 위해 책임 있는 AI 콘텐츠 필터 주석을 추가합니다.

Name Type Description Required Default
choices array Yes
created integer 채팅 완성이 만들어진 시점의 Unix 타임스탬프(초)입니다. Yes
id string 채팅 완성의 고유 식별자입니다. Yes
model string 채팅 완성에 사용되는 모델입니다. Yes
object enum 항상 chat.completion인 개체 형식입니다.
가능한 값: chat.completion		 Yes
prompt_filter_results array 채팅 완료에 대한 즉각적인 입력과 관련된 책임 있는 AI 콘텐츠 필터 주석입니다. No
system_fingerprint string 이 지문은 모델이 실행되는 백 엔드 구성을 나타냅니다.

결정론에 영향을 미칠 수 있는 백 엔드 변경이 이루어진 시기를 이해하기 위해 seed 요청 매개 변수와 함께 사용할 수 있습니다.		 No
usage OpenAI.CompletionUsage 완성 요청의 사용 통계입니다. No

AzureCreateChatCompletionStreamResponse

Name Type Description Required Default
choices array 채팅 완성 선택 항목 목록입니다. n이 1보다 큰 경우 두 개 이상의 요소를 포함할 수 있습니다. 검색 증강 생성과
stream_options: {"include_usage": true}을 설정한 경우 마지막 청크입니다.		 Yes
content_filter_results AzureContentFilterResultForChoice 생성 AI 시스템에서 생성한 단일 응답 항목에 대한 콘텐츠 필터 결과입니다. No
created integer 채팅 완성이 만들어진 시점의 Unix 타임스탬프(초)입니다. 각 청크에는 동일한 타임스탬프가 있습니다. Yes
delta AzureChatCompletionStreamResponseDelta Azure OpenAI 서비스의 스트리밍 채팅 응답 메시지에 대한 확장 응답 모델입니다.
이 모델은 의도, 인용 및 기타를 위해 On Your Data 기능에서 사용하는 채팅 메시지 컨텍스트에 대한 지원을 추가합니다.
관련된 정보는 비어 있을 수도 있습니다.		 No
id string 채팅 완성의 고유 식별자입니다. 각 청크는 동일한 ID를 갖습니다. Yes
model string 완성을 생성할 모델입니다. Yes
object enum 항상 chat.completion.chunk인 개체 형식입니다.
가능한 값: chat.completion.chunk		 Yes
system_fingerprint string 이 지문은 모델이 실행되는 백 엔드 구성을 나타냅니다.
결정론에 영향을 미칠 수 있는 백 엔드 변경이 이루어진 시기를 이해하기 위해 seed 요청 매개 변수와 함께 사용할 수 있습니다.		 No
usage object 완성 요청의 사용 통계입니다. No
└completion_tokens integer 생성된 완성의 토큰 수입니다. No 0
└─ 완료_토큰_상세사항 object 완성에 사용되는 토큰 분석입니다. No
└─ 수락된 예측 토큰 integer 예측 출력을 사용할 때 완료에 나타난 예측의
토큰 수입니다.		 No 0
└audio_tokens integer 모델에서 생성된 오디오 입력 토큰입니다. No 0
└─ 추론_토큰 integer 추론을 위해 모델에서 생성한 토큰입니다. No 0
└─ 거부된_예측_토큰 integer 예측 출력을 사용할 때 완료에 나타난 예측의
토큰 수입니다. 그러나, 제한과
추론 토큰, 이러한 토큰은 여전히 합계로 계산됩니다.
청구, 출력 및 컨텍스트 창을 위한 완료 토큰
같습니다.		 No 0
└prompt_tokens integer 프롬프트에 있는 토큰 수입니다. No 0
└─ 프롬프트_토큰_세부사항 object 프롬프트에 사용된 토큰의 분석입니다. No
└audio_tokens integer 프롬프트에 있는 오디오 입력 토큰입니다. No 0
└─ 캐시된_토큰 (cached_tokens) integer 프롬프트에 캐시된 토큰이 있습니다. No 0
└total_tokens integer 요청에 사용된 총 토큰 수입니다(프롬프트 + 완성). No 0

AzureCreateEmbeddingRequest

Name Type Description Required Default
dimensions integer 결과 출력 포함에 있어야 하는 차원의 수입니다. text-embedding-3 이상 모델에서만 지원됩니다. No
encoding_format enum 반환할 포함의 형식입니다. float 또는 base64일 수 있습니다.
가능한 값: floatbase64		 No
input 문자열 또는 배열 Yes
model string 포함 요청에 사용할 모델입니다. Yes
user string 최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. No

AzureCreateFileRequestMultiPart

Name Type Description Required Default
expires_after object Yes
└) 앵커 AzureFileExpiryAnchor No
└( 초) integer No
file string Yes
목적 enum 업로드된 파일의 의도된 목적. 다음 중 하나: - assistantsAssistants API에서 사용 - batch: Batch API에서 사용됨 - fine-tune: 미세 조정에 사용됨 - evals: eval 데이터 집합에 사용됨
가능한 값: assistants, batch, fine-tuneevals		 Yes

AzureCreateImageEditRequestMultiPart

Name Type Description Required Default
background enum 생성된 이미지의 배경에 대한 투명도를 설정할 수 있습니다.
이 매개 변수는 gpt-image-1에만 지원됩니다. 다음 중 하나여야 합니다.
transparent opaque 또는auto(기본값) auto가 사용될 때
모델은 이미지에 가장 적합한 배경을 자동으로 결정합니다.

transparent인 경우 출력 형식은 투명성을 지원해야 하므로
png (기본값) 또는 webp 중 하나로 설정해야 합니다.
가능한 값: transparent, opaqueauto		 No
image 문자열 또는 배열 Yes
mask string No
model string 이미지 편집 작업에 사용할 모델 배포입니다. Yes
n integer 생성할 이미지 수입니다. 1에서 10 사이여야 합니다. No 1
output_compression integer 생성된 이미지의 압축 수준(0-100%)입니다. 이 매개 변수
gpt-image-1는 webp 또는 jpeg 출력에서만 지원됩니다.
형식이며 기본값은 100입니다.		 No 100
output_format enum 생성된 이미지가 반환되는 형식입니다. 이 매개 변수는
gpt-image-1만 지원됩니다. png, jpeg, 또는 webp 중 하나여야 합니다.
기본값은 png입니다.
가능한 값: png, jpegwebp		 No
prompt string 원하는 이미지에 대한 텍스트 설명입니다. 최대 길이는 1000자 dall-e-2, 32000자입니다 gpt-image-1. Yes
quality enum 생성될 이미지의 품질입니다. high, medium 및 low는 오직 gpt-image-1에 대해서만 지원됩니다. dall-e-2는 standard 품질만 지원합니다. 기본값은 auto입니다.
가능한 값: standard, low, medium, highauto		 No
response_format enum 생성된 이미지가 반환되는 형식입니다. url 또는 b64_json 중 하나여야 합니다. URL은 이미지가 생성된 후 60분 동안만 유효합니다. 이 매개 변수는 dall-e-2에 대해서만 지원되며, gpt-image-1은 항상 base64로 인코딩된 이미지를 반환합니다.
가능한 값: urlb64_json		 No
size enum 생성된 이미지의 크기입니다. 1024x1024의 경우 1536x1024, 1024x1536(가로), auto(세로) 또는 gpt-image-1(기본값) 중 하나여야 하고, 256x256의 경우 512x512, 1024x1024 또는 dall-e-2 중 하나여야 합니다.
가능한 값: 256x256, 512x512, 1024x10241536x1024, 1024x1536auto		 No
user string 최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. No

AzureCreateImageRequest

Name Type Description Required Default
background enum 생성된 이미지의 배경에 대한 투명도를 설정할 수 있습니다.
이 매개 변수는 gpt-image-1에만 지원됩니다. 다음 중 하나여야 합니다.
transparent opaque 또는auto(기본값) auto가 사용될 때
모델은 이미지에 가장 적합한 배경을 자동으로 결정합니다.

transparent인 경우 출력 형식은 투명성을 지원해야 하므로
png (기본값) 또는 webp 중 하나로 설정해야 합니다.
가능한 값: transparent, opaqueauto		 No
model string 이미지 생성에 사용할 모델 배포입니다. Yes
moderation enum 에 의해 gpt-image-1생성된 이미지의 콘텐츠 조정 수준을 제어합니다. 덜 제한적인 필터링 또는 low (기본값) 중 하나 auto 여야 합니다.
가능한 값: lowauto		 No
n integer 생성할 이미지 수입니다. 1에서 10 사이여야 합니다. dall-e-3의 경우, n=1만 지원됩니다. No 1
output_compression integer 생성된 이미지의 압축 수준(0-100%)입니다. 이 매개 변수는 gpt-image-1이 webp 또는 jpeg 출력 형식에서만 지원되며 기본값은 100입니다. No 100
output_format enum 생성된 이미지가 반환되는 형식입니다. 이 매개 변수는 gpt-image-1에만 지원됩니다. png, jpeg, 또는 webp 중 하나여야 합니다.
가능한 값: png, jpegwebp		 No
prompt string 원하는 이미지에 대한 텍스트 설명입니다. 최대 길이는 32000자 gpt-image-1, 1000자 dall-e-2 , 4000자입니다 dall-e-3. Yes
quality enum 생성될 이미지의 품질입니다.

- auto (기본값)은 지정된 모델의 최고 품질을 자동으로 선택합니다.
- high, medium 및 low는 gpt-image-1에 대해 지원됩니다.
- 및 hd는 standard에 대해 dall-e-3를 지원합니다.
- standard는 dall-e-2에 대한 유일한 옵션입니다.
가능한 값: standard, hd, lowmedium, highauto		 No
response_format enum 생성된 이미지가 dall-e-2 및 dall-e-3로 반환되는 형식입니다. url 또는 b64_json 중 하나여야 합니다. URL은 이미지가 생성된 후 60분 동안만 유효합니다. 이 매개 변수는 gpt-image-1에 대해 지원되지 않습니다. gpt-image-1는 항상 base64로 인코딩된 이미지를 반환합니다.
가능한 값: urlb64_json		 No
size enum 생성된 이미지의 크기입니다. 1024x1024의 경우 1536x1024, 1024x1536(가로), auto(세로) 또는 gpt-image-1(기본값) 중 하나여야 하고, 256x256의 경우 512x512, 1024x1024 또는 dall-e-2 중 하나여야 하며, 1024x1024의 경우 1792x1024, 1024x1792 또는 dall-e-3 중 하나여야 합니다.
가능한 값: auto,, 1024x10241536x1024, 1024x1536256x256, 512x512, 1792x10241024x1792		 No
style enum 생성된 이미지의 스타일입니다. 이 매개 변수는 dall-e-3에만 지원됩니다. vivid 또는 natural 중 하나여야 합니다. 생생함이 모델이 초현실적이고 극적인 이미지를 생성하는 쪽으로 유도합니다. 자연은 모델이 더 자연스럽고 덜 실제적인 이미지를 생성하게 합니다.
가능한 값: vividnatural		 No
user string 최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. No

AzureCreateResponse

Name Type Description Required Default
background boolean 백그라운드에서 모델 응답을 실행할지 여부입니다. No False
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로 설정되거나 조직이
데이터 보존 없음 프로그램에 등록됨).		 No
input 문자열 또는 배열 No
instructions string 모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다.

previous_response_id와 함께 사용할 경우 이전의 지침이 적용됩니다.
응답은 다음 응답으로 전달되지 않습니다. 이렇게 하면 간단해집니다.
새 응답에서 시스템(또는 개발자) 메시지를 교환합니다.		 No
max_output_tokens integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한입니다. No
최대_도구_호출수 integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. No
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
model string 이 응답을 만드는 데 사용할 모델 배포입니다. Yes
parallel_tool_calls boolean 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. No True
previous_response_id string 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다.		 No
prompt object 프롬프트 템플릿 및 해당 변수에 대한 참조입니다. No
└─ ID string 사용할 프롬프트 템플릿의 고유 식별자입니다. No
└) 변수 OpenAI.ResponsePromptVariables 프롬프트에서 변수를 대체할 값의 선택적
맵입니다. 대체 값은 문자열이거나 다른 값일 수 있습니다.
이미지 또는 파일과 같은 응답 입력 형식입니다.		 No
└─ 버전 string 프롬프트 템플릿의 선택적 버전입니다. No
reasoning object o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.		 No
└) 노력 OpenAI.ReasoningEffort o 시리즈 모델만

추론 모델에서 추론 작업을 제한합니다.
현재 지원되는 값은 low, medium 및 high입니다. 줄이는
추론 작업으로 인해 응답 속도가 빨라지고 사용된 토큰 수가 줄어들 수 있습니다.
응답에서의 추론에 관하여		 No
└generate_summary enum 사용되지 않음: 대신 사용합니다 summary .

모델에서 수행하는 추론에 대한 요약입니다. 다음과 같을 수 있습니다.
는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용합니다.
auto, concise 또는 detailed 중 하나입니다.
가능한 값: auto, concisedetailed		 No
└) 요약 enum 모델에서 수행하는 추론에 대한 요약입니다. 다음과 같을 수 있습니다.
는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용합니다.
auto, concise 또는 detailed 중 하나입니다.
가능한 값: auto, concisedetailed		 No
store boolean 를 통해 나중에 검색할 수 있도록 생성된 모델 응답을 저장할지 여부
API.		 No True
stream boolean true로 설정하면 모델 응답 데이터가 클라이언트로 스트리밍됩니다.
서버에서 보낸 이벤트를 사용하여 생성됩니다.		 No False
temperature number 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 더 낮은 값을 지정하면 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.		 No 1
text object 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반 텍스트 또는 구조화된 JSON 데이터일 수 있습니다. No
└─ 형식 OpenAI.ResponseTextFormatConfiguration No
tool_choice object 모델이 호출하는 도구(있는 경우)를 제어합니다.

none 는 모델이 도구를 호출하지 않고 대신 메시지를 생성한다는 의미입니다.

auto 는 모델이 메시지를 생성하거나 메시지를 호출하는 중에서 선택할 수 있습니다.
더 많은 도구.

required는 모델이 하나 이상의 도구를 호출해야 함을 의미합니다.		 No
└─ 형식 OpenAI.ToolChoiceObjectType 모델이 기본 제공 도구를 사용하여 응답을 생성해야 임을 나타냅니다. No
tools array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. 너
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

- 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
파일 검색과 같은 모델의 기능.
- 함수 호출(사용자 지정 도구): 사용자가 정의한 함수
모델을 사용하여 사용자 고유의 코드를 호출할 수 있습니다.		 No
top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. No
top_p number 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.		 No 1
truncation enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled		 No
user string 최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. No

AzureCreateSpeechRequestMultiPart

텍스트 음성 변환 작업의 동작을 제어하는 요청 옵션의 표현입니다.

Name Type Description Required Default
input string 오디오를 생성하기 위한 텍스트입니다. 최대 길이는 4096자입니다. Yes
instructions string 추가 지침으로 생성된 오디오의 음성을 제어합니다. tts-1 또는 tts-1-hd와 함께 작동하지 않습니다. No
model string 이 텍스트 음성 변환 요청에 사용할 모델입니다. Yes
response_format object 텍스트 음성 변환에 지원되는 오디오 출력 형식입니다. No
speed number 생성된 오디오의 음성 속도입니다. 값은 0.25에서 4.0까지의 범위에서 유효하며, 기본값은 1.0이고 더 빠른 음성에 해당하는 값은 더 높습니다. No 1
스트림_포맷 enum 오디오를 스트리밍할 형식입니다. 지원되는 형식은 다음과 같습니다 sseaudio. sse는 tts-1 또는 tts-1-hd에 대해 지원되지 않습니다.
가능한 값: sseaudio		 No
voice object Yes

AzureCreateTranscriptionRequestMultiPart

오디오 대화 내용 기록 요청에 대한 구성 정보입니다.

Name Type Description Required Default
chunking_strategy object No
└prefix_padding_ms integer VAD가 음성을 감지하기 전에 포함할 오디오 양()
밀리초).		 No 300
└침묵 지속 시간(ms) silence_duration_ms integer 음성 중지를 감지하는 무음 기간(밀리초)입니다.
값이 짧으면 모델이 더 빠르게 응답합니다.
하지만 사용자가 잠깐 멈추면 개입할 수도 있습니다.		 No 200
└) 임계값 number 음성 활동 감지의 민감도 임계값(0.0~1.0)입니다. A
임계값이 높을수록 모델이 활성화되도록 더 큰 소리의 오디오가 필요하고
따라서 시끄러운 환경에서 더 나은 성능을 발휘할 수 있습니다.		 No 0.5
└─ 형식 enum 서버 쪽 VAD를 사용하여 수동 청크를 사용하도록 설정하려면 server_vad로 설정해야 합니다.
가능한 값: server_vad		 No
file string Yes
filename string 오디오 데이터와 연결할 선택적 파일 이름 또는 설명 식별자입니다. No
include[] array 전사 응답에 포함해야 할 추가 정보입니다.
logprobs 에서 토큰의 로그 확률을 반환합니다.
모델의 대화 내용 기록에 대한 신뢰도를 파악하기 위한 응답입니다.
logprobs에서는 오직 response_format이 json로 설정되었을 때만 작동합니다.
모델 gpt-4o-transcribe 및 gpt-4o-mini-transcribe.		 No
language string 입력 오디오의 언어입니다. ISO-639-1(예: en형식)로 입력 언어를 제공하면 정확도와 대기 시간이 향상됩니다. No
model string 이 대화 내용 기록 요청에 사용할 모델입니다. No
prompt string 모델 스타일을 안내하거나 이전 오디오 세그먼트를 계속 진행하기 위한 선택적 텍스트입니다. 프롬프트는 오디오 언어와 일치해야 합니다. No
response_format object No
stream boolean true로 설정하면 모델 응답 데이터가 클라이언트로 스트리밍됩니다.
서버에서 보낸 이벤트를 사용하여 생성됩니다. 참고: whisper-1 모델에서는 스트리밍이 지원되지 않으므로 무시됩니다.		 No False
temperature number 샘플링 온도(0에서 1 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 더 낮은 값을 지정하면 출력이 더욱 집중되고 결정적이게 됩니다. 0으로 설정하면 모델은 로그 확률 을 사용하여 특정 임계값에 도달할 때까지 온도를 자동으로 높입니다. No 0
timestamp_granularities[] array 이 전사를 위해 채울 타임스탬프 세분성입니다. 타임스탬프 세분성을 사용하려면 response_format을 verbose_json으로 설정해야 합니다. word 또는 segment 옵션 중 하나 또는 둘 다 지원됩니다. 참고: 세그먼트 타임스탬프에 대한 추가 대기 시간은 없지만 단어 타임스탬프를 생성하면 추가 대기 시간이 발생합니다. No ['segment']

AzureCreateTranslationRequestMultiPart

오디오 대화 내용 기록 요청에 대한 구성 정보입니다.

Name Type Description Required Default
file string Yes
filename string 오디오 데이터와 연결할 선택적 파일 이름 또는 설명 식별자입니다. No
model string 이 번역 요청에 사용할 모델입니다. No
prompt string 모델 스타일을 안내하거나 이전 오디오 세그먼트를 계속 진행하기 위한 선택적 텍스트입니다. 프롬프트는 영어로 되어 있어야 합니다. No
response_format object No
temperature number 샘플링 온도(0에서 1 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 더 낮은 값을 지정하면 출력이 더욱 집중되고 결정적이게 됩니다. 0으로 설정하면 모델은 로그 확률 을 사용하여 특정 임계값에 도달할 때까지 온도를 자동으로 높입니다. No 0

AzureErrorResponse

Name Type Description Required Default
error object 오류 세부 정보입니다. No
└) 코드 string 오류에 대한 고유한 컴퓨터 생성 식별자입니다. No
└─ 내부_오류 No
└) 메시지 string 오류와 관련된 사람이 읽을 수 있는 메시지입니다. No
└─ 매개 변수 string 해당하는 경우 오류와 연결된 요청 입력 매개 변수 No
└─ 형식 enum 개체 형식은 항상 'error'입니다.
가능한 값: error		 No

AzureEvalAPICompletionsSamplingParams

Name Type Description Required Default
parallel_tool_calls boolean No
response_format OpenAI.ResponseTextFormatConfiguration No
tools array No

Azure 평가 API 모델 샘플링 매개변수

Name Type Description Required Default
max_tokens integer 생성된 출력의 최대 토큰 수입니다. No
reasoning_effort enum 생성 중에 적용되는 추론 작업의 수준을 제어합니다.
가능한 값: low, mediumhigh		 No
seed integer 샘플링 중에 임의성을 초기화하는 시드 값입니다. No
temperature number 온도가 높을수록 출력의 임의성이 증가합니다. No
top_p number 핵 샘플링을 위한 온도에 대한 대안; 1.0에는 모든 토큰이 포함됩니다. No

AzureEvalAPIResponseSamplingParams

Name Type Description Required Default
parallel_tool_calls boolean No
response_format OpenAI.ResponseTextFormatConfiguration No
tools array No

AzureFileExpiryAnchor

Property Value
Type string
Values created_at

AzureFineTuneReinforcementMethod

Name Type Description Required Default
채점자 object 지정된 작업을 사용하여 입력과 참조 간의 문자열 비교를 수행하는 StringCheckGrader 개체입니다. Yes
└calculate_output string 채점자 결과에 따라 출력을 계산하는 수식. No
└─ 평가_기준 enum 사용할 평가 메트릭입니다. fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, 또는 rouge_l 중 하나입니다.
가능한 값: fuzzy_match,, bleu,gleumeteor, rouge_1rouge_2, rouge_3rouge_4, rouge_5rouge_l		 No
└> 채점자 object No
└─ 입력 array 입력 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다. No
└─ 모델 string 평가에 사용할 모델입니다. No
└) 이름 string 등급자의 이름입니다. No
└작업 enum 수행할 문자열 검사 작업입니다. eq, ne, like 또는 ilike 중 하나입니다.
가능한 값: eq, ne, likeilike		 No
└─ 범위 array 점수의 범위입니다. 기본값은 [0, 1]입니다. No
└─ 참조 string 채점 기준이 되는 텍스트입니다. No
└─ 샘플링_파라미터 모델의 샘플링 매개 변수입니다. No
└─ 형식 enum 항상 multi인 개체 형식입니다.
가능한 값: multi		 No
하이퍼 매개 변수 OpenAI.FineTuneReinforcementHyperparameters 강화 미세 조정 작업에 사용되는 하이퍼 매개 변수입니다. No
response_format object No
└json_schema object 응답 형식에 대한 JSON 스키마 No
└─ 형식 enum 응답 형식 유형
가능한 값: json_schema		 No

AzureImage

Name Type Description Required Default
b64_json string 생성된 이미지의 base64로 인코딩된 JSON입니다. gpt-image-1의 기본값이며, response_format이 b64_json로 dall-e-2 및 dall-e-3에 설정된 경우에만 존재합니다. No
content_filter_results AzureContentFilterImageResponseResults 이미지 생성 작업의 출력 응답 콘텐츠에 대한 콘텐츠 필터 결과입니다. Yes
prompt_filter_results AzureContentFilterImagePromptResults 이미지 생성 작업의 입력 요청 콘텐츠에 대한 콘텐츠 필터 결과입니다. Yes
수정된_프롬프트 string 오직 dall-e-3만을 위해 사용된 수정된 프롬프트는 이미지를 생성하기 위한 것입니다. No
url string dall-e-2 또는 dall-e-3을 사용할 때, response_format가 url(기본값)로 설정된 경우 생성된 이미지의 URL. 에 대해 gpt-image-1지원되지 않습니다. No

AzureImagesResponse

Name Type Description Required Default
background enum 이미지 생성에 사용되는 백그라운드 매개 변수입니다. transparent 또는 opaque 중 하나입니다.
가능한 값: transparentopaque		 No
created integer 이미지를 만들 때의 Unix 타임스탬프(초)입니다. Yes
data array No
output_format enum 이미지 생성의 출력 형식입니다. png, webp 또는 jpeg 중 하나입니다.
가능한 값: png, webpjpeg		 No
quality enum 생성된 이미지의 품질입니다. low, medium 또는 high 중 하나입니다.
가능한 값: low, mediumhigh		 No
size enum 생성된 이미지의 크기입니다. 1024x1024, 1024x1536 또는 1536x1024 중 하나입니다.
가능한 값: 1024x1024, 1024x15361536x1024		 No
usage object gpt-image-1 전용 이미지 생성에 대한 토큰 사용량 정보입니다. No
└input_tokens integer 입력 프롬프트의 토큰 수(이미지 및 텍스트)입니다. No
입력 토큰 세부정보 └input_tokens_details object 입력 토큰은 이미지 생성에 대한 자세한 정보를 제공합니다. No
└image_tokens integer 입력 프롬프트의 이미지 토큰 수입니다. No
└text_tokens integer 입력 프롬프트의 텍스트 토큰 수입니다. No
└─ 출력 토큰 (output_tokens) integer 출력 이미지의 이미지 토큰 수입니다. No
└total_tokens integer 이미지 생성에 사용되는 총 토큰 수(이미지 및 텍스트)입니다. No

Azure 파일 목록 응답

Name Type Description Required Default
data array Yes
first_id string Yes
has_more boolean Yes
last_id string Yes
object enum
가능한 값: list		 Yes

AzureOpenAIFile

Name Type Description Required Default
bytes integer 파일의 크기(바이트)입니다. Yes
created_at integer 파일을 만들 때의 Unix 타임스탬프(초)입니다. Yes
expires_at integer 파일이 만료될 때의 Unix 타임스탬프(초)입니다. No
filename string 파일 이름입니다. Yes
id string API 엔드포인트에서 참조할 수 있는 파일 식별자입니다. Yes
object enum 항상 file인 개체 형식입니다.
가능한 값: file		 Yes
목적 enum 파일의 용도입니다. 지원되는 값은 assistants, assistants_output, batchbatch_outputfine-tune 및 .fine-tune-results
가능한 값: assistants,assistants_output, batch, batch_outputfine-tune, fine-tune-resultsevals		 Yes
status enum
가능한 값: uploaded,pending, running, processederror, deletingdeleted		 Yes
상태 세부정보 string 더 이상 권장되지 않음. 미세 조정 학습 파일의 유효성 검사에 실패한 이유에 대한 자세한 내용은 의 errorfine_tuning.job필드를 참조하세요. No

AzureOpenAIVideoGenerationErrorResponse

Name Type Description Required Default
code string 오류에 대한 고유한 컴퓨터 생성 식별자입니다. No
inner_error object 해당하는 경우 이 오류를 발생시킨 업스트림 오류입니다. No
└) 코드 enum 내부 오류와 연결된 코드입니다.
가능한 값: ResponsibleAIPolicyViolation		 No
└─ 오류_세부사항 내부 오류와 관련된 콘텐츠 필터 결과 세부 정보입니다. No
└revised_prompt string 해당하는 경우 생성에 사용되는 수정된 프롬프트입니다. No
message string 오류와 관련된 사람이 읽을 수 있는 메시지입니다. No
param string 해당하는 경우 오류와 연결된 요청 입력 매개 변수 No
type string 해당하는 경우 오류와 연결된 입력 줄 번호입니다. No

AzureResponse

Name Type Description Required Default
background boolean 백그라운드에서 모델 응답을 실행할지 여부입니다. No False
created_at integer 이 응답을 만든 시점의 Unix 타임스탬프(초)입니다. Yes
error object 모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다. Yes
└) 코드 OpenAI.ResponseErrorCode 응답에 대한 오류 코드입니다. No
└) 메시지 string 사람이 읽을 수 있는 오류 설명입니다. No
id string 이 응답의 고유 식별자입니다. Yes
incomplete_details object 응답이 불완전한 이유에 대한 세부 정보입니다. Yes
└) 이유 enum 응답이 불완전한 이유입니다.
가능한 값: max_output_tokenscontent_filter		 No
instructions 문자열 또는 배열 Yes
max_output_tokens integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한입니다. No
최대_도구_호출수 integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. No
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 Yes
model string 이 응답을 생성하는 데 사용되는 모델입니다. Yes
object enum 이 리소스의 개체 유형은 항상 response로 설정됩니다.
가능한 값: response		 Yes
output array 모델에서 생성된 콘텐츠 항목의 배열입니다.

- 배열에 있는 항목의 길이와 순서가 output 종속됩니다.
모델의 응답에 따라.
- output 배열의 첫 번째 항목에 액세스하고
생성된 콘텐츠가 있는 assistant 메시지라고 가정하는 것보다
모델에서 output_text 속성을 사용하는 것을 고려해 볼 수 있습니다.
SDK에서 지원됩니다.		 Yes
output_text string 집계된 텍스트 출력을 포함하는 SDK 전용 편의 속성
output_text 배열에 있는 모든 output 항목(있는 경우)에서.
Python 및 JavaScript SDK에서 지원됩니다.		 No
parallel_tool_calls boolean 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. Yes True
previous_response_id string 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다.		 No
prompt object 프롬프트 템플릿 및 해당 변수에 대한 참조입니다. No
└─ ID string 사용할 프롬프트 템플릿의 고유 식별자입니다. No
└) 변수 OpenAI.ResponsePromptVariables 프롬프트에서 변수를 대체할 값의 선택적
맵입니다. 대체 값은 문자열이거나 다른 값일 수 있습니다.
이미지 또는 파일과 같은 응답 입력 형식입니다.		 No
└─ 버전 string 프롬프트 템플릿의 선택적 버전입니다. No
reasoning object o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.		 No
└) 노력 OpenAI.ReasoningEffort o 시리즈 모델만

추론 모델에서 추론 작업을 제한합니다.
현재 지원되는 값은 low, medium 및 high입니다. 줄이는
추론 작업으로 인해 응답 속도가 빨라지고 사용된 토큰 수가 줄어들 수 있습니다.
응답에서의 추론에 관하여		 No
└generate_summary enum 사용되지 않음: 대신 사용합니다 summary .

모델에서 수행하는 추론에 대한 요약입니다. 다음과 같을 수 있습니다.
는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용합니다.
auto, concise 또는 detailed 중 하나입니다.
가능한 값: auto, concisedetailed		 No
└) 요약 enum 모델에서 수행하는 추론에 대한 요약입니다. 다음과 같을 수 있습니다.
는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용합니다.
auto, concise 또는 detailed 중 하나입니다.
가능한 값: auto, concisedetailed		 No
status enum 응답 생성의 상태입니다. 다음 중 하나인 completed, failed
in_progress, cancelled, queued 또는 incomplete.
가능한 값: completed, failed, in_progresscancelled, queuedincomplete		 No
temperature number 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 더 낮은 값을 지정하면 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.		 Yes
text object 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반 텍스트 또는 구조화된 JSON 데이터일 수 있습니다. No
└─ 형식 OpenAI.ResponseTextFormatConfiguration No
tool_choice object 모델이 호출하는 도구(있는 경우)를 제어합니다.

none 는 모델이 도구를 호출하지 않고 대신 메시지를 생성한다는 의미입니다.

auto 는 모델이 메시지를 생성하거나 메시지를 호출하는 중에서 선택할 수 있습니다.
더 많은 도구.

required는 모델이 하나 이상의 도구를 호출해야 함을 의미합니다.		 No
└─ 형식 OpenAI.ToolChoiceObjectType 모델이 기본 제공 도구를 사용하여 응답을 생성해야 임을 나타냅니다. No
tools array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. You
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

- 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
모델의 기능.		 No
top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. No
top_p number 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.		 Yes
truncation enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled		 No
usage OpenAI.ResponseUsage 입력 토큰, 출력 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다.
출력 토큰 및 사용된 총 토큰의 분석입니다.		 No
user string 최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. Yes

AzureSearchChatDataSource

Azure Search 리소스를 사용할 데이터 원본 구성을 나타냅니다.

Name Type Description Required Default
parameters object Azure Search 데이터 원본의 사용을 제어하는 매개 변수 정보입니다. Yes
└─ 부분 결과 허용 boolean true로 설정하면 시스템에서 부분 검색 결과를 사용할 수 있으며 모든 검색 결과가 있으면 요청이 실패합니다.
부분 쿼리가 실패합니다. 지정하지 않거나 false로 지정하면 검색 쿼리가 실패할 경우 요청이 실패합니다.		 No False
└) 인증 object No
└─ 엑세스_토큰 string No
└) 키 string No
└─ 관리된_아이덴티티_리소스_ID string No
└─ 형식 enum
가능한 값: access_token		 No
└ 임베딩_종속성 object Azure OpenAI 임베딩 모델 배포에 대해 공공 서비스 호출을 수행하는 벡터화 소스를 나타냅니다. No
└) 인증 AzureChatDataSourceApiKeyAuthenticationOptions 또는 AzureChatDataSourceAccessTokenAuthenticationOptions 엔드포인트 기반 벡터화 원본과 함께 사용할 인증 메커니즘입니다.
엔드포인트 인증은 API 키 및 액세스 토큰 메커니즘을 지원합니다.		 No
└─ 배포_이름 string 벡터화에 사용할 임베딩 모델 배포입니다. 이 배포는 동일한 Azure OpenAI 내에 있어야 합니다.
채팅 완료에 사용되는 모델 배포로서의 리소스.		 No
└) 차원 integer 임베딩에서 요청할 차원의 수입니다.
'text-embedding-3' 이상 모델에서만 지원됩니다.		 No
└─ 엔드포인트 string 포함을 검색할 리소스 엔드포인트 URL을 지정합니다.
다음 형식이어야 합니다.
https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings.
api-version 쿼리 매개 변수는 허용되지 않습니다.		 No
└─ 형식 enum 이 벡터화 원본 유형에 대해 항상 '통합'된 형식 식별자입니다.
가능한 값: integrated		 No
└─ 엔드포인트 string 사용할 Azure Search 리소스의 절대 엔드포인트 경로입니다. No
└fields_mapping object Azure Search 리소스와 함께 사용할 필드 매핑입니다. No
└content_fields array 콘텐츠로 처리해야 하는 인덱스 필드의 이름입니다. No
└content_fields_separator string 콘텐츠 필드에서 사용해야 하는 구분 기호 패턴입니다. No
└filepath_field string 파일 경로로 사용할 인덱스 필드의 이름입니다. No
└image_vector_fields array 이미지 벡터 데이터를 나타내는 필드의 이름입니다. No
└title_field string 제목으로 사용할 인덱스 필드의 이름입니다. No
└url_field string URL로 사용할 인덱스 필드의 이름입니다. No
└vector_fields array 벡터 데이터를 나타내는 필드의 이름입니다. No
└) 필터 string 검색에 적용할 필터입니다. No
└in_scope boolean 쿼리를 인덱싱된 데이터의 사용으로 제한해야 하는지 여부입니다. No
└include_contexts array 응답에 포함할 출력 컨텍스트 속성입니다.
기본적으로 인용 및 의도가 요청됩니다.		 No ['인용', '의도']
└index_name string Azure Search 리소스에 지정된 대로 사용할 인덱스의 이름입니다. No
└max_search_queries integer 단일 사용자 메시지에 대해 검색 공급자에게 보내야 하는 재작성된 쿼리의 최대 수입니다.
기본적으로 시스템은 자동으로 결정합니다.		 No
└query_type enum 사용할 Azure Search 리소스에 대한 쿼리 유형입니다.
가능한 값: simple, semantic, vector, vector_simple_hybridvector_semantic_hybrid		 No
└semantic_configuration string 쿼리에 대한 추가 의미 체계 구성입니다. No
└) 엄격함 integer 검색 관련성 필터링의 구성된 엄격성입니다.
높은 엄격성은 답변의 정확도를 증가시키지만, 재현율은 낮아집니다.		 No
└top_n_documents integer 쿼리에 기능할 구성된 문서 수입니다. No
type enum 항상 'azure_search'인 구별된 형식 식별자입니다.
가능한 값: azure_search		 Yes

AzureUserSecurityContext

사용자 보안 컨텍스트에는 애플리케이션 자체를 설명하는 몇 가지 매개 변수와 애플리케이션과 상호 작용하는 최종 사용자가 포함됩니다. 이러한 필드는 AI 애플리케이션을 보호하는 포괄적인 접근 방식을 제공하여 보안 운영 팀이 보안 인시던트를 조사하고 완화할 수 있도록 지원합니다. 클라우드용 Microsoft Defender를 사용하여 AI 애플리케이션을 보호하는 방법에 대해 자세히 알아봅니다.

Name Type Description Required Default
application_name string 애플리케이션의 이름입니다. 중요한 개인 정보는 이 필드에 포함하지 않아야 합니다. No
end_user_id string 이 식별자는 생성형 AI 애플리케이션 내에서 최종 사용자를 인증하는 데 사용되는 Microsoft Entra ID(이전의 Azure Active Directory) 사용자 개체 ID입니다. 중요한 개인 정보는 이 필드에 포함하지 않아야 합니다. No
end_user_tenant_id string 최종 사용자가 속한 Microsoft 365 테넌트 ID입니다. 생성 AI 애플리케이션이 다중 테넌트인 경우 필요합니다. No
source_ip string 원래 클라이언트의 IP 주소를 캡처합니다. No

ChatCompletionMessageToolCallsItem

함수 호출과 같이 모델에서 생성된 도구 호출입니다.

배열: OpenAI.ChatCompletionMessageToolCall

CreateVideoGenerationRequest

Name Type Description Required Default
height integer 비디오의 높이입니다. 지원되는 해상도는 가로 방향과 세로 방향 모두에서 480x480, 854x480, 720x720, 1280x720, 1080x1080 및 1920x1080입니다. Yes
model string 이 요청에 사용할 배포의 이름입니다. Yes
n_seconds integer 비디오 생성 작업의 기간입니다. 1~20초 사이여야 합니다. No 5
n_variants integer 이 작업에 대한 변형으로 만들 비디오 수입니다. 1~5 사이여야 합니다. 크기가 작을수록 더 많은 변형이 허용됩니다. No 1
prompt string 이 비디오 생성 작업에 대한 프롬프트입니다. Yes
width integer 비디오의 너비입니다. 지원되는 해상도는 가로 방향과 세로 방향 모두에서 480x480, 854x480, 720x720, 1280x720, 1080x1080 및 1920x1080입니다. Yes

CreateVideoGenerationWithMediaRequestMultiPart (미디어 요청 멀티파트를 사용한 비디오 생성)

미디어 파일이 있는 비디오 생성 작업 요청의 속성입니다.

Name Type Description Required Default
files array Yes
height integer 비디오의 높이입니다. 지원되는 해상도는 가로 방향과 세로 방향 모두에서 480x480, 854x480, 720x720, 1280x720, 1080x1080 및 1920x1080입니다. Yes
inpaint_items array 이 동영상 생성 작업을 위한 선택적 페인팅 항목. No
model string 이 요청에 사용할 배포의 이름입니다. Yes
n_seconds integer 비디오 생성 작업의 기간입니다. 1~20초 사이여야 합니다. No 5
n_variants integer 이 작업에 대한 변형으로 만들 비디오 수입니다. 1~5 사이여야 합니다. 크기가 작을수록 더 많은 변형이 허용됩니다. No 1
prompt string 이 비디오 생성 작업에 대한 프롬프트입니다. Yes
width integer 비디오의 너비입니다. 지원되는 해상도는 가로 방향과 세로 방향 모두에서 480x480, 854x480, 720x720, 1280x720, 1080x1080 및 1920x1080입니다. Yes

CropBounds

페인팅 항목의 자르기 경계. 그러면 인페인팅에 사용해야 하는 미디어 항목의 영역이 지정됩니다.

Name Type Description Required Default
bottom_fraction number 원본 미디어 항목의 높이의 일부로 지정된 자르기 상자의 하단 경계. 0.0에서 1.0 사이여야 합니다. 원본 미디어 항목의 절반 높이에 0.5를 사용합니다. No 1
left_fraction number 원본 미디어 항목의 너비에 대한 분수로 지정된 자르기 상자의 왼쪽 경계. 0.0에서 1.0 사이여야 합니다. 예를 들어 원래 미디어 항목의 너비 절반에 0.5를 사용합니다. No 0
right_fraction number 원본 미디어 항목의 너비에 대한 분수로 지정된 자르기 상자의 오른쪽 경계. 0.0에서 1.0 사이여야 합니다. 예를 들어 원래 미디어 항목의 너비 절반에 0.5를 사용합니다. No 1
top_fraction number 원본 미디어 항목의 높이에 대한 분수로 지정된 자르기 상자의 상단 경계. 0.0에서 1.0 사이여야 합니다. 원본 미디어 항목의 절반 높이에 0.5를 사용합니다. No 0

ElasticsearchChatDataSource

Name Type Description Required Default
parameters object Elasticsearch 데이터 원본의 사용을 제어하는 매개 변수 정보입니다. Yes
└─ 부분 결과 허용 boolean true로 설정하면 시스템에서 부분 검색 결과를 사용할 수 있으며 모든 검색 결과가 있으면 요청이 실패합니다.
부분 쿼리가 실패합니다. 지정하지 않거나 false로 지정하면 검색 쿼리가 실패할 경우 요청이 실패합니다.		 No False
└) 인증 object No
└encoded_api_key string No
└) 키 string No
└key_id string No
└─ 형식 enum
가능한 값: encoded_api_key		 No
└ 임베딩_종속성 AzureChatDataSourceVectorizationSource 데이터 원본을 포함하는 리소스로 사용할 수 있는 데이터 벡터화 원본의 표현입니다. No
└─ 엔드포인트 string No
└fields_mapping object No
└content_fields array No
└content_fields_separator string No
└filepath_field string No
└title_field string No
└url_field string No
└vector_fields array No
└in_scope boolean 쿼리를 인덱싱된 데이터의 사용으로 제한해야 하는지 여부입니다. No
└include_contexts array 응답에 포함할 출력 컨텍스트 속성입니다.
기본적으로 인용 및 의도가 요청됩니다.		 No ['인용', '의도']
└index_name string No
└max_search_queries integer 단일 사용자 메시지에 대해 검색 공급자에게 보내야 하는 재작성된 쿼리의 최대 수입니다.
기본적으로 시스템은 자동으로 결정합니다.		 No
└query_type enum
가능한 값: simplevector		 No
└) 엄격함 integer 검색 관련성 필터링의 구성된 엄격성입니다.
높은 엄격성은 답변의 정확도를 증가시키지만, 재현율은 낮아집니다.		 No
└top_n_documents integer 쿼리에 기능할 구성된 문서 수입니다. No
type enum 항상 'elasticsearch'인 구별된 형식 식별자입니다.
가능한 값: elasticsearch		 Yes

InpaintItem

비디오 생성 작업을 위한 인페인팅 항목입니다. 비디오 생성에서 인페인팅에 사용해야 하는 미디어 항목을 지정합니다.

Name Type Description Required Default
crop_bounds object 페인팅 항목의 자르기 경계.
그러면 인페인팅에 사용해야 하는 미디어 항목의 영역이 지정됩니다.		 No
└bottom_fraction number 원본 미디어 항목의 높이의 일부로 지정된 자르기 상자의 하단 경계. 0.0에서 1.0 사이여야 합니다. 원본 미디어 항목의 절반 높이에 0.5를 사용합니다. No 1
└left_fraction number 원본 미디어 항목의 너비에 대한 분수로 지정된 자르기 상자의 왼쪽 경계. 0.0에서 1.0 사이여야 합니다. 예를 들어 원래 미디어 항목의 너비 절반에 0.5를 사용합니다. No 0
└right_fraction number 원본 미디어 항목의 너비에 대한 분수로 지정된 자르기 상자의 오른쪽 경계. 0.0에서 1.0 사이여야 합니다. 예를 들어 원래 미디어 항목의 너비 절반에 0.5를 사용합니다. No 1
└top_fraction number 원본 미디어 항목의 높이에 대한 분수로 지정된 자르기 상자의 상단 경계. 0.0에서 1.0 사이여야 합니다. 원본 미디어 항목의 절반 높이에 0.5를 사용합니다. No 0
파일_이름 string 미디어 항목의 파일 이름입니다. 이 요청에서 파일 첨부 파일의 파일 이름과 일치해야 합니다. Yes
프레임 인덱스 integer 이 미디어 항목의 프레임 인덱스입니다. 그러면 이 인페인팅 항목에 대해 생성된 비디오의 시작 프레임이 지정됩니다. Yes 0
type object 인페인팅 항목의 유형입니다. Yes

JobStatus

비디오 생성 작업의 상태입니다.

Property Value
Description 비디오 생성 작업의 상태입니다.
Type string
Values preprocessing
queued
running
processing
cancelled
succeeded
failed

MediaItemType

인페인팅 항목의 유형입니다.

Property Value
Description 인페인팅 항목의 유형입니다.
Type string
Values image

MongoDBChatDataSource

Name Type Description Required Default
parameters object MongoDB 데이터 원본의 사용을 제어하는 매개 변수 정보입니다. Yes
└─ 부분 결과 허용 boolean true로 설정하면 시스템에서 부분 검색 결과를 사용할 수 있으며 모든 검색 결과가 있으면 요청이 실패합니다.
부분 쿼리가 실패합니다. 지정하지 않거나 false로 지정하면 검색 쿼리가 실패할 경우 요청이 실패합니다.		 No False
└app_name string MongoDB 애플리케이션의 이름입니다. No
└) 인증 object No
└) 암호 string No
└─ 형식 enum
가능한 값: username_and_password		 No
└> 사용자 이름 string No
└collection_name string MongoDB 컬렉션의 이름입니다. No
└database_name string MongoDB 데이터베이스의 이름입니다. No
└ 임베딩_종속성 object Azure OpenAI 임베딩 모델 배포에 대해 공공 서비스 호출을 수행하는 벡터화 소스를 나타냅니다. No
└) 인증 AzureChatDataSourceApiKeyAuthenticationOptions 또는 AzureChatDataSourceAccessTokenAuthenticationOptions 엔드포인트 기반 벡터화 원본과 함께 사용할 인증 메커니즘입니다.
엔드포인트 인증은 API 키 및 액세스 토큰 메커니즘을 지원합니다.		 No
└─ 배포_이름 string 벡터화에 사용할 임베딩 모델 배포입니다. 이 배포는 동일한 Azure OpenAI 내에 있어야 합니다.
채팅 완료에 사용되는 모델 배포로서의 리소스.		 No
└) 차원 integer 임베딩에서 요청할 차원의 수입니다.
'text-embedding-3' 이상 모델에서만 지원됩니다.		 No
└─ 엔드포인트 string 포함을 검색할 리소스 엔드포인트 URL을 지정합니다.
다음 형식이어야 합니다.
https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings.
api-version 쿼리 매개 변수는 허용되지 않습니다.		 No
└─ 형식 enum 이 벡터화 원본 형식 유형에 대한 식별자는 항상 'deployment_name'입니다.
가능한 값: deployment_name		 No
└─ 엔드포인트 string MongoDB 클러스터 엔드포인트의 이름입니다. No
└fields_mapping object MongoDB 데이터 원본에서 사용하는 데이터에 적용할 필드 매핑입니다.
MongoDB에는 콘텐츠 및 벡터 필드 매핑이 필요합니다.		 No
└content_fields array No
└content_fields_separator string No
└filepath_field string No
└title_field string No
└url_field string No
└vector_fields array No
└in_scope boolean 쿼리를 인덱싱된 데이터의 사용으로 제한해야 하는지 여부입니다. No
└include_contexts array 응답에 포함할 출력 컨텍스트 속성입니다.
기본적으로 인용 및 의도가 요청됩니다.		 No ['인용', '의도']
└index_name string MongoDB 인덱스의 이름입니다. No
└max_search_queries integer 단일 사용자 메시지에 대해 검색 공급자에게 보내야 하는 재작성된 쿼리의 최대 수입니다.
기본적으로 시스템은 자동으로 결정합니다.		 No
└) 엄격함 integer 검색 관련성 필터링의 구성된 엄격성입니다.
높은 엄격성은 답변의 정확도를 증가시키지만, 재현율은 낮아집니다.		 No
└top_n_documents integer 쿼리에 기능할 구성된 문서 수입니다. No
type enum 항상 'mongo_db'인 구별된 형식 식별자입니다.
가능한 값: mongo_db		 Yes

OpenAI.Annotation

OpenAI.Annotation에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
file_citation OpenAI.AnnotationFileCitation
url_citation OpenAI.AnnotationUrlCitation
file_path OpenAI.AnnotationFilePath
Name Type Description Required Default
type OpenAI.AnnotationType Yes

OpenAI.AnnotationFileCitation

파일에 대한 인용입니다.

Name Type Description Required Default
file_id string 파일의 ID입니다. Yes
filename string 인용된 파일의 파일 이름입니다. Yes
index integer 파일 목록에 있는 파일의 인덱스입니다. Yes
type enum 파일 인용의 형식입니다. 항상 file_citation입니다.
가능한 값: file_citation		 Yes

OpenAI.AnnotationFilePath

파일의 경로입니다.

Name Type Description Required Default
file_id string 파일의 ID입니다. Yes
index integer 파일 목록에 있는 파일의 인덱스입니다. Yes
type enum 파일 경로의 형식입니다. 항상 file_path입니다.
가능한 값: file_path		 Yes

OpenAI.AnnotationType

Property Value
Type string
Values file_citation
url_citation
file_path
container_file_citation

OpenAI.AnnotationUrlCitation

모델 응답을 생성하는 데 사용되는 웹 리소스에 대한 인용입니다.

Name Type Description Required Default
end_index integer 메시지에서 URL 인용의 마지막 문자 인덱스입니다. Yes
start_index integer 메시지에서 URL 인용의 첫 번째 문자 인덱스입니다. Yes
title string 웹 리소스의 제목입니다. Yes
type enum URL 인용의 형식입니다. 항상 url_citation입니다.
가능한 값: url_citation		 Yes
url string 웹 리소스의 URL입니다. Yes

OpenAI.ApproximateLocation

Name Type Description Required Default
city string No
country string No
region string No
timezone string No
type enum
가능한 값: approximate		 Yes

OpenAI.AudioResponseFormat

출력의 형식(다음 옵션 중 하나: json, text, srt또는 verbose_jsonvtt. gpt-4o-transcribe 및 gpt-4o-mini-transcribe에 대해 지원되는 유일한 형식은 json입니다.

Property Value
Description 출력의 형식(다음 옵션 중 하나: json, text, srt또는 verbose_jsonvtt. gpt-4o-transcribe 및 gpt-4o-mini-transcribe에 대해 지원되는 유일한 형식은 json입니다.
Type string
Values json
text
srt
verbose_json
vtt

OpenAI.자동 세분화 전략 요청 매개변수

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

Name Type Description Required Default
type enum 항상 auto입니다.
가능한 값: auto		 Yes

OpenAI.ChatCompletionFunctionCallOption

{"name": "my_function"}을 통해 특정 함수를 지정하면 모델이 해당 함수를 호출하게 됩니다.

Name Type Description Required Default
name string 호출할 함수의 이름입니다. Yes

OpenAI.ChatCompletionFunctions

Name Type Description Required Default
description string 함수를 호출하는 시기와 방법을 선택하기 위해 모델에서 사용하는 함수의 기능에 대한 설명입니다. No
name string 호출할 함수의 이름입니다. a~z, A~Z, 0~9 또는 밑줄과 대시를 포함해야 하며 최대 길이는 64자여야 합니다. Yes
parameters 함수가 허용하는 매개 변수로, JSON 스키마 개체로 설명됩니다.
JSON 스키마 참조를 확인하십시오.
형식에 대한 설명서입니다.

parameters를 생략하면 빈 매개 변수 목록이 있는 함수가 정의됩니다.		 No

OpenAI.ChatCompletionMessageAudioChunk

Name Type Description Required Default
data string No
expires_at integer No
id string No
transcript string No

OpenAI.ChatCompletionMessageToolCall

Name Type Description Required Default
function object 모델이 호출한 함수입니다. Yes
└─ 인수 string JSON 형식의 모델에 의해 생성된 함수 호출에 사용할 인수입니다. 모델은 항상 유효한 JSON을 생성하지 않으며 함수 스키마에서 정의되지 않은 매개 변수를 허위로 제공할 수 있습니다. 함수를 호출하기 전에 코드에서 인수의 유효성을 검사하세요. No
└) 이름 string 호출할 함수의 이름입니다. No
id string 도구 호출의 ID입니다. Yes
type enum 도구의 종류입니다. 현재는 function만 지원됩니다.
가능한 값: function		 Yes

OpenAI.ChatCompletionMessageToolCallChunk

Name Type Description Required Default
function object No
└─ 인수 string JSON 형식의 모델에 의해 생성된 함수 호출에 사용할 인수입니다. 모델은 항상 유효한 JSON을 생성하지 않으며 함수 스키마에서 정의되지 않은 매개 변수를 허위로 제공할 수 있습니다. 함수를 호출하기 전에 코드에서 인수의 유효성을 검사하세요. No
└) 이름 string 호출할 함수의 이름입니다. No
id string 도구 호출의 ID입니다. No
index integer Yes
type enum 도구의 종류입니다. 현재는 function만 지원됩니다.
가능한 값: function		 No

OpenAI.ChatCompletionNamedToolChoice

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

Name Type Description Required Default
function object Yes
└) 이름 string 호출할 함수의 이름입니다. No
type enum 도구의 종류입니다. 현재는 function만 지원됩니다.
가능한 값: function		 Yes

OpenAI.ChatCompletionRequestAssistantMessage

사용자 메시지에 대한 응답으로 모델에서 보낸 메시지입니다.

Name Type Description Required Default
audio object 모델의 이전 오디오 응답에 대한 데이터입니다. No
└─ ID string 모델의 이전 오디오 응답에 대한 고유 식별자입니다. No
content 문자열 또는 배열 No
function_call object 더 이상 사용되지 않으며 tool_calls로 대체되었습니다. 모델에 의해 생성된 대로 호출되어야 하는 함수의 이름과 인수입니다. No
└─ 인수 string No
└) 이름 string No
name string 참가자의 선택적 이름입니다. 동일한 역할의 참가자를 구별하기 위한 모델 정보를 제공합니다. No
refusal string 도우미가 보낸 거절 메시지입니다. No
role enum 메시지 작성자의 역할(이 경우 assistant)입니다.
가능한 값: assistant		 Yes
tool_calls ChatCompletionMessageToolCallsItem 함수 호출과 같이 모델에서 생성된 도구 호출입니다. No

OpenAI.ChatCompletionRequestAssistantMessageContentPart

Name Type Description Required Default
refusal string 모델이 생성한 거부 메시지입니다. Yes
text string 텍스트 콘텐츠입니다. Yes
type enum 콘텐츠 부분의 형식입니다.
가능한 값: refusal		 Yes

OpenAI.ChatCompletionRequestDeveloperMessage

사용자가 보낸 메시지에 관계없이 모델이 따라야 하는 개발자 제공 지침입니다. o1 모델 이상에서는 developer 메시지가 이전 system 메시지를 대체합니다.

Name Type Description Required Default
content 문자열 또는 배열 Yes
name string 참가자의 선택적 이름입니다. 동일한 역할의 참가자를 구별하기 위한 모델 정보를 제공합니다. No
role enum 메시지 작성자의 역할(이 경우 developer)입니다.
가능한 값: developer		 Yes

OpenAI.ChatCompletionRequestFunctionMessage

Name Type Description Required Default
content string 함수 메시지의 콘텐츠입니다. Yes
name string 호출할 함수의 이름입니다. Yes
role enum 메시지 작성자의 역할(이 경우 function)입니다.
가능한 값: function		 Yes

OpenAI.ChatCompletionRequestMessage

OpenAI.ChatCompletionRequestMessage에 대한 판별자

이 구성 요소는 속성을 role 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
system OpenAI.ChatCompletionRequestSystemMessage
developer OpenAI.ChatCompletionRequestDeveloperMessage
user OpenAI.ChatCompletionRequestUserMessage
assistant OpenAI.ChatCompletionRequestAssistantMessage
tool OpenAI.ChatCompletionRequestToolMessage
function OpenAI.ChatCompletionRequestFunctionMessage
Name Type Description Required Default
content 문자열 또는 배열 No
role object 메시지 작성자의 역할 Yes

OpenAI.ChatCompletionRequestMessageContentPart

OpenAI.ChatCompletionRequestMessageContentPart에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
text OpenAI.ChatCompletionRequestMessageContentPartText
image_url OpenAI.ChatCompletionRequestMessageContentPartImage
refusal OpenAI.ChatCompletionRequestMessageContentPartRefusal
file OpenAI.ChatCompletionRequestMessageContentPartFile
input_audio OpenAI.ChatCompletionRequestMessageContentPartAudio
Name Type Description Required Default
type OpenAI.ChatCompletionRequestMessageContentPartType Yes

OpenAI.ChatCompletionRequestMessageContentPartAudio

Name Type Description Required Default
input_audio object Yes
└) 데이터 string Base64로 인코딩된 오디오 데이터입니다. No
└─ 형식 enum 인코딩된 오디오 데이터의 형식입니다. 현재 "wav" 및 "mp3"를 지원합니다.
가능한 값: wavmp3		 No
type enum 콘텐츠 부분의 형식입니다. 항상 input_audio입니다.
가능한 값: input_audio		 Yes

OpenAI.ChatCompletionRequestMessageContentPartFile

Name Type Description Required Default
file object Yes
└file_data string 모델에 파일을 전달할 때 사용되는 base64로 인코딩된 파일 데이터입니다.
문자열로 지정합니다.		 No
└ file_id string 입력으로 사용할 업로드된 파일의 ID입니다. No
└> 파일 이름 string 모델에 파일을 전달할 때 사용되는 파일의 이름입니다.
string.		 No
type enum 콘텐츠 부분의 형식입니다. 항상 file입니다.
가능한 값: file		 Yes

OpenAI.ChatCompletionRequestMessageContentPartImage

Name Type Description Required Default
image_url object Yes
└) 세부 정보 enum 이미지의 세부 수준을 지정합니다.
가능한 값: auto, lowhigh		 No
└) url string 이미지의 URL 또는 base64로 인코딩된 이미지 데이터입니다. No
type enum 콘텐츠 부분의 형식입니다.
가능한 값: image_url		 Yes

OpenAI.ChatCompletionRequestMessageContentPartRefusal

Name Type Description Required Default
refusal string 모델이 생성한 거부 메시지입니다. Yes
type enum 콘텐츠 부분의 형식입니다.
가능한 값: refusal		 Yes

OpenAI.ChatCompletionRequestMessageContentPartText

Name Type Description Required Default
text string 텍스트 콘텐츠입니다. Yes
type enum 콘텐츠 부분의 형식입니다.
가능한 값: text		 Yes

OpenAI.ChatCompletionRequestMessageContentPartType

Property Value
Type string
Values text
file
input_audio
image_url
refusal

OpenAI.ChatCompletionRequestSystemMessage

사용자가 보낸 메시지에 관계없이 모델이 따라야 하는 개발자 제공 지침입니다. o1 모델 이상에서는 대신 이 목적을 위해 메시지를 사용합니다 developer .

Name Type Description Required Default
content 문자열 또는 배열 Yes
name string 참가자의 선택적 이름입니다. 동일한 역할의 참가자를 구별하기 위한 모델 정보를 제공합니다. No
role enum 메시지 작성자의 역할(이 경우 system)입니다.
가능한 값: system		 Yes

OpenAI.ChatCompletionRequestSystemMessageContentPart

참조: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

Name Type Description Required Default
content 문자열 또는 배열 Yes
role enum 메시지 작성자의 역할(이 경우 tool)입니다.
가능한 값: tool		 Yes
tool_call_id string 이 메시지가 응답하는 도구 호출입니다. Yes

OpenAI.ChatCompletionRequestToolMessageContentPart

참조: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

프롬프트 또는 추가 컨텍스트 정보를 포함하는 최종 사용자가 보낸 메시지입니다.

Name Type Description Required Default
content 문자열 또는 배열 Yes
name string 참가자의 선택적 이름입니다. 동일한 역할의 참가자를 구별하기 위한 모델 정보를 제공합니다. No
role enum 메시지 작성자의 역할(이 경우 user)입니다.
가능한 값: user		 Yes

OpenAI.ChatCompletionRequestUserMessageContentPart

Name Type Description Required Default
file object Yes
└file_data string 모델에 파일을 전달할 때 사용되는 base64로 인코딩된 파일 데이터입니다.
문자열로 지정합니다.		 No
└ file_id string 입력으로 사용할 업로드된 파일의 ID입니다. No
└> 파일 이름 string 모델에 파일을 전달할 때 사용되는 파일의 이름입니다.
string.		 No
image_url object Yes
└) 세부 정보 enum 이미지의 세부 수준을 지정합니다.
가능한 값: auto, lowhigh		 No
└) url string 이미지의 URL 또는 base64로 인코딩된 이미지 데이터입니다. No
input_audio object Yes
└) 데이터 string Base64로 인코딩된 오디오 데이터입니다. No
└─ 형식 enum 인코딩된 오디오 데이터의 형식입니다. 현재 "wav" 및 "mp3"를 지원합니다.
가능한 값: wavmp3		 No
text string 텍스트 콘텐츠입니다. Yes
type enum 콘텐츠 부분의 형식입니다. 항상 file입니다.
가능한 값: file		 Yes

OpenAI.ChatCompletionRole

메시지 작성자의 역할

Property Value
Description 메시지 작성자의 역할
Type string
Values system
developer
user
assistant
tool
function

OpenAI.ChatCompletionStreamOptions

스트리밍 응답에 대한 옵션입니다. stream: true를 설정할 때만 설정합니다.

Name Type Description Required Default
include_usage boolean 설정된 경우 추가 청크가 data: [DONE] 전에 스트리밍됩니다.
메시지가 표시됩니다. 이 청크의 필드에는 usage 토큰 사용 통계가 표시됩니다.
전체 요청에 대해, 해당 choices 필드는 항상 비어 있습니다.
배열.

다른 모든 청크에도 usage 필드가 포함되지만, 그 필드는 null입니다.
값. 메모: 스트림이 중단되면 다음을 수신하지 못할 수 있습니다.
요청에 대한 총 토큰 사용량을 포함하는 최종 사용량 청크입니다.		 No

OpenAI.ChatCompletionStreamResponseDelta

스트리밍된 모델 응답을 통해 생성된 채팅 완성 델타입니다.

Name Type Description Required Default
audio object No
└) 데이터 string No
└─ 만료_시간 integer No
└─ ID string No
└) 대본 string No
content string 청크 메시지의 콘텐츠입니다. No
function_call object 더 이상 사용되지 않으며 tool_calls로 대체되었습니다. 모델에 의해 생성된 대로 호출되어야 하는 함수의 이름과 인수입니다. No
└─ 인수 string No
└) 이름 string No
refusal string 모델이 생성한 거부 메시지입니다. No
role object 메시지 작성자의 역할 No
tool_calls array No

OpenAI.ChatCompletionTokenLogprob

Name Type Description Required Default
bytes array 토큰의 UTF-8 바이트 표현을 나타내는 정수 목록입니다. 문자가 여러 토큰으로 표현되고 해당 바이트 표현이 결합되어 올바른 텍스트 표현을 생성해야 하는 경우에 유용합니다. 토큰에 대한 바이트 표현이 없는 경우 null일 수 있습니다. Yes
logprob number 이 토큰이 상위 20개 가장 가능성이 높은 토큰에 포함될 경우의 로그 가능성입니다. 그렇지 않으면 값 -9999.0은 토큰이 매우 가능성이 낮음을 나타내는 데 사용됩니다. Yes
token string 토큰입니다. Yes
top_logprobs array 이 토큰 위치에서 가장 가능성이 높은 토큰 및 해당 로그 확률의 목록입니다. 드문 경우지만 반환된 요청 top_logprobs의 수보다 적을 수 있습니다. Yes

OpenAI.ChatCompletionTool

Name Type Description Required Default
function OpenAI.FunctionObject Yes
type enum 도구의 종류입니다. 현재는 function만 지원됩니다.
가능한 값: function		 Yes

OpenAI.ChatCompletionToolChoiceOption

모델이 호출하는 도구(있는 경우)를 제어합니다. none 는 모델이 도구를 호출하지 않고 대신 메시지를 생성한다는 의미입니다. auto는 모델이 메시지 생성 또는 하나 이상의 도구 호출 중에서 선택할 수 있음을 의미합니다. required는 모델이 하나 이상의 도구를 호출해야 함을 의미합니다. {"type": "function", "function": {"name": "my_function"}}을 사용하여 특정 도구를 지정하면 모델이 해당 도구를 강제 호출하게 됩니다.

none은 도구가 없는 경우 기본값입니다. auto는 도구가 있는 경우 기본값입니다.

Name Type Description Required Default
function object Yes
└) 이름 string 호출할 함수의 이름입니다. No
type enum 도구의 종류입니다. 현재는 function만 지원됩니다.
가능한 값: function		 Yes

OpenAI.ChatOutputPrediction

모델에서 예측된 출력의 기본 표현입니다.

OpenAI.ChatOutputPrediction에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
content OpenAI.ChatOutputPredictionContent
Name Type Description Required Default
type OpenAI.ChatOutputPredictionType Yes

OpenAI.ChatOutputPredictionContent

다시 생성되는 텍스트 파일의 콘텐츠와 같은 정적 예측 출력 콘텐츠입니다.

Name Type Description Required Default
content 문자열 또는 배열 Yes
type enum 제공하려는 예측 콘텐츠의 형식입니다. 이 형식은 다음과 같습니다.
현재는 항상 content입니다.
가능한 값: content		 Yes

OpenAI.ChatOutputPredictionType

Property Value
Type string
Values content

OpenAI.ChunkingStrategyRequestParam

파일을 청크하는 데 사용되는 청크 전략입니다. 설정하지 않으면 auto 전략을 사용합니다.

OpenAI.ChunkingStrategyRequestParam에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
static OpenAI.StaticChunkingStrategyRequestParam
Name Type Description Required Default
type enum 청크 전략의 유형입니다.
가능한 값: autostatic		 Yes

OpenAI.ChunkingStrategyResponseParam

OpenAI.ChunkingStrategyResponseParam에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
other OpenAI.OtherChunkingStrategyResponseParam (오픈AI 기타 청크 전략 응답 매개변수)
static OpenAI.StaticChunkingStrategyResponseParam
Name Type Description Required Default
type enum
가능한 값: staticother		 Yes

OpenAI 코드 해석기 출력

OpenAI.CodeInterpreterOutput에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
image OpenAI.CodeInterpreterOutputImage
logs OpenAI.CodeInterpreterOutputLogs
Name Type Description Required Default
type OpenAI.CodeInterpreterOutputType Yes

OpenAI.CodeInterpreterOutputImage

코드 인터프리터의 이미지 출력입니다.

Name Type Description Required Default
type enum 출력의 형식입니다. 항상 '이미지'입니다.
가능한 값: image		 Yes
url string 코드 인터프리터에서 이미지 출력의 URL입니다. Yes

OpenAI.CodeInterpreterOutputLogs

코드 인터프리터의 로그 출력입니다.

Name Type Description Required Default
logs string 코드 인터프리터의 로그 출력입니다. Yes
type enum 출력의 형식입니다. 항상 'logs'입니다.
가능한 값: logs		 Yes

OpenAI.CodeInterpreterOutputType

Property Value
Type string
Values logs
image

OpenAI.CodeInterpreterTool

프롬프트에 대한 응답을 생성하는 데 도움이 되는 Python 코드를 실행하는 도구입니다.

Name Type Description Required Default
container object 코드 인터프리터 컨테이너에 대한 구성입니다. 필요에 따라 ID 지정
코드를 실행할 파일.		 Yes
└ file_ids array 코드에서 사용할 수 있도록 업로드된 파일의 선택적 목록입니다. No
└─ 형식 enum 항상 auto입니다.
가능한 값: auto		 No
type enum 코드 인터프리터 도구의 형식입니다. 항상 code_interpreter입니다.
가능한 값: code_interpreter		 Yes

OpenAI.CodeInterpreterToolAuto

코드 인터프리터 컨테이너에 대한 구성입니다. 필요에 따라 코드를 실행할 파일의 ID를 지정합니다.

Name Type Description Required Default
file_ids array 코드에서 사용할 수 있도록 업로드된 파일의 선택적 목록입니다. No
type enum 항상 auto입니다.
가능한 값: auto		 Yes

OpenAI.CodeInterpreterToolCallItemParam

코드를 실행하는 도구 호출입니다.

Name Type Description Required Default
code string 실행할 코드이거나, 사용할 수 없는 경우 null입니다. Yes
container_id string 코드를 실행하는 데 사용되는 컨테이너의 ID입니다. Yes
outputs array 코드 인터프리터에서 생성된 출력(예: 로그 또는 이미지)입니다.
사용할 수 있는 출력이 없으면 null일 수 있습니다.		 Yes
type enum
가능한 값: code_interpreter_call		 Yes

OpenAI.CodeInterpreterToolCallItemResource

코드를 실행하는 도구 호출입니다.

Name Type Description Required Default
code string 실행할 코드이거나, 사용할 수 없는 경우 null입니다. Yes
container_id string 코드를 실행하는 데 사용되는 컨테이너의 ID입니다. Yes
outputs array 코드 인터프리터에서 생성된 출력(예: 로그 또는 이미지)입니다.
사용할 수 있는 출력이 없으면 null일 수 있습니다.		 Yes
status enum
가능한 값: in_progress, completed, incomplete, interpretingfailed		 Yes
type enum
가능한 값: code_interpreter_call		 Yes

OpenAI.ComparisonFilter

정의된 비교 작업을 사용하여 지정된 특성 키를 지정된 값과 비교하는 데 사용되는 필터입니다.

Name Type Description Required Default
key string 값과 비교할 키입니다. Yes
type enum 비교 연산eqnegtgteltlte자를 지정합니다.
- eq:같음
- ne: 같지 않음
- gt: 보다 큼
- gte: 크거나 같음
- lt:미만
- lte: 작거나 같음
가능한 값: eq, ne, gtgte, ltlte		 Yes
value 문자열 또는 숫자 또는 불리언 Yes

OpenAI.CompletionUsage

완성 요청의 사용 통계입니다.

Name Type Description Required Default
completion_tokens integer 생성된 완성의 토큰 수입니다. Yes 0
completion_tokens_details object 완성에 사용되는 토큰 분석입니다. No
└─ 수락된 예측 토큰 integer 예측 출력을 사용할 때 완료에 나타난 예측의
토큰 수입니다.		 No 0
└audio_tokens integer 모델에서 생성된 오디오 입력 토큰입니다. No 0
└─ 추론_토큰 integer 추론을 위해 모델에서 생성한 토큰입니다. No 0
└─ 거부된_예측_토큰 integer 예측 출력을 사용할 때 완료에 나타난 예측의
토큰 수입니다. 그러나, 제한과
추론 토큰, 이러한 토큰은 여전히 합계로 계산됩니다.
청구, 출력 및 컨텍스트 창을 위한 완료 토큰
같습니다.		 No 0
prompt_tokens integer 프롬프트에 있는 토큰 수입니다. Yes 0
prompt_tokens_details object 프롬프트에 사용된 토큰의 분석입니다. No
└audio_tokens integer 프롬프트에 있는 오디오 입력 토큰입니다. No 0
└─ 캐시된_토큰 (cached_tokens) integer 프롬프트에 캐시된 토큰이 있습니다. No 0
total_tokens integer 요청에 사용된 총 토큰 수입니다(프롬프트 + 완성). Yes 0

OpenAI.CompoundFilter

and 또는 or를 사용하여 여러 필터를 결합합니다.

Name Type Description Required Default
filters array 결합할 필터의 배열입니다. 항목은 ComparisonFilter 또는 CompoundFilter일 수 있습니다. Yes
type enum 작업 유형: and 또는 or.
가능한 값: andor		 Yes

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
Name Type Description Required Default
type OpenAI.ComputerActionType Yes

OpenAI.ComputerActionClick

클릭 동작입니다.

Name Type Description Required Default
button enum 클릭하는 동안 누른 마우스 단추를 나타냅니다. left, right, wheel, back, forward 중 하나입니다.
가능한 값: left, right, wheel, backforward		 Yes
type enum 이벤트 유형을 지정합니다. 클릭 작업의 경우 이 속성은
항상 click로 설정합니다.
가능한 값: click		 Yes
x integer 클릭이 발생한 x 좌표입니다. Yes
y integer 클릭이 발생한 y 좌표입니다. Yes

OpenAI.ComputerActionDoubleClick

두 번 클릭 동작입니다.

Name Type Description Required Default
type enum 이벤트 유형을 지정합니다. 두 번 클릭 작업의 경우 이 속성은
항상 double_click로 설정합니다.
가능한 값: double_click		 Yes
x integer 두 번 클릭이 발생한 x 좌표입니다. Yes
y integer 이중 클릭이 발생한 y 좌표입니다. Yes

OpenAI.ComputerActionDrag

끌기 작업입니다.

Name Type Description Required Default
path array 끌기 동작의 경로를 나타내는 좌표 배열입니다. 좌표가 배열로 표시됩니다.
예를 들어, 개체의
<br>[<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br>]<br>		 Yes
type enum 이벤트 유형을 지정합니다. 끌기 작업의 경우 이 속성은 다음과 같습니다.
항상 drag로 설정합니다.
가능한 값: drag		 Yes

OpenAI.ComputerActionKeyPress

모델이 수행하려는 키 프레스의 컬렉션입니다.

Name Type Description Required Default
keys array 모델이 누르도록 요청하는 키 조합입니다. 이는
각각 키를 나타내는 문자열 배열입니다.		 Yes
type enum 이벤트 유형을 지정합니다. 키 입력 작업의 경우 이 속성은 다음과 같습니다.
항상 keypress로 설정합니다.
가능한 값: keypress		 Yes

OpenAI.ComputerActionMove

마우스 이동 동작입니다.

Name Type Description Required Default
type enum 이벤트 유형을 지정합니다. 이동 작업의 경우 이 속성은
항상 move로 설정합니다.
가능한 값: move		 Yes
x integer 이동할 x 좌표입니다. Yes
y integer 이동할 y 좌표입니다. Yes

OpenAI.ComputerActionScreenshot

스크린샷 작업입니다.

Name Type Description Required Default
type enum 이벤트 유형을 지정합니다. 스크린샷 작업의 경우 이 속성은 다음과 같습니다.
항상 screenshot로 설정합니다.
가능한 값: screenshot		 Yes

OpenAI.ComputerActionScroll

스크롤 동작입니다.

Name Type Description Required Default
scroll_x integer 가로 스크롤 거리입니다. Yes
scroll_y integer 세로 스크롤 거리입니다. Yes
type enum 이벤트 유형을 지정합니다. 스크롤 작업의 경우 이 속성은
항상 scroll로 설정합니다.
가능한 값: scroll		 Yes
x integer 스크롤이 발생한 x 좌표입니다. Yes
y integer 스크롤이 발생한 y 좌표입니다. Yes

OpenAI.ComputerActionType

Property Value
Type string
Values screenshot
click
double_click
scroll
type
wait
keypress
drag
move

OpenAI.ComputerActionTypeKeys

텍스트에 입력할 작업입니다.

Name Type Description Required Default
text string 입력할 텍스트입니다. Yes
type enum 이벤트 유형을 지정합니다. 형식 작업의 경우 이 속성은
항상 type로 설정합니다.
가능한 값: type		 Yes

OpenAI.ComputerActionWait

대기 작업입니다.

Name Type Description Required Default
type enum 이벤트 유형을 지정합니다. 대기 작업의 경우 이 속성은
항상 wait로 설정합니다.
가능한 값: wait		 Yes

OpenAI.ComputerToolCallItemParam

컴퓨터 사용 도구에 대한 도구 호출입니다.

Name Type Description Required Default
action OpenAI.ComputerAction Yes
call_id string 출력을 사용하여 도구 호출에 응답할 때 사용되는 식별자입니다. Yes
pending_safety_checks array 보류 중인 보안 검사에서 컴퓨터 호출을 확인합니다. Yes
type enum
가능한 값: computer_call		 Yes

OpenAI.ComputerToolCallItemResource

컴퓨터 사용 도구에 대한 도구 호출입니다.

Name Type Description Required Default
action OpenAI.ComputerAction Yes
call_id string 출력을 사용하여 도구 호출에 응답할 때 사용되는 식별자입니다. Yes
pending_safety_checks array 보류 중인 보안 검사에서 컴퓨터 호출을 확인합니다. Yes
status enum 항목의 상태입니다. in_progress, completed 또는 하나
incomplete; 항목이 API를 통해 반환될 때 채워집니다.
가능한 값: in_progress, completedincomplete		 Yes
type enum
가능한 값: computer_call		 Yes

OpenAI.ComputerToolCallOutputItemOutput

OpenAI.ComputerToolCallOutputItemOutput에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
computer_screenshot OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot
Name Type Description Required Default
type OpenAI.ComputerToolCallOutputItemOutputType 컴퓨터 사용 도구와 함께 사용되는 컴퓨터 스크린샷 이미지입니다. Yes

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Name Type Description Required Default
file_id string No
image_url string No
type enum
가능한 값: computer_screenshot		 Yes

OpenAI.ComputerToolCallOutputItemOutputType

컴퓨터 사용 도구와 함께 사용되는 컴퓨터 스크린샷 이미지입니다.

Property Value
Description 컴퓨터 사용 도구와 함께 사용되는 컴퓨터 스크린샷 이미지입니다.
Type string
Values computer_screenshot

OpenAI.ComputerToolCallOutputItemParam

컴퓨터 도구 호출의 출력입니다.

Name Type Description Required Default
acknowledged_safety_checks array API에서 보고한 안전 검사는 다음에서 확인되었습니다.
개발자.		 No
call_id string 출력을 생성한 컴퓨터 도구 호출의 ID입니다. Yes
output OpenAI.ComputerToolCallOutputItemOutput Yes
type enum
가능한 값: computer_call_output		 Yes

OpenAI.ComputerToolCallOutputItemResource

컴퓨터 도구 호출의 출력입니다.

Name Type Description Required Default
acknowledged_safety_checks array API에서 보고한 안전 검사는 다음에서 확인되었습니다.
개발자.		 No
call_id string 출력을 생성한 컴퓨터 도구 호출의 ID입니다. Yes
output OpenAI.ComputerToolCallOutputItemOutput Yes
status enum 항목의 상태입니다. in_progress, completed 또는 하나
incomplete; 항목이 API를 통해 반환될 때 채워집니다.
가능한 값: in_progress, completedincomplete		 Yes
type enum
가능한 값: computer_call_output		 Yes

OpenAI.ComputerToolCallSafetyCheck

컴퓨터 호출에 대한 보류 중인 안전 검사입니다.

Name Type Description Required Default
code string 보류 중인 안전 검사의 유형입니다. Yes
id string 보류 중인 안전 검사의 ID입니다. Yes
message string 보류 중인 안전 검사에 대한 세부 정보입니다. Yes

OpenAI.ComputerUsePreviewTool

가상 컴퓨터를 제어하는 도구입니다.

Name Type Description Required Default
display_height integer 컴퓨터 디스플레이의 높이입니다. Yes
display_width integer 컴퓨터 표시의 너비입니다. Yes
environment enum 제어할 컴퓨터 환경의 유형입니다.
가능한 값: windows, mac, linux, ubuntubrowser		 Yes
type enum 컴퓨터 사용 도구의 유형입니다. 항상 computer_use_preview입니다.
가능한 값: computer_use_preview		 Yes

OpenAI.Coordinate

x/y 좌표 쌍(예: { x: 100, y: 200 }

Name Type Description Required Default
x integer X 좌표입니다. Yes
y integer Y 좌표입니다. Yes

OpenAI.CreateEmbeddingResponse

Name Type Description Required Default
data array 모델에 의해 생성된 포함 목록입니다. Yes
model string 포함을 생성하는 데 사용된 모델의 이름입니다. Yes
object enum 항상 "목록"인 개체 형식입니다.
가능한 값: list		 Yes
usage object 요청에 대한 사용 정보입니다. Yes
└prompt_tokens integer 프롬프트에서 사용되는 토큰 수입니다. No
└total_tokens integer 요청에 사용된 총 토큰 수입니다. No

OpenAI.CreateEvalItem

프롬프트 또는 컨텍스트를 구성하는 채팅 메시지입니다. 네임스페이스 item에 대한 변수 참조(예: {{item.name}})를 포함할 수 있습니다.

Name Type Description Required Default
content string 또는 OpenAI.EvalItemContent 모델에 대한 텍스트 입력 - 템플릿 문자열을 포함할 수 있습니다. Yes
role enum 메시지 입력의 역할입니다. user, assistant, system 중 하나 또는
developer;
가능한 값: user, assistant, systemdeveloper		 Yes
type enum 메시지 입력의 형식입니다. 항상 message입니다.
가능한 값: message		 No

OpenAI.CreateEvalRunRequest

Name Type Description Required Default
데이터_소스 object Yes
└─ 형식 OpenAI.EvalRunDataSourceType No
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
name string 런의 이름입니다. No

OpenAI.CreateFineTuningJobRequest

유효한 모델:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini
Name Type Description Required Default
하이퍼 매개 변수 object 미세 조정 작업에 사용되는 하이퍼 매개 변수입니다.
이 값은 method 대신 사용되지 않으며, method 매개 변수로 전달해야 합니다.		 No
└batch_size enum
가능한 값: auto		 No
└learning_rate_multiplier enum
가능한 값: auto		 No
└n_epochs enum
가능한 값: auto		 No
통합 array 미세 조정 작업에 사용할 수 있는 통합 목록입니다. No
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
메서드 OpenAI.FineTuneMethod 미세 조정에 사용되는 메서드입니다. No
model string(아래 유효한 모델 참조) 미세 조정할 모델의 이름입니다. Yes
seed integer 시드는 작업의 재현성을 제어합니다. 동일한 시드 및 작업 매개 변수를 전달하면 동일한 결과가 생성되지만 드문 경우에 다를 수 있습니다.
시드를 지정하지 않으면 시드가 생성됩니다.		 No
suffix string 미세 조정된 모델 이름에 추가될 최대 64자의 문자열입니다.

예를 들어 suffix "custom-model-name"은 다음과 같은 ft:gpt-4o-mini:openai:custom-model-name:7p4lURel모델 이름을 생성합니다.		 No None
교육 파일 string 학습 데이터가 포함된 업로드된 파일의 ID입니다. 데이터 세트의 형식을 JSONL 파일로 지정해야 합니다. 또한 용도 fine-tune로 파일을 업로드해야 합니다.

파일의 내용은 모델에서 채팅, 완료 형식을 사용하는지 또는 미세 조정 메서드에서 기본 설정 형식을 사용하는지에 따라 달라야 합니다.		 Yes
검증_파일 string 유효성 검사 데이터를 포함하는 업로드된 파일의 ID입니다.

이 파일을 제공하는 경우 데이터는 유효성 검사를 생성하는 데 사용됩니다.
미세 조정 중에 메트릭을 주기적으로 측정합니다. 이러한 메트릭은 다음에서 볼 수 있습니다.
미세 조정 결과 파일입니다.
학습 파일과 유효성 검사 파일 모두에 동일한 데이터가 있으면 안 됩니다.

데이터 세트의 형식을 JSONL 파일로 지정해야 합니다. 용도 fine-tune로 파일을 업로드해야 합니다.		 No

OpenAI.CreateFineTuningJobRequestIntegration

OpenAI.CreateFineTuningJobRequestIntegration에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
wandb OpenAI.CreateFineTuningJobRequestWandbIntegration
Name Type Description Required Default
type string(아래 유효한 모델 참조) Yes

OpenAI.CreateFineTuningJobRequestWandbIntegration

Name Type Description Required Default
type enum
가능한 값: wandb		 Yes
wandb object Yes
└) 엔터티 string No
└) 이름 string No
└) 프로젝트 string No
└─ 태그 array No

OpenAI.CreateVectorStoreFileBatchRequest

Name Type Description Required Default
특성 object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다. 키는 문자열입니다.
최대 길이는 64자입니다. 값은 최대값이 있는 문자열입니다.
최대 512자, 부울 또는 숫자.		 No
chunking_strategy OpenAI.ChunkingStrategyRequestParam 파일을 청크하는 데 사용되는 청크 전략입니다. 설정하지 않으면 auto 전략을 사용합니다. No
file_ids array 벡터 저장소에서 사용해야 하는 파일 ID 목록입니다. 파일에 액세스할 수 있는 file_search와 같은 도구에 유용합니다. Yes

OpenAI.CreateVectorStoreFileRequest

Name Type Description Required Default
특성 object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다. 키는 문자열입니다.
최대 길이는 64자입니다. 값은 최대값이 있는 문자열입니다.
최대 512자, 부울 또는 숫자.		 No
chunking_strategy OpenAI.ChunkingStrategyRequestParam 파일을 청크하는 데 사용되는 청크 전략입니다. 설정하지 않으면 auto 전략을 사용합니다. No
file_id string 벡터 저장소에서 사용해야 하는 파일 ID입니다. 파일에 액세스할 수 있는 file_search와 같은 도구에 유용합니다. Yes

OpenAI.CreateVectorStoreRequest

Name Type Description Required Default
chunking_strategy object 기본 전략. 이 전략은 현재 max_chunk_size_tokens의 800 및 chunk_overlap_tokens의 400을 사용합니다. No
└> static OpenAI.StaticChunkingStrategy No
└─ 형식 enum 항상 static입니다.
가능한 값: static		 No
expires_after OpenAI.VectorStoreExpirationAfter 벡터 저장소에 대한 만료 정책입니다. No
file_ids array 벡터 저장소에서 사용해야 하는 파일 ID 목록입니다. 파일에 액세스할 수 있는 file_search와 같은 도구에 유용합니다. No
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
name string 벡터 저장소의 이름입니다. No

OpenAI.DeleteFileResponse

Name Type Description Required Default
삭제됨 boolean Yes
id string Yes
object enum
가능한 값: file		 Yes

OpenAI.DeleteVectorStoreFileResponse (벡터 스토어 파일 삭제 응답)

Name Type Description Required Default
삭제됨 boolean Yes
id string Yes
object enum
가능한 값: vector_store.file.deleted		 Yes

OpenAI.DeleteVectorStoreResponse

Name Type Description Required Default
삭제됨 boolean Yes
id string Yes
object enum
가능한 값: vector_store.deleted		 Yes

OpenAI.Embedding

임베딩 엔드포인트가 반환한 임베딩 벡터를 나타냅니다.

Name Type Description Required Default
embedding 배열 또는 문자열 Yes
index integer 포함 목록의 포함 인덱스입니다. Yes
object enum 항상 "포함"되는 개체 형식입니다.
가능한 값: embedding		 Yes

OpenAI.Eval

데이터 원본 구성 및 테스트 조건이 있는 Eval 개체입니다. Eval은 LLM 통합을 위해 수행할 작업을 나타냅니다. 결과는 다음과 같습니다.

  • 내 챗봇의 품질 향상
  • 내 챗봇이 고객 지원을 얼마나 잘 처리하는지 확인합니다.
  • gpt-4o보다 사용 시 o4-mini가 더 나은지 확인합니다.
Name Type Description Required Default
created_at integer eval을 만들 때의 Unix 타임스탬프(초)입니다. Yes
데이터 소스 구성 object Yes
└─ 형식 OpenAI.EvalDataSourceConfigType No
id string 평가에 대한 고유 식별자입니다. Yes
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 Yes
name string 평가의 이름입니다. Yes
object enum 개체 유형입니다.
가능한 값: eval		 Yes
테스트 기준 array 테스트 조건 목록입니다. Yes None

OpenAI.EvalApiError

Eval API의 오류 응답을 나타내는 개체입니다.

Name Type Description Required Default
code string 오류 코드입니다. Yes
message string 오류 메시지입니다. Yes

OpenAI.EvalCompletionsRunDataSourceParams

모델 샘플링 구성을 설명하는 CompletionsRunDataSource 개체입니다.

Name Type Description Required Default
입력 메시지 object No
└─ 항목_참조 string 네임스페이스의 변수에 대한 item 참조입니다. 즉, "item.input_trajectory" No
└) 템플릿 array 프롬프트 또는 컨텍스트를 형성하는 채팅 메시지 목록입니다. 네임스페이스 item에 대한 변수 참조(예: {{item.name}})를 포함할 수 있습니다. No
└─ 형식 enum 입력 메시지의 형식입니다. 항상 item_reference입니다.
가능한 값: item_reference		 No
model string 완성을 생성하는 데 사용할 모델의 이름입니다(예: "o3-mini"). No
샘플링_파라미터 AzureEvalAPICompletionsSamplingParams No
근원 object Yes
└─ 콘텐츠 array jsonl 파일의 내용입니다. No
└created_after integer 이 시간 이후에 만든 항목을 필터링하는 선택적 Unix 타임스탬프입니다. No
└created_before integer 이 시간 전에 만든 항목을 필터링하는 선택적 Unix 타임스탬프입니다. No
└─ ID string 파일의 식별자입니다. No
└─ 제한 integer 반환할 항목의 선택적 최대 수입니다. No
└) 메타데이터 object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
└─ 모델 string 필터링할 선택적 모델(예: 'gpt-4o')입니다. No
└─ 형식 enum 원본의 형식입니다. 항상 stored_completions입니다.
가능한 값: stored_completions		 No
type enum 실행 데이터 원본의 형식입니다. 항상 completions입니다.
가능한 값: completions		 Yes

OpenAI.EvalCustomDataSourceConfigParams

평가 실행에 사용되는 데이터 원본에 대한 스키마를 정의하는 CustomDataSourceConfig 개체입니다. 이 스키마는 다음과 같은 데이터의 모양을 정의하는 데 사용됩니다.

  • 테스트 조건을 정의하는 데 사용되며
  • 실행을 만들 때 필요한 데이터
Name Type Description Required Default
샘플 스키마 포함 boolean 평가에서 샘플 네임스페이스를 채워야 하는지 여부(예: 데이터 원본에서 응답을 생성하여) No False
아이템_스키마 object 데이터 원본의 각 행에 대한 json 스키마입니다. Yes
type enum 데이터 원본의 유형입니다. 항상 custom입니다.
가능한 값: custom		 Yes

OpenAI.EvalCustomDataSourceConfigResource

item의 스키마와 선택적으로 sample 네임스페이스를 지정하는 CustomDataSourceConfig입니다. 응답 스키마는 다음과 같은 데이터의 모양을 정의합니다.

  • 테스트 조건을 정의하는 데 사용되며
  • 실행을 만들 때 필요한 데이터
Name Type Description Required Default
schema object 실행 데이터 원본 항목에 대한 json 스키마입니다.
여기에서 JSON 스키마를 빌드하는 방법을 알아봅니 다.		 Yes
type enum 데이터 원본의 유형입니다. 항상 custom입니다.
가능한 값: custom		 Yes

OpenAI.EvalDataSourceConfigParams

OpenAI.EvalDataSourceConfigParams에 대한 구분자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
custom OpenAI.EvalCustomDataSourceConfigParams
logs OpenAI.EvalLogsDataSourceConfigParams
stored_completions OpenAI.EvalStoredCompletionsDataSourceConfigParams
Name Type Description Required Default
type OpenAI.EvalDataSourceConfigType Yes

OpenAI.EvalDataSourceConfigResource

OpenAI.EvalDataSourceConfigResource의 분류기

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
custom OpenAI.EvalCustomDataSourceConfigResource
stored_completions OpenAI.EvalStoredCompletionsDataSourceConfigResource
logs OpenAI.EvalLogsDataSourceConfigResource
Name Type Description Required Default
type OpenAI.EvalDataSourceConfigType Yes

OpenAI.EvalDataSourceConfigType

Property Value
Type string
Values custom
logs
stored_completions

OpenAI.EvalGraderLabelModelParams

모델을 사용하여 평가의 각 항목에 레이블을 할당하는 LabelModelGrader 개체입니다.

Name Type Description Required Default
input array 프롬프트 또는 컨텍스트를 형성하는 채팅 메시지 목록입니다. 네임스페이스 item에 대한 변수 참조(예: {{item.name}})를 포함할 수 있습니다. Yes
라벨 array 평가에서 각 항목으로 분류할 레이블입니다. Yes
model string 평가에 사용할 모델입니다. 구조화된 출력을 지원해야 합니다. Yes
name string 등급자의 이름입니다. Yes
passing_labels array 합격 결과를 나타내는 레이블입니다. 레이블의 하위 집합이어야 합니다. Yes
type enum 항상 label_model인 개체 형식입니다.
가능한 값: label_model		 Yes

OpenAI.EvalGraderLabelModelResource

Name Type Description Required Default
input array Yes
라벨 array 평가에서 각 항목에 할당할 레이블입니다. Yes
model string 평가에 사용할 모델입니다. 구조화된 출력을 지원해야 합니다. Yes
name string 등급자의 이름입니다. Yes
passing_labels array 합격 결과를 나타내는 레이블입니다. 레이블의 하위 집합이어야 합니다. Yes
type enum 항상 label_model인 개체 형식입니다.
가능한 값: label_model		 Yes

OpenAI.EvalGraderParams

OpenAI.EvalGraderParams에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
label_model OpenAI.EvalGraderLabelModelParams
string_check OpenAI.EvalGraderStringCheckParams
text_similarity OpenAI.EvalGraderTextSimilarityParams
python OpenAI.EvalGraderPythonParams
score_model OpenAI.EvalGraderScoreModelParams
Name Type Description Required Default
type OpenAI.GraderType Yes

OpenAI.EvalGraderPythonParams

Name Type Description Required Default
image_tag string Python 스크립트에 사용할 이미지 태그입니다. No
name string 등급자의 이름입니다. Yes
통과 임계값 number 점수의 임계값입니다. No
근원 string Python 스크립트의 소스 코드입니다. Yes
type enum 항상 python인 개체 형식입니다.
가능한 값: python		 Yes

OpenAI.EvalGraderPythonResource

Name Type Description Required Default
image_tag string Python 스크립트에 사용할 이미지 태그입니다. No
name string 등급자의 이름입니다. Yes
통과 임계값 number 점수의 임계값입니다. No
근원 string Python 스크립트의 소스 코드입니다. Yes
type enum 항상 python인 개체 형식입니다.
가능한 값: python		 Yes

OpenAI.EvalGraderResource

OpenAI.EvalGraderResource에 대한 구분자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
label_model OpenAI.EvalGraderLabelModelResource
text_similarity OpenAI.EvalGraderTextSimilarityResource
python OpenAI.EvalGraderPythonResource
score_model OpenAI.EvalGraderScoreModelResource
Name Type Description Required Default
type OpenAI.GraderType Yes

OpenAI.EvalGraderScoreModelParams

Name Type Description Required Default
input array 입력 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다. Yes
model string 평가에 사용할 모델입니다. Yes
name string 등급자의 이름입니다. Yes
통과 임계값 number 점수의 임계값입니다. No
range array 점수의 범위입니다. 기본값은 [0, 1]입니다. No
샘플링_파라미터 모델의 샘플링 매개 변수입니다. No
type enum 항상 score_model인 개체 형식입니다.
가능한 값: score_model		 Yes

OpenAI.EvalGraderScoreModelResource

Name Type Description Required Default
input array 입력 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다. Yes
model string 평가에 사용할 모델입니다. Yes
name string 등급자의 이름입니다. Yes
통과 임계값 number 점수의 임계값입니다. No
range array 점수의 범위입니다. 기본값은 [0, 1]입니다. No
샘플링_파라미터 모델의 샘플링 매개 변수입니다. No
type enum 항상 score_model인 개체 형식입니다.
가능한 값: score_model		 Yes

OpenAI.EvalGraderStringCheckParams

Name Type Description Required Default
input string 입력 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다. Yes
name string 등급자의 이름입니다. Yes
수술 enum 수행할 문자열 검사 작업입니다. eq, ne, like 또는 ilike 중 하나입니다.
가능한 값: eq, ne, likeilike		 Yes
reference string 참조 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다. Yes
type enum 항상 string_check인 개체 형식입니다.
가능한 값: string_check		 Yes

OpenAI.EvalGraderTextSimilarityParams (OpenAI 평가 채점 텍스트 유사성 매개변수)

Name Type Description Required Default
평가 지표 enum 사용할 평가 메트릭입니다. fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, 또는 rouge_l 중 하나입니다.
가능한 값: fuzzy_match,, bleu,gleumeteor, rouge_1rouge_2, rouge_3rouge_4, rouge_5rouge_l		 Yes
input string 채점되는 텍스트입니다. Yes
name string 등급자의 이름입니다. Yes
통과 임계값 number 점수의 임계값입니다. Yes
reference string 채점 기준이 되는 텍스트입니다. Yes
type enum 채점자의 유형입니다.
가능한 값: text_similarity		 Yes

OpenAI.EvalGraderTextSimilarityResource

Name Type Description Required Default
평가 지표 enum 사용할 평가 메트릭입니다. fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, 또는 rouge_l 중 하나입니다.
가능한 값: fuzzy_match,, bleu,gleumeteor, rouge_1rouge_2, rouge_3rouge_4, rouge_5rouge_l		 Yes
input string 채점되는 텍스트입니다. Yes
name string 등급자의 이름입니다. Yes
통과 임계값 number 점수의 임계값입니다. Yes
reference string 채점 기준이 되는 텍스트입니다. Yes
type enum 채점자의 유형입니다.
가능한 값: text_similarity		 Yes

OpenAI.EvalItem

계층 구조 다음 명령을 나타내는 역할이 있는 모델에 대한 메시지 입력입니다. developer 역할 또는 system 역할과 함께 제공된 지침은 user 역할과 함께 제공된 지침보다 우선합니다. 역할이 있는 assistant 메시지는 이전 상호 작용에서 모델에 의해 생성된 것으로 추정됩니다.

Name Type Description Required Default
content object Yes
└─ 형식 OpenAI.EvalItemContentType No
role enum 메시지 입력의 역할입니다. user, assistant, system 중 하나 또는
developer;
가능한 값: user, assistant, systemdeveloper		 Yes
type enum 메시지 입력의 형식입니다. 항상 message입니다.
가능한 값: message		 No

OpenAI.EvalItemContent

OpenAI.EvalItemContent에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
input_text OpenAI.EvalItemContentInputText
output_text OpenAI.EvalItemContentOutputText
Name Type Description Required Default
type OpenAI.EvalItemContentType Yes

오픈AI.평가항목콘텐츠입력텍스트

Name Type Description Required Default
text string Yes
type enum
가능한 값: input_text		 Yes

OpenAI.EvalItemContentOutputText

Name Type Description Required Default
text string Yes
type enum
가능한 값: output_text		 Yes

OpenAI.EvalItemContentType

Property Value
Type string
Values input_text
output_text

OpenAI.EvalJsonlRunDataSourceParams

eval과 일치하는 JSONL 파일을 지정하는 JsonlRunDataSource 개체

Name Type Description Required Default
근원 object Yes
└─ 콘텐츠 array jsonl 파일의 내용입니다. No
└─ ID string 파일의 식별자입니다. No
└─ 형식 enum jsonl 원본의 형식입니다. 항상 file_id입니다.
가능한 값: file_id		 No
type enum 데이터 원본의 유형입니다. 항상 jsonl입니다.
가능한 값: jsonl		 Yes

OpenAI.EvalList

평가 목록을 나타내는 개체입니다.

Name Type Description Required Default
data array eval 개체의 배열입니다. Yes
first_id string 데이터 배열에서 첫 번째 eval의 식별자입니다. Yes
has_more boolean 더 많은 평가를 사용할 수 있는지 여부를 나타냅니다. Yes
last_id string 데이터 배열의 마지막 평가에 대한 식별자입니다. Yes
object enum 이 개체의 형식입니다. 항상 "list"로 설정됩니다.
가능한 값: list		 Yes

OpenAI.EvalLogsDataSourceConfigParams

로그 쿼리의 메타데이터 속성을 지정하는 데이터 원본 구성입니다. 일반적으로 이러한 메타데이터는 다음과 같 usecase=chatbot 거나 prompt-version=v2같은 메타데이터입니다.

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

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
type enum 데이터 원본의 유형입니다. 항상 logs입니다.
가능한 값: logs		 Yes

OpenAI.EvalLogs 데이터 소스 구성 리소스

로그 쿼리의 메타데이터 속성을 지정하는 LogsDataSourceConfig입니다. 일반적으로 이러한 메타데이터는 다음과 같 usecase=chatbot 거나 prompt-version=v2같은 메타데이터입니다. 이 데이터 원본 구성에서 반환된 스키마는 evals에서 사용할 수 있는 변수를 정의하는 데 사용됩니다. item 이 sample 데이터 원본 구성을 사용할 때 둘 다 정의됩니다.

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

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 Yes
schema object 실행 데이터 원본 항목에 대한 json 스키마입니다.
여기에서 JSON 스키마를 빌드하는 방법을 알아봅니 다.		 Yes
type enum 데이터 원본의 유형입니다. 항상 logs입니다.
가능한 값: logs		 Yes

OpenAI.EvalResponsesRunDataSourceParams

모델 샘플링 구성을 설명하는 ResponsesRunDataSource 개체입니다.

Name Type Description Required Default
입력 메시지 object No
└─ 항목_참조 string 네임스페이스의 변수에 대한 item 참조입니다. 즉, "item.name" No
└) 템플릿 array 프롬프트 또는 컨텍스트를 형성하는 채팅 메시지 목록입니다. 네임스페이스 item에 대한 변수 참조(예: {{item.name}})를 포함할 수 있습니다. No
└─ 형식 enum 입력 메시지의 형식입니다. 항상 item_reference입니다.
가능한 값: item_reference		 No
model string 완성을 생성하는 데 사용할 모델의 이름입니다(예: "o3-mini"). No
샘플링_파라미터 AzureEvalAPIResponseSamplingParams No
근원 object Yes
└─ 콘텐츠 array jsonl 파일의 내용입니다. No
└created_after integer 이 타임스탬프(포함) 후에 만든 항목만 포함합니다. 응답을 선택하는 데 사용되는 쿼리 매개 변수입니다. No
└created_before integer 이 타임스탬프(포함) 이전에 만든 항목만 포함합니다. 응답을 선택하는 데 사용되는 쿼리 매개 변수입니다. No
└─ ID string 파일의 식별자입니다. No
└─ 지침_검색 string '명령' 필드를 검색하는 선택적 문자열입니다. 응답을 선택하는 데 사용되는 쿼리 매개 변수입니다. No
└) 메타데이터 object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
└─ 모델 string 응답을 찾을 모델의 이름입니다. 응답을 선택하는 데 사용되는 쿼리 매개 변수입니다. No
└─ 추론_노력 OpenAI.ReasoningEffort 선택적 추론 작업 매개 변수입니다. 응답을 선택하는 데 사용되는 쿼리 매개 변수입니다. No
└> 온도 number 샘플링 온도. 응답을 선택하는 데 사용되는 쿼리 매개 변수입니다. No
└도구 array 도구 이름 목록입니다. 응답을 선택하는 데 사용되는 쿼리 매개 변수입니다. No
└ top_p number 누클리어스 샘플링 매개 변수입니다. 응답을 선택하는 데 사용되는 쿼리 매개 변수입니다. No
└─ 형식 enum 실행 데이터 원본의 형식입니다. 항상 responses입니다.
가능한 값: responses		 No
└─ 사용자 array 사용자 식별자 목록입니다. 응답을 선택하는 데 사용되는 쿼리 매개 변수입니다. No
type enum 실행 데이터 원본의 형식입니다. 항상 responses입니다.
가능한 값: responses		 Yes

OpenAI.EvalRun

평가 실행을 나타내는 스키마입니다.

Name Type Description Required Default
created_at integer 평가 실행이 생성되었을 때 Unix 타임스탬프(초)입니다. Yes
데이터_소스 object Yes
└─ 형식 OpenAI.EvalRunDataSourceType No
error OpenAI.EvalApiError Eval API의 오류 응답을 나타내는 개체입니다. Yes
eval_id string 연관된 평가의 식별자입니다. Yes
id string 평가 작업에 대한 고유 식별자입니다. Yes
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 Yes
model string 해당하는 경우 평가되는 모델입니다. Yes
name string 평가 실행의 이름입니다. Yes
object enum 개체의 유형. 항상 "eval.run"입니다.
가능한 값: eval.run		 Yes
모델별 사용량 array 평가 실행 중 각 모델에 대한 사용 통계입니다. Yes
테스트 기준별 결과 array 평가 실행 중에 적용된 테스트 조건당 결과입니다. Yes
보고서_주소 string UI 대시보드에서 렌더링된 평가 실행 보고서의 URL입니다. Yes
결과_수량 object 평가 실행 결과를 요약한 카운터입니다. Yes
└) 오류가 발생했습니다. integer 오류가 발생한 출력 항목의 수입니다. No
└> 실패 integer 평가를 통과하지 못한 출력 항목 수입니다. No
└─ 통과함 integer 평가를 통과한 출력 항목의 수입니다. No
└합계 integer 실행된 총 출력 항목 수입니다. No
status string 평가 실행의 상태입니다. Yes

OpenAI.EvalRunDataContentSource

OpenAI.EvalRunDataContentSource에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
file_id OpenAI.EvalRunFileIdDataContentSource
stored_completions OpenAI.EvalRunStoredCompletionsDataContentSource
responses OpenAI.EvalRunResponsesDataContentSource
Name Type Description Required Default
type OpenAI.EvalRunDataContentSourceType Yes

OpenAI.EvalRunDataContentSourceType

Property Value
Type string
Values file_id
file_content
stored_completions
responses

OpenAI.EvalRunDataSourceCompletionsResource

Name Type Description Required Default
type enum
가능한 값: completions		 Yes

OpenAI.EvalRunDataSourceJsonlResource

Name Type Description Required Default
type enum
가능한 값: jsonl		 Yes

OpenAI.EvalRunDataSourceParams

OpenAI.EvalRunDataSourceParams에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
jsonl OpenAI.EvalJsonlRunDataSourceParams
completions OpenAI.EvalCompletionsRunDataSourceParams
responses OpenAI.EvalResponsesRunDataSourceParams
Name Type Description Required Default
type OpenAI.EvalRunDataSourceType Yes

OpenAI.EvalRunDataSourceResource

Name Type Description Required Default
type OpenAI.EvalRunDataSourceType Yes

OpenAI.EvalRunDataSourceResponsesResource

Name Type Description Required Default
type enum
가능한 값: responses		 Yes

OpenAI.EvalRunDataSourceType

Property Value
Type string
Values jsonl
completions
responses

OpenAI.EvalRunFileContentDataContentSource

Name Type Description Required Default
content array jsonl 파일의 내용입니다. Yes
type enum jsonl 원본의 형식입니다. 항상 file_content입니다.
가능한 값: file_content		 Yes

OpenAI.EvalRunFileIdDataContentSource

Name Type Description Required Default
id string 파일의 식별자입니다. Yes
type enum jsonl 원본의 형식입니다. 항상 file_id입니다.
가능한 값: file_id		 Yes

OpenAI.EvalRunList

평가에 대한 실행 목록을 나타내는 개체입니다.

Name Type Description Required Default
data array eval 실행 개체의 배열입니다. Yes
first_id string 데이터 배열에서 첫 번째 eval 실행의 식별자입니다. Yes
has_more boolean 더 많은 평가를 사용할 수 있는지 여부를 나타냅니다. Yes
last_id string 데이터 배열에서 마지막 eval 실행의 식별자입니다. Yes
object enum 이 개체의 형식입니다. 항상 "list"로 설정됩니다.
가능한 값: list		 Yes

OpenAI.EvalRunOutputItem

평가 실행 출력 항목을 나타내는 스키마입니다.

Name Type Description Required Default
created_at integer 평가 실행이 생성되었을 때 Unix 타임스탬프(초)입니다. Yes
데이터 소스 항목 object 입력 데이터 원본 항목의 세부 정보입니다. Yes
데이터소스_아이템_ID integer 데이터 원본 항목의 식별자입니다. Yes
eval_id string 평가 그룹의 식별자입니다. Yes
id string 평가 실행 출력 항목에 대한 고유 식별자입니다. Yes
object enum 개체의 유형. 항상 "eval.run.output_item"입니다.
가능한 값: eval.run.output_item		 Yes
results array 평가 실행의 결과 목록입니다. Yes
run_id string 이 출력 항목과 연결된 평가 실행의 식별자입니다. Yes
견본 object 평가 실행의 입력 및 출력을 포함하는 샘플입니다. Yes
└) 오류 OpenAI.EvalApiError Eval API의 오류 응답을 나타내는 개체입니다. No
└완료_사유 string 샘플 생성이 완료된 이유입니다. No
└─ 입력 array 입력 메시지의 배열입니다. No
└─ 최대_완료_토큰 integer 완료에 허용되는 최대 토큰 수입니다. No
└─ 모델 string 샘플을 생성하는 데 사용되는 모델입니다. No
└─ 출력 array 출력 메시지의 배열입니다. No
└) 시드 integer 샘플을 생성하는 데 사용되는 시드입니다. No
└> 온도 number 사용된 샘플링 온도입니다. No
└ top_p number 샘플링에 사용되는 top_p 값입니다. No
└) 사용량 object 샘플에 대한 토큰 사용 세부 정보입니다. No
└─ 캐시된_토큰 (cached_tokens) integer 캐시에서 검색된 토큰 수입니다. No
└completion_tokens integer 생성된 완료 토큰 수입니다. No
└prompt_tokens integer 사용된 프롬프트 토큰의 수입니다. No
└total_tokens integer 사용된 총 토큰 수입니다. No
status string 평가 실행의 상태입니다. Yes

OpenAI.EvalRunOutputItemList

평가 실행의 출력 항목 목록을 나타내는 개체입니다.

Name Type Description Required Default
data array eval 실행 출력 항목 개체의 배열입니다. Yes
first_id string 데이터 배열에서 첫 번째 eval 실행 출력 항목의 식별자입니다. Yes
has_more boolean 사용할 수 있는 eval 실행 출력 항목이 더 있는지 여부를 나타냅니다. Yes
last_id string 데이터 배열에서 마지막 eval 실행 출력 항목의 식별자입니다. Yes
object enum 이 개체의 형식입니다. 항상 "list"로 설정됩니다.
가능한 값: list		 Yes

OpenAI.EvalRunResponsesDataContentSource

실행 데이터 원본 구성을 설명하는 EvalResponsesSource 개체입니다.

Name Type Description Required Default
created_after integer 이 타임스탬프(포함) 후에 만든 항목만 포함합니다. 응답을 선택하는 데 사용되는 쿼리 매개 변수입니다. No
이전에 생성됨 integer 이 타임스탬프(포함) 이전에 만든 항목만 포함합니다. 응답을 선택하는 데 사용되는 쿼리 매개 변수입니다. No
instructions_search string '명령' 필드를 검색하는 선택적 문자열입니다. 응답을 선택하는 데 사용되는 쿼리 매개 변수입니다. No
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
model string 응답을 찾을 모델의 이름입니다. 응답을 선택하는 데 사용되는 쿼리 매개 변수입니다. No
reasoning_effort object o 시리즈 모델만

추론 모델에서 추론 작업을 제한합니다.
현재 지원되는 값은 low, medium 및 high입니다. 줄이는
추론 작업으로 인해 응답 속도가 빨라지고 사용된 토큰 수가 줄어들 수 있습니다.
응답에서의 추론에 관하여		 No
temperature number 샘플링 온도. 응답을 선택하는 데 사용되는 쿼리 매개 변수입니다. No
tools array 도구 이름 목록입니다. 응답을 선택하는 데 사용되는 쿼리 매개 변수입니다. No
top_p number 누클리어스 샘플링 매개 변수입니다. 응답을 선택하는 데 사용되는 쿼리 매개 변수입니다. No
type enum 실행 데이터 원본의 형식입니다. 항상 responses입니다.
가능한 값: responses		 Yes
사용자들 array 사용자 식별자 목록입니다. 응답을 선택하는 데 사용되는 쿼리 매개 변수입니다. No

OpenAI.EvalRunStoredCompletionsDataContentSource

필터 집합을 설명하는 StoredCompletionsRunDataSource 구성

Name Type Description Required Default
created_after integer 이 시간 이후에 만든 항목을 필터링하는 선택적 Unix 타임스탬프입니다. No
이전에 생성됨 integer 이 시간 전에 만든 항목을 필터링하는 선택적 Unix 타임스탬프입니다. No
limit integer 반환할 항목의 선택적 최대 수입니다. No
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 Yes
model string 필터링할 선택적 모델(예: 'gpt-4o')입니다. No
type enum 원본의 형식입니다. 항상 stored_completions입니다.
가능한 값: stored_completions		 Yes

OpenAI.EvalStoredCompletionsDataSourceConfigParams

더 이상 사용되지 않고 LogsDataSourceConfig로 대체되었습니다.

Name Type Description Required Default
metadata object 저장된 완료 데이터 원본에 대한 메타데이터 필터입니다. No
type enum 데이터 원본의 유형입니다. 항상 stored_completions입니다.
가능한 값: stored_completions		 Yes

OpenAI.EvalStoredCompletionsDataSourceConfigResource

더 이상 사용되지 않고 LogsDataSourceConfig로 대체되었습니다.

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

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 Yes
schema object 실행 데이터 원본 항목에 대한 json 스키마입니다.
여기에서 JSON 스키마를 빌드하는 방법을 알아봅니 다.		 Yes
type enum 데이터 원본의 유형입니다. 항상 stored_completions입니다.
가능한 값: stored_completions		 Yes

OpenAI.FileSearchTool

업로드된 파일에서 관련 콘텐츠를 검색하는 도구입니다.

Name Type Description Required Default
filters object No
max_num_results integer 반환할 결과의 최대 수입니다. 이 숫자는 1에서 50 사이여야 합니다. No
ranking_options object No
└─ 랭커 enum 파일 검색에 사용할 순위입니다.
가능한 값: autodefault-2024-11-15		 No
└점수 임계값 number 파일 검색의 점수 임계값으로, 0에서 1 사이의 숫자입니다. 1에 가까운 숫자는 가장 관련성이 큰 결과만 반환하려고 시도하지만 더 적은 결과를 반환할 수 있습니다. No
type enum 파일 검색 도구의 형식입니다. 항상 file_search입니다.
가능한 값: file_search		 Yes
vector_store_ids array 검색할 벡터 저장소의 ID입니다. Yes

OpenAI.FileSearchToolCallItemParam

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

Name Type Description Required Default
queries array 파일을 검색하는 데 사용되는 쿼리입니다. Yes
results array 파일 검색 도구 호출의 결과입니다. No
type enum
가능한 값: file_search_call		 Yes

OpenAI.FileSearchToolCallItemResource

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

Name Type Description Required Default
queries array 파일을 검색하는 데 사용되는 쿼리입니다. Yes
results array 파일 검색 도구 호출의 결과입니다. No
status enum 파일 검색 도구 호출의 상태입니다. in_progress,
searching, incomplete또는 failed
가능한 값: in_progress, searching, completed, incompletefailed		 Yes
type enum
가능한 값: file_search_call		 Yes

OpenAI.Filters

Name Type Description Required Default
filters array 결합할 필터의 배열입니다. 항목은 ComparisonFilter 또는 CompoundFilter일 수 있습니다. Yes
key string 값과 비교할 키입니다. Yes
type enum 작업 유형: and 또는 or.
가능한 값: andor		 Yes
value 문자열 또는 숫자 또는 불리언 특성 키와 비교할 값입니다. 문자열, 숫자 또는 부울 유형을 지원합니다. Yes

OpenAI.FineTuneDPOHyperparameters

DPO 미세 조정 작업에 사용되는 하이퍼 매개 변수입니다.

Name Type Description Required Default
배치 크기 enum
가능한 값: auto		 No
beta enum
가능한 값: auto		 No
learning_rate_multiplier enum
가능한 값: auto		 No
n_epochs enum
가능한 값: auto		 No

OpenAI.FineTuneDPOMethod

DPO 미세 조정 메서드에 대한 구성입니다.

Name Type Description Required Default
하이퍼 매개 변수 OpenAI.FineTuneDPOHyperparameters DPO 미세 조정 작업에 사용되는 하이퍼 매개 변수입니다. No

OpenAI.FineTuneMethod

미세 조정에 사용되는 메서드입니다.

Name Type Description Required Default
데이터 보호 책임자 (dpo) OpenAI.FineTuneDPOMethod DPO 미세 조정 메서드에 대한 구성입니다. No
보충 AzureFineTuneReinforcementMethod No
감독됨 OpenAI.FineTuneSupervisedMethod 감독된 미세 조정 방법에 대한 구성입니다. No
type enum 메서드의 형식입니다. supervised, dpo또는 reinforcement.입니다.
가능한 값: supervised, dporeinforcement		 Yes

OpenAI.FineTuneReinforcementHyperparameters

강화 미세 조정 작업에 사용되는 하이퍼 매개 변수입니다.

Name Type Description Required Default
배치 크기 enum
가능한 값: auto		 No
compute_multiplier enum
가능한 값: auto		 No
평가 간격 enum
가능한 값: auto		 No
eval_samples (이밸 샘플즈) enum
가능한 값: auto		 No
learning_rate_multiplier enum
가능한 값: auto		 No
n_epochs enum
가능한 값: auto		 No
reasoning_effort enum 추론 노력의 수준입니다.
가능한 값: default, low, mediumhigh		 No

OpenAI.FineTuneSupervisedHyperparameters

미세 조정 작업에 사용되는 하이퍼 매개 변수입니다.

Name Type Description Required Default
배치 크기 enum
가능한 값: auto		 No
learning_rate_multiplier enum
가능한 값: auto		 No
n_epochs enum
가능한 값: auto		 No

OpenAI.FineTuneSupervisedMethod

감독된 미세 조정 방법에 대한 구성입니다.

Name Type Description Required Default
하이퍼 매개 변수 OpenAI.FineTuneSupervisedHyperparameters 미세 조정 작업에 사용되는 하이퍼 매개 변수입니다. No

OpenAI.FineTuningIntegration

OpenAI.FineTuningIntegration의 분류기

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
wandb OpenAI.FineTuningIntegrationWandb
Name Type Description Required Default
type string(아래 유효한 모델 참조) Yes

OpenAI.FineTuningIntegrationWandb

Name Type Description Required Default
type enum 미세 조정 작업에 사용할 통합 유형
가능한 값: wandb		 Yes
wandb object 가중치 및 바이어스와 통합하기 위한 설정입니다. 이 페이로드는 다음 프로젝트를 지정합니다.
메트릭이 전송됩니다. 필요에 따라 실행에 대한 명시적 표시 이름을 설정하고 태그를 추가할 수 있습니다.
실행에 앞서 실행과 연관될 기본 엔터티(팀, 사용자 이름 등)를 설정합니다.		 Yes
└) 엔터티 string 실행에 사용할 엔터티입니다. 이렇게 하면 WandB 사용자의 팀 또는 사용자 이름을 설정할 수 있습니다.
실행과 관련된 것과 같습니다. 설정하지 않으면 등록된 WandB API 키의 기본 엔터티가 사용됩니다.		 No
└) 이름 string 실행에 대해 설정할 표시 이름입니다. 설정하지 않으면 작업 ID를 이름으로 사용합니다. No
└) 프로젝트 string 새 실행을 만들 프로젝트의 이름입니다. No
└─ 태그 array 새로 만든 실행에 연결할 태그 목록입니다. 이러한 태그는 WandB에 직접 전달됩니다. 일부
기본 태그는 OpenAI에 의해 생성됩니다. "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".		 No

OpenAI.FineTuningJob

개체는 fine_tuning.job API를 통해 만들어진 미세 조정 작업을 나타냅니다.

Name Type Description Required Default
created_at integer 미세 조정 작업이 만들어진 시간에 대한 Unix 타임스탬프(초)입니다. Yes
error object failed가 포함된 미세 조정 작업의 경우, 오류의 원인에 대한 더욱 자세한 정보가 포함됩니다. Yes
└) 코드 string 컴퓨터에서 읽을 수 있는 오류 코드입니다. No
└) 메시지 string 사람이 읽을 수 있는 오류 메시지 No
└─ 매개 변수 string 유효하지 않은 매개 변수입니다(일반적으로 training_file 또는 validation_file.). 실패가 매개 변수 특정이 아닌 경우 이 필드는 null이 됩니다. No
estimated_finish integer 미세 조정 작업이 완료될 것으로 예상되는 Unix 타임스탬프(초)입니다. 미세 조정 작업이 실행 중이 아니면 값은 null이 됩니다. No
세밀하게 조정된 모델 string 생성되는 미세 조정된 모델의 이름입니다. 미세 조정 작업이 계속 실행 중인 경우 값은 null이 됩니다. Yes
finished_at integer 미세 조정 작업이 완료된 시간에 대한 Unix 타임스탬프(초)입니다. 미세 조정 작업이 계속 실행 중인 경우 값은 null이 됩니다. Yes
하이퍼 매개 변수 object 미세 조정 작업에 사용되는 하이퍼 매개 변수입니다. 이 값은 작업을 실행할 supervised 때만 반환됩니다. Yes
└batch_size enum
가능한 값: auto		 No
└learning_rate_multiplier enum
가능한 값: auto		 No
└n_epochs enum
가능한 값: auto		 No
id string API 엔드포인트에서 참조할 수 있는 개체 식별자입니다. Yes
통합 array 이 미세 조정 작업에 사용할 통합 목록입니다. No
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 Yes
메서드 OpenAI.FineTuneMethod 미세 조정에 사용되는 메서드입니다. No
model string 미세 조정되는 기본 모델입니다. Yes
object enum 항상 "fine_tuning.job"인 오브젝트 타입입니다.
가능한 값: fine_tuning.job		 Yes
organization_id string 미세 조정 작업을 수행하는 조직입니다. Yes
result_files array 미세 조정 작업에 대한 컴파일된 결과 파일 ID입니다. 파일 API를 사용하여 결과를 검색할 수 있습니다. Yes
seed integer 미세 조정 작업에 사용하는 시드입니다. Yes
status enum 미세 조정 작업의 현재 상태는 validating_files, queued, running, succeeded, failed, 또는 cancelled 중 하나일 수 있습니다.
가능한 값: validating_files, queued, runningsucceeded, failedcancelled		 Yes
trained_tokens integer 이 미세 조정 작업에서 처리한 청구 가능 토큰의 총 수입니다. 미세 조정 작업이 계속 실행 중인 경우 값은 null이 됩니다. Yes
교육 파일 string 학습에 사용되는 파일 ID입니다. 파일 API를 사용하여 학습 데이터를 검색할 수 있습니다. Yes
user_provided_suffix string 작업 만들기 요청에 지정된 대로 작업에 적용되는 설명 접미사입니다. No
검증_파일 string 유효성 검사에 사용되는 파일 ID입니다. 파일 API를 사용하여 유효성 검사 결과를 검색할 수 있습니다. Yes

OpenAI.FineTuningJobCheckpoint

fine_tuning.job.checkpoint 객체는 사용 준비가 된 미세 조정 작업의 모델 검사점을 나타냅니다.

Name Type Description Required Default
created_at integer 검사점이 만들어진 Unix 타임스탬프(초)입니다. Yes
fine_tuned_model_checkpoint string 만들어진 미세 조정 검사점 모델의 이름입니다. Yes
fine_tuning_job_id (미세 조정 작업 ID) string 이 검사점이 만들어진 미세 조정 작업의 이름입니다. Yes
id string API 엔드포인트에서 참조할 수 있는 검사점 식별자입니다. Yes
메트릭 object 미세 조정 작업 중 단계 수에 대한 메트릭입니다. Yes
└full_valid_loss number No
└full_valid_mean_token_accuracy number No
└─ 단계 number No
└train_loss number No
└train_mean_token_accuracy number No
└valid_loss number No
└─ valid_mean_token_accuracy (유효 평균 토큰 정확도) number No
object enum 항상 "fine_tuning.job.checkpoint"인 개체 형식입니다.
가능한 값: fine_tuning.job.checkpoint		 Yes
단계_번호 integer 검사점이 만들어진 단계 번호입니다. Yes

OpenAI.FineTuningJobEvent

작업 이벤트 개체 미세 조정

Name Type Description Required Default
created_at integer 미세 조정 작업이 만들어진 시간에 대한 Unix 타임스탬프(초)입니다. Yes
data 이벤트와 연결된 데이터입니다. No
id string 개체 식별자입니다. Yes
level enum 이벤트의 로그 수준입니다.
가능한 값: info, warnerror		 Yes
message string 이벤트의 메시지입니다. Yes
object enum 개체 형식으로는 항상 "fine_tuning.job.event"이 사용됩니다.
가능한 값: fine_tuning.job.event		 Yes
type enum 이벤트의 유형입니다.
가능한 값: messagemetrics		 No

OpenAI.FunctionObject

Name Type Description Required Default
description string 함수를 호출하는 시기와 방법을 선택하기 위해 모델에서 사용하는 함수의 기능에 대한 설명입니다. No
name string 호출할 함수의 이름입니다. a~z, A~Z, 0~9 또는 밑줄과 대시를 포함해야 하며 최대 길이는 64자여야 합니다. Yes
parameters 함수가 허용하는 매개 변수로, JSON 스키마 개체로 설명됩니다. No
strict boolean 함수 호출을 생성할 때 엄격한 스키마 준수를 사용하도록 설정할지 여부입니다. true로 설정하면 모델은 parameters 필드에 정의된 정확한 스키마를 따릅니다. strict가 true인 경우 JSON 스키마의 하위 집합만 지원됩니다. No False

OpenAI.FunctionTool

모델에서 호출하도록 선택할 수 있는 함수를 사용자 고유의 코드로 정의합니다.

Name Type Description Required Default
description string 함수에 대한 설명입니다. 모델에서 함수를 호출할지 여부를 결정하는 데 사용됩니다. No
name string 호출할 함수의 이름입니다. Yes
parameters 함수의 매개 변수를 설명하는 JSON 스키마 개체입니다. Yes
strict boolean 엄격한 매개 변수 유효성 검사를 적용할지 여부입니다. 기본값 true. Yes
type enum 함수 도구의 형식입니다. 항상 function입니다.
가능한 값: function		 Yes

OpenAI.FunctionToolCallItemParam

함수를 실행하는 도구 호출입니다.

Name Type Description Required Default
arguments string 함수에 전달할 인수의 JSON 문자열입니다. Yes
call_id string 모델에서 생성된 함수 도구 호출의 고유 ID입니다. Yes
name string 실행할 함수의 이름입니다. Yes
type enum
가능한 값: function_call		 Yes

OpenAI.FunctionToolCallItemResource

함수를 실행하는 도구 호출입니다.

Name Type Description Required Default
arguments string 함수에 전달할 인수의 JSON 문자열입니다. Yes
call_id string 모델에서 생성된 함수 도구 호출의 고유 ID입니다. Yes
name string 실행할 함수의 이름입니다. Yes
status enum 항목의 상태입니다. in_progress, completed 또는 하나
incomplete; 항목이 API를 통해 반환될 때 채워집니다.
가능한 값: in_progress, completedincomplete		 Yes
type enum
가능한 값: function_call		 Yes

OpenAI.FunctionToolCallOutputItemParam

함수 도구 호출의 출력입니다.

Name Type Description Required Default
call_id string 모델에서 생성된 함수 도구 호출의 고유 ID입니다. Yes
output string 함수 도구 호출 출력의 JSON 문자열입니다. Yes
type enum
가능한 값: function_call_output		 Yes

OpenAI.FunctionToolCallOutputItemResource

함수 도구 호출의 출력입니다.

Name Type Description Required Default
call_id string 모델에서 생성된 함수 도구 호출의 고유 ID입니다. Yes
output string 함수 도구 호출 출력의 JSON 문자열입니다. Yes
status enum 항목의 상태입니다. in_progress, completed 또는 하나
incomplete; 항목이 API를 통해 반환될 때 채워집니다.
가능한 값: in_progress, completedincomplete		 Yes
type enum
가능한 값: function_call_output		 Yes

OpenAI.Grader

OpenAI.Grader에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
label_model OpenAI.GraderLabelModel
text_similarity OpenAI.GraderTextSimilarity
python OpenAI.GraderPython
score_model OpenAI.GraderScoreModel
multi OpenAI.GraderMulti
Name Type Description Required Default
type OpenAI.GraderType Yes

OpenAI.GraderLabelModel

모델을 사용하여 평가의 각 항목에 레이블을 할당하는 LabelModelGrader 개체입니다.

Name Type Description Required Default
input array Yes
라벨 array 평가에서 각 항목에 할당할 레이블입니다. Yes
model string 평가에 사용할 모델입니다. 구조화된 출력을 지원해야 합니다. Yes
name string 등급자의 이름입니다. Yes
passing_labels array 합격 결과를 나타내는 레이블입니다. 레이블의 하위 집합이어야 합니다. Yes
type enum 항상 label_model인 개체 형식입니다.
가능한 값: label_model		 Yes

OpenAI.GraderMulti

MultiGrader 개체는 여러 채점자의 출력을 결합하여 단일 점수를 생성합니다.

Name Type Description Required Default
출력_계산 string 채점자 결과에 따라 출력을 계산하는 수식. Yes
채점자 object Yes
name string 등급자의 이름입니다. Yes
type enum 항상 multi인 개체 형식입니다.
가능한 값: multi		 Yes

OpenAI.GraderPython

입력에서 Python 스크립트를 실행하는 PythonGrader 개체입니다.

Name Type Description Required Default
image_tag string Python 스크립트에 사용할 이미지 태그입니다. No
name string 등급자의 이름입니다. Yes
근원 string Python 스크립트의 소스 코드입니다. Yes
type enum 항상 python인 개체 형식입니다.
가능한 값: python		 Yes

OpenAI.GraderScoreModel

모델을 사용하여 입력에 점수를 할당하는 ScoreModelGrader 개체입니다.

Name Type Description Required Default
input array 입력 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다. Yes
model string 평가에 사용할 모델입니다. Yes
name string 등급자의 이름입니다. Yes
range array 점수의 범위입니다. 기본값은 [0, 1]입니다. No
샘플링_파라미터 모델의 샘플링 매개 변수입니다. No
type enum 항상 score_model인 개체 형식입니다.
가능한 값: score_model		 Yes

OpenAI.GraderStringCheck

지정된 작업을 사용하여 입력과 참조 간의 문자열 비교를 수행하는 StringCheckGrader 개체입니다.

Name Type Description Required Default
input string 입력 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다. Yes
name string 등급자의 이름입니다. Yes
수술 enum 수행할 문자열 검사 작업입니다. eq, ne, like 또는 ilike 중 하나입니다.
가능한 값: eq, ne, likeilike		 Yes
reference string 참조 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다. Yes
type enum 항상 string_check인 개체 형식입니다.
가능한 값: string_check		 Yes

OpenAI.GraderTextSimilarity

유사성 메트릭에 따라 텍스트를 채점하는 TextSimilarityGrader 개체입니다.

Name Type Description Required Default
평가 지표 enum 사용할 평가 메트릭입니다. fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, 또는 rouge_l 중 하나입니다.
가능한 값: fuzzy_match,, bleu,gleumeteor, rouge_1rouge_2, rouge_3rouge_4, rouge_5rouge_l		 Yes
input string 채점되는 텍스트입니다. Yes
name string 등급자의 이름입니다. Yes
reference string 채점 기준이 되는 텍스트입니다. Yes
type enum 채점자의 유형입니다.
가능한 값: text_similarity		 Yes

OpenAI.GraderType

Property Value
Type string
Values string_check
text_similarity
score_model
label_model
python
multi

OpenAI.ImageGenTool

와 같은 gpt-image-1모델을 사용하여 이미지를 생성하는 도구입니다.

Name Type Description Required Default
background enum 생성된 이미지의 배경 형식입니다. 다음 중 하나입니다. transparent
opaque 또는 auto입니다. 기본값: auto.
가능한 값: transparent, opaqueauto		 No
input_image_mask object 인페인팅을 위한 선택적 마스크입니다. image_url를 포함하고 있습니다.
(문자열, 선택 사항) 및 file_id(문자열, 선택 사항).		 No
└ file_id string 마스크 이미지의 파일 ID입니다. No
└image_url string Base64로 인코딩된 마스크 이미지입니다. No
model enum 사용할 이미지 생성 모델입니다. 기본값: gpt-image-1.
가능한 값: gpt-image-1		 No
moderation enum 생성된 이미지에 대한 조정 수준입니다. 기본값: auto.
가능한 값: autolow		 No
output_compression integer 출력 이미지의 압축 수준입니다. 기본값은 100입니다. No 100
output_format enum 생성된 이미지의 출력 형식입니다. png, webp 또는 하나
jpeg; 기본값: png.
가능한 값: png, webpjpeg		 No
partial_images integer 스트리밍 모드에서 생성할 부분 이미지의 수(기본값) 0에서 3까지입니다. No 0
quality enum 생성된 이미지의 품질입니다. low, medium, high 중 하나입니다.
또는 auto. 기본값: auto.
가능한 값: low, medium, highauto		 No
size enum 생성된 이미지의 크기입니다. 다음 중 하나인 1024x1024, 1024x1536
1536x1024 또는 auto입니다. 기본값: auto.
가능한 값: 1024x1024, 1024x1536, 1536x1024auto		 No
type enum 이미지 생성 도구의 형식입니다. 항상 image_generation입니다.
가능한 값: image_generation		 Yes

OpenAI.ImageGenToolCallItemParam

모델에서 만든 이미지 생성 요청입니다.

Name Type Description Required Default
result string base64로 인코딩된 생성된 이미지입니다. Yes
type enum
가능한 값: image_generation_call		 Yes

OpenAI.ImageGenToolCallItemResource

모델에서 만든 이미지 생성 요청입니다.

Name Type Description Required Default
result string base64로 인코딩된 생성된 이미지입니다. Yes
status enum
가능한 값: in_progress, completed, generatingfailed		 Yes
type enum
가능한 값: image_generation_call		 Yes

OpenAI.ImplicitUserMessage

Name Type Description Required Default
content 문자열 또는 배열 Yes

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를 무상태로 사용할 때 다중 턴 대화에서 추론 항목을 사용할 수 있습니다.
Property Value
Description 모델 응답에 포함할 추가 출력 데이터를 지정합니다. 현재
지원되는 값은 다음과 같습니다.
- 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로 설정되거나 조직이
데이터 보존 없음 프로그램에 등록됨).
Type string
Values 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

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
Name Type Description Required Default
type OpenAI.ItemContentType 다중 모달 입력 및 출력 콘텐츠입니다. Yes

OpenAI.ItemContentInputAudio

모델에 대한 오디오 입력입니다.

Name Type Description Required Default
data string Base64로 인코딩된 오디오 데이터입니다. Yes
format enum 오디오 데이터의 형식입니다. 현재 지원되는 형식은 다음과 같습니다 mp3 .
wav;
가능한 값: mp3wav		 Yes
type enum 입력 항목의 형식입니다. 항상 input_audio입니다.
가능한 값: input_audio		 Yes

OpenAI.ItemContentInputFile

모델에 대한 파일 입력입니다.

Name Type Description Required Default
file_data string 모델로 보낼 파일의 콘텐츠입니다. No
file_id string 모델로 보낼 파일의 ID입니다. No
filename string 모델로 보낼 파일의 이름입니다. No
type enum 입력 항목의 형식입니다. 항상 input_file입니다.
가능한 값: input_file		 Yes

OpenAI.ItemContentInputImage

모델에 대한 이미지 입력입니다.

Name Type Description Required Default
detail enum 모델에 보낼 이미지의 세부 수준입니다. high, low 또는 auto 중 하나입니다. 기본값은 auto입니다.
가능한 값: low, highauto		 No
file_id string 모델로 보낼 파일의 ID입니다. No
image_url string 모델로 보낼 이미지의 URL입니다. 데이터 URL의 정규화된 URL 또는 base64로 인코딩된 이미지입니다. No
type enum 입력 항목의 형식입니다. 항상 input_image입니다.
가능한 값: input_image		 Yes

OpenAI.ItemContentInputText

모델에 대한 텍스트 입력입니다.

Name Type Description Required Default
text string 모델에 대한 텍스트 입력입니다. Yes
type enum 입력 항목의 형식입니다. 항상 input_text입니다.
가능한 값: input_text		 Yes

OpenAI.ItemContentOutputAudio

모델의 오디오 출력입니다.

Name Type Description Required Default
data string 모델의 Base64로 인코딩된 오디오 데이터입니다. Yes
transcript string 모델의 오디오 데이터 대본입니다. Yes
type enum 출력 오디오의 형식입니다. 항상 output_audio입니다.
가능한 값: output_audio		 Yes

OpenAI.ItemContentOutputText

모델의 텍스트 출력입니다.

Name Type Description Required Default
annotations array 텍스트 출력의 주석입니다. Yes
logprobs array No
text string 모델의 텍스트 출력입니다. Yes
type enum 출력 텍스트의 형식입니다. 항상 output_text입니다.
가능한 값: output_text		 Yes

OpenAI.ItemContentRefusal

모델의 거부입니다.

Name Type Description Required Default
refusal string 모델로부터의 거부에 대한 설명입니다. Yes
type enum 거부의 유형입니다. 항상 refusal입니다.
가능한 값: refusal		 Yes

OpenAI.ItemContentType

다중 모달 입력 및 출력 콘텐츠입니다.

Property Value
Description 다중 모달 입력 및 출력 콘텐츠입니다.
Type string
Values input_text
input_audio
input_image
input_file
output_text
output_audio
refusal

OpenAI.ItemParam

응답을 생성하는 데 사용되는 콘텐츠 항목입니다.

OpenAI.ItemParam에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
file_search_call OpenAI.FileSearchToolCallItemParam
computer_call OpenAI.ComputerToolCallItemParam
computer_call_output OpenAI.ComputerToolCallOutputItemParam
web_search_call OpenAI.WebSearchToolCallItemParam
function_call OpenAI.FunctionToolCallItemParam
function_call_output OpenAI.FunctionToolCallOutputItemParam
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
message OpenAI.ResponsesMessageItemParam
Name Type Description Required Default
type OpenAI.ItemType Yes

OpenAI.ItemReferenceItemParam

참조할 항목의 내부 식별자입니다.

Name Type Description Required Default
id string 참조되는 이전에 생성된 응답 항목의 서비스 원본 ID입니다. Yes
type enum
가능한 값: item_reference		 Yes

OpenAI.ItemResource

응답을 생성하는 데 사용되는 콘텐츠 항목입니다.

OpenAI.ItemResource에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
file_search_call OpenAI.FileSearchToolCallItemResource
computer_call OpenAI.ComputerToolCallItemResource
computer_call_output OpenAI.ComputerToolCallOutputItemResource
web_search_call OpenAI.WebSearchToolCallItemResource
function_call OpenAI.FunctionToolCallItemResource
function_call_output OpenAI.FunctionToolCallOutputItemResource
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_approval_response OpenAI.MCPApprovalResponseItemResource
mcp_call OpenAI.MCPCallItemResource
message OpenAI.ResponsesMessageItemResource
Name Type Description Required Default
id string Yes
type OpenAI.ItemType Yes

OpenAI.ItemType

Property Value
Type string
Values 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

OpenAI.ListFineTuningJobCheckpointsResponse

Name Type Description Required Default
data array Yes
first_id string No
has_more boolean Yes
last_id string No
object enum
가능한 값: list		 Yes

OpenAI.ListFineTuningJobEventsResponse

Name Type Description Required Default
data array Yes
has_more boolean Yes
object enum
가능한 값: list		 Yes

OpenAI.ListModelsResponse

Name Type Description Required Default
data array Yes
object enum
가능한 값: list		 Yes

OpenAI.ListPaginatedFineTuningJobsResponse

Name Type Description Required Default
data array Yes
has_more boolean Yes
object enum
가능한 값: list		 Yes

OpenAI.ListVectorStoreFilesFilter

Property Value
Type string
Values in_progress
completed
failed
cancelled

OpenAI.ListVectorStoreFilesResponse

Name Type Description Required Default
data array Yes
first_id string Yes
has_more boolean Yes
last_id string Yes
object enum
가능한 값: list		 Yes

OpenAI.ListVectorStoresResponse

Name Type Description Required Default
data array Yes
first_id string Yes
has_more boolean Yes
last_id string Yes
object enum
가능한 값: list		 Yes

OpenAI.LocalShellExecAction

서버에서 셸 명령을 실행합니다.

Name Type Description Required Default
명령어 array 실행할 명령. Yes
env object 명령에 대해 설정할 환경 변수입니다. Yes
타임아웃_밀리초 integer 명령에 대한 선택적 시간 제한(밀리초)입니다. No
type enum 로컬 셸 동작의 형식입니다. 항상 exec입니다.
가능한 값: exec		 Yes
user string 명령을 실행할 때 사용할 선택적 사용자입니다. No
작업 디렉토리 string 명령을 실행할 선택적 작업 디렉터리입니다. No

OpenAI.LocalShellTool

모델이 로컬 환경에서 셸 명령을 실행할 수 있도록 하는 도구입니다.

Name Type Description Required Default
type enum 로컬 셸 도구의 형식입니다. 항상 local_shell입니다.
가능한 값: local_shell		 Yes

OpenAI.LocalShellToolCallItemParam

로컬 셸에서 명령을 실행하는 도구 호출입니다.

Name Type Description Required Default
action OpenAI.LocalShellExecAction 서버에서 셸 명령을 실행합니다. Yes
call_id string 모델에서 생성된 로컬 셸 도구 호출의 고유 ID입니다. Yes
type enum
가능한 값: local_shell_call		 Yes

OpenAI.LocalShellToolCallItemResource

로컬 셸에서 명령을 실행하는 도구 호출입니다.

Name Type Description Required Default
action OpenAI.LocalShellExecAction 서버에서 셸 명령을 실행합니다. Yes
call_id string 모델에서 생성된 로컬 셸 도구 호출의 고유 ID입니다. Yes
status enum
가능한 값: in_progress, completedincomplete		 Yes
type enum
가능한 값: local_shell_call		 Yes

OpenAI.LocalShellToolCallOutputItemParam

로컬 셸 도구 호출의 출력입니다.

Name Type Description Required Default
output string 로컬 셸 도구 호출 출력의 JSON 문자열입니다. Yes
type enum
가능한 값: local_shell_call_output		 Yes

OpenAI.LocalShellToolCallOutputItemResource

로컬 셸 도구 호출의 출력입니다.

Name Type Description Required Default
output string 로컬 셸 도구 호출 출력의 JSON 문자열입니다. Yes
status enum
가능한 값: in_progress, completedincomplete		 Yes
type enum
가능한 값: local_shell_call_output		 Yes

OpenAI.Location

OpenAI.Location에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
approximate OpenAI.ApproximateLocation
Name Type Description Required Default
type OpenAI.LocationType Yes

OpenAI.LocationType

Property Value
Type string
Values approximate

OpenAI.LogProb

토큰의 로그 확률입니다.

Name Type Description Required Default
bytes array Yes
logprob number Yes
token string Yes
top_logprobs array Yes

OpenAI.MCPApprovalRequestItemParam

도구 호출에 대한 사용자 승인 요청입니다.

Name Type Description Required Default
arguments string 도구에 대한 인수의 JSON 문자열입니다. Yes
name string 실행할 도구의 이름입니다. Yes
server_label string 요청을 만드는 MCP 서버의 레이블입니다. Yes
type enum
가능한 값: mcp_approval_request		 Yes

OpenAI.MCPApprovalRequestItemResource

도구 호출에 대한 사용자 승인 요청입니다.

Name Type Description Required Default
arguments string 도구에 대한 인수의 JSON 문자열입니다. Yes
name string 실행할 도구의 이름입니다. Yes
server_label string 요청을 만드는 MCP 서버의 레이블입니다. Yes
type enum
가능한 값: mcp_approval_request		 Yes

OpenAI.MCPApprovalResponseItemParam

MCP 승인 요청에 대한 응답입니다.

Name Type Description Required Default
approval_request_id string 응답할 승인 요청의 ID입니다. Yes
approve boolean 요청이 승인되었는지 여부입니다. Yes
reason string 결정의 선택적 이유입니다. No
type enum
가능한 값: mcp_approval_response		 Yes

OpenAI.MCPApprovalResponseItemResource

MCP 승인 요청에 대한 응답입니다.

Name Type Description Required Default
approval_request_id string 응답할 승인 요청의 ID입니다. Yes
approve boolean 요청이 승인되었는지 여부입니다. Yes
reason string 결정의 선택적 이유입니다. No
type enum
가능한 값: mcp_approval_response		 Yes

OpenAI.MCPCallItemParam

MCP 서버에서 도구 호출입니다.

Name Type Description Required Default
arguments string 도구에 전달된 인수의 JSON 문자열입니다. Yes
error string 도구 호출의 오류(있는 경우)입니다. No
name string 실행된 도구의 이름입니다. Yes
output string 도구 호출의 출력입니다. No
server_label string 도구를 실행하는 MCP 서버의 레이블입니다. Yes
type enum
가능한 값: mcp_call		 Yes

OpenAI.MCPCallItemResource

MCP 서버에서 도구 호출입니다.

Name Type Description Required Default
arguments string 도구에 전달된 인수의 JSON 문자열입니다. Yes
error string 도구 호출의 오류(있는 경우)입니다. No
name string 실행된 도구의 이름입니다. Yes
output string 도구 호출의 출력입니다. No
server_label string 도구를 실행하는 MCP 서버의 레이블입니다. Yes
type enum
가능한 값: mcp_call		 Yes

OpenAI.MCPListToolsItemParam

MCP 서버에서 사용할 수 있는 도구 목록입니다.

Name Type Description Required Default
error string 서버에서 도구를 나열할 수 없는 경우 오류 메시지입니다. No
server_label string MCP 서버의 레이블입니다. Yes
tools array 서버에서 사용할 수 있는 도구입니다. Yes
type enum
가능한 값: mcp_list_tools		 Yes

OpenAI.MCPListToolsItemResource

MCP 서버에서 사용할 수 있는 도구 목록입니다.

Name Type Description Required Default
error string 서버에서 도구를 나열할 수 없는 경우 오류 메시지입니다. No
server_label string MCP 서버의 레이블입니다. Yes
tools array 서버에서 사용할 수 있는 도구입니다. Yes
type enum
가능한 값: mcp_list_tools		 Yes

OpenAI.MCPListToolsTool

MCP 서버에서 사용할 수 있는 도구입니다.

Name Type Description Required Default
annotations 도구에 대한 추가 주석입니다. No
description string 도구에 대한 설명입니다. No
input_schema 도구의 입력을 설명하는 JSON 스키마입니다. Yes
name string 도구의 이름입니다. Yes

OpenAI.MCPTool

모델에서 MCP(원격 모델 컨텍스트 프로토콜) 서버를 통해 추가 도구에 액세스할 수 있도록 합니다.

Name Type Description Required Default
allowed_tools object No
└─ 도구_이름 array 허용되는 도구 이름 목록입니다. No
headers object MCP 서버로 보낼 선택적 HTTP 헤더입니다. 인증에 사용
또는 다른 목적.		 No
require_approval 개체(아래 유효한 모델 참조) 승인이 필요한 MCP 서버의 도구를 지정합니다. No
server_label string 이 MCP 서버에 대한 레이블로, 도구 호출에서 이를 식별하는 데 사용됩니다. Yes
server_url string MCP 서버의 URL입니다. Yes
type enum MCP 도구의 형식입니다. 항상 mcp입니다.
가능한 값: mcp		 Yes

OpenAI.MetadataPropertyForRequest

개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 구조화된 형식으로 개체에 대한 추가 정보를 저장하고 API 또는 대시보드를 통해 개체를 쿼리하는 데 유용할 수 있습니다.

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

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

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

OpenAI.Model

API와 함께 사용할 수 있는 OpenAI 모델 제품에 대해 설명합니다.

Name Type Description Required Default
created integer 모델을 만들 때 Unix 타임스탬프(초)입니다. Yes
id string API 엔드포인트에서 참조할 수 있는 모델 식별자입니다. Yes
object enum 개체 유형은 항상 "model"입니다.
가능한 값: model		 Yes
owned_by string 모델을 소유하는 조직입니다. Yes

OpenAI.OtherChunkingStrategyResponseParam

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

Name Type Description Required Default
type enum 항상 other입니다.
가능한 값: other		 Yes

OpenAI.ParallelToolCalls

도구를 사용하는 동안 병렬 함수 호출을 사용하도록 설정할지 여부입니다.

형식: 불리언

OpenAI.Prompt

프롬프트 템플릿 및 해당 변수에 대한 참조입니다.

Name Type Description Required Default
id string 사용할 프롬프트 템플릿의 고유 식별자입니다. Yes
변수 object 프롬프트에서 변수를 대체할 값의 선택적
맵입니다. 대체 값은 문자열이거나 다른 값일 수 있습니다.
이미지 또는 파일과 같은 응답 입력 형식입니다.		 No
버전 string 프롬프트 템플릿의 선택적 버전입니다. No

OpenAI.RankingOptions

Name Type Description Required Default
ranker enum 파일 검색에 사용할 순위입니다.
가능한 값: autodefault-2024-11-15		 No
score_threshold number 파일 검색의 점수 임계값으로, 0에서 1 사이의 숫자입니다. 1에 가까운 숫자는 가장 관련성이 큰 결과만 반환하려고 시도하지만 더 적은 결과를 반환할 수 있습니다. No

OpenAI.Reasoning

o 시리즈 모델만

Name Type Description Required Default
effort object o 시리즈 모델만

추론 모델에서 추론 작업을 제한합니다.
현재 지원되는 값은 low, medium 및 high입니다. 줄이는
추론 작업으로 인해 응답 속도가 빨라지고 사용된 토큰 수가 줄어들 수 있습니다.
응답에서의 추론에 관하여		 No
generate_summary enum 사용되지 않음: 대신 사용합니다 summary .

모델에서 수행하는 추론에 대한 요약입니다. 다음과 같을 수 있습니다.
는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용합니다.
auto, concise 또는 detailed 중 하나입니다.
가능한 값: auto, concisedetailed		 No
summary enum 모델에서 수행하는 추론에 대한 요약입니다. 다음과 같을 수 있습니다.
는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용합니다.
auto, concise 또는 detailed 중 하나입니다.
가능한 값: auto, concisedetailed		 No

OpenAI.ReasoningEffort

o 시리즈 모델만

추론 모델에서 추론 작업을 제한합니다. 현재 지원되는 값은 low, medium 및 high입니다. 추론 작업을 줄이면 응답 속도가 빨라지고 응답에서 추론에 사용되는 토큰이 줄어들 수 있습니다.

Property Value
Description o 시리즈 모델만

추론 모델에서 추론 작업을 제한합니다.
현재 지원되는 값은 low, medium 및 high입니다. 줄이는
추론 작업으로 인해 응답 속도가 빨라지고 사용된 토큰 수가 줄어들 수 있습니다.
응답에서의 추론에 관하여
Type string
Values low
medium
high

OpenAI.ReasoningItemParam

응답을 생성하는 동안 추론 모델에서 사용하는 생각 체인에 대한 설명입니다. 대화의 후속 턴을 처리하기 위해 컨텍스트를 수동으로 관리하는 경우 응답 API에 해당 항목을 input에 추가해야 합니다.

Name Type Description Required Default
encrypted_content string 응답이 일 때 채워진 추론 항목의 암호화된 콘텐츠
reasoning.encrypted_content으로 생성되어 include 매개 변수에 있습니다.		 No
summary array 추론 텍스트 내용입니다. Yes
type enum
가능한 값: reasoning		 Yes

OpenAI.ReasoningItemResource

응답을 생성하는 동안 추론 모델에서 사용하는 생각 체인에 대한 설명입니다. 대화의 후속 턴을 처리하기 위해 컨텍스트를 수동으로 관리하는 경우 응답 API에 해당 항목을 input에 추가해야 합니다.

Name Type Description Required Default
encrypted_content string 응답이 일 때 채워진 추론 항목의 암호화된 콘텐츠
reasoning.encrypted_content으로 생성되어 include 매개 변수에 있습니다.		 No
summary array 추론 텍스트 내용입니다. Yes
type enum
가능한 값: reasoning		 Yes

OpenAI.ReasoningItemSummaryPart

OpenAI.ReasoningItemSummaryPart에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
summary_text OpenAI.ReasoningItemSummaryTextPart
Name Type Description Required Default
type OpenAI.ReasoningItemSummaryPartType Yes

OpenAI.ReasoningItemSummaryPartType

Property Value
Type string
Values summary_text

OpenAI.ReasoningItemSummaryTextPart

Name Type Description Required Default
text string Yes
type enum
가능한 값: summary_text		 Yes

OpenAI.Response

Name Type Description Required Default
background boolean 백그라운드에서 모델 응답을 실행할지 여부입니다. No False
created_at integer 이 응답을 만든 시점의 Unix 타임스탬프(초)입니다. Yes
error object 모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다. Yes
└) 코드 OpenAI.ResponseErrorCode 응답에 대한 오류 코드입니다. No
└) 메시지 string 사람이 읽을 수 있는 오류 설명입니다. No
id string 이 응답의 고유 식별자입니다. Yes
incomplete_details object 응답이 불완전한 이유에 대한 세부 정보입니다. Yes
└) 이유 enum 응답이 불완전한 이유입니다.
가능한 값: max_output_tokenscontent_filter		 No
instructions 문자열 또는 배열 Yes
max_output_tokens integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한입니다. No
최대_도구_호출수 integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. No
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 Yes
object enum 이 리소스의 개체 유형은 항상 response로 설정됩니다.
가능한 값: response		 Yes
output array 모델에서 생성된 콘텐츠 항목의 배열입니다.

- 배열에 있는 항목의 길이와 순서가 output 종속됩니다.
모델의 응답에 따라.
- output 배열의 첫 번째 항목에 액세스하고
생성된 콘텐츠가 있는 assistant 메시지라고 가정하는 것보다
모델에서 output_text 속성을 사용하는 것을 고려해 볼 수 있습니다.
SDK에서 지원됩니다.		 Yes
output_text string 집계된 텍스트 출력을 포함하는 SDK 전용 편의 속성
output_text 배열에 있는 모든 output 항목(있는 경우)에서.
Python 및 JavaScript SDK에서 지원됩니다.		 No
parallel_tool_calls boolean 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. Yes True
previous_response_id string 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다.		 No
prompt object 프롬프트 템플릿 및 해당 변수에 대한 참조입니다. No
└─ ID string 사용할 프롬프트 템플릿의 고유 식별자입니다. No
└) 변수 OpenAI.ResponsePromptVariables 프롬프트에서 변수를 대체할 값의 선택적
맵입니다. 대체 값은 문자열이거나 다른 값일 수 있습니다.
이미지 또는 파일과 같은 응답 입력 형식입니다.		 No
└─ 버전 string 프롬프트 템플릿의 선택적 버전입니다. No
reasoning object o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.		 No
└) 노력 OpenAI.ReasoningEffort o 시리즈 모델만

추론 모델에서 추론 작업을 제한합니다.
현재 지원되는 값은 low, medium 및 high입니다. 줄이는
추론 작업으로 인해 응답 속도가 빨라지고 사용된 토큰 수가 줄어들 수 있습니다.
응답에서의 추론에 관하여		 No
└generate_summary enum 사용되지 않음: 대신 사용합니다 summary .

모델에서 수행하는 추론에 대한 요약입니다. 다음과 같을 수 있습니다.
는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용합니다.
auto, concise 또는 detailed 중 하나입니다.
가능한 값: auto, concisedetailed		 No
└) 요약 enum 모델에서 수행하는 추론에 대한 요약입니다. 다음과 같을 수 있습니다.
는 모델의 추론 프로세스를 디버깅하고 이해하는 데 유용합니다.
auto, concise 또는 detailed 중 하나입니다.
가능한 값: auto, concisedetailed		 No
status enum 응답 생성의 상태입니다. 다음 중 하나인 completed, failed
in_progress, cancelled, queued 또는 incomplete.
가능한 값: completed, failed, in_progresscancelled, queuedincomplete		 No
temperature number 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 더 낮은 값을 지정하면 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.		 Yes
text object 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반 텍스트 또는 구조화된 JSON 데이터일 수 있습니다. No
└─ 형식 OpenAI.ResponseTextFormatConfiguration No
tool_choice object 모델이 호출하는 도구(있는 경우)를 제어합니다.

none 는 모델이 도구를 호출하지 않고 대신 메시지를 생성한다는 의미입니다.

auto 는 모델이 메시지를 생성하거나 메시지를 호출하는 중에서 선택할 수 있습니다.
더 많은 도구.

required는 모델이 하나 이상의 도구를 호출해야 함을 의미합니다.		 No
└─ 형식 OpenAI.ToolChoiceObjectType 모델이 기본 제공 도구를 사용하여 응답을 생성해야 임을 나타냅니다. No
tools array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. You
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

- 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
모델의 기능.		 No
top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. No
top_p number 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.		 Yes
truncation enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled		 No
usage OpenAI.ResponseUsage 입력 토큰, 출력 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다.
출력 토큰 및 사용된 총 토큰의 분석입니다.		 No
user string 최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. Yes

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

부분 코드 조각이 코드 인터프리터에 의해 스트리밍될 때 내보내집니다.

Name Type Description Required Default
delta string 코드 인터프리터가 스트리밍하는 부분 코드 조각입니다. Yes
item_id string 코드 인터프리터 도구 호출 항목의 고유 식별자입니다. Yes
output_index integer 코드가 스트리밍되는 응답의 출력 항목 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.code_interpreter_call_code.delta입니다.
가능한 값: response.code_interpreter_call_code.delta		 Yes

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

코드 조각이 코드 인터프리터에 의해 종료될 때 내보내집니다.

Name Type Description Required Default
code string 코드 인터프리터의 최종 코드 조각 출력입니다. Yes
item_id string 코드 인터프리터 도구 호출 항목의 고유 식별자입니다. Yes
output_index integer 코드가 종료되는 응답의 출력 항목 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.code_interpreter_call_code.done입니다.
가능한 값: response.code_interpreter_call_code.done		 Yes

OpenAI.ResponseCodeInterpreterCallCompletedEvent

코드 인터프리터 호출이 완료되면 내보내집니다.

Name Type Description Required Default
item_id string 코드 인터프리터 도구 호출 항목의 고유 식별자입니다. Yes
output_index integer 코드 인터프리터 호출이 완료된 응답의 출력 항목 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.code_interpreter_call.completed입니다.
가능한 값: response.code_interpreter_call.completed		 Yes

OpenAI.ResponseCodeInterpreterCallInProgressEvent

코드 인터프리터 호출이 진행 중일 때 내보내집니다.

Name Type Description Required Default
item_id string 코드 인터프리터 도구 호출 항목의 고유 식별자입니다. Yes
output_index integer 코드 인터프리터 호출이 진행 중인 응답의 출력 항목 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.code_interpreter_call.in_progress입니다.
가능한 값: response.code_interpreter_call.in_progress		 Yes

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

코드 인터프리터가 코드 조각을 적극적으로 해석할 때 내보내집니다.

Name Type Description Required Default
item_id string 코드 인터프리터 도구 호출 항목의 고유 식별자입니다. Yes
output_index integer 코드 인터프리터가 코드를 해석하는 응답에서 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.code_interpreter_call.interpreting입니다.
가능한 값: response.code_interpreter_call.interpreting		 Yes

OpenAI.ResponseCompletedEvent

모델 응답이 완료되면 내보내집니다.

Name Type Description Required Default
response object Yes
└) 배경 boolean 백그라운드에서 모델 응답을 실행할지 여부입니다. No False
└─ 생성일시 integer 이 응답을 만든 시점의 Unix 타임스탬프(초)입니다. No
└) 오류 OpenAI.ResponseError 모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다. No
└─ ID string 이 응답의 고유 식별자입니다. No
└─ 불완전한 세부사항 object 응답이 불완전한 이유에 대한 세부 정보입니다. No
└) 이유 enum 응답이 불완전한 이유입니다.
가능한 값: max_output_tokenscontent_filter		 No
└) 지침 문자열 또는 배열 모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다.

previous_response_id와 함께 사용할 경우 이전의 지침이 적용됩니다.
응답은 다음 응답으로 전달되지 않습니다. 이렇게 하면 간단해집니다.
새 응답에서 시스템(또는 개발자) 메시지를 교환합니다.		 No
└ 최대_출력_토큰 integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한입니다. No
└max_tool_calls integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. No
└) 메타데이터 object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
└) 개체 enum 이 리소스의 개체 유형은 항상 response로 설정됩니다.
가능한 값: response		 No
└─ 출력 array 모델에서 생성된 콘텐츠 항목의 배열입니다.

- 배열에 있는 항목의 길이와 순서가 output 종속됩니다.
모델의 응답에 따라.
- output 배열의 첫 번째 항목에 액세스하고
생성된 콘텐츠가 있는 assistant 메시지라고 가정하는 것보다
모델에서 output_text 속성을 사용하는 것을 고려해 볼 수 있습니다.
SDK에서 지원됩니다.		 No
└output_text string 집계된 텍스트 출력을 포함하는 SDK 전용 편의 속성
output_text 배열에 있는 모든 output 항목(있는 경우)에서.
Python 및 JavaScript SDK에서 지원됩니다.		 No
└parallel_tool_calls boolean 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. No True
└이전_응답_아이디 string 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다.		 No
└) 프롬프트 OpenAI.Prompt 프롬프트 템플릿 및 해당 변수에 대한 참조입니다. No
└) 추론 OpenAI.Reasoning o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.		 No
└─ 상태 enum 응답 생성의 상태입니다. 다음 중 하나인 completed, failed
in_progress, cancelled, queued 또는 incomplete.
가능한 값: completed, failed, in_progresscancelled, queuedincomplete		 No
└> 온도 number 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 더 낮은 값을 지정하면 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.		 No
└) 텍스트 object 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반 텍스트 또는 구조화된 JSON 데이터일 수 있습니다. No
└─ 형식 OpenAI.ResponseTextFormatConfiguration No
└tool_choice OpenAI.ToolChoiceOptions 또는 OpenAI.ToolChoiceObject 모델을 생성할 때 사용할 도구(또는 도구)를 선택하는 방법
응답입니다. 도구를 지정하는 방법을 알아보려면 tools 매개 변수를 참조하세요.
모델이 호출할 수 있습니다.		 No
└도구 array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. You
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

- 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
모델의 기능.		 No
└top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. No
└ top_p number 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.		 No
└> 잘림 enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled		 No
└) 사용량 OpenAI.ResponseUsage 입력 토큰, 출력 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다.
출력 토큰 및 사용된 총 토큰의 분석입니다.		 No
└─ 사용자 string 최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. No
type enum 이벤트의 형식입니다. 항상 response.completed입니다.
가능한 값: response.completed		 Yes

OpenAI.ResponseContentPartAddedEvent

새 콘텐츠 파트가 추가될 때 내보내집니다.

Name Type Description Required Default
content_index integer 추가된 콘텐츠 파트의 인덱스입니다. Yes
item_id string 콘텐츠 파트가 추가된 출력 항목의 ID입니다. Yes
output_index integer 콘텐츠 파트가 추가된 출력 항목의 인덱스입니다. Yes
part object Yes
└─ 형식 OpenAI.ItemContentType 다중 모달 입력 및 출력 콘텐츠입니다. No
type enum 이벤트의 형식입니다. 항상 response.content_part.added입니다.
가능한 값: response.content_part.added		 Yes

OpenAI.ResponseContentPartDoneEvent

콘텐츠 파트가 완료되면 내보내집니다.

Name Type Description Required Default
content_index integer 완료된 콘텐츠 파트의 인덱스입니다. Yes
item_id string 콘텐츠 파트가 추가된 출력 항목의 ID입니다. Yes
output_index integer 콘텐츠 파트가 추가된 출력 항목의 인덱스입니다. Yes
part object Yes
└─ 형식 OpenAI.ItemContentType 다중 모달 입력 및 출력 콘텐츠입니다. No
type enum 이벤트의 형식입니다. 항상 response.content_part.done입니다.
가능한 값: response.content_part.done		 Yes

OpenAI.ResponseCreatedEvent

응답을 만들 때 내보내는 이벤트입니다.

Name Type Description Required Default
response object Yes
└) 배경 boolean 백그라운드에서 모델 응답을 실행할지 여부입니다. No False
└─ 생성일시 integer 이 응답을 만든 시점의 Unix 타임스탬프(초)입니다. No
└) 오류 OpenAI.ResponseError 모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다. No
└─ ID string 이 응답의 고유 식별자입니다. No
└─ 불완전한 세부사항 object 응답이 불완전한 이유에 대한 세부 정보입니다. No
└) 이유 enum 응답이 불완전한 이유입니다.
가능한 값: max_output_tokenscontent_filter		 No
└) 지침 문자열 또는 배열 모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다.

previous_response_id와 함께 사용할 경우 이전의 지침이 적용됩니다.
응답은 다음 응답으로 전달되지 않습니다. 이렇게 하면 간단해집니다.
새 응답에서 시스템(또는 개발자) 메시지를 교환합니다.		 No
└ 최대_출력_토큰 integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한입니다. No
└max_tool_calls integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. No
└) 메타데이터 object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
└) 개체 enum 이 리소스의 개체 유형은 항상 response로 설정됩니다.
가능한 값: response		 No
└─ 출력 array 모델에서 생성된 콘텐츠 항목의 배열입니다.

- 배열에 있는 항목의 길이와 순서가 output 종속됩니다.
모델의 응답에 따라.
- output 배열의 첫 번째 항목에 액세스하고
생성된 콘텐츠가 있는 assistant 메시지라고 가정하는 것보다
모델에서 output_text 속성을 사용하는 것을 고려해 볼 수 있습니다.
SDK에서 지원됩니다.		 No
└output_text string 집계된 텍스트 출력을 포함하는 SDK 전용 편의 속성
output_text 배열에 있는 모든 output 항목(있는 경우)에서.
Python 및 JavaScript SDK에서 지원됩니다.		 No
└parallel_tool_calls boolean 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. No True
└이전_응답_아이디 string 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다.		 No
└) 프롬프트 OpenAI.Prompt 프롬프트 템플릿 및 해당 변수에 대한 참조입니다. No
└) 추론 OpenAI.Reasoning o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.		 No
└─ 상태 enum 응답 생성의 상태입니다. 다음 중 하나인 completed, failed
in_progress, cancelled, queued 또는 incomplete.
가능한 값: completed, failed, in_progresscancelled, queuedincomplete		 No
└> 온도 number 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 더 낮은 값을 지정하면 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.		 No
└) 텍스트 object 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반 텍스트 또는 구조화된 JSON 데이터일 수 있습니다. No
└─ 형식 OpenAI.ResponseTextFormatConfiguration No
└tool_choice OpenAI.ToolChoiceOptions 또는 OpenAI.ToolChoiceObject 모델을 생성할 때 사용할 도구(또는 도구)를 선택하는 방법
응답입니다. 도구를 지정하는 방법을 알아보려면 tools 매개 변수를 참조하세요.
모델이 호출할 수 있습니다.		 No
└도구 array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. You
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

- 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
모델의 기능.		 No
└top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. No
└ top_p number 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.		 No
└> 잘림 enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled		 No
└) 사용량 OpenAI.ResponseUsage 입력 토큰, 출력 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다.
출력 토큰 및 사용된 총 토큰의 분석입니다.		 No
└─ 사용자 string 최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. No
type enum 이벤트의 형식입니다. 항상 response.created입니다.
가능한 값: response.created		 Yes

OpenAI.ResponseError

모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다.

Name Type Description Required Default
code OpenAI.ResponseErrorCode 응답에 대한 오류 코드입니다. Yes
message string 사람이 읽을 수 있는 오류 설명입니다. Yes

OpenAI.ResponseErrorCode

응답에 대한 오류 코드입니다.

Property Value
Description 응답에 대한 오류 코드입니다.
Type string
Values 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

오류가 발생할 때 내보냅니다.

Name Type Description Required Default
code string 오류 코드입니다. Yes
message string 오류 메시지입니다. Yes
param string 오류 매개 변수입니다. Yes
type enum 이벤트의 형식입니다. 항상 error입니다.
가능한 값: error		 Yes

OpenAI.ResponseFailedEvent

응답이 실패할 때 내보내는 이벤트입니다.

Name Type Description Required Default
response object Yes
└) 배경 boolean 백그라운드에서 모델 응답을 실행할지 여부입니다. No False
└─ 생성일시 integer 이 응답을 만든 시점의 Unix 타임스탬프(초)입니다. No
└) 오류 OpenAI.ResponseError 모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다. No
└─ ID string 이 응답의 고유 식별자입니다. No
└─ 불완전한 세부사항 object 응답이 불완전한 이유에 대한 세부 정보입니다. No
└) 이유 enum 응답이 불완전한 이유입니다.
가능한 값: max_output_tokenscontent_filter		 No
└) 지침 문자열 또는 배열 모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다.

previous_response_id와 함께 사용할 경우 이전의 지침이 적용됩니다.
응답은 다음 응답으로 전달되지 않습니다. 이렇게 하면 간단해집니다.
새 응답에서 시스템(또는 개발자) 메시지를 교환합니다.		 No
└ 최대_출력_토큰 integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한입니다. No
└max_tool_calls integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. No
└) 메타데이터 object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
└) 개체 enum 이 리소스의 개체 유형은 항상 response로 설정됩니다.
가능한 값: response		 No
└─ 출력 array 모델에서 생성된 콘텐츠 항목의 배열입니다.

- 배열에 있는 항목의 길이와 순서가 output 종속됩니다.
모델의 응답에 따라.
- output 배열의 첫 번째 항목에 액세스하고
생성된 콘텐츠가 있는 assistant 메시지라고 가정하는 것보다
모델에서 output_text 속성을 사용하는 것을 고려해 볼 수 있습니다.
SDK에서 지원됩니다.		 No
└output_text string 집계된 텍스트 출력을 포함하는 SDK 전용 편의 속성
output_text 배열에 있는 모든 output 항목(있는 경우)에서.
Python 및 JavaScript SDK에서 지원됩니다.		 No
└parallel_tool_calls boolean 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. No True
└이전_응답_아이디 string 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다.		 No
└) 프롬프트 OpenAI.Prompt 프롬프트 템플릿 및 해당 변수에 대한 참조입니다. No
└) 추론 OpenAI.Reasoning o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.		 No
└─ 상태 enum 응답 생성의 상태입니다. 다음 중 하나인 completed, failed
in_progress, cancelled, queued 또는 incomplete.
가능한 값: completed, failed, in_progresscancelled, queuedincomplete		 No
└> 온도 number 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 더 낮은 값을 지정하면 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.		 No
└) 텍스트 object 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반 텍스트 또는 구조화된 JSON 데이터일 수 있습니다. No
└─ 형식 OpenAI.ResponseTextFormatConfiguration No
└tool_choice OpenAI.ToolChoiceOptions 또는 OpenAI.ToolChoiceObject 모델을 생성할 때 사용할 도구(또는 도구)를 선택하는 방법
응답입니다. 도구를 지정하는 방법을 알아보려면 tools 매개 변수를 참조하세요.
모델이 호출할 수 있습니다.		 No
└도구 array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. You
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

- 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
모델의 기능.		 No
└top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. No
└ top_p number 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.		 No
└> 잘림 enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled		 No
└) 사용량 OpenAI.ResponseUsage 입력 토큰, 출력 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다.
출력 토큰 및 사용된 총 토큰의 분석입니다.		 No
└─ 사용자 string 최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. No
type enum 이벤트의 형식입니다. 항상 response.failed입니다.
가능한 값: response.failed		 Yes

OpenAI.ResponseFileSearchCallCompletedEvent

파일 검색 호출이 완료될 때 내보내집니다(결과를 찾은 경우).

Name Type Description Required Default
item_id string 파일 검색 호출이 시작되는 출력 항목의 ID입니다. Yes
output_index integer 파일 검색 호출이 시작되는 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.file_search_call.completed입니다.
가능한 값: response.file_search_call.completed		 Yes

OpenAI.ResponseFileSearchCallInProgressEvent

파일 검색 호출이 시작될 때 내보내집니다.

Name Type Description Required Default
item_id string 파일 검색 호출이 시작되는 출력 항목의 ID입니다. Yes
output_index integer 파일 검색 호출이 시작되는 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.file_search_call.in_progress입니다.
가능한 값: response.file_search_call.in_progress		 Yes

OpenAI.ResponseFileSearchCallSearchingEvent

파일 검색이 현재 검색 중일 때 내보내집니다.

Name Type Description Required Default
item_id string 파일 검색 호출이 시작되는 출력 항목의 ID입니다. Yes
output_index integer 파일 검색 호출에서 검색하는 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.file_search_call.searching입니다.
가능한 값: response.file_search_call.searching		 Yes

OpenAI.ResponseFormat

OpenAI.ResponseFormat에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
text OpenAI.ResponseFormatText
json_object OpenAI.ResponseFormatJsonObject
json_schema OpenAI.ResponseFormatJsonSchema
Name Type Description Required Default
type enum
가능한 값: text, json_objectjson_schema		 Yes

OpenAI.ResponseFormatJsonObject

JSON 개체 응답 형식입니다. JSON 응답을 생성하는 이전 메서드입니다. 이를 지원하는 모델에는 사용하는 json_schema 것이 좋습니다. 모델에서 JSON을 생성하도록 지시하는 시스템 또는 사용자 메시지 없이는 JSON을 생성하지 않습니다.

Name Type Description Required Default
type enum 정의되는 응답 형식의 유형입니다. 항상 json_object입니다.
가능한 값: json_object		 Yes

OpenAI.ResponseFormatJsonSchema

JSON 스키마 응답 형식입니다. 구조적 JSON 응답을 생성하는 데 사용됩니다.

Name Type Description Required Default
json_schema object JSON 스키마를 비롯한 구조적 출력 구성 옵션입니다. Yes
└) 설명 string 이 응답 형식이 모델에서 어떻게 사용되는지에 대한 설명입니다.
형식으로 응답하는 방법을 결정합니다.		 No
└) 이름 string 응답 형식의 이름입니다. 최대 64자까지 가능하며,
a-z, A-Z, 0-9이거나 밑줄과 대시를 포함해야 합니다.		 No
└─ 스키마 OpenAI.ResponseFormatJsonSchemaSchema JSON 스키마 개체로 설명되는 응답 형식에 대한 스키마입니다.
여기에서 JSON 스키마를 빌드하는 방법을 알아봅니 다.		 No
└─ 엄격한 boolean 출력을 생성할 때 엄격한 스키마 준수를 사용하도록 설정할지 여부입니다.
true로 설정하면 모델은 항상 정의된 정확한 스키마를 따릅니다.
schema 필드에. JSON 스키마의 하위 집합만 지원되는 경우
strict은 true입니다.		 No False
type enum 정의되는 응답 형식의 유형입니다. 항상 json_schema입니다.
가능한 값: json_schema		 Yes

OpenAI.ResponseFormatJsonSchemaSchema

JSON 스키마 개체로 설명되는 응답 형식에 대한 스키마입니다. 여기에서 JSON 스키마를 빌드하는 방법을 알아봅니 다.

Type: 객체

OpenAI.ResponseFormatText

기본 응답 형식입니다. 텍스트 응답을 생성하는 데 사용됩니다.

Name Type Description Required Default
type enum 정의되는 응답 형식의 유형입니다. 항상 text입니다.
가능한 값: text		 Yes

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

부분 함수 호출 인수 델타가 있을 때 내보내집니다.

Name Type Description Required Default
delta string 추가되는 함수 호출 인수 델타입니다. Yes
item_id string 함수 호출 인수 델타가 추가되는 출력 항목의 ID입니다. Yes
output_index integer 함수 호출 인수 델타가 추가되는 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.function_call_arguments.delta입니다.
가능한 값: response.function_call_arguments.delta		 Yes

OpenAI.ResponseFunctionCallArgumentsDoneEvent

함수 호출 인수가 종료될 때 내보내집니다.

Name Type Description Required Default
arguments string 함수 호출 인수입니다. Yes
item_id string 항목의 ID입니다. Yes
output_index integer 출력 항목의 인덱스입니다. Yes
type enum
가능한 값: response.function_call_arguments.done		 Yes

OpenAI.ResponseImageGenCallCompletedEvent

이미지 생성 도구 호출이 완료되고 최종 이미지를 사용할 수 있을 때 내보내집니다.

Name Type Description Required Default
item_id string 처리 중인 이미지 생성 항목의 고유 식별자입니다. Yes
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 언제나 'response.image_generation_call.completed'로 표시됩니다.
가능한 값: response.image_generation_call.completed		 Yes

OpenAI.ResponseImageGenCallGeneratingEvent

이미지 생성 도구 호출이 이미지(중간 상태)를 적극적으로 생성할 때 내보내집니다.

Name Type Description Required Default
item_id string 처리 중인 이미지 생성 항목의 고유 식별자입니다. Yes
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 'response.image_generation_call.generating'입니다.
가능한 값: response.image_generation_call.generating		 Yes

OpenAI.ResponseImageGenCallInProgressEvent

이미지 생성 도구 호출이 진행 중일 때 내보내집니다.

Name Type Description Required Default
item_id string 처리 중인 이미지 생성 항목의 고유 식별자입니다. Yes
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 'response.image_generation_call.in_progress'입니다.
가능한 값: response.image_generation_call.in_progress		 Yes

OpenAI.ResponseImageGenCallPartialImageEvent

이미지 생성 스트리밍 중에 부분 이미지를 사용할 수 있을 때 내보내집니다.

Name Type Description Required Default
item_id string 처리 중인 이미지 생성 항목의 고유 식별자입니다. Yes
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다. Yes
partial_image_b64 string Base64로 인코딩된 부분 이미지 데이터로, 이미지로 렌더링하는 데 적합합니다. Yes
partial_image_index integer 부분 이미지에 대한 0부터 시작하는 인덱스입니다(백 엔드는 1 기반이지만 사용자의 경우 0 기반). Yes
type enum 이벤트의 형식입니다. 항상 'response.image_generation_call.partial_image'입니다.
가능한 값: response.image_generation_call.partial_image		 Yes

OpenAI.ResponseInProgressEvent

응답이 진행 중일 때 내보내집니다.

Name Type Description Required Default
response object Yes
└) 배경 boolean 백그라운드에서 모델 응답을 실행할지 여부입니다. No False
└─ 생성일시 integer 이 응답을 만든 시점의 Unix 타임스탬프(초)입니다. No
└) 오류 OpenAI.ResponseError 모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다. No
└─ ID string 이 응답의 고유 식별자입니다. No
└─ 불완전한 세부사항 object 응답이 불완전한 이유에 대한 세부 정보입니다. No
└) 이유 enum 응답이 불완전한 이유입니다.
가능한 값: max_output_tokenscontent_filter		 No
└) 지침 문자열 또는 배열 모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다.

previous_response_id와 함께 사용할 경우 이전의 지침이 적용됩니다.
응답은 다음 응답으로 전달되지 않습니다. 이렇게 하면 간단해집니다.
새 응답에서 시스템(또는 개발자) 메시지를 교환합니다.		 No
└ 최대_출력_토큰 integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한입니다. No
└max_tool_calls integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. No
└) 메타데이터 object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
└) 개체 enum 이 리소스의 개체 유형은 항상 response로 설정됩니다.
가능한 값: response		 No
└─ 출력 array 모델에서 생성된 콘텐츠 항목의 배열입니다.

- 배열에 있는 항목의 길이와 순서가 output 종속됩니다.
모델의 응답에 따라.
- output 배열의 첫 번째 항목에 액세스하고
생성된 콘텐츠가 있는 assistant 메시지라고 가정하는 것보다
모델에서 output_text 속성을 사용하는 것을 고려해 볼 수 있습니다.
SDK에서 지원됩니다.		 No
└output_text string 집계된 텍스트 출력을 포함하는 SDK 전용 편의 속성
output_text 배열에 있는 모든 output 항목(있는 경우)에서.
Python 및 JavaScript SDK에서 지원됩니다.		 No
└parallel_tool_calls boolean 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. No True
└이전_응답_아이디 string 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다.		 No
└) 프롬프트 OpenAI.Prompt 프롬프트 템플릿 및 해당 변수에 대한 참조입니다. No
└) 추론 OpenAI.Reasoning o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.		 No
└─ 상태 enum 응답 생성의 상태입니다. 다음 중 하나인 completed, failed
in_progress, cancelled, queued 또는 incomplete.
가능한 값: completed, failed, in_progresscancelled, queuedincomplete		 No
└> 온도 number 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 더 낮은 값을 지정하면 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.		 No
└) 텍스트 object 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반 텍스트 또는 구조화된 JSON 데이터일 수 있습니다. No
└─ 형식 OpenAI.ResponseTextFormatConfiguration No
└tool_choice OpenAI.ToolChoiceOptions 또는 OpenAI.ToolChoiceObject 모델을 생성할 때 사용할 도구(또는 도구)를 선택하는 방법
응답입니다. 도구를 지정하는 방법을 알아보려면 tools 매개 변수를 참조하세요.
모델이 호출할 수 있습니다.		 No
└도구 array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. You
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

- 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
모델의 기능.		 No
└top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. No
└ top_p number 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.		 No
└> 잘림 enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled		 No
└) 사용량 OpenAI.ResponseUsage 입력 토큰, 출력 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다.
출력 토큰 및 사용된 총 토큰의 분석입니다.		 No
└─ 사용자 string 최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. No
type enum 이벤트의 형식입니다. 항상 response.in_progress입니다.
가능한 값: response.in_progress		 Yes

OpenAI.ResponseIncompleteEvent

응답이 완료되지 않은 것으로 완료될 때 내보내지는 이벤트입니다.

Name Type Description Required Default
response object Yes
└) 배경 boolean 백그라운드에서 모델 응답을 실행할지 여부입니다. No False
└─ 생성일시 integer 이 응답을 만든 시점의 Unix 타임스탬프(초)입니다. No
└) 오류 OpenAI.ResponseError 모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다. No
└─ ID string 이 응답의 고유 식별자입니다. No
└─ 불완전한 세부사항 object 응답이 불완전한 이유에 대한 세부 정보입니다. No
└) 이유 enum 응답이 불완전한 이유입니다.
가능한 값: max_output_tokenscontent_filter		 No
└) 지침 문자열 또는 배열 모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다.

previous_response_id와 함께 사용할 경우 이전의 지침이 적용됩니다.
응답은 다음 응답으로 전달되지 않습니다. 이렇게 하면 간단해집니다.
새 응답에서 시스템(또는 개발자) 메시지를 교환합니다.		 No
└ 최대_출력_토큰 integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한입니다. No
└max_tool_calls integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. No
└) 메타데이터 object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
└) 개체 enum 이 리소스의 개체 유형은 항상 response로 설정됩니다.
가능한 값: response		 No
└─ 출력 array 모델에서 생성된 콘텐츠 항목의 배열입니다.

- 배열에 있는 항목의 길이와 순서가 output 종속됩니다.
모델의 응답에 따라.
- output 배열의 첫 번째 항목에 액세스하고
생성된 콘텐츠가 있는 assistant 메시지라고 가정하는 것보다
모델에서 output_text 속성을 사용하는 것을 고려해 볼 수 있습니다.
SDK에서 지원됩니다.		 No
└output_text string 집계된 텍스트 출력을 포함하는 SDK 전용 편의 속성
output_text 배열에 있는 모든 output 항목(있는 경우)에서.
Python 및 JavaScript SDK에서 지원됩니다.		 No
└parallel_tool_calls boolean 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. No True
└이전_응답_아이디 string 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다.		 No
└) 프롬프트 OpenAI.Prompt 프롬프트 템플릿 및 해당 변수에 대한 참조입니다. No
└) 추론 OpenAI.Reasoning o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.		 No
└─ 상태 enum 응답 생성의 상태입니다. 다음 중 하나인 completed, failed
in_progress, cancelled, queued 또는 incomplete.
가능한 값: completed, failed, in_progresscancelled, queuedincomplete		 No
└> 온도 number 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 더 낮은 값을 지정하면 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.		 No
└) 텍스트 object 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반 텍스트 또는 구조화된 JSON 데이터일 수 있습니다. No
└─ 형식 OpenAI.ResponseTextFormatConfiguration No
└tool_choice OpenAI.ToolChoiceOptions 또는 OpenAI.ToolChoiceObject 모델을 생성할 때 사용할 도구(또는 도구)를 선택하는 방법
응답입니다. 도구를 지정하는 방법을 알아보려면 tools 매개 변수를 참조하세요.
모델이 호출할 수 있습니다.		 No
└도구 array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. You
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

- 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
모델의 기능.		 No
└top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. No
└ top_p number 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.		 No
└> 잘림 enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled		 No
└) 사용량 OpenAI.ResponseUsage 입력 토큰, 출력 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다.
출력 토큰 및 사용된 총 토큰의 분석입니다.		 No
└─ 사용자 string 최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. No
type enum 이벤트의 형식입니다. 항상 response.incomplete입니다.
가능한 값: response.incomplete		 Yes

OpenAI.ResponseItemList

응답 항목 목록입니다.

Name Type Description Required Default
data array 이 응답을 생성하는 데 사용되는 항목 목록입니다. Yes
first_id string 목록의 첫 번째 항목 ID입니다. Yes
has_more boolean 사용할 수 있는 항목이 더 있는지 여부입니다. Yes
last_id string 목록의 마지막 항목 ID입니다. Yes
object enum 반환되는 개체의 형식은 list이어야 합니다.
가능한 값: list		 Yes

OpenAI.ResponseMCPCallArgumentsDeltaEvent

MCP 도구 호출의 인수에 대한 델타(부분 업데이트)가 있을 때 내보내집니다.

Name Type Description Required Default
delta MCP 도구 호출에 대한 인수에 대한 부분 업데이트입니다. Yes
item_id string 처리 중인 MCP 도구 호출 항목의 고유 식별자입니다. Yes
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 해당 값은 항상 'response.mcp_call.arguments_delta'입니다.
가능한 값: response.mcp_call.arguments_delta		 Yes

OpenAI.ResponseMCPCallArgumentsDoneEvent

MCP 도구 호출에 대한 인수가 종료될 때 내보내집니다.

Name Type Description Required Default
arguments MCP 도구 호출에 대한 최종 인수입니다. Yes
item_id string 처리 중인 MCP 도구 호출 항목의 고유 식별자입니다. Yes
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 'response.mcp_call.arguments_done'입니다.
가능한 값: response.mcp_call.arguments_done		 Yes

OpenAI.ResponseMCPCallCompletedEvent

MCP 도구 호출이 성공적으로 완료되면 내보냅니다.

Name Type Description Required Default
type enum 이벤트의 형식입니다. 항상 'response.mcp_call.completed'입니다.
가능한 값: response.mcp_call.completed		 Yes

OpenAI.ResponseMCPCallFailedEvent

MCP 도구 호출이 실패했을 때 내보냅니다.

Name Type Description Required Default
type enum 이벤트의 형식입니다. 항상 'response.mcp_call.failed'입니다.
가능한 값: response.mcp_call.failed		 Yes

OpenAI.ResponseMCPCallInProgressEvent

MCP 도구 호출이 진행 중일 때 내보내집니다.

Name Type Description Required Default
item_id string 처리 중인 MCP 도구 호출 항목의 고유 식별자입니다. Yes
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 'response.mcp_call.in_progress'입니다.
가능한 값: response.mcp_call.in_progress		 Yes

OpenAI.ResponseMCPListToolsCompletedEvent

사용 가능한 MCP 도구 목록을 성공적으로 검색한 경우 내보냅니다.

Name Type Description Required Default
type enum 이벤트의 형식입니다. 항상 'response.mcp_list_tools.completed'입니다.
가능한 값: response.mcp_list_tools.completed		 Yes

OpenAI.ResponseMCPListToolsFailedEvent

사용 가능한 MCP 도구를 나열하지 못한 경우 내보냅니다.

Name Type Description Required Default
type enum 이벤트의 형식입니다. 항상 'response.mcp_list_tools.failed'입니다.
가능한 값: response.mcp_list_tools.failed		 Yes

OpenAI.ResponseMCPListToolsInProgressEvent

시스템이 사용 가능한 MCP 도구 목록을 검색하는 중일 때 내보내집니다.

Name Type Description Required Default
type enum 이벤트의 형식입니다. 항상 'response.mcp_list_tools.in_progress'입니다.
가능한 값: response.mcp_list_tools.in_progress		 Yes

OpenAI.ResponseOutputItemAddedEvent

새 출력 항목이 추가될 때 내보내집니다.

Name Type Description Required Default
item object 응답을 생성하는 데 사용되는 콘텐츠 항목입니다. Yes
└─ ID string No
└─ 형식 OpenAI.ItemType No
output_index integer 추가된 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.output_item.added입니다.
가능한 값: response.output_item.added		 Yes

OpenAI.ResponseOutputItemDoneEvent

출력 항목이 완료된 것으로 표시될 때 내보내집니다.

Name Type Description Required Default
item object 응답을 생성하는 데 사용되는 콘텐츠 항목입니다. Yes
└─ ID string No
└─ 형식 OpenAI.ItemType No
output_index integer 완료된 것으로 표시된 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.output_item.done입니다.
가능한 값: response.output_item.done		 Yes

OpenAI.ResponsePromptVariables

프롬프트에서 변수를 대체할 값의 선택적 맵입니다. 대체 값은 문자열이거나 이미지 또는 파일과 같은 다른 응답 입력 형식일 수 있습니다.

Type: 객체

OpenAI.ResponseQueuedEvent

응답이 큐에 대기되고 처리되기를 기다리는 경우 내보내집니다.

Name Type Description Required Default
response object Yes
└) 배경 boolean 백그라운드에서 모델 응답을 실행할지 여부입니다. No False
└─ 생성일시 integer 이 응답을 만든 시점의 Unix 타임스탬프(초)입니다. No
└) 오류 OpenAI.ResponseError 모델이 응답을 생성하지 못할 때 반환되는 오류 개체입니다. No
└─ ID string 이 응답의 고유 식별자입니다. No
└─ 불완전한 세부사항 object 응답이 불완전한 이유에 대한 세부 정보입니다. No
└) 이유 enum 응답이 불완전한 이유입니다.
가능한 값: max_output_tokenscontent_filter		 No
└) 지침 문자열 또는 배열 모델 컨텍스트에 삽입된 시스템(또는 개발자) 메시지입니다.

previous_response_id와 함께 사용할 경우 이전의 지침이 적용됩니다.
응답은 다음 응답으로 전달되지 않습니다. 이렇게 하면 간단해집니다.
새 응답에서 시스템(또는 개발자) 메시지를 교환합니다.		 No
└ 최대_출력_토큰 integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 응답에 대해 생성할 수 있는 토큰 수에 대한 상한입니다. No
└max_tool_calls integer 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 수입니다. 이 최대 수는 개별 도구가 아닌 모든 기본 제공 도구 호출에 적용됩니다. 모델에서 도구를 호출하려는 추가 시도는 무시됩니다. No
└) 메타데이터 object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
└) 개체 enum 이 리소스의 개체 유형은 항상 response로 설정됩니다.
가능한 값: response		 No
└─ 출력 array 모델에서 생성된 콘텐츠 항목의 배열입니다.

- 배열에 있는 항목의 길이와 순서가 output 종속됩니다.
모델의 응답에 따라.
- output 배열의 첫 번째 항목에 액세스하고
생성된 콘텐츠가 있는 assistant 메시지라고 가정하는 것보다
모델에서 output_text 속성을 사용하는 것을 고려해 볼 수 있습니다.
SDK에서 지원됩니다.		 No
└output_text string 집계된 텍스트 출력을 포함하는 SDK 전용 편의 속성
output_text 배열에 있는 모든 output 항목(있는 경우)에서.
Python 및 JavaScript SDK에서 지원됩니다.		 No
└parallel_tool_calls boolean 모델이 도구 호출을 병렬로 실행할 수 있도록 허용할지 여부입니다. No True
└이전_응답_아이디 string 모델에 대한 이전 응답의 고유 ID입니다. 이 기능을 사용하면
멀티 턴에 걸친 대화를 만들 수 있습니다.		 No
└) 프롬프트 OpenAI.Prompt 프롬프트 템플릿 및 해당 변수에 대한 참조입니다. No
└) 추론 OpenAI.Reasoning o 시리즈 모델만

추론 모델에 대한 구성 옵션입니다.		 No
└─ 상태 enum 응답 생성의 상태입니다. 다음 중 하나인 completed, failed
in_progress, cancelled, queued 또는 incomplete.
가능한 값: completed, failed, in_progresscancelled, queuedincomplete		 No
└> 온도 number 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 더 낮은 값을 지정하면 출력이 더욱 집중되고 결정적이게 됩니다.
일반적으로 이 항목 또는 top_p 중 하나만 변경하는 것이 좋습니다.		 No
└) 텍스트 object 모델의 텍스트 응답에 대한 구성 옵션입니다. 일반 텍스트 또는 구조화된 JSON 데이터일 수 있습니다. No
└─ 형식 OpenAI.ResponseTextFormatConfiguration No
└tool_choice OpenAI.ToolChoiceOptions 또는 OpenAI.ToolChoiceObject 모델을 생성할 때 사용할 도구(또는 도구)를 선택하는 방법
응답입니다. 도구를 지정하는 방법을 알아보려면 tools 매개 변수를 참조하세요.
모델이 호출할 수 있습니다.		 No
└도구 array 응답을 생성하는 동안 모델에서 호출할 수 있는 도구 배열입니다. You
매개 변수를 tool_choice 설정하여 사용할 도구를 지정할 수 있습니다.

모델을 제공할 수 있는 도구의 두 가지 범주는 다음과 같습니다.

- 기본 제공 도구: OpenAI에서 제공하며 기능을 확장하는 도구로,
모델의 기능.		 No
└top_logprobs integer 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. No
└ top_p number 온도를 사용한 샘플링의 대안인 핵 샘플링은
여기서 모델은 top_p 확률을 가진 토큰의 결과를 고려합니다.
대용량. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만을 의미합니다.
고려됩니다.

일반적으로 이 항목 또는 temperature 중 하나만 변경하는 것이 좋습니다.		 No
└> 잘림 enum 모델 응답에 사용할 잘림 전략입니다.
- auto: 이 응답 및 이전 응답의 컨텍스트가 초과되는 경우
모델의 컨텍스트 창 크기가 일정 수준을 초과하면 모델이 해당 부분을 잘라냅니다.
입력 항목을 삭제하여 컨텍스트 창에 맞도록 응답하기
대화 중간.
- disabled (기본값): 모델 응답이 컨텍스트 창을 초과하는 경우
모델 크기와 관련된 요청은 400 오류로 실패합니다.
가능한 값: autodisabled		 No
└) 사용량 OpenAI.ResponseUsage 입력 토큰, 출력 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다.
출력 토큰 및 사용된 총 토큰의 분석입니다.		 No
└─ 사용자 string 최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. No
type enum 이벤트의 형식입니다. 항상 'response.queued'입니다.
가능한 값: response.queued		 Yes

OpenAI.ResponseReasoningDeltaEvent

추론 콘텐츠에 대한 델타(부분 업데이트)가 있을 때 내보내집니다.

Name Type Description Required Default
content_index integer 출력 항목 내의 추론 콘텐츠 부분의 인덱스입니다. Yes
delta 추론 콘텐츠에 대한 부분 업데이트입니다. Yes
item_id string 추론이 업데이트되는 항목의 고유 식별자입니다. Yes
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 'response.reasoning.delta'입니다.
가능한 값: response.reasoning.delta		 Yes

OpenAI.ResponseReasoningDoneEvent

항목에 대한 추론 콘텐츠가 종료될 때 내보내집니다.

Name Type Description Required Default
content_index integer 출력 항목 내의 추론 콘텐츠 부분의 인덱스입니다. Yes
item_id string 추론이 완료되는 항목의 고유 식별자입니다. Yes
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다. Yes
text string 완료된 추론 텍스트입니다. Yes
type enum 이벤트의 형식입니다. 항상 'response.reasoning.done'입니다.
가능한 값: response.reasoning.done		 Yes

OpenAI.ResponseReasoningSummaryDeltaEvent

추론 요약 콘텐츠에 대한 델타(부분 업데이트)가 있을 때 내보내집니다.

Name Type Description Required Default
delta 추론 요약 콘텐츠에 대한 부분 업데이트입니다. Yes
item_id string 추론 요약이 업데이트되는 항목의 고유 식별자입니다. Yes
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다. Yes
summary_index integer 출력 항목 내의 요약 부분 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 'response.reasoning_summary.delta'입니다.
가능한 값: response.reasoning_summary.delta		 Yes

OpenAI.ResponseReasoningSummaryDoneEvent

항목에 대한 추론 요약 콘텐츠가 완료될 때 내보내집니다.

Name Type Description Required Default
item_id string 추론 요약이 완료되는 항목의 고유 식별자입니다. Yes
output_index integer 응답의 출력 배열에 있는 출력 항목의 인덱스입니다. Yes
summary_index integer 출력 항목 내의 요약 부분 인덱스입니다. Yes
text string 완료된 추론 요약 텍스트입니다. Yes
type enum 이벤트의 형식입니다. 항상 'response.reasoning_summary.done'.
가능한 값: response.reasoning_summary.done		 Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

새 추론 요약 부분이 추가될 때 내보내집니다.

Name Type Description Required Default
item_id string 이 요약 파트가 연결된 항목의 ID입니다. Yes
output_index integer 이 요약 부분이 연결된 출력 항목의 인덱스입니다. Yes
part object Yes
└─ 형식 OpenAI.ReasoningItemSummaryPartType No
summary_index integer 추론 요약 내의 요약 부분 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.reasoning_summary_part.added입니다.
가능한 값: response.reasoning_summary_part.added		 Yes

OpenAI.ResponseReasoningSummaryPartDoneEvent

추론 요약 부분이 완료될 때 내보내집니다.

Name Type Description Required Default
item_id string 이 요약 파트가 연결된 항목의 ID입니다. Yes
output_index integer 이 요약 부분이 연결된 출력 항목의 인덱스입니다. Yes
part object Yes
└─ 형식 OpenAI.ReasoningItemSummaryPartType No
summary_index integer 추론 요약 내의 요약 부분 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.reasoning_summary_part.done입니다.
가능한 값: response.reasoning_summary_part.done		 Yes

OpenAI.ResponseReasoningSummaryTextDeltaEvent

추론 요약 텍스트에 델타가 추가될 때 내보내집니다.

Name Type Description Required Default
delta string 요약에 추가된 텍스트 델타입니다. Yes
item_id string 이 요약 텍스트 델타가 연결된 항목의 ID입니다. Yes
output_index integer 이 요약 텍스트 델타와 관련된 출력 항목의 인덱스입니다. Yes
summary_index integer 추론 요약 내의 요약 부분 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.reasoning_summary_text.delta입니다.
가능한 값: response.reasoning_summary_text.delta		 Yes

OpenAI.ResponseReasoningSummaryTextDoneEvent

추론 요약 텍스트가 완료될 때 내보내집니다.

Name Type Description Required Default
item_id string 이 요약 텍스트가 연결된 항목의 ID입니다. Yes
output_index integer 이 요약 텍스트가 연결된 출력 항목의 인덱스입니다. Yes
summary_index integer 추론 요약 내의 요약 부분 인덱스입니다. Yes
text string 완료된 추론 요약의 전체 텍스트입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.reasoning_summary_text.done입니다.
가능한 값: response.reasoning_summary_text.done		 Yes

OpenAI.ResponseRefusalDeltaEvent

부분 거부 텍스트가 있을 때 내보냅니다.

Name Type Description Required Default
content_index integer 거부 텍스트가 추가되는 콘텐츠 부분의 인덱스입니다. Yes
delta string 추가되는 거부 텍스트입니다. Yes
item_id string 거부 텍스트가 추가되는 출력 항목의 ID입니다. Yes
output_index integer 거부 텍스트가 추가되는 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.refusal.delta입니다.
가능한 값: response.refusal.delta		 Yes

OpenAI.ResponseRefusalDoneEvent

거부 텍스트가 종료될 때 내보내집니다.

Name Type Description Required Default
content_index integer 거부 텍스트가 완료된 콘텐츠 부분의 인덱스입니다. Yes
item_id string 거부 텍스트가 완료된 출력 항목의 ID입니다. Yes
output_index integer 거부 텍스트가 완료된 출력 항목의 인덱스입니다. Yes
refusal string 최종 거부 텍스트입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.refusal.done입니다.
가능한 값: response.refusal.done		 Yes

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
Name Type Description Required Default
sequence_number integer 이 이벤트의 시퀀스 번호입니다. Yes
type OpenAI.ResponseStreamEventType Yes

OpenAI.ResponseStreamEventType

Property Value
Type string
Values 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

추가 텍스트 델타가 있을 때 내보냅니다.

Name Type Description Required Default
content_index integer 텍스트 델타가 추가된 콘텐츠 부분의 인덱스입니다. Yes
delta string 추가된 텍스트 델타입니다. Yes
item_id string 텍스트 델타가 추가된 출력 항목의 ID입니다. Yes
output_index integer 텍스트 델타가 추가된 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.output_text.delta입니다.
가능한 값: response.output_text.delta		 Yes

OpenAI.ResponseTextDoneEvent

텍스트 콘텐츠가 종료될 때 내보내집니다.

Name Type Description Required Default
content_index integer 텍스트 콘텐츠가 종료되는 콘텐츠 부분의 인덱스입니다. Yes
item_id string 텍스트 콘텐츠가 최종 확정된 출력 항목의 ID입니다. Yes
output_index integer 텍스트가 완성될 때의 출력 항목 인덱스입니다. Yes
text string 최종 확정된 텍스트 콘텐츠입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.output_text.done입니다.
가능한 값: response.output_text.done		 Yes

OpenAI.ResponseTextFormatConfiguration

OpenAI.ResponseTextFormatConfiguration에 대한 판별자

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
text OpenAI.ResponseTextFormatConfigurationText
json_object OpenAI.ResponseTextFormatConfigurationJsonObject
json_schema OpenAI.ResponseTextFormatConfigurationJsonSchema
Name Type Description Required Default
type OpenAI.ResponseTextFormatConfigurationType 모델이 출력해야 하는 형식을 지정하는 개체입니다.

구성 { "type": "json_schema" } 을 통해 구조적 출력을 사용할 수 있습니다.
모델이 제공된 JSON 스키마와 일치하도록 합니다. 기본 형식은 { "type": "text" } 추가 옵션이 없습니다.

gpt-4o 및 최신 모델에는 권장되지 않습니다.

{ "type": "json_object" }을 활성화하면 이전 JSON 모드를 사용할 수 있습니다.
는 모델이 생성하는 메시지가 유효한 JSON인지 확인합니다. json_schema 사용하기
지원하는 모델이 기본 설정됩니다.		 Yes

OpenAI.ResponseTextFormatConfigurationJsonObject

Name Type Description Required Default
type enum
가능한 값: json_object		 Yes

OpenAI.ResponseTextFormatConfigurationJsonSchema

JSON 스키마 응답 형식입니다. 구조적 JSON 응답을 생성하는 데 사용됩니다.

Name Type Description Required Default
description string 이 응답 형식이 모델에서 어떻게 사용되는지에 대한 설명입니다.
형식으로 응답하는 방법을 결정합니다.		 No
name string 응답 형식의 이름입니다. 최대 64자까지 가능하며,
a-z, A-Z, 0-9이거나 밑줄과 대시를 포함해야 합니다.		 Yes
schema OpenAI.ResponseFormatJsonSchemaSchema JSON 스키마 개체로 설명되는 응답 형식에 대한 스키마입니다.
여기에서 JSON 스키마를 빌드하는 방법을 알아봅니 다.		 Yes
strict boolean 출력을 생성할 때 엄격한 스키마 준수를 사용하도록 설정할지 여부입니다.
true로 설정하면 모델은 항상 정의된 정확한 스키마를 따릅니다.
schema 필드에. JSON 스키마의 하위 집합만 지원되는 경우
strict은 true입니다.		 No False
type enum 정의되는 응답 형식의 유형입니다. 항상 json_schema입니다.
가능한 값: json_schema		 Yes

OpenAI.ResponseTextFormatConfigurationText

Name Type Description Required Default
type enum
가능한 값: text		 Yes

OpenAI.ResponseTextFormatConfigurationType

모델이 출력해야 하는 형식을 지정하는 개체입니다.

구성 { "type": "json_schema" } 은 구조적 출력을 사용하도록 설정하여 모델이 제공된 JSON 스키마와 일치하도록 합니다.

기본 형식은 { "type": "text" } 추가 옵션이 없습니다.

gpt-4o 및 최신 모델에는 권장되지 않습니다.

{ "type": "json_object" } 이전 JSON 모드를 사용하도록 설정하면 모델이 생성하는 메시지가 유효한 JSON인지 확인합니다. 이를 지원하는 모델에는 사용하는 json_schema 것이 좋습니다.

Property Value
Description 모델이 출력해야 하는 형식을 지정하는 개체입니다.

구성 { "type": "json_schema" } 은 구조적 출력을 사용하도록 설정하여 모델이 제공된 JSON 스키마와 일치하도록 합니다.

기본 형식은 { "type": "text" } 추가 옵션이 없습니다.

gpt-4o 및 최신 모델에는 권장되지 않습니다.

{ "type": "json_object" } 이전 JSON 모드를 사용하도록 설정하면 모델이 생성하는 메시지가 유효한 JSON인지 확인합니다. 이를 지원하는 모델에는 사용하는 json_schema것이 좋습니다.

OpenAI.ResponseUsage

입력 토큰, 출력 토큰, 출력 토큰 분석 및 사용된 총 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다.

Name Type Description Required Default
input_tokens integer 입력 토큰의 수입니다. Yes
input_tokens_details object 입력 토큰에 대한 자세한 분석입니다. Yes
└─ 캐시된_토큰 (cached_tokens) integer 캐시에서 검색된 토큰 수입니다. No
output_tokens integer 출력 토큰의 수입니다. Yes
output_tokens_details object 출력 토큰에 대한 자세한 분석입니다. Yes
└─ 추론_토큰 integer 추론 토큰의 수입니다. No
total_tokens integer 사용된 총 토큰 수입니다. Yes

OpenAI.ResponseWebSearchCallCompletedEvent

참고: web_search 아직 Azure OpenAI를 통해 사용할 수 없습니다.

Name Type Description Required Default
item_id string 웹 검색 호출과 연결된 출력 항목의 고유 ID입니다. Yes
output_index integer 웹 검색 호출이 연결된 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.web_search_call.completed입니다.
가능한 값: response.web_search_call.completed		 Yes

OpenAI.ResponseWebSearchCallInProgressEvent

참고: web_search 아직 Azure OpenAI를 통해 사용할 수 없습니다.

Name Type Description Required Default
item_id string 웹 검색 호출과 연결된 출력 항목의 고유 ID입니다. Yes
output_index integer 웹 검색 호출이 연결된 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.web_search_call.in_progress입니다.
가능한 값: response.web_search_call.in_progress		 Yes

OpenAI.ResponseWebSearchCallSearchingEvent

참고: web_search 아직 Azure OpenAI를 통해 사용할 수 없습니다.

Name Type Description Required Default
item_id string 웹 검색 호출과 연결된 출력 항목의 고유 ID입니다. Yes
output_index integer 웹 검색 호출이 연결된 출력 항목의 인덱스입니다. Yes
type enum 이벤트의 형식입니다. 항상 response.web_search_call.searching입니다.
가능한 값: response.web_search_call.searching		 Yes

OpenAI.ResponsesAssistantMessageItemParam

역할이 있는 메시지 매개 변수 항목입니다 assistant .

Name Type Description Required Default
content array 메시지와 연결된 콘텐츠입니다. Yes
role enum 메시지의 역할은 항상 assistant입니다.
가능한 값: assistant		 Yes

OpenAI.ResponsesAssistantMessageItemResource

assistant 역할이 있는 메시지 리소스 항목입니다.

Name Type Description Required Default
content array 메시지와 연결된 콘텐츠입니다. Yes
role enum 메시지의 역할은 항상 assistant입니다.
가능한 값: assistant		 Yes

OpenAI.ResponsesDeveloperMessageItemParam

역할이 있는 메시지 매개 변수 항목입니다 developer .

Name Type Description Required Default
content array 메시지와 연결된 콘텐츠입니다. Yes
role enum 메시지의 역할은 항상 developer입니다.
가능한 값: developer		 Yes

OpenAI.ResponsesDeveloperMessageItemResource

developer 역할이 있는 메시지 리소스 항목입니다.

Name Type Description Required Default
content array 메시지와 연결된 콘텐츠입니다. Yes
role enum 메시지의 역할은 항상 developer입니다.
가능한 값: developer		 Yes

OpenAI.ResponsesMessageItemParam

클라이언트 요청 매개 변수로 제공된 역할 및 콘텐츠를 나타내는 응답 메시지 항목입니다.

OpenAI.ResponsesMessageItemParam에 대한 판별자

이 구성 요소는 속성을 role 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
user OpenAI.ResponsesUserMessageItemParam
system OpenAI.ResponsesSystemMessageItemParam
developer OpenAI.ResponsesDeveloperMessageItemParam
assistant OpenAI.ResponsesAssistantMessageItemParam
Name Type Description Required Default
role object 응답 메시지 항목에 대한 유효한 역할의 컬렉션입니다. Yes
type enum 항상 '메시지'인 응답 항목의 형식입니다.
가능한 값: message		 Yes

OpenAI.ResponsesMessageItemResource

서비스 응답에 제공된 역할 및 콘텐츠를 나타내는 응답 메시지 리소스 항목입니다.

OpenAI.ResponsesMessageItemResource에 대한 판별자

이 구성 요소는 속성을 role 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
user OpenAI.ResponsesUserMessageItemResource
system OpenAI.ResponsesSystemMessageItemResource
developer OpenAI.ResponsesDeveloperMessageItemResource
assistant OpenAI.ResponsesAssistantMessageItemResource
Name Type Description Required Default
role object 응답 메시지 항목에 대한 유효한 역할의 컬렉션입니다. Yes
status enum 항목의 상태입니다. in_progress, completed 또는 하나
incomplete; 항목이 API를 통해 반환될 때 채워집니다.
가능한 값: in_progress, completedincomplete		 Yes
type enum 항상 '메시지'인 응답 항목의 형식입니다.
가능한 값: message		 Yes

OpenAI.ResponsesMessageRole

응답 메시지 항목에 대한 유효한 역할의 컬렉션입니다.

Property Value
Description 응답 메시지 항목에 대한 유효한 역할의 컬렉션입니다.
Type string
Values system
developer
user
assistant

OpenAI.ResponsesSystemMessageItemParam

역할이 있는 메시지 매개 변수 항목입니다 system .

Name Type Description Required Default
content array 메시지와 연결된 콘텐츠입니다. Yes
role enum 메시지의 역할은 항상 system입니다.
가능한 값: system		 Yes

OpenAI.ResponsesSystemMessageItemResource

system 역할이 있는 메시지 리소스 항목입니다.

Name Type Description Required Default
content array 메시지와 연결된 콘텐츠입니다. Yes
role enum 메시지의 역할은 항상 system입니다.
가능한 값: system		 Yes

OpenAI.ResponsesUserMessageItemParam

역할이 있는 메시지 매개 변수 항목입니다 user .

Name Type Description Required Default
content array 메시지와 연결된 콘텐츠입니다. Yes
role enum 메시지의 역할은 항상 user입니다.
가능한 값: user		 Yes

OpenAI.ResponsesUserMessageItemResource

user 역할이 있는 메시지 리소스 항목입니다.

Name Type Description Required Default
content array 메시지와 연결된 콘텐츠입니다. Yes
role enum 메시지의 역할은 항상 user입니다.
가능한 값: user		 Yes

OpenAI.RunGraderRequest

Name Type Description Required Default
채점자 object 지정된 작업을 사용하여 입력과 참조 간의 문자열 비교를 수행하는 StringCheckGrader 개체입니다. Yes
└calculate_output string 채점자 결과에 따라 출력을 계산하는 수식. No
└─ 평가_기준 enum 사용할 평가 메트릭입니다. fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, 또는 rouge_l 중 하나입니다.
가능한 값: fuzzy_match,, bleu,gleumeteor, rouge_1rouge_2, rouge_3rouge_4, rouge_5rouge_l		 No
└> 채점자 object No
└image_tag string Python 스크립트에 사용할 이미지 태그입니다. No
└─ 입력 array 입력 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다. No
└─ 모델 string 평가에 사용할 모델입니다. No
└) 이름 string 등급자의 이름입니다. No
└작업 enum 수행할 문자열 검사 작업입니다. eq, ne, like 또는 ilike 중 하나입니다.
가능한 값: eq, ne, likeilike		 No
└─ 범위 array 점수의 범위입니다. 기본값은 [0, 1]입니다. No
└─ 참조 string 채점 기준이 되는 텍스트입니다. No
└─ 샘플링_파라미터 모델의 샘플링 매개 변수입니다. No
└) 원본 string Python 스크립트의 소스 코드입니다. No
└─ 형식 enum 항상 multi인 개체 형식입니다.
가능한 값: multi		 No
item 채점자에게 제공되는 데이터 세트 항목입니다. 내용을 채우기 위해 사용됩니다.
네임스페이스입니다 item .		 No
model_sample string 평가할 모델 샘플입니다. 이 값은 채우기 위해 사용됩니다.
네임스페이스입니다 sample .
output_json 모델 샘플이 인 경우 변수가 채워집니다.
유효한 JSON 문자열입니다.		 Yes

OpenAI.RunGraderResponse

Name Type Description Required Default
metadata object Yes
└) 오류 object No
└formula_parse_error boolean No
└invalid_variable_error boolean No
└ 모델_채점기_파싱_오류 boolean No
└model_grader_refusal_error boolean No
└model_grader_server_error boolean No
└─ 모델_그레이더_서버_오류_세부사항 string No
└─ 기타_오류 boolean No
└python_grader_runtime_error boolean No
└python_grader_runtime_error_details string No
└python_grader_server_error boolean No
└python_grader_server_error_type string No
└샘플_파싱_오류 (sample_parse_error) boolean No
└truncated_observation_error boolean No
└비응답_보상_오류 boolean No
└ 실행_시간 number No
└) 이름 string No
└샘플링된_모델_이름 string No
└─ 점수 No
└token_usage integer No
└─ 형식 string No
model_grader_token_usage_per_model Yes
보상 number Yes
보조_보상 Yes

OpenAI.StaticChunkingStrategy

Name Type Description Required Default
chunk_overlap_tokens integer 청크 간에 겹치는 토큰 수입니다. 기본값은 400입니다.

겹침은 max_chunk_size_tokens의 절반을 초과할 수 없습니다.		 Yes
max_chunk_size_tokens integer 각 청크의 최대 토큰 수입니다. 기본값은 800입니다. 최솟값은 100이고 최댓값은 4096입니다. Yes

OpenAI.StaticChunkingStrategyRequestParam

청크 크기와 청크 겹침을 설정하여 고유한 청크 전략을 사용자 지정합니다.

Name Type Description Required Default
정적 OpenAI.StaticChunkingStrategy Yes
type enum 항상 static입니다.
가능한 값: static		 Yes

OpenAI.StaticChunkingStrategyResponseParam

Name Type Description Required Default
정적 OpenAI.StaticChunkingStrategy Yes
type enum 항상 static입니다.
가능한 값: static		 Yes

OpenAI.StopConfiguration

최신 추론 모델 o3 및 o4-mini에서는 지원되지 않습니다.

API가 추가 토큰 생성을 중지하는 최대 4개의 시퀀스입니다. 반환된 텍스트에는 중지 시퀀스가 포함되지 않습니다.

이 스키마는 다음 형식 중 하나를 허용합니다.

  • string
  • array

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
Name Type Description Required Default
type OpenAI.ToolType 응답을 생성하는 데 사용할 수 있는 도구입니다. Yes

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
Name Type Description Required Default
type OpenAI.ToolChoiceObjectType 모델이 기본 제공 도구를 사용하여 응답을 생성해야 임을 나타냅니다. Yes

OpenAI.ToolChoiceObjectCodeInterpreter

Name Type Description Required Default
type enum
가능한 값: code_interpreter		 Yes

OpenAI.ToolChoiceObjectComputer

Name Type Description Required Default
type enum
가능한 값: computer_use_preview		 Yes

OpenAI.ToolChoiceObjectFileSearch

Name Type Description Required Default
type enum
가능한 값: file_search		 Yes

OpenAI.ToolChoiceObjectFunction

모델을 강제로 특정 함수를 호출하려면 이 옵션을 사용합니다.

Name Type Description Required Default
name string 호출할 함수의 이름입니다. Yes
type enum 함수 호출의 경우 형식은 항상 function.입니다.
가능한 값: function		 Yes

OpenAI.ToolChoiceObjectImageGen

Name Type Description Required Default
type enum
가능한 값: image_generation		 Yes

OpenAI.ToolChoiceObjectMCP

이 옵션을 사용하여 모델이 원격 MCP 서버에서 특정 도구를 호출하도록 합니다.

Name Type Description Required Default
name string 서버에서 호출할 도구의 이름입니다. No
server_label string 사용할 MCP 서버의 레이블입니다. Yes
type enum MCP 도구의 경우 형식은 항상 mcp.입니다.
가능한 값: mcp		 Yes

OpenAI.ToolChoiceObjectType

모델이 기본 제공 도구를 사용하여 응답을 생성해야 임을 나타냅니다.

Property Value
Description 모델이 기본 제공 도구를 사용하여 응답을 생성해야 임을 나타냅니다.
Type string
Values file_search
function
computer_use_preview
web_search_preview
image_generation
code_interpreter
mcp

OpenAI.ToolChoiceObjectWebSearch

참고: web_search 아직 Azure OpenAI를 통해 사용할 수 없습니다.

Name Type Description Required Default
type enum
가능한 값: web_search_preview		 Yes

OpenAI.ToolChoiceOptions

모델이 호출하는 도구(있는 경우)를 제어합니다.

none 는 모델이 도구를 호출하지 않고 대신 메시지를 생성한다는 의미입니다.

auto는 모델이 메시지 생성 또는 하나 이상의 도구 호출 중에서 선택할 수 있음을 의미합니다.

required는 모델이 하나 이상의 도구를 호출해야 함을 의미합니다.

Property Value
Description 모델이 호출하는 도구(있는 경우)를 제어합니다.

none 는 모델이 도구를 호출하지 않고 대신 메시지를 생성한다는 의미입니다.

auto 는 모델이 메시지를 생성하거나 메시지를 호출하는 중에서 선택할 수 있습니다.
더 많은 도구.

required는 모델이 하나 이상의 도구를 호출해야 함을 의미합니다.
Type string
Values none
auto
required

OpenAI.ToolType

응답을 생성하는 데 사용할 수 있는 도구입니다.

Property Value
Description 응답을 생성하는 데 사용할 수 있는 도구입니다.
Type string
Values file_search
function
computer_use_preview
web_search_preview
mcp
code_interpreter
image_generation
local_shell

OpenAI.TopLogProb

토큰의 상위 로그 확률입니다.

Name Type Description Required Default
bytes array Yes
logprob number Yes
token string Yes

OpenAI.TranscriptionAudioResponseFormat

참조: OpenAI.AudioResponseFormat

OpenAI.TranscriptionInclude

Property Value
Type string
Values logprobs

OpenAI.TranscriptionSegment

Name Type Description Required Default
avg_logprob number 세그먼트의 평균 logprob입니다. 값이 -1보다 낮은 경우 logprobs가 실패한 것으로 간주합니다. Yes
compression_ratio number 세그먼트의 압축 비율입니다. 값이 2.4보다 큰 경우 압축에 실패한 것으로 간주합니다. Yes
end number 세그먼트의 종료 시간(초)입니다. Yes
id integer 세그먼트의 고유 식별자입니다. Yes
no_speech_prob number 세그먼트에 음성이 없을 확률입니다. 값이 1.0보다 높고 avg_logprob가 -1 미만인 경우, 이 세그먼트를 무음으로 간주합니다. Yes
seek integer 세그먼트의 오프셋을 찾습니다. Yes
start number 세그먼트의 시작 시간(초)입니다. Yes
temperature number 세그먼트를 생성하는 데 사용되는 온도 매개 변수입니다. Yes
text string 세그먼트의 텍스트 콘텐츠입니다. Yes
tokens array 텍스트 콘텐츠에 대한 토큰 ID의 배열입니다. Yes

OpenAI.TranscriptionWord

Name Type Description Required Default
end number 단어의 종료 시간(초)입니다. Yes
start number 단어의 시작 시간(초)입니다. Yes
word string 단어의 텍스트 내용입니다. Yes

OpenAI.TranslationAudioResponseFormat

참조: OpenAI.AudioResponseFormat

OpenAI.UpdateVectorStoreFileAttributesRequest

Name Type Description Required Default
특성 object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다. 키는 문자열입니다.
최대 길이는 64자입니다. 값은 최대값이 있는 문자열입니다.
최대 512자, 부울 또는 숫자.		 Yes

OpenAI.UpdateVectorStoreRequest

Name Type Description Required Default
expires_after object 벡터 저장소에 대한 만료 정책입니다. No
└) 앵커 enum 만료 정책이 적용되는 앵커 타임스탬프입니다. 지원되는 앵커: last_active_at.
가능한 값: last_active_at		 No
└요일 integer 벡터 저장소가 만료되는 앵커 시간 이후의 일 수입니다. No
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 No
name string 벡터 저장소의 이름입니다. No

OpenAI.VadConfig

Name Type Description Required Default
prefix_padding_ms integer VAD가 음성을 감지하기 전에 포함할 오디오 양()
밀리초).		 No 300
silence_duration_ms integer 음성 중지를 감지하는 무음 기간(밀리초)입니다.
값이 짧으면 모델이 더 빠르게 응답합니다.
하지만 사용자가 잠깐 멈추면 개입할 수도 있습니다.		 No 200
threshold number 음성 활동 감지의 민감도 임계값(0.0~1.0)입니다. A
임계값이 높을수록 모델이 활성화되도록 더 큰 소리의 오디오가 필요하고
따라서 시끄러운 환경에서 더 나은 성능을 발휘할 수 있습니다.		 No 0.5
type enum 서버 쪽 VAD를 사용하여 수동 청크를 사용하도록 설정하려면 server_vad로 설정해야 합니다.
가능한 값: server_vad		 Yes

OpenAI.ValidateGraderRequest

Name Type Description Required Default
채점자 object 지정된 작업을 사용하여 입력과 참조 간의 문자열 비교를 수행하는 StringCheckGrader 개체입니다. Yes
└calculate_output string 채점자 결과에 따라 출력을 계산하는 수식. No
└─ 평가_기준 enum 사용할 평가 메트릭입니다. fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, 또는 rouge_l 중 하나입니다.
가능한 값: fuzzy_match,, bleu,gleumeteor, rouge_1rouge_2, rouge_3rouge_4, rouge_5rouge_l		 No
└> 채점자 object No
└image_tag string Python 스크립트에 사용할 이미지 태그입니다. No
└─ 입력 array 입력 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다. No
└─ 모델 string 평가에 사용할 모델입니다. No
└) 이름 string 등급자의 이름입니다. No
└작업 enum 수행할 문자열 검사 작업입니다. eq, ne, like 또는 ilike 중 하나입니다.
가능한 값: eq, ne, likeilike		 No
└─ 범위 array 점수의 범위입니다. 기본값은 [0, 1]입니다. No
└─ 참조 string 채점 기준이 되는 텍스트입니다. No
└─ 샘플링_파라미터 모델의 샘플링 매개 변수입니다. No
└) 원본 string Python 스크립트의 소스 코드입니다. No
└─ 형식 enum 항상 multi인 개체 형식입니다.
가능한 값: multi		 No

OpenAI.ValidateGraderResponse

Name Type Description Required Default
채점자 object 지정된 작업을 사용하여 입력과 참조 간의 문자열 비교를 수행하는 StringCheckGrader 개체입니다. No
└calculate_output string 채점자 결과에 따라 출력을 계산하는 수식. No
└─ 평가_기준 enum 사용할 평가 메트릭입니다. fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, 또는 rouge_l 중 하나입니다.
가능한 값: fuzzy_match,, bleu,gleumeteor, rouge_1rouge_2, rouge_3rouge_4, rouge_5rouge_l		 No
└> 채점자 object No
└image_tag string Python 스크립트에 사용할 이미지 태그입니다. No
└─ 입력 array 입력 텍스트입니다. 여기에는 템플릿 문자열이 포함될 수 있습니다. No
└─ 모델 string 평가에 사용할 모델입니다. No
└) 이름 string 등급자의 이름입니다. No
└작업 enum 수행할 문자열 검사 작업입니다. eq, ne, like 또는 ilike 중 하나입니다.
가능한 값: eq, ne, likeilike		 No
└─ 범위 array 점수의 범위입니다. 기본값은 [0, 1]입니다. No
└─ 참조 string 채점 기준이 되는 텍스트입니다. No
└─ 샘플링_파라미터 모델의 샘플링 매개 변수입니다. No
└) 원본 string Python 스크립트의 소스 코드입니다. No
└─ 형식 enum 항상 multi인 개체 형식입니다.
가능한 값: multi		 No

OpenAI.VectorStoreExpirationAfter

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

Name Type Description Required Default
닻 enum 만료 정책이 적용되는 앵커 타임스탬프입니다. 지원되는 앵커: last_active_at.
가능한 값: last_active_at		 Yes
days integer 벡터 저장소가 만료되는 앵커 시간 이후의 일 수입니다. Yes

OpenAI.VectorStoreFileAttributes

개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 구조화된 형식으로 개체에 대한 추가 정보를 저장하고 API 또는 대시보드를 통해 개체를 쿼리하는 데 유용할 수 있습니다. 키는 최대 길이가 64자인 문자열입니다. 값은 최대 길이가 512자이고 부울 또는 숫자인 문자열입니다.

Type: 객체

OpenAI.VectorStoreFileBatchObject

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

Name Type Description Required Default
created_at integer 벡터 저장소 파일 일괄 처리가 만들어진 시점의 Unix 타임스탬프(초)입니다. Yes
파일_개수 object Yes
└' 취소됨 integer 취소된 파일 수입니다. No
└> 완료됨 integer 처리된 파일 수입니다. No
└> 실패 integer 처리하지 못한 파일 수입니다. No
└진행 중 integer 현재 처리 중인 파일 수입니다. No
└합계 integer 총 파일 수입니다. No
id string API 엔드포인트에서 참조할 수 있는 식별자입니다. Yes
object enum 항상 vector_store.file_batch인 개체 형식입니다.
가능한 값: vector_store.files_batch		 Yes
status enum 벡터 저장소 파일 일괄 처리의 상태로, in_progress, completed, cancelled 또는 failed일 수 있습니다.
가능한 값: in_progress, completed, cancelledfailed		 Yes
벡터 저장소 ID string 파일이 연결된 벡터 저장소의 ID입니다. Yes

OpenAI.VectorStoreFileObject

벡터 저장소에 연결된 파일 목록입니다.

Name Type Description Required Default
특성 object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다. 키는 문자열입니다.
최대 길이는 64자입니다. 값은 최대값이 있는 문자열입니다.
최대 512자, 부울 또는 숫자.		 No
chunking_strategy object No
└─ 형식 enum
가능한 값: staticother		 No
created_at integer 벡터 저장소 파일이 만들어진 시점의 Unix 타임스탬프(초)입니다. Yes
id string API 엔드포인트에서 참조할 수 있는 식별자입니다. Yes
마지막_오류 object 이 벡터 저장소 파일과 연결된 마지막 오류입니다. 오류가 없으면 null이 됩니다. Yes
└) 코드 enum server_error 또는 rate_limit_exceeded중 하나입니다.
가능한 값: server_error, unsupported_fileinvalid_file		 No
└) 메시지 string 사람이 읽을 수 있는 오류 설명입니다. No
object enum 항상 vector_store.file인 개체 형식입니다.
가능한 값: vector_store.file		 Yes
status enum 벡터 저장소 파일의 상태로, in_progress, completed, cancelled 또는 failed일 수 있습니다. completed 상태는 벡터 저장소 파일을 사용할 준비가 되었음을 나타냅니다.
가능한 값: in_progress, completed, cancelledfailed		 Yes
usage_bytes integer 총 벡터 저장소 사용량(바이트)입니다. 원래 파일 크기와 다를 수 있습니다. Yes
벡터 저장소 ID string 파일이 연결된 벡터 저장소의 ID입니다. Yes

OpenAI.VectorStoreObject

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

Name Type Description Required Default
created_at integer 벡터 저장소가 만들어진 시점의 Unix 타임스탬프(초)입니다. Yes
expires_after OpenAI.VectorStoreExpirationAfter 벡터 저장소에 대한 만료 정책입니다. No
expires_at integer 벡터 저장소가 만료될 시점의 Unix 타임스탬프(초)입니다. No
파일_개수 object Yes
└' 취소됨 integer 취소된 파일 수입니다. No
└> 완료됨 integer 성공적으로 처리된 파일 수입니다. No
└> 실패 integer 처리하지 못한 파일 수입니다. No
└진행 중 integer 현재 처리 중인 파일 수입니다. No
└합계 integer 총 파일 수입니다. No
id string API 엔드포인트에서 참조할 수 있는 식별자입니다. Yes
최근 활동 시간 integer 벡터 저장소가 마지막으로 활성 상태였던 시점의 Unix 타임스탬프(초)입니다. Yes
metadata object 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 다음과 같을 수 있습니다.
구조화된 개체에 대한 추가 정보를 저장하는 데 유용합니다.
형식을 지정하고 API 또는 대시보드를 통해 개체를 쿼리합니다.

키는 최대 길이가 64자인 문자열입니다. 값은 문자열입니다.
최대 길이는 512자입니다.		 Yes
name string 벡터 저장소의 이름입니다. Yes
object enum 항상 vector_store인 개체 형식입니다.
가능한 값: vector_store		 Yes
status enum 벡터 저장소의 상태로, expired, in_progress 또는 completed일 수 있습니다. completed의 상태는 벡터 저장소를 사용할 준비가 되었음을 나타냅니다.
가능한 값: expired, in_progresscompleted		 Yes
usage_bytes integer 벡터 저장소의 파일에 사용되는 총 바이트 수입니다. Yes

OpenAI.VoiceIdsShared

Property Value
Type string
Values alloy
ash
ballad
coral
echo
fable
onyx
nova
sage
shimmer
verse

OpenAI.WebSearchAction

OpenAI.WebSearchAction에 대한 디스크리미네이터

이 구성 요소는 속성을 type 사용하여 서로 다른 형식을 구분합니다.

타입 값 Schema
find OpenAI.WebSearchActionFind
open_page OpenAI.WebSearchActionOpenPage
search OpenAI.WebSearchActionSearch
Name Type Description Required Default
type OpenAI.WebSearchActionType Yes

OpenAI.WebSearchActionFind

작업 유형 "find": 로드된 페이지 내에서 패턴을 검색합니다.

Name Type Description Required Default
패턴 string 페이지 내에서 검색할 패턴 또는 텍스트입니다. Yes
type enum 작업 형식입니다.
가능한 값: find		 Yes
url string 패턴을 검색한 페이지의 URL입니다. Yes

OpenAI.WebSearchActionOpenPage

작업 유형 "open_page" - 검색 결과에서 특정 URL을 엽니다.

Name Type Description Required Default
type enum 작업 형식입니다.
가능한 값: open_page		 Yes
url string 모델에서 연 URL입니다. Yes

OpenAI.WebSearchActionSearch

작업 유형 "search" - 웹 검색 쿼리를 수행합니다.

Name Type Description Required Default
query string 검색 쿼리. Yes
type enum 작업 형식입니다.
가능한 값: search		 Yes

OpenAI.WebSearchActionType

Property Value
Type string
Values search
open_page
find

OpenAI.WebSearchPreviewTool

참고: web_search 아직 Azure OpenAI를 통해 사용할 수 없습니다.

Name Type Description Required Default
search_context_size enum 검색에 사용할 컨텍스트 창 공간의 양에 대한 높은 수준의 지침입니다. low, medium 또는 high 중 하나입니다. medium 기본값입니다.
가능한 값: low, mediumhigh		 No
type enum 웹 검색 도구의 형식입니다. web_search_preview 또는 web_search_preview_2025_03_11중 하나입니다.
가능한 값: web_search_preview		 Yes
user_location object No
└─ 형식 OpenAI.LocationType No

OpenAI.WebSearchToolCallItemParam

참고: web_search 아직 Azure OpenAI를 통해 사용할 수 없습니다.

Name Type Description Required Default
action object Yes
└─ 형식 OpenAI.WebSearchActionType No
type enum
가능한 값: web_search_call		 Yes

OpenAI.WebSearchToolCallItemResource

참고: web_search 아직 Azure OpenAI를 통해 사용할 수 없습니다.

Name Type Description Required Default
action object Yes
└─ 형식 OpenAI.WebSearchActionType No
status enum 웹 검색 도구 호출의 상태입니다.
가능한 값: in_progress, searching, completedfailed		 Yes
type enum
가능한 값: web_search_call		 Yes

PineconeChatDataSource

Name Type Description Required Default
parameters object Pinecone 데이터 원본의 사용을 제어하는 매개 변수 정보입니다. Yes
└─ 부분 결과 허용 boolean true로 설정하면 시스템에서 부분 검색 결과를 사용할 수 있으며 모든 검색 결과가 있으면 요청이 실패합니다.
부분 쿼리가 실패합니다. 지정하지 않거나 false로 지정하면 검색 쿼리가 실패할 경우 요청이 실패합니다.		 No False
└) 인증 object No
└) 키 string No
└─ 형식 enum
가능한 값: api_key		 No
└ 임베딩_종속성 object 데이터 원본을 포함하는 리소스로 사용할 수 있는 데이터 벡터화 원본의 표현입니다. No
└─ 형식 AzureChatDataSourceVectorizationSourceType 구체적인 벡터화 원본에 대한 구분 식별자입니다. No
└) 환경 string Pinecone에서 사용할 환경 이름입니다. No
└fields_mapping object Pinecone 데이터 원본에서 사용하는 데이터에 적용할 필드 매핑입니다.
Pinecone에는 콘텐츠 필드 매핑이 필요합니다.		 No
└content_fields array No
└content_fields_separator string No
└filepath_field string No
└title_field string No
└url_field string No
└in_scope boolean 쿼리를 인덱싱된 데이터의 사용으로 제한해야 하는지 여부입니다. No
└include_contexts array 응답에 포함할 출력 컨텍스트 속성입니다.
기본적으로 인용 및 의도가 요청됩니다.		 No ['인용', '의도']
└index_name string 사용할 Pinecone 데이터베이스 인덱스의 이름입니다. No
└max_search_queries integer 단일 사용자 메시지에 대해 검색 공급자에게 보내야 하는 재작성된 쿼리의 최대 수입니다.
기본적으로 시스템은 자동으로 결정합니다.		 No
└) 엄격함 integer 검색 관련성 필터링의 구성된 엄격성입니다.
높은 엄격성은 답변의 정확도를 증가시키지만, 재현율은 낮아집니다.		 No
└top_n_documents integer 쿼리에 기능할 구성된 문서 수입니다. No
type enum 항상 'pinecone'인 구별된 형식 식별자입니다.
가능한 값: pinecone		 Yes

Quality

검색할 비디오 콘텐츠의 품질입니다. 반환해야 하는 비디오 콘텐츠의 품질을 지정합니다.

Property Value
Description 검색할 비디오 콘텐츠의 품질입니다.
반환해야 하는 비디오 콘텐츠의 품질을 지정합니다.
Type string
Values high
low

ResponseFormatJSONSchemaRequest

Name Type Description Required Default
json_schema object 응답 형식에 대한 JSON 스키마 Yes
type enum 응답 형식 유형
가능한 값: json_schema		 Yes

ResponseModalities

모델이 생성하도록 할 출력 형식. 대부분의 모델은 기본값인 텍스트를 생성할 수 있습니다.

["text"]

gpt-4o-audio-preview 모델을 사용하여 오디오를 생성할 수도 있습니다. 이 모델이 텍스트 및 오디오 응답을 모두 생성하도록 요청하려면 다음을 사용할 수 있습니다.

["text", "audio"]

배열: 문자열

SpeechGenerationResponseFormat

텍스트 음성 변환에 지원되는 오디오 출력 형식입니다.

이 구성 요소는 다음 중 하나일 수 있습니다.

VideoGeneration

비디오 생성 결과입니다.

Name Type Description Required Default
created_at integer 비디오가 생성된 시간입니다. Yes
height integer 비디오의 높이입니다. Yes
id string 비디오 생성의 ID입니다. Yes
job_id string 이 비디오에 대한 비디오 생성 작업의 ID입니다. Yes
n_seconds integer 비디오 생성 기간입니다. Yes
object enum
가능한 값: video.generation		 Yes
prompt string 이 비디오 생성을 위한 프롬프트입니다. Yes
width integer 비디오의 너비입니다. Yes

VideoGenerationJob

비디오 생성 작업입니다.

Name Type Description Required Default
created_at integer 작업이 생성된 시점입니다. Yes
expires_at integer 서비스에서 작업이 자동으로 삭제되는 시간입니다. 데이터 손실을 방지하려면 이 날짜 이전에 작업의 비디오 콘텐츠와 메타데이터를 저장해야 합니다. No
failure_reason string(아래 유효한 모델 참조) No
finished_at integer 모든 비디오 세대의 작업이 완료된 시간입니다. No
generations array 이 작업에 대해 생성된 비디오입니다. 이 숫자는 주어진 n_variants와 세대 생성 성공률에 따라 달라집니다. No
height integer 비디오의 높이입니다. Yes
id string 작업의 ID입니다. Yes
inpaint_items array 이 동영상 생성 작업을 위한 선택적 페인팅 항목. No
model string 이 비디오 생성 작업에 사용할 배포의 이름입니다. Yes
n_seconds integer 비디오 생성 작업의 기간입니다. Yes
n_variants integer 이 비디오 생성 작업의 변형으로 만들 비디오 수입니다. Yes
object enum
가능한 값: video.generation.job		 Yes
prompt string 이 비디오 생성 작업에 대한 프롬프트입니다. Yes
status object 비디오 생성 작업의 상태입니다. Yes
width integer 비디오의 높이입니다. Yes

VideoGenerationJobList

비디오 생성 작업 목록입니다.

Name Type Description Required Default
data array 비디오 생성 작업 목록입니다. Yes
first_id string 사용 가능한 경우 현재 페이지에서 첫 번째 작업의 ID입니다. No
has_more boolean 목록 이후에 사용할 수 있는 작업이 더 있는지 여부를 나타내는 플래그입니다. Yes
last_id string 현재 페이지의 마지막 작업 ID(사용 가능한 경우)입니다. No
object enum
가능한 값: list		 Yes

다음 단계

모델 및 REST API를 사용한 미세 조정에 대해 알아보세요. Azure OpenAI를 지원하는 기본 모델에 대해 자세히 알아봅니다.