Azure OpenAI Service REST API 미리 보기 참조
이 문서에서는 Azure OpenAI에 대한 유추 REST API 엔드포인트에 대한 세부 정보를 제공합니다.
API 사양
Azure OpenAI 모델 및 리소스 관리 및 상호 작용은 다음 세 가지 기본 API 화면으로 구분됩니다.
- 제어 평면
- 데이터 평면 - 작성
- 데이터 평면 - 유추
각 API 화면/사양은 다른 Azure OpenAI 기능 집합을 캡슐화합니다. 각 API에는 고유한 미리 보기 집합과 안정적인/GA(일반 공급) API 릴리스가 있습니다. 현재 미리 보기 릴리스는 월별 주기를 따르는 경향이 있습니다.
| API | 최신 미리 보기 릴리스 | 최신 GA 릴리스 | 사양 | 설명 |
|---|---|---|---|---|
| 제어 평면 | 2024-06-01-preview |
2023-05-01 |
사양 파일 | Azure OpenAI는 다른 모든 Azure AI Service와 공통 컨트롤 플레인을 공유합니다. 컨트롤 플레인 API는 Azure OpenAI 리소스 만들기, 모델 배포 및 기타 상위 수준 리소스 관리 작업 등에 사용됩니다. 또한 컨트롤 플레인은 Azure Resource Manager, Bicep, Terraform 및 Azure CLI와 같은 기능으로 수행할 수 있는 작업을 제어합니다. |
| 데이터 평면 - 작성 | 2024-10-01-preview |
2024-06-01 |
사양 파일 | 데이터 평면 작성 API는 미세 조정, 파일 업로드, 수집 작업, 일괄 처리, 특정 모델 수준 쿼리를 제어합니다. |
| 데이터 평면 - 유추 | 2024-10-01-preview |
2024-06-01 |
사양 파일 | 데이터 평면 유추 API는 완성, 채팅 완성, 포함, 음성/위스퍼, 데이터, Dall-e, 도우미 등과 같은 기능에 대한 유추 기능/엔드포인트를 제공합니다. |
인증
Azure OpenAI는 두 가지 인증 방법을 제공합니다. API 키 또는 Microsoft Entra ID를 사용할 수 있습니다.
API 키 인증: 이 인증 형식의 경우 모든 API 요청은
api-keyHTTP 헤더에 API 키를 포함해야 합니다. 빠른 시작은 이러한 형식의 인증으로 전화를 거는 방법에 대한 지침을 제공합니다.Microsoft Entra ID 인증: Microsoft Entra 토큰을 사용하여 API 호출을 인증할 수 있습니다. 인증 토큰은 요청에
Authorization헤더로 포함됩니다. 제공된 토큰은Bearer가 앞에 와야 합니다(예:Bearer YOUR_AUTH_TOKEN). Microsoft Entra ID로 인증하는 방법 가이드를 읽을 수 있습니다.
REST API 버전 관리
서비스 API는 api-version 쿼리 매개 변수를 사용하여 버전이 지정됩니다. 모든 버전은 YYYY-MM-DD 날짜 구조를 따릅니다. 예시:
POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01
데이터 평면 유추
이 문서의 나머지 부분에서는 Azure OpenAI 데이터 평면 유추 사양 2024-10-01-preview의 최신 미리 보기 릴리스에 대해 설명합니다. 이 문서에는 도우미, 스레드 및 벡터 저장소와 같은 최신 미리 보기 기능에 대한 설명서가 포함되어 있습니다.
최신 GA API 릴리스에 대한 설명서를 찾는 경우 최신 GA 데이터 평면 유추 API를 참조하세요.
완성 - 만들기
POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-01-preview
제공된 프롬프트, 매개 변수 및 선택한 모델에 대한 완성을 만듭니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| deployment-id | 경로 | 예 | string | 배포된 모델의 배포 ID입니다. |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
Content-Type: application/json
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| prompt | 문자열 또는 배열 | 문자열, 문자열 배열, 토큰 배열 또는 토큰 배열의 배열로 인코딩된 완료를 생성하라는 프롬프트. <|endoftext|>는 학습 중에 모델이 보는 문서 구분 기호이므로 프롬프트가 지정되지 않은 경우 모델은 새 문서의 시작 부분에서 생성되는 것처럼 생성됩니다. |
예 | |
| best_of | 정수 | 서버 쪽에서 best_of 완료를 생성하고 "최상"(토큰당 로그 확률이 가장 높은 것)을 반환합니다. 결과를 스트리밍할 수 없습니다.n과 함께 사용하면 best_of는 후보 완료 횟수를 제어하고 n은 반환할 횟수를 지정합니다. best_of는 n보다 커야 합니다.참고: 이 매개 변수는 많은 완료를 생성하므로 토큰 할당량을 빠르게 소모할 수 있습니다. 신중하게 사용하고 max_tokens 및 stop에 대한 설정이 적절한지 확인합니다. |
아니요 | 1 |
| echo | 부울 값 | 완료와 함께 프롬프트를 다시 에코합니다. |
아니요 | False |
| frequency_penalty | number | -2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트의 기존 빈도를 기반으로 새 토큰에 불이익을 주어 모델이 동일한 줄을 그대로 반복할 가능성을 줄입니다. |
아니요 | 0 |
| logit_bias | 개체 | 완료 시 지정된 토큰이 나타날 가능성을 수정합니다. 토큰(GPT 토크나이저에서 토큰 ID로 지정)을 -100에서 100 사이의 관련 바이어스 값에 매핑하는 JSON 개체를 허용합니다. 수학적으로, 바이어스는 샘플링 전에 모델에 의해 생성된 로짓에 추가됩니다. 정확한 효과는 모델마다 다르지만 -1과 1 사이의 값은 선택 가능성을 줄이거나 높여야 합니다. -100 또는 100과 같은 값은 관련 토큰을 금지하거나 독점적으로 선택해야 합니다. 예를 들어, {"50256": -100}을 전달하면 <|endoftext|> 토큰이 생성되지 않습니다. |
아니요 | None |
| 로그 문제 | 정수 | 가장 가능성이 높은 logprobs 출력 토큰과 선택한 토큰에 대한 로그 확률을 포함합니다. 예를 들어 5인 경우 logprobs API는 가장 가능성이 큰 5개의 토큰 목록을 반환합니다. API는 항상 샘플링된 토큰을 반환 logprob 하므로 응답에 최대 logprobs+1 요소가 있을 수 있습니다.logprobs의 최댓값은 5입니다. |
아니요 | None |
| max_tokens | 정수 | 완료 시 생성할 수 있는 최대 토큰 수입니다. 프롬프트의 토큰 수에 max_tokens를 더한 값은 모델의 컨텍스트 길이를 초과할 수 없습니다. |
아니요 | 16 |
| n | 정수 | 각 프롬프트에 대해 생성할 완료 수입니다. 참고: 이 매개 변수는 많은 완료를 생성하므로 토큰 할당량을 빠르게 소모할 수 있습니다. 신중하게 사용하고 max_tokens 및 stop에 대한 설정이 적절한지 확인합니다. |
아니요 | 1 |
| presence_penalty | number | -2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트에 나타나는지 여부에 따라 새 토큰에 페널티를 부여하여 모델이 새 항목에 대해 이야기할 가능성을 높입니다. |
아니요 | 0 |
| seed | 정수 | 지정된 경우 시스템은 결정론적으로 샘플링하기 위해 최선을 다하므로 동일한 seed 및 매개 변수를 사용하는 반복 요청이 동일한 결과를 반환해야 합니다.결정성은 보장되지 않으며 백 엔드의 변경 내용을 모니터링하려면 system_fingerprint 응답 매개 변수를 참조해야 합니다. |
아니요 | |
| stop | 문자열 또는 배열 | API가 추가 토큰 생성을 중지하는 최대 4개의 시퀀스입니다. 반환된 텍스트에는 중지 시퀀스가 포함되지 않습니다. |
아니요 | |
| stream | 부울 값 | 부분 진행률을 다시 스트리밍할지 여부를 나타냅니다. 설정된 경우 토큰은 데이터 전용 서버 전송 이벤트로 전송되며 스트림은 data: [DONE] 메시지로 종료됩니다." |
아니요 | False |
| 접미사 | string | 삽입된 텍스트가 완료된 뒤에 오는 접미사입니다. 이 매개 변수는 gpt-3.5-turbo-instruct에만 지원됩니다. |
아니요 | None |
| 온도 | 번호 | 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. 일반적으로 이를 변경하거나 top_p을(를) 변경하는 것이 좋지만 둘 다 변경하지는 않는 것이 좋습니다. |
아니요 | 1 |
| top_p | 번호 | 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 temperature을(를) 변경하는 것이 좋지만 둘 다 변경하지는 않는 것이 좋습니다. |
아니요 | 1 |
| user | string | 남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다. |
아니요 |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | createCompletionResponse | API의 완료 응답을 나타냅니다. 참고: 스트리밍된 응답 개체와 비스트림 응답 개체는 채팅 엔드포인트와 달리 동일한 셰이프를 공유합니다. |
상태 코드: 기본값
설명: 서비스를 사용할 수 없음
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | errorResponse |
예제
예시
제공된 프롬프트, 매개 변수 및 선택한 모델에 대한 완성을 만듭니다.
POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-01-preview
{
"prompt": [
"tell me a joke about mango"
],
"max_tokens": 32,
"temperature": 1.0,
"n": 1
}
응답: 상태 코드: 200
{
"body": {
"id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
"created": 1686617332,
"choices": [
{
"text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
"index": 0,
"finish_reason": "stop",
"logprobs": null
}
],
"usage": {
"completion_tokens": 20,
"prompt_tokens": 6,
"total_tokens": 26
}
}
}
포함 - 만들기
POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-01-preview
기계 학습 모델 및 알고리즘에서 쉽게 사용할 수 있는 지정된 입력의 벡터 표현을 가져옵니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| deployment-id | 경로 | 예 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
Content-Type: application/json
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| input | 문자열 또는 배열 | 문자열 또는 토큰 배열로 인코딩된 포함할 텍스트를 입력합니다. 단일 요청에 여러 입력을 포함하려면 문자열의 배열 또는 토큰 배열의 배열을 전달합니다. 입력은 모델의 최대 입력 토큰(8,192개 text-embedding-ada-002토큰)을 초과해서는 안 되며, 빈 문자열일 수 없으며 배열은 2,048차원 이하여야 합니다. |
예 | |
| user | string | 최종 사용자를 나타내는 고유 식별자로, 남용을 모니터링하고 감지하는 데 도움이 됩니다. | 아니요 | |
| input_type | string | 사용할 포함 검색의 입력 형식 | 아니요 | |
| encoding_format | string | 포함을 반환할 형식입니다. float 또는 base64 중 하나일 수 있습니다. 기본값은 float입니다. |
아니요 | |
| dimensions | 정수 | 결과 출력 포함에 있어야 하는 차원의 수입니다. text-embedding-3 이상 모델에서만 지원됩니다. |
아니요 |
응답
| 이름 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 개체 | string | 예 | ||
| model | string | 예 | ||
| 데이터 | 배열 | 예 | ||
| 사용량 | 개체 | 예 |
usage의 속성
prompt_tokens
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| prompt_tokens | 정수 |
total_tokens
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| total_tokens | 정수 |
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | 개체 |
예제
예시
지정된 프롬프트에 대한 포함을 반환합니다.
POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-01-preview
{
"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
]
}
],
"usage": {
"prompt_tokens": 4,
"total_tokens": 4
}
}
}
채팅 완성 - 만들기
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-01-preview
채팅 메시지에 대한 완성을 만듭니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| deployment-id | 경로 | 예 | string | 배포된 모델의 배포 ID입니다. |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
Content-Type: application/json
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 온도 | 번호 | 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. 일반적으로 이를 변경하거나 top_p을(를) 변경하는 것이 좋지만 둘 다 변경하지는 않는 것이 좋습니다. |
아니요 | 1 |
| top_p | 번호 | 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 temperature을(를) 변경하는 것이 좋지만 둘 다 변경하지는 않는 것이 좋습니다. |
아니요 | 1 |
| stream | 부울 값 | 설정되면 ChatGPT의 경우처럼 부분 메시지 델타가 전송됩니다. 토큰은 데이터 전용 서버 전송 이벤트로 전송되며 스트림은 data: [DONE] 메시지로 종료됩니다. |
아니요 | False |
| stop | 문자열 또는 배열 | API가 추가 토큰 생성을 중지하는 최대 4개의 시퀀스입니다. |
아니요 | |
| max_tokens | 정수 | 채팅 완료 시 생성할 수 있는 최대 토큰 수입니다. 입력 토큰과 생성된 토큰의 총 길이는 모델의 컨텍스트 길이에 따라 제한됩니다. |
아니요 | |
| max_completion_tokens | 정수 | 표시되는 출력 토큰 및 추론 토큰을 포함하여 완료를 위해 생성할 수 있는 토큰 수에 대한 상한입니다. o1 시리즈 모델에서만 지원됩니다. 향후 API 릴리스에서 다른 모델로 지원을 확장합니다. | 아니요 | |
| presence_penalty | number | -2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트에 나타나는지 여부에 따라 새 토큰에 페널티를 부여하여 모델이 새 항목에 대해 이야기할 가능성을 높입니다. |
아니요 | 0 |
| frequency_penalty | number | -2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트의 기존 빈도를 기반으로 새 토큰에 불이익을 주어 모델이 동일한 줄을 그대로 반복할 가능성을 줄입니다. |
아니요 | 0 |
| logit_bias | 개체 | 완료 시 지정된 토큰이 나타날 가능성을 수정합니다. 토큰(토크나이저에서 토큰 ID로 지정)을 -100에서 100 사이의 관련 바이어스 값에 매핑하는 JSON 개체를 허용합니다. 수학적으로, 바이어스는 샘플링 전에 모델에 의해 생성된 로짓에 추가됩니다. 정확한 효과는 모델마다 다르지만 -1과 1 사이의 값은 선택 가능성을 줄이거나 높여야 합니다. -100 또는 100과 같은 값은 관련 토큰을 금지하거나 독점적으로 선택해야 합니다. |
아니요 | None |
| user | string | 남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다. |
아니요 | |
| messages | 배열 | 지금까지의 대화를 구성하는 메시지 목록입니다. | 예 | |
| data_sources | 배열 | 이를 사용하는 Azure OpenAI 채팅 확장에 대한 구성 항목입니다. 이 추가 사양은 Azure OpenAI와만 호환됩니다. |
아니요 | |
| 로그 문제 | 부울 값 | 출력 토큰의 로그 확률을 반환할지 여부를 나타냅니다. true인 경우 message의 content에 반환된 각 출력 토큰의 로그 확률을 반환합니다. |
아니요 | False |
| top_logprobs | 정수 | 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. 이 매개 변수를 사용하는 경우 logprobs를 true로 설정해야 합니다. |
아니요 | |
| n | 정수 | 각 입력 메시지에 대해 생성할 채팅 완료 선택 항목 수입니다. 모든 선택 항목에 걸쳐 생성된 토큰 수에 따라 요금이 부과됩니다. 비용을 최소화하려면 n을 1로 유지합니다. |
아니요 | 1 |
| parallel_tool_calls | ParallelToolCalls | 도구를 사용하는 동안 병렬 함수 호출을 사용하도록 설정할지 여부입니다. | 아니요 | True |
| response_format | ResponseFormatText, ResponseFormatJsonObject 또는 ResponseFormatJsonSchema | 모델이 출력해야 하는 형식을 지정하는 개체입니다. GPT-4o, GPT-4o mini, GPT-4 Turbo 및 모든 GPT-3.5 Turbo 모델과 호환됩니다gpt-3.5-turbo-1106.{ "type": "json_schema", "json_schema": {...} }로 설정하면 구조화된 출력이 사용하도록 설정되어 모델이 제공된 JSON 스키마와 일치함이 보장됩니다.{ "type": "json_object" }(으)로 설정하면 모델이 생성하는 메시지가 유효한 JSON임을 보장하는 JSON 모드가 사용하도록 설정됩니다.중요: JSON 모드를 사용하는 경우 시스템 또는 사용자 메시지를 통해 직접 JSON을 생성하도록 모델에 지시해야 합니다. 이렇게 하지 않으면 생성이 토큰 제한에 도달할 때까지 모델은 공백의 끝없는 스트림을 생성하여 장기 실행되고 겉보기에 "중단" 요청이 발생할 수 있습니다. 또한 생성이 max_tokens을(를) 초과했거나 대화가 최대 컨텍스트 길이를 초과했음을 나타내는 finish_reason="length"인 경우 메시지 콘텐츠가 부분적으로 잘릴 수 있습니다. |
아니요 | |
| seed | 정수 | 이 기능은 베타 버전으로 제공됩니다. 지정된 경우 시스템은 결정론적으로 샘플링하기 위해 최선을 다하므로 동일한 seed 및 매개 변수를 사용하는 반복 요청이 동일한 결과를 반환해야 합니다.결정성은 보장되지 않으며 백 엔드의 변경 내용을 모니터링하려면 system_fingerprint 응답 매개 변수를 참조해야 합니다. |
아니요 | |
| stream_options | chatCompletionStreamOptions | 스트리밍 응답에 대한 옵션입니다. 설정할 stream: true때만 설정합니다. |
아니요 | None |
| tools | 배열 | 모델이 호출할 수 있는 도구 목록입니다. 현재 함수만 도구로 지원됩니다. 모델이 JSON 입력을 생성할 수 있는 함수 목록을 제공하려면 이를 사용합니다. 최대 128개의 함수가 지원됩니다. |
아니요 | |
| tool_choice | chatCompletionToolChoiceOption | 모델이 호출하는 도구(있는 경우)를 제어합니다. none은(는) 모델이 도구를 호출하지 않고 대신 메시지를 생성함을 의미합니다. auto은(는) 모델이 메시지 생성 또는 하나 이상의 도구 호출 중에서 선택할 수 있음을 의미합니다. required은(는) 모델이 하나 이상의 도구를 호출해야 함을 의미합니다. {"type": "function", "function": {"name": "my_function"}}을 사용하여 특정 도구를 지정하면 모델이 해당 도구를 강제 호출하게 됩니다. none은(는) 도구가 없는 경우 기본값입니다. auto은(는) 도구가 있는 경우 기본값입니다. |
아니요 | |
| function_call | 문자열 또는 chatCompletionFunctionCallOption | tool_choice에는 더 이상 사용되지 않습니다.모델에서 호출되는 함수(해당하는 경우)를 제어합니다. none은 모델이 함수를 호출하지 않고 대신 메시지를 생성함을 의미합니다.auto는 모델이 메시지 생성 또는 함수 호출 중에서 선택할 수 있음을 의미합니다.{"name": "my_function"}을 통해 특정 함수를 지정하면 모델이 해당 함수를 호출하게 됩니다.함수가 없을 경우 none이 기본값입니다. 함수가 있는 경우 auto가 기본값입니다. |
아니요 | |
| functions | 배열 | tools을(를) 위해 사용되지 않습니다.모델이 JSON 입력을 생성할 수 있는 함수 목록입니다. |
아니요 |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | createChatCompletionResponse 또는 createChatCompletionStreamResponse |
상태 코드: 기본값
설명: 서비스를 사용할 수 없음
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | errorResponse |
예제
예시
제공된 프롬프트, 매개 변수 및 선택한 모델에 대한 완성을 만듭니다.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-01-preview
{
"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? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
}
}
],
"usage": {
"completion_tokens": 557,
"prompt_tokens": 33,
"total_tokens": 590
}
}
}
예시
Azure Search 데이터 및 시스템 할당 관리 ID를 기준으로 완성을 만듭니다.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-01-preview
{
"messages": [
{
"role": "user",
"content": "can you tell me how to care for a dog?"
}
],
"data_sources": [
{
"type": "azure_search",
"parameters": {
"endpoint": "https://your-search-endpoint.search.windows.net/",
"index_name": "{index name}",
"authentication": {
"type": "system_assigned_managed_identity"
}
}
}
]
}
응답: 상태 코드: 200
{
"body": {
"id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
"created": 1686676106,
"choices": [
{
"index": 0,
"finish_reason": "stop",
"message": {
"role": "assistant",
"content": "Content of the completion [doc1].",
"context": {
"citations": [
{
"content": "Citation content.",
"title": "Citation Title",
"filepath": "contoso.txt",
"url": "https://contoso.blob.windows.net/container/contoso.txt",
"chunk_id": "0"
}
],
"intent": "dog care"
}
}
}
],
"usage": {
"completion_tokens": 557,
"prompt_tokens": 33,
"total_tokens": 590
}
}
}
예시
Azure Search 이미지 벡터 데이터를 기준으로 완성을 만듭니다.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-01-preview
{
"messages": [
{
"role": "user",
"content": "can you tell me how to care for a dog?"
}
],
"data_sources": [
{
"type": "azure_search",
"parameters": {
"endpoint": "https://your-search-endpoint.search.windows.net/",
"index_name": "{index name}",
"query_type": "vector",
"fields_mapping": {
"image_vector_fields": [
"image_vector"
]
},
"authentication": {
"type": "api_key",
"key": "{api key}"
}
}
}
]
}
응답: 상태 코드: 200
{
"body": {
"id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
"created": 1686676106,
"choices": [
{
"index": 0,
"finish_reason": "stop",
"message": {
"role": "assistant",
"content": "Content of the completion."
}
}
],
"usage": {
"completion_tokens": 557,
"prompt_tokens": 33,
"total_tokens": 590
}
}
}
예시
Azure Search 벡터 데이터, 이전 도우미 메시지 및 사용자 할당 관리 ID를 기준으로 완성을 만듭니다.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-01-preview
{
"messages": [
{
"role": "user",
"content": "can you tell me how to care for a cat?"
},
{
"role": "assistant",
"content": "Content of the completion [doc1].",
"context": {
"intent": "cat care"
}
},
{
"role": "user",
"content": "how about dog?"
}
],
"data_sources": [
{
"type": "azure_search",
"parameters": {
"endpoint": "https://your-search-endpoint.search.windows.net/",
"authentication": {
"type": "user_assigned_managed_identity",
"managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
},
"index_name": "{index name}",
"query_type": "vector",
"embedding_dependency": {
"type": "deployment_name",
"deployment_name": "{embedding deployment name}"
},
"in_scope": true,
"top_n_documents": 5,
"strictness": 3,
"role_information": "You are an AI assistant that helps people find information.",
"fields_mapping": {
"content_fields_separator": "\\n",
"content_fields": [
"content"
],
"filepath_field": "filepath",
"title_field": "title",
"url_field": "url",
"vector_fields": [
"contentvector"
]
}
}
}
]
}
응답: 상태 코드: 200
{
"body": {
"id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
"created": 1686676106,
"choices": [
{
"index": 0,
"finish_reason": "stop",
"message": {
"role": "assistant",
"content": "Content of the completion [doc1].",
"context": {
"citations": [
{
"content": "Citation content 2.",
"title": "Citation Title 2",
"filepath": "contoso2.txt",
"url": "https://contoso.blob.windows.net/container/contoso2.txt",
"chunk_id": "0"
}
],
"intent": "dog care"
}
}
}
],
"usage": {
"completion_tokens": 557,
"prompt_tokens": 33,
"total_tokens": 590
}
}
}
예시
제공된 Azure Cosmos DB에 대한 완성을 만듭니다.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-01-preview
{
"messages": [
{
"role": "user",
"content": "can you tell me how to care for a dog?"
}
],
"data_sources": [
{
"type": "azure_cosmos_db",
"parameters": {
"authentication": {
"type": "connection_string",
"connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
},
"database_name": "vectordb",
"container_name": "azuredocs",
"index_name": "azuredocindex",
"embedding_dependency": {
"type": "deployment_name",
"deployment_name": "{embedding deployment name}"
},
"fields_mapping": {
"content_fields": [
"content"
],
"vector_fields": [
"contentvector"
]
}
}
}
]
}
응답: 상태 코드: 200
{
"body": {
"id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
"created": 1686676106,
"choices": [
{
"index": 0,
"finish_reason": "stop",
"message": {
"role": "assistant",
"content": "Content of the completion [doc1].",
"context": {
"citations": [
{
"content": "Citation content.",
"title": "Citation Title",
"filepath": "contoso.txt",
"url": "https://contoso.blob.windows.net/container/contoso.txt",
"chunk_id": "0"
}
],
"intent": "dog care"
}
}
}
],
"usage": {
"completion_tokens": 557,
"prompt_tokens": 33,
"total_tokens": 590
}
}
}
예시
제공된 Mongo DB에 대한 완료를 만듭니다.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-01-preview
{
"messages": [
{
"role": "user",
"content": "can you tell me how to care for a dog?"
}
],
"data_sources": [
{
"type": "mongo_db",
"parameters": {
"authentication": {
"type": "username_and_password",
"username": "<username>",
"password": "<password>"
},
"endpoint": "<endpoint_name>",
"app_name": "<application name>",
"database_name": "sampledb",
"collection_name": "samplecollection",
"index_name": "sampleindex",
"embedding_dependency": {
"type": "deployment_name",
"deployment_name": "{embedding deployment name}"
},
"fields_mapping": {
"content_fields": [
"content"
],
"vector_fields": [
"contentvector"
]
}
}
}
]
}
응답: 상태 코드: 200
{
"body": {
"id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
"created": 1686676106,
"choices": [
{
"index": 0,
"finish_reason": "stop",
"message": {
"role": "assistant",
"content": "Content of the completion [doc1].",
"context": {
"citations": [
{
"content": "Citation content.",
"title": "Citation Title",
"filepath": "contoso.txt",
"url": "https://contoso.blob.windows.net/container/contoso.txt",
"chunk_id": "0"
}
],
"intent": "dog care"
}
}
}
],
"usage": {
"completion_tokens": 557,
"prompt_tokens": 33,
"total_tokens": 590
}
}
}
예시
제공된 Elasticsearch에 대한 완성을 만듭니다.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-01-preview
{
"messages": [
{
"role": "user",
"content": "can you tell me how to care for a dog?"
}
],
"data_sources": [
{
"type": "elasticsearch",
"parameters": {
"endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
"index_name": "{index name}",
"authentication": {
"type": "key_and_key_id",
"key": "{key}",
"key_id": "{key id}"
}
}
}
]
}
응답: 상태 코드: 200
{
"body": {
"id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
"created": 1686676106,
"choices": [
{
"index": 0,
"finish_reason": "stop",
"message": {
"role": "assistant",
"content": "Content of the completion [doc1].",
"context": {
"citations": [
{
"content": "Citation content.",
"title": "Citation Title",
"filepath": "contoso.txt",
"url": "https://contoso.blob.windows.net/container/contoso.txt",
"chunk_id": "0"
}
],
"intent": "dog care"
}
}
}
],
"usage": {
"completion_tokens": 557,
"prompt_tokens": 33,
"total_tokens": 590
}
}
}
예시
제공된 Pinecone 리소스에 대한 완성을 만듭니다.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-01-preview
{
"messages": [
{
"role": "user",
"content": "can you tell me how to care for a dog?"
}
],
"data_sources": [
{
"type": "pinecone",
"parameters": {
"authentication": {
"type": "api_key",
"key": "{api key}"
},
"environment": "{environment name}",
"index_name": "{index name}",
"embedding_dependency": {
"type": "deployment_name",
"deployment_name": "{embedding deployment name}"
},
"fields_mapping": {
"title_field": "title",
"url_field": "url",
"filepath_field": "filepath",
"content_fields": [
"content"
],
"content_fields_separator": "\n"
}
}
}
]
}
응답: 상태 코드: 200
{
"body": {
"id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
"created": 1686676106,
"choices": [
{
"index": 0,
"finish_reason": "stop",
"message": {
"role": "assistant",
"content": "Content of the completion [doc1].",
"context": {
"citations": [
{
"content": "Citation content.",
"title": "Citation Title",
"filepath": "contoso.txt",
"url": "https://contoso.blob.windows.net/container/contoso.txt",
"chunk_id": "0"
}
],
"intent": "dog care"
}
}
}
],
"usage": {
"completion_tokens": 557,
"prompt_tokens": 33,
"total_tokens": 590
}
}
}
전사 - 만들기
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-01-preview
오디오를 입력 언어로 전사합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| deployment-id | 경로 | 예 | string | 위스퍼 모델의 배포 ID입니다. |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
콘텐츠 형식: multipart/form-data
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 파일 | string | 전사할 오디오 파일 개체입니다. | 예 | |
| prompt | string | 모델 스타일을 안내하거나 이전 오디오 세그먼트를 계속 진행하기 위한 선택적 텍스트입니다. 프롬프트는 오디오 언어와 일치해야 합니다. | 아니요 | |
| response_format | audioResponseFormat | 출력의 형식을 정의합니다. | 아니요 | |
| 온도 | number | 샘플링 온도(0에서 1 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. 0으로 설정하면 모델은 로그 확률을 사용하여 특정 임계값에 도달할 때까지 온도를 자동으로 높입니다. | 아니요 | 0 |
| language | string | 입력 오디오의 언어입니다. ISO-639-1 형식으로 입력 언어를 제공하면 정확도와 대기 시간이 향상됩니다. | 아니요 | |
| timestamp_granularities[] | 배열 | 이 대화 내용 기록을 위해 채울 타임스탬프 세분성입니다. 타임스탬프 세분성을 사용하려면 response_format을 verbose_json으로 설정해야 합니다. word 또는 segment 옵션 중 하나 또는 둘 다 지원됩니다. 참고: 세그먼트 타임스탬프에 대한 추가 대기 시간은 없지만 단어 타임스탬프를 생성하면 추가 대기 시간이 발생합니다. |
아니요 | ['segment'] |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | audioResponse 또는 audioVerboseResponse | |
| text/plain | string | 출력 형식으로 텍스트를 전사했습니다(response_format 텍스트, vtt 또는 srt 중 하나인 경우). |
예제
예시
제공된 음성 오디오 데이터에서 전사된 텍스트 및 관련 메타데이터를 가져옵니다.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"text": "A structured object when requesting json or verbose_json"
}
}
예시
제공된 음성 오디오 데이터에서 전사된 텍스트 및 관련 메타데이터를 가져옵니다.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-01-preview
"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"
응답: 상태 코드: 200
{
"type": "string",
"example": "plain text when requesting text, srt, or vtt"
}
번역 - 만들기
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-01-preview
입력 오디오를 영어 텍스트로 전사하고 번역합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| deployment-id | 경로 | 예 | string | 배포된 위스퍼 모델의 배포 ID입니다. |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
콘텐츠 형식: multipart/form-data
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 파일 | string | 번역할 오디오 파일입니다. | 예 | |
| prompt | string | 모델 스타일을 안내하거나 이전 오디오 세그먼트를 계속 진행하기 위한 선택적 텍스트입니다. 프롬프트는 영어로 되어 있어야 합니다. | 아니요 | |
| response_format | audioResponseFormat | 출력의 형식을 정의합니다. | 아니요 | |
| 온도 | number | 샘플링 온도(0에서 1 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. 0으로 설정하면 모델은 로그 확률을 사용하여 특정 임계값에 도달할 때까지 온도를 자동으로 높입니다. | 아니요 | 0 |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | audioResponse 또는 audioVerboseResponse | |
| text/plain | string | 출력 형식으로 텍스트를 전사했습니다(response_format 텍스트, vtt 또는 srt 중 하나인 경우). |
예제
예시
제공된 음성 오디오 데이터에서 영어 전사 텍스트 및 관련 메타데이터를 가져옵니다.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-01-preview
"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"
응답: 상태 코드: 200
{
"body": {
"text": "A structured object when requesting json or verbose_json"
}
}
예시
제공된 음성 오디오 데이터에서 영어 전사 텍스트 및 관련 메타데이터를 가져옵니다.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-01-preview
"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"
응답: 상태 코드: 200
{
"type": "string",
"example": "plain text when requesting text, srt, or vtt"
}
음성 - 만들기
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2024-10-01-preview
입력 텍스트에서 오디오를 생성합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| deployment-id | 경로 | 예 | string | 배포된 tts 모델의 배포 ID입니다. |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
콘텐츠 형식: multipart/form-data
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| input | string | 오디오를 합성할 텍스트입니다. 최대 길이는 4,096자입니다. | 예 | |
| voice | enum | 음성 합성에 사용할 음성입니다. 가능한 값: alloy, echo, fable, onyx, nova, shimmer |
예 | |
| response_format | enum | 오디오를 합성할 형식입니다. 가능한 값: mp3, opus, aac, flac, wav, pcm |
아니요 | |
| 속도 | number | 합성된 오디오의 속도입니다. 0.25~4.0의 값을 선택합니다. 기본값은 1.0입니다. |
아니요 | 1.0 |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/octet-stream | string |
예제
예시
제공된 텍스트에서 오디오를 합성합니다.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2024-10-01-preview
{
"input": "Hi! What are you going to make?",
"voice": "fable",
"response_format": "mp3"
}
응답: 상태 코드: 200
{
"body": "101010101"
}
이미지 생성 - 만들기
POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-01-preview
지정된 DALLE 모델 배포의 텍스트 캡션에서 이미지 일괄 처리를 생성합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| deployment-id | 경로 | 예 | string | 배포된 dalle 모델의 배포 ID입니다. |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
Content-Type: application/json
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| prompt | string | 원하는 이미지에 대한 텍스트 설명입니다. 최대 길이는 4,000자입니다. | 예 | |
| n | 정수 | 생성할 이미지 수입니다. | 아니요 | 1 |
| 크기 | imageSize | 생성된 이미지의 크기입니다. | 아니요 | 1024 x 1024 |
| response_format | imagesResponseFormat | 생성된 이미지가 반환되는 형식입니다. | 아니요 | URL |
| user | string | 남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다. | 아니요 | |
| 품질 | imageQuality | 생성될 이미지의 품질입니다. | 아니요 | 표준 |
| style | imageStyle | 생성된 이미지의 스타일입니다. | 아니요 | vivid |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | generateImagesResponse |
상태 코드: 기본값
설명: 오류가 발생했습니다.
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | dalleErrorResponse |
예제
예시
프롬프트가 지정된 이미지를 만듭니다.
POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-01-preview
{
"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 https://{endpoint}/openai/assistants?api-version=2024-10-01-preview
도우미 목록을 반환합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| limit | query | 아니요 | 정수 | |
| order | query | 아니요 | string | |
| after | query | 아니요 | string | |
| before | query | 아니요 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | listAssistantsResponse |
예제
예시
도우미 목록을 반환합니다.
GET https://{endpoint}/openai/assistants?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"object": "list",
"data": [
{
"id": "asst_abc123",
"object": "assistant",
"created_at": 1707257477,
"name": "Stock Analyst",
"description": null,
"model": "gpt-4-1106-preview",
"instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
"tools": [
{
"type": "code_interpreter"
}
],
"tool_resources": {},
"metadata": {},
"top_p": 1.0,
"temperature": 1.0,
"response_format": "auto"
},
{
"id": "asst_abc456",
"object": "assistant",
"created_at": 1698982718,
"name": "My Assistant",
"description": null,
"model": "gpt-4-turbo",
"instructions": "You are a helpful assistant designed to make me better at coding!",
"tools": [],
"tool_resources": {},
"metadata": {},
"top_p": 1.0,
"temperature": 1.0,
"response_format": "auto"
},
{
"id": "asst_abc789",
"object": "assistant",
"created_at": 1698982643,
"name": null,
"description": null,
"model": "gpt-4-turbo",
"instructions": null,
"tools": [],
"tool_resources": {},
"metadata": {},
"top_p": 1.0,
"temperature": 1.0,
"response_format": "auto"
}
],
"first_id": "asst_abc123",
"last_id": "asst_abc789",
"has_more": false
}
}
만들기 - 도우미
POST https://{endpoint}/openai/assistants?api-version=2024-10-01-preview
모델과 지침이 포함된 도우미를 만듭니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
Content-Type: application/json
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| model | 예 | |||
| 이름 | string | 도우미의 이름입니다. 최대 길이는 256자입니다. |
아니요 | |
| description | string | 도우미에 대한 설명입니다. 최대 길이는 512자입니다. |
아니요 | |
| 지침 | string | 도우미가 사용하는 시스템 지침입니다. 최대 길이는 256,000자입니다. |
아니요 | |
| tools | 배열 | 도우미에서 사용하도록 설정된 도구 목록입니다. 도우미당 최대 128개의 도구가 있을 수 있습니다. 도구는 형식 code_interpreter, retrieval 또는 function일 수 있습니다. |
아니요 | [] |
| tool_resources | 개체 | 도우미 도구에서 사용하는 리소스 집합입니다. 리소스는 도구 유형에 따라 다릅니다. 예를 들어 code_interpreter 도구에는 파일 ID 목록이 필요하지만 file_search 도구에는 벡터 저장소 ID 목록이 필요합니다. |
아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 | |
| 온도 | 번호 | 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. |
아니요 | 1 |
| top_p | 번호 | 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 온도를 변경하는 것이 좋지만 둘 다 변경하는 것은 권장하지 않습니다. |
아니요 | 1 |
| response_format | assistantsApiResponseFormatOption | 모델이 출력해야 하는 형식을 지정합니다. gpt-3.5-turbo-1106 이후의 GPT-4 Turbo 및 모든 GPT-3.5 Turbo 모델과 호환됩니다.{ "type": "json_object" }(으)로 설정하면 모델이 생성하는 메시지가 유효한 JSON임을 보장하는 JSON 모드가 사용하도록 설정됩니다.중요: JSON 모드를 사용하는 경우 시스템 또는 사용자 메시지를 통해 직접 JSON을 생성하도록 모델에 지시해야 합니다. 이렇게 하지 않으면 생성이 토큰 제한에 도달할 때까지 모델은 공백의 끝없는 스트림을 생성하여 장기 실행되고 겉보기에 "중단" 요청이 발생할 수 있습니다. 또한 생성이 max_tokens을(를) 초과했거나 대화가 최대 컨텍스트 길이를 초과했음을 나타내는 finish_reason="length"인 경우 메시지 콘텐츠가 부분적으로 잘릴 수 있습니다. |
아니요 |
tool_resources의 속성
code_interpreter
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_ids | 배열 | code_interpreter 도구에서 사용할 수 있는 파일 ID 목록입니다. 도구와 연결된 파일은 최대 20개일 수 있습니다. |
[] |
file_search
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| vector_store_ids | 배열 | 이 도우미에 연결된 벡터 저장소입니다. 도우미에 연결된 벡터 저장소가 최대 1개 있을 수 있습니다. |
|
| vector_stores | 배열 | file_ids를 사용하여 벡터 저장소를 만들고 이 도우미에 연결하기 위한 도우미입니다. 도우미에 연결된 벡터 저장소가 최대 1개 있을 수 있습니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | assistantObject | 모델을 호출하고 도구를 사용할 수 있는 assistant를 나타냅니다. |
예제
예시
모델과 지침이 포함된 도우미를 만듭니다.
POST https://{endpoint}/openai/assistants?api-version=2024-10-01-preview
{
"name": "Math Tutor",
"instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
"tools": [
{
"type": "code_interpreter"
}
],
"model": "gpt-4-1106-preview"
}
응답: 상태 코드: 200
{
"body": {
"id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
"object": "assistant",
"created_at": 1707295707,
"name": "Math Tutor",
"description": null,
"model": "gpt-4-1106-preview",
"instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
"tools": [
{
"type": "code_interpreter"
}
],
"metadata": {},
"top_p": 1.0,
"temperature": 1.0,
"response_format": "auto"
}
}
가져오기 - 도우미
GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview
도우미를 검색합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| assistant_id | 경로 | 예 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | assistantObject | 모델을 호출하고 도구를 사용할 수 있는 assistant를 나타냅니다. |
예제
예시
도우미를 검색합니다.
GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"id": "asst_abc123",
"object": "assistant",
"created_at": 1699009709,
"name": "HR Helper",
"description": null,
"model": "gpt-4-turbo",
"instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
"tools": [
{
"type": "file_search"
}
],
"metadata": {},
"top_p": 1.0,
"temperature": 1.0,
"response_format": "auto"
}
}
수정 - 도우미
POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview
도우미를 수정합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| assistant_id | 경로 | 예 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
Content-Type: application/json
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| model | 아니요 | |||
| 이름 | string | 도우미의 이름입니다. 최대 길이는 256자입니다. |
아니요 | |
| description | string | 도우미에 대한 설명입니다. 최대 길이는 512자입니다. |
아니요 | |
| 지침 | string | 도우미가 사용하는 시스템 지침입니다. 최대 길이는 32,768자입니다. |
아니요 | |
| tools | 배열 | 도우미에서 사용하도록 설정된 도구 목록입니다. 도우미당 최대 128개의 도구가 있을 수 있습니다. 도구는 형식 code_interpreter, retrieval 또는 function일 수 있습니다. |
아니요 | [] |
| tool_resources | 개체 | 도우미 도구에서 사용하는 리소스 집합입니다. 리소스는 도구 유형에 따라 다릅니다. 예를 들어 code_interpreter 도구에는 파일 ID 목록이 필요하지만 file_search 도구에는 벡터 저장소 ID 목록이 필요합니다. |
아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 | |
| 온도 | 번호 | 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. |
아니요 | 1 |
| top_p | 번호 | 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 온도를 변경하는 것이 좋지만 둘 다 변경하는 것은 권장하지 않습니다. |
아니요 | 1 |
| response_format | assistantsApiResponseFormatOption | 모델이 출력해야 하는 형식을 지정합니다. gpt-3.5-turbo-1106 이후의 GPT-4 Turbo 및 모든 GPT-3.5 Turbo 모델과 호환됩니다.{ "type": "json_object" }(으)로 설정하면 모델이 생성하는 메시지가 유효한 JSON임을 보장하는 JSON 모드가 사용하도록 설정됩니다.중요: JSON 모드를 사용하는 경우 시스템 또는 사용자 메시지를 통해 직접 JSON을 생성하도록 모델에 지시해야 합니다. 이렇게 하지 않으면 생성이 토큰 제한에 도달할 때까지 모델은 공백의 끝없는 스트림을 생성하여 장기 실행되고 겉보기에 "중단" 요청이 발생할 수 있습니다. 또한 생성이 max_tokens을(를) 초과했거나 대화가 최대 컨텍스트 길이를 초과했음을 나타내는 finish_reason="length"인 경우 메시지 콘텐츠가 부분적으로 잘릴 수 있습니다. |
아니요 |
tool_resources의 속성
code_interpreter
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_ids | 배열 | code_interpreter 도구에서 사용할 수 있는 파일 ID 목록을 재정의합니다. 도구와 연결된 파일은 최대 20개일 수 있습니다. |
[] |
file_search
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| vector_store_ids | 배열 | 이 도우미에 연결된 벡터 저장소를 재정의합니다. 도우미에 연결된 벡터 저장소가 최대 1개 있을 수 있습니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | assistantObject | 모델을 호출하고 도구를 사용할 수 있는 assistant를 나타냅니다. |
예제
예시
도우미를 수정합니다.
POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview
{
"instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
"tools": [
{
"type": "file_search"
}
],
"model": "gpt-4-turbo"
}
응답: 상태 코드: 200
{
"body": {
"id": "asst_123",
"object": "assistant",
"created_at": 1699009709,
"name": "HR Helper",
"description": null,
"model": "gpt-4-turbo",
"instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
"tools": [
{
"type": "file_search"
}
],
"tool_resources": {
"file_search": {
"vector_store_ids": []
}
},
"metadata": {},
"top_p": 1.0,
"temperature": 1.0,
"response_format": "auto"
}
}
삭제 - 도우미
DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview
도우미를 삭제합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| assistant_id | 경로 | 예 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | deleteAssistantResponse |
예제
예시
도우미를 삭제합니다.
DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
"object": "assistant.deleted",
"deleted": true
}
}
만들기 - 스레드
POST https://{endpoint}/openai/threads?api-version=2024-10-01-preview
스레드를 만듭니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
Content-Type: application/json
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| messages | 배열 | 스레드를 시작할 메시지 목록입니다. | 아니요 | |
| tool_resources | 개체 | 이 스레드의 도우미 도구에서 사용할 수 있는 리소스 집합입니다. 리소스는 도구 유형에 따라 다릅니다. 예를 들어 code_interpreter 도구에는 파일 ID 목록이 필요하지만 file_search 도구에는 벡터 저장소 ID 목록이 필요합니다. |
아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 |
tool_resources의 속성
code_interpreter
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_ids | 배열 | code_interpreter 도구에서 사용할 수 있는 파일 ID 목록입니다. 도구와 연결된 파일은 최대 20개일 수 있습니다. |
[] |
file_search
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| vector_store_ids | 배열 | 이 스레드에 연결된 벡터 저장소입니다. 스레드에 연결된 벡터 저장소가 최대 1개 있을 수 있습니다. |
|
| vector_stores | 배열 | file_ids를 사용하여 벡터 저장소를 만들고 이 스레드에 연결하기 위한 도우미입니다. 스레드에 연결된 최대 하나의 벡터 저장소가 있을 수 있습니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | threadObject | 메시지를 포함하는 스레드를 나타냅니다. |
예제
예시
스레드를 만듭니다.
POST https://{endpoint}/openai/threads?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"id": "thread_v7V4csrNOxtNmgcwGg496Smx",
"object": "thread",
"created_at": 1707297136,
"metadata": {}
}
}
가져오기 - 스레드
GET https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview
스레드를 검색합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| thread_id | 경로 | 예 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | threadObject | 메시지를 포함하는 스레드를 나타냅니다. |
예제
예시
스레드를 검색합니다.
GET https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"id": "thread_v7V4csrNOxtNmgcwGg496Smx",
"object": "thread",
"created_at": 1707297136,
"metadata": {},
"tool_resources": {
"code_interpreter": {
"file_ids": []
}
}
}
}
수정 - 스레드
POST https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview
스레드를 수정합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| thread_id | 경로 | 예 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
Content-Type: application/json
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| tool_resources | 개체 | 이 스레드의 도우미 도구에서 사용할 수 있는 리소스 집합입니다. 리소스는 도구 유형에 따라 다릅니다. 예를 들어 code_interpreter 도구에는 파일 ID 목록이 필요하지만 file_search 도구에는 벡터 저장소 ID 목록이 필요합니다. |
아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 |
tool_resources의 속성
code_interpreter
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_ids | 배열 | code_interpreter 도구에서 사용할 수 있는 파일 ID 목록입니다. 도구와 연결된 파일은 최대 20개일 수 있습니다. |
[] |
file_search
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| vector_store_ids | 배열 | 이 스레드에 연결된 벡터 저장소입니다. 스레드에 연결된 최대 하나의 벡터 저장소가 있을 수 있습니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | threadObject | 메시지를 포함하는 스레드를 나타냅니다. |
예제
예시
스레드를 수정합니다.
POST https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview
{
"metadata": {
"modified": "true",
"user": "abc123"
}
}
응답: 상태 코드: 200
{
"body": {
"id": "thread_v7V4csrNOxtNmgcwGg496Smx",
"object": "thread",
"created_at": 1707297136,
"metadata": {
"modified": "true",
"user": "abc123"
},
"tool_resources": {}
}
}
삭제 - 스레드
DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview
스레드를 삭제합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| thread_id | 경로 | 예 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | deleteThreadResponse |
예제
예시
스레드를 삭제합니다.
DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"id": "thread_v7V4csrNOxtNmgcwGg496Smx",
"object": "thread.deleted",
"deleted": true
}
}
나열 - 메시지
GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-01-preview
지정된 스레드에 대한 메시지 목록을 반환합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| thread_id | 경로 | 예 | string | |
| limit | query | 아니요 | 정수 | |
| order | query | 아니요 | string | |
| after | query | 아니요 | string | |
| before | query | 아니요 | string | |
| run_id | query | 아니요 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | listMessagesResponse |
예제
예시
메시지 나열
GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"object": "list",
"data": [
{
"id": "msg_abc123",
"object": "thread.message",
"created_at": 1699016383,
"assistant_id": null,
"thread_id": "thread_abc123",
"run_id": null,
"role": "user",
"content": [
{
"type": "text",
"text": {
"value": "How does AI work? Explain it in simple terms.",
"annotations": []
}
}
],
"attachments": [],
"metadata": {}
},
{
"id": "msg_abc456",
"object": "thread.message",
"created_at": 1699016383,
"assistant_id": null,
"thread_id": "thread_abc123",
"run_id": null,
"role": "user",
"content": [
{
"type": "text",
"text": {
"value": "Hello, what is AI?",
"annotations": []
}
}
],
"attachments": [],
"metadata": {}
}
],
"first_id": "msg_abc123",
"last_id": "msg_abc456",
"has_more": false
}
}
만들기 - 메시지
POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-01-preview
메시지 작성.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| thread_id | 경로 | 예 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
Content-Type: application/json
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 역할(role) | string | 메시지를 만드는 엔터티의 역할입니다. 허용되는 값은 다음과 같습니다. - user: 메시지가 실제 사용자에 의해 전송되었으며 대부분의 경우 사용자 생성 메시지를 나타내는 데 사용되어야 함을 나타냅니다.- assistant: 메시지가 도우미에 의해 생성되었음을 나타냅니다. 도우미의 메시지를 대화에 삽입하려면 이 값을 사용합니다. |
예 | |
| content | string | 메시지의 내용입니다. | 예 | |
| 첨부 파일 | 배열 | 메시지에 첨부된 파일 목록 및 추가해야 하는 도구입니다. | 아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | messageObject | 스레드 내의 메시지를 나타냅니다. |
예제
예시
메시지 작성.
POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-01-preview
{
"role": "user",
"content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}
응답: 상태 코드: 200
{
"body": {
"id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
"object": "thread.message",
"created_at": 1707298421,
"assistant_id": null,
"thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
"run_id": null,
"role": "user",
"content": [
{
"type": "text",
"text": {
"value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
"annotations": []
}
}
],
"attachments": [],
"metadata": {}
}
}
가져오기 - 메시지
GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview
메시지를 검색합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| thread_id | 경로 | 예 | string | |
| message_id | 경로 | 예 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | messageObject | 스레드 내의 메시지를 나타냅니다. |
예제
예시
메시지를 검색합니다.
GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
"object": "thread.message",
"created_at": 1707298421,
"thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
"role": "user",
"content": [
{
"type": "text",
"text": {
"value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
"annotations": []
}
}
],
"file_ids": [],
"assistant_id": null,
"run_id": null,
"metadata": {}
}
}
수정 - 메시지
POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview
메시지를 수정합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| thread_id | 경로 | 예 | string | |
| message_id | 경로 | 예 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
Content-Type: application/json
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | messageObject | 스레드 내의 메시지를 나타냅니다. |
예제
예시
메시지를 수정합니다.
POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview
{
"metadata": {
"modified": "true",
"user": "abc123"
}
}
응답: 상태 코드: 200
{
"body": {
"id": "msg_abc123",
"object": "thread.message",
"created_at": 1699017614,
"assistant_id": null,
"thread_id": "thread_abc123",
"run_id": null,
"role": "user",
"content": [
{
"type": "text",
"text": {
"value": "How does AI work? Explain it in simple terms.",
"annotations": []
}
}
],
"file_ids": [],
"metadata": {
"modified": "true",
"user": "abc123"
}
}
}
만들기 - 스레드 및 실행
POST https://{endpoint}/openai/threads/runs?api-version=2024-10-01-preview
스레드를 만들고 한 요청에서 실행합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
Content-Type: application/json
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| assistant_id | string | 이 실행을 실행하는 데 사용할 도우미의 ID입니다. | 예 | |
| 스레드 | createThreadRequest | 아니요 | ||
| model | string | 이 실행에 사용할 모델의 배포 이름입니다. 여기에 값이 제공되면 도우미와 연결된 모델이 재정의됩니다. 그렇지 않은 경우 도우미와 연결된 모델이 사용됩니다. | 아니요 | |
| 지침 | string | 도우미의 기본 시스템 메시지를 대체합니다. 이는 실행별로 동작을 수정하는 데 유용합니다. | 아니요 | |
| tools | 배열 | 도우미가 이 실행에 사용할 수 있는 도구를 재정의합니다. 이는 실행별로 동작을 수정하는 데 유용합니다. | 아니요 | |
| tool_resources | 개체 | 도우미 도구에서 사용하는 리소스 집합입니다. 리소스는 도구 유형에 따라 다릅니다. 예를 들어 code_interpreter 도구에는 파일 ID 목록이 필요하지만 file_search 도구에는 벡터 저장소 ID 목록이 필요합니다. |
아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 | |
| 온도 | 번호 | 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. |
아니요 | 1 |
| top_p | 번호 | 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 온도를 변경하는 것이 좋지만 둘 다 변경하는 것은 권장하지 않습니다. |
아니요 | 1 |
| stream | 부울 값 | true인 경우, 실행 서버에서 보낸 이벤트 중에 발생하는 이벤트 스트림을 반환하고, data: [DONE] 메시지를 표시하면서 실행이 터미널 상태가 될 때 종료됩니다. |
아니요 | |
| stream_options | chatCompletionStreamOptions | 스트리밍 응답에 대한 옵션입니다. 설정할 stream: true때만 설정합니다. |
아니요 | None |
| max_prompt_tokens | 정수 | 실행 과정에서 사용할 수 있는 프롬프트 토큰의 최대 수입니다. 이 실행은 여러 번의 실행 동안 지정된 수의 프롬프트 토큰만 사용하려고 최선의 노력을 기울입니다. 실행이 지정된 프롬프트 토큰 수를 초과하면 상태 incomplete로 종료됩니다. 자세한 내용은 incomplete_details를 참조하세요. |
아니요 | |
| max_completion_tokens | 정수 | 실행 과정에서 사용할 수 있는 완료 토큰의 최대 수입니다. 이 실행은 여러 번의 실행 동안 지정된 수의 완성 토큰만 사용하려고 최선의 노력을 기울입니다. 실행이 지정된 완성 토큰 수를 초과하면 상태 incomplete로 종료됩니다. 자세한 내용은 incomplete_details를 참조하세요. |
아니요 | |
| truncation_strategy | truncationObject | 실행 전에 스레드가 잘리는 방법에 대한 컨트롤입니다. 실행의 초기 컨텍스트 창을 제어하는 데 사용합니다. | 아니요 | |
| tool_choice | assistantsApiToolChoiceOption | 모델이 호출하는 도구(있는 경우)를 제어합니다.none은 모델이 도구를 호출하지 않고 대신 메시지를 생성함을 의미합니다.auto는 기본값이며 모델이 메시지 생성 또는 도구 호출 중에서 선택할 수 있음을 의미합니다.{"type": "file_search"} 또는 {"type": "function", "function": {"name": "my_function"}}과 같은 특정 도구를 지정하면 모델이 해당 도구를 호출하게 됩니다. |
아니요 | |
| parallel_tool_calls | ParallelToolCalls | 도구를 사용하는 동안 병렬 함수 호출을 사용하도록 설정할지 여부입니다. | 아니요 | True |
| response_format | assistantsApiResponseFormatOption | 모델이 출력해야 하는 형식을 지정합니다. gpt-3.5-turbo-1106 이후의 GPT-4 Turbo 및 모든 GPT-3.5 Turbo 모델과 호환됩니다.{ "type": "json_object" }(으)로 설정하면 모델이 생성하는 메시지가 유효한 JSON임을 보장하는 JSON 모드가 사용하도록 설정됩니다.중요: JSON 모드를 사용하는 경우 시스템 또는 사용자 메시지를 통해 직접 JSON을 생성하도록 모델에 지시해야 합니다. 이렇게 하지 않으면 생성이 토큰 제한에 도달할 때까지 모델은 공백의 끝없는 스트림을 생성하여 장기 실행되고 겉보기에 "중단" 요청이 발생할 수 있습니다. 또한 생성이 max_tokens을(를) 초과했거나 대화가 최대 컨텍스트 길이를 초과했음을 나타내는 finish_reason="length"인 경우 메시지 콘텐츠가 부분적으로 잘릴 수 있습니다. |
아니요 |
tool_resources의 속성
code_interpreter
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_ids | 배열 | code_interpreter 도구에서 사용할 수 있는 파일 ID 목록입니다. 도구와 연결된 파일은 최대 20개일 수 있습니다. |
[] |
file_search
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| vector_store_ids | 배열 | 이 도우미에 연결된 벡터 저장소의 ID입니다. 도우미에 연결된 벡터 저장소가 최대 1개 있을 수 있습니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | runObject | 스레드에서 실행되는 실행을 나타냅니다. |
예제
예시
스레드를 만들고 한 요청에서 실행합니다.
POST https://{endpoint}/openai/threads/runs?api-version=2024-10-01-preview
{
"assistant_id": "asst_abc123",
"thread": {
"messages": [
{
"role": "user",
"content": "Explain deep learning to a 5 year old."
}
]
}
}
응답: 상태 코드: 200
{
"body": {
"id": "run_abc123",
"object": "thread.run",
"created_at": 1699076792,
"assistant_id": "asst_abc123",
"thread_id": "thread_abc123",
"status": "queued",
"started_at": null,
"expires_at": 1699077392,
"cancelled_at": null,
"failed_at": null,
"completed_at": null,
"required_action": null,
"last_error": null,
"model": "gpt-4-turbo",
"instructions": "You are a helpful assistant.",
"tools": [],
"tool_resources": {},
"metadata": {},
"temperature": 1.0,
"top_p": 1.0,
"max_completion_tokens": null,
"max_prompt_tokens": null,
"truncation_strategy": {
"type": "auto",
"last_messages": null
},
"incomplete_details": null,
"usage": null,
"response_format": "auto",
"tool_choice": "auto"
}
}
나열 - 실행
GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview
스레드에 속하는 실행 목록을 반환합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| thread_id | 경로 | 예 | string | |
| limit | query | 아니요 | 정수 | |
| order | query | 아니요 | string | |
| after | query | 아니요 | string | |
| before | query | 아니요 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | listRunsResponse |
예제
예시
스레드에 속하는 실행 목록을 반환합니다.
GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"object": "list",
"data": [
{
"id": "run_abc123",
"object": "thread.run",
"created_at": 1699075072,
"assistant_id": "asst_abc123",
"thread_id": "thread_abc123",
"status": "completed",
"started_at": 1699075072,
"expires_at": null,
"cancelled_at": null,
"failed_at": null,
"completed_at": 1699075073,
"last_error": null,
"model": "gpt-4-turbo",
"instructions": null,
"incomplete_details": null,
"tools": [
{
"type": "code_interpreter"
}
],
"tool_resources": {
"code_interpreter": {
"file_ids": [
"file-abc123",
"file-abc456"
]
}
},
"metadata": {},
"usage": {
"prompt_tokens": 123,
"completion_tokens": 456,
"total_tokens": 579
},
"temperature": 1.0,
"top_p": 1.0,
"max_prompt_tokens": 1000,
"max_completion_tokens": 1000,
"truncation_strategy": {
"type": "auto",
"last_messages": null
},
"response_format": "auto",
"tool_choice": "auto"
},
{
"id": "run_abc456",
"object": "thread.run",
"created_at": 1699063290,
"assistant_id": "asst_abc123",
"thread_id": "thread_abc123",
"status": "completed",
"started_at": 1699063290,
"expires_at": null,
"cancelled_at": null,
"failed_at": null,
"completed_at": 1699063291,
"last_error": null,
"model": "gpt-4-turbo",
"instructions": null,
"incomplete_details": null,
"tools": [
{
"type": "code_interpreter"
}
],
"tool_resources": {
"code_interpreter": {
"file_ids": [
"file-abc123",
"file-abc456"
]
}
},
"metadata": {},
"usage": {
"prompt_tokens": 123,
"completion_tokens": 456,
"total_tokens": 579
},
"temperature": 1.0,
"top_p": 1.0,
"max_prompt_tokens": 1000,
"max_completion_tokens": 1000,
"truncation_strategy": {
"type": "auto",
"last_messages": null
},
"response_format": "auto",
"tool_choice": "auto"
}
],
"first_id": "run_abc123",
"last_id": "run_abc456",
"has_more": false
}
}
만들기 - 실행
POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview
실행을 만듭니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| thread_id | 경로 | 예 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
Content-Type: application/json
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| assistant_id | string | 이 실행을 실행하는 데 사용할 도우미의 ID입니다. | 예 | |
| model | string | 이 실행을 수행하는 데 사용할 모델의 ID입니다. 여기에 값이 제공되면 도우미와 연결된 모델이 재정의됩니다. 그렇지 않은 경우 도우미와 연결된 모델이 사용됩니다. | 아니요 | |
| 지침 | string | 도우미의 기본 시스템 메시지를 대체합니다. 이는 실행별로 동작을 수정하는 데 유용합니다. | 아니요 | |
| additional_instructions | string | 실행 지침 끝에 추가 지침을 추가합니다. 이는 다른 지침을 재정의하지 않고 실행별로 동작을 수정하는 데 유용합니다. | 아니요 | |
| additional_messages | 배열 | 실행을 만들기 전에 스레드에 추가 메시지를 추가합니다. | 아니요 | |
| tools | 배열 | 도우미가 이 실행에 사용할 수 있는 도구를 재정의합니다. 이는 실행별로 동작을 수정하는 데 유용합니다. | 아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 | |
| 온도 | 번호 | 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. |
아니요 | 1 |
| top_p | 번호 | 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 온도를 변경하는 것이 좋지만 둘 다 변경하는 것은 권장하지 않습니다. |
아니요 | 1 |
| stream | 부울 값 | true인 경우, 실행 서버에서 보낸 이벤트 중에 발생하는 이벤트 스트림을 반환하고, data: [DONE] 메시지를 표시하면서 실행이 터미널 상태가 될 때 종료됩니다. |
아니요 | |
| max_prompt_tokens | 정수 | 실행 과정에서 사용할 수 있는 프롬프트 토큰의 최대 수입니다. 이 실행은 여러 번의 실행 동안 지정된 수의 프롬프트 토큰만 사용하려고 최선의 노력을 기울입니다. 실행이 지정된 프롬프트 토큰 수를 초과하면 상태 incomplete로 종료됩니다. 자세한 내용은 incomplete_details를 참조하세요. |
아니요 | |
| max_completion_tokens | 정수 | 실행 과정에서 사용할 수 있는 완료 토큰의 최대 수입니다. 이 실행은 여러 번의 실행 동안 지정된 수의 완성 토큰만 사용하려고 최선의 노력을 기울입니다. 실행이 지정된 완성 토큰 수를 초과하면 상태 incomplete로 종료됩니다. 자세한 내용은 incomplete_details를 참조하세요. |
아니요 | |
| truncation_strategy | truncationObject | 실행 전에 스레드가 잘리는 방법에 대한 컨트롤입니다. 실행의 초기 컨텍스트 창을 제어하는 데 사용합니다. | 아니요 | |
| tool_choice | assistantsApiToolChoiceOption | 모델이 호출하는 도구(있는 경우)를 제어합니다.none은 모델이 도구를 호출하지 않고 대신 메시지를 생성함을 의미합니다.auto는 기본값이며 모델이 메시지 생성 또는 도구 호출 중에서 선택할 수 있음을 의미합니다.{"type": "file_search"} 또는 {"type": "function", "function": {"name": "my_function"}}과 같은 특정 도구를 지정하면 모델이 해당 도구를 호출하게 됩니다. |
아니요 | |
| parallel_tool_calls | ParallelToolCalls | 도구를 사용하는 동안 병렬 함수 호출을 사용하도록 설정할지 여부입니다. | 아니요 | True |
| response_format | assistantsApiResponseFormatOption | 모델이 출력해야 하는 형식을 지정합니다. gpt-3.5-turbo-1106 이후의 GPT-4 Turbo 및 모든 GPT-3.5 Turbo 모델과 호환됩니다.{ "type": "json_object" }(으)로 설정하면 모델이 생성하는 메시지가 유효한 JSON임을 보장하는 JSON 모드가 사용하도록 설정됩니다.중요: JSON 모드를 사용하는 경우 시스템 또는 사용자 메시지를 통해 직접 JSON을 생성하도록 모델에 지시해야 합니다. 이렇게 하지 않으면 생성이 토큰 제한에 도달할 때까지 모델은 공백의 끝없는 스트림을 생성하여 장기 실행되고 겉보기에 "중단" 요청이 발생할 수 있습니다. 또한 생성이 max_tokens을(를) 초과했거나 대화가 최대 컨텍스트 길이를 초과했음을 나타내는 finish_reason="length"인 경우 메시지 콘텐츠가 부분적으로 잘릴 수 있습니다. |
아니요 |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | runObject | 스레드에서 실행되는 실행을 나타냅니다. |
예제
예시
실행을 만듭니다.
POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview
{
"assistant_id": "asst_abc123"
}
응답: 상태 코드: 200
{
"body": {
"id": "run_abc123",
"object": "thread.run",
"created_at": 1699063290,
"assistant_id": "asst_abc123",
"thread_id": "thread_abc123",
"status": "queued",
"started_at": 1699063290,
"expires_at": null,
"cancelled_at": null,
"failed_at": null,
"completed_at": 1699063291,
"last_error": null,
"model": "gpt-4-turbo",
"instructions": null,
"incomplete_details": null,
"tools": [
{
"type": "code_interpreter"
}
],
"metadata": {},
"usage": null,
"temperature": 1.0,
"top_p": 1.0,
"max_prompt_tokens": 1000,
"max_completion_tokens": 1000,
"truncation_strategy": {
"type": "auto",
"last_messages": null
},
"response_format": "auto",
"tool_choice": "auto"
}
}
가져오기 - 실행
GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview
실행을 검색합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| thread_id | 경로 | 예 | string | |
| run_id | 경로 | 예 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | runObject | 스레드에서 실행되는 실행을 나타냅니다. |
예제
예시
실행을 가져옵니다.
GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
"object": "thread.run",
"created_at": 1707303196,
"assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
"thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
"status": "completed",
"started_at": 1707303197,
"expires_at": null,
"cancelled_at": null,
"failed_at": null,
"completed_at": 1707303201,
"last_error": null,
"model": "gpt-4-1106-preview",
"instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
"tools": [],
"file_ids": [],
"metadata": {}
}
}
수정 - 실행
POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview
실행을 수정합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| thread_id | 경로 | 예 | string | |
| run_id | 경로 | 예 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
Content-Type: application/json
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | runObject | 스레드에서 실행되는 실행을 나타냅니다. |
예제
예시
실행을 수정합니다.
POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview
{
"metadata": {
"user_id": "user_abc123"
}
}
응답: 상태 코드: 200
{
"body": {
"id": "run_abc123",
"object": "thread.run",
"created_at": 1699075072,
"assistant_id": "asst_abc123",
"thread_id": "thread_abc123",
"status": "completed",
"started_at": 1699075072,
"expires_at": null,
"cancelled_at": null,
"failed_at": null,
"completed_at": 1699075073,
"last_error": null,
"model": "gpt-4-turbo",
"instructions": null,
"incomplete_details": null,
"tools": [
{
"type": "code_interpreter"
}
],
"tool_resources": {
"code_interpreter": {
"file_ids": [
"file-abc123",
"file-abc456"
]
}
},
"metadata": {
"user_id": "user_abc123"
},
"usage": {
"prompt_tokens": 123,
"completion_tokens": 456,
"total_tokens": 579
},
"temperature": 1.0,
"top_p": 1.0,
"max_prompt_tokens": 1000,
"max_completion_tokens": 1000,
"truncation_strategy": {
"type": "auto",
"last_messages": null
},
"response_format": "auto",
"tool_choice": "auto"
}
}
제출 - 실행할 도구 출력
POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2024-10-01-preview
실행에 status: "requires_action"이 있고 required_action.type이 submit_tool_outputs인 경우 모두 완료되면 이 엔드포인트를 사용하여 도구 호출의 출력을 제출할 수 있습니다. 모든 출력은 단일 요청으로 제출되어야 합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| thread_id | 경로 | 예 | string | |
| run_id | 경로 | 예 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
Content-Type: application/json
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| tool_outputs | 배열 | 출력이 제출되는 도구 목록입니다. | 예 | |
| stream | 부울 값 | true인 경우, 실행 서버에서 보낸 이벤트 중에 발생하는 이벤트 스트림을 반환하고, data: [DONE] 메시지를 표시하면서 실행이 터미널 상태가 될 때 종료됩니다. |
아니요 |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | runObject | 스레드에서 실행되는 실행을 나타냅니다. |
예제
예시
실행에 status: "requires_action"이 있고 required_action.type이 submit_tool_outputs인 경우 모두 완료되면 이 엔드포인트를 사용하여 도구 호출의 출력을 제출할 수 있습니다. 모든 출력은 단일 요청으로 제출되어야 합니다.
POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2024-10-01-preview
{
"tool_outputs": [
{
"tool_call_id": "call_001",
"output": "70 degrees and sunny."
}
]
}
응답: 상태 코드: 200
{
"body": {
"id": "run_123",
"object": "thread.run",
"created_at": 1699075592,
"assistant_id": "asst_123",
"thread_id": "thread_123",
"status": "queued",
"started_at": 1699075592,
"expires_at": 1699076192,
"cancelled_at": null,
"failed_at": null,
"completed_at": null,
"last_error": null,
"model": "gpt-4-turbo",
"instructions": null,
"tools": [
{
"type": "function",
"function": {
"name": "get_current_weather",
"description": "Get the current weather in a given location",
"parameters": {
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "The city and state, e.g. San Francisco, CA"
},
"unit": {
"type": "string",
"enum": [
"celsius",
"fahrenheit"
]
}
},
"required": [
"location"
]
}
}
}
],
"metadata": {},
"usage": null,
"temperature": 1.0,
"top_p": 1.0,
"max_prompt_tokens": 1000,
"max_completion_tokens": 1000,
"truncation_strategy": {
"type": "auto",
"last_messages": null
},
"response_format": "auto",
"tool_choice": "auto"
}
}
취소 - 실행
POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2024-10-01-preview
in_progress인 실행을 취소합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| thread_id | 경로 | 예 | string | |
| run_id | 경로 | 예 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | runObject | 스레드에서 실행되는 실행을 나타냅니다. |
예제
예시
in_progress인 실행을 취소합니다.
POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"id": "run_abc123",
"object": "thread.run",
"created_at": 1699076126,
"assistant_id": "asst_abc123",
"thread_id": "thread_abc123",
"status": "cancelling",
"started_at": 1699076126,
"expires_at": 1699076726,
"cancelled_at": null,
"failed_at": null,
"completed_at": null,
"last_error": null,
"model": "gpt-4-turbo",
"instructions": "You summarize books.",
"tools": [
{
"type": "file_search"
}
],
"tool_resources": {
"file_search": {
"vector_store_ids": [
"vs_123"
]
}
},
"metadata": {},
"usage": null,
"temperature": 1.0,
"top_p": 1.0,
"response_format": "auto"
}
}
나열 - 실행 단계
GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2024-10-01-preview
실행에 속하는 실행 단계 목록을 반환합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| thread_id | 경로 | 예 | string | |
| run_id | 경로 | 예 | string | |
| limit | query | 아니요 | 정수 | |
| order | query | 아니요 | string | |
| after | query | 아니요 | string | |
| before | query | 아니요 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | listRunStepsResponse |
예제
예시
실행에 속하는 실행 단계 목록을 반환합니다.
GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"object": "list",
"data": [
{
"id": "step_abc123",
"object": "thread.run.step",
"created_at": 1699063291,
"run_id": "run_abc123",
"assistant_id": "asst_abc123",
"thread_id": "thread_abc123",
"type": "message_creation",
"status": "completed",
"cancelled_at": null,
"completed_at": 1699063291,
"expired_at": null,
"failed_at": null,
"last_error": null,
"step_details": {
"type": "message_creation",
"message_creation": {
"message_id": "msg_abc123"
}
},
"usage": {
"prompt_tokens": 123,
"completion_tokens": 456,
"total_tokens": 579
}
}
],
"first_id": "step_abc123",
"last_id": "step_abc456",
"has_more": false
}
}
가져오기 - 실행 단계
GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2024-10-01-preview
실행 단계를 검색합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| thread_id | 경로 | 예 | string | |
| run_id | 경로 | 예 | string | |
| step_id | 경로 | 예 | string | |
| api-version | query | 예 | string | API 버전 |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | runStepObject | 실행 수행의 단계를 나타냅니다. |
예제
예시
실행 단계를 검색합니다.
GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"id": "step_abc123",
"object": "thread.run.step",
"created_at": 1699063291,
"run_id": "run_abc123",
"assistant_id": "asst_abc123",
"thread_id": "thread_abc123",
"type": "message_creation",
"status": "completed",
"cancelled_at": null,
"completed_at": 1699063291,
"expired_at": null,
"failed_at": null,
"last_error": null,
"step_details": {
"type": "message_creation",
"message_creation": {
"message_id": "msg_abc123"
}
},
"usage": {
"prompt_tokens": 123,
"completion_tokens": 456,
"total_tokens": 579
}
}
}
나열 - 벡터 저장소
GET https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview
벡터 저장소 목록을 반환합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| limit | query | 아니요 | 정수 | |
| order | query | 아니요 | string | |
| after | query | 아니요 | string | |
| before | query | 아니요 | string | |
| api-version | query | 예 | string |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | listVectorStoresResponse |
예제
예시
벡터 저장소 목록을 반환합니다.
GET https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"object": "list",
"data": [
{
"id": "vs_abc123",
"object": "vector_store",
"created_at": 1699061776,
"name": "Support FAQ",
"bytes": 139920,
"file_counts": {
"in_progress": 0,
"completed": 3,
"failed": 0,
"cancelled": 0,
"total": 3
}
},
{
"id": "vs_abc456",
"object": "vector_store",
"created_at": 1699061776,
"name": "Support FAQ v2",
"bytes": 139920,
"file_counts": {
"in_progress": 0,
"completed": 3,
"failed": 0,
"cancelled": 0,
"total": 3
}
}
],
"first_id": "vs_abc123",
"last_id": "vs_abc456",
"has_more": false
}
}
만들기 - 벡터 저장소
POST https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview
벡터 저장소를 만듭니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| api-version | query | 예 | string |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
Content-Type: application/json
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| file_ids | 배열 | 벡터 저장소에서 사용해야 하는 파일 ID 목록입니다. 파일에 액세스할 수 있는 file_search와 같은 도구에 유용합니다. |
아니요 | |
| 이름 | string | 벡터 저장소의 이름입니다. | 아니요 | |
| expires_after | vectorStoreExpirationAfter | 벡터 저장소에 대한 만료 정책입니다. | 아니요 | |
| chunking_strategy | autoChunkingStrategyRequestParam 또는 staticChunkingStrategyRequestParam | 파일을 청크하는 데 사용되는 청크 전략입니다. 설정하지 않으면 auto 전략을 사용합니다. 비어 있지 않은 경우에만 file_ids 적용할 수 있습니다. |
아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | vectorStoreObject | 벡터 저장소는 file_search 도구에서 사용할 수 있는 처리된 파일의 컬렉션입니다. |
예제
예시
벡터 저장소를 만듭니다.
POST https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"id": "vs_abc123",
"object": "vector_store",
"created_at": 1699061776,
"name": "Support FAQ",
"bytes": 139920,
"file_counts": {
"in_progress": 0,
"completed": 3,
"failed": 0,
"cancelled": 0,
"total": 3
}
}
}
가져오기 - 벡터 저장소
GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview
벡터 저장소를 검색합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| vector_store_id | 경로 | 예 | string | |
| api-version | query | 예 | string |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | vectorStoreObject | 벡터 저장소는 file_search 도구에서 사용할 수 있는 처리된 파일의 컬렉션입니다. |
예제
예시
벡터 저장소를 검색합니다.
GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"id": "vs_abc123",
"object": "vector_store",
"created_at": 1699061776
}
}
수정 - 벡터 저장소
POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview
벡터 저장소를 수정합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| vector_store_id | 경로 | 예 | string | |
| api-version | query | 예 | string |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
Content-Type: application/json
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| name | string | 벡터 저장소의 이름입니다. | 아니요 | |
| expires_after | vectorStoreExpirationAfter | 벡터 저장소에 대한 만료 정책입니다. | 아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | vectorStoreObject | 벡터 저장소는 file_search 도구에서 사용할 수 있는 처리된 파일의 컬렉션입니다. |
예제
예시
벡터 저장소를 수정합니다.
POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview
{
"name": "Support FAQ"
}
응답: 상태 코드: 200
{
"body": {
"id": "vs_abc123",
"object": "vector_store",
"created_at": 1699061776,
"name": "Support FAQ",
"bytes": 139920,
"file_counts": {
"in_progress": 0,
"completed": 3,
"failed": 0,
"cancelled": 0,
"total": 3
}
}
}
삭제 - 벡터 저장소
DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview
벡터 저장소를 삭제합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| vector_store_id | 경로 | 예 | string | |
| api-version | query | 예 | string |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | deleteVectorStoreResponse |
예제
예시
벡터 저장소를 삭제합니다.
DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"id": "vs_abc123",
"object": "vector_store.deleted",
"deleted": true
}
}
나열 - 벡터 저장소 파일
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview
벡터 저장소 파일 목록을 반환합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| vector_store_id | 경로 | 예 | string | |
| limit | query | 아니요 | 정수 | |
| order | query | 아니요 | string | |
| after | query | 아니요 | string | |
| before | query | 아니요 | string | |
| 필터링 | query | 아니요 | string | |
| api-version | query | 예 | string |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | listVectorStoreFilesResponse |
예제
예시
벡터 저장소 파일 목록을 반환합니다.
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"object": "list",
"data": [
{
"id": "file-abc123",
"object": "vector_store.file",
"created_at": 1699061776,
"vector_store_id": "vs_abc123"
},
{
"id": "file-abc456",
"object": "vector_store.file",
"created_at": 1699061776,
"vector_store_id": "vs_abc123"
}
],
"first_id": "file-abc123",
"last_id": "file-abc456",
"has_more": false
}
}
만들기 - 벡터 저장소 파일
POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview
벡터 저장소에 파일을 연결하여 벡터 저장소 파일을 만듭니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| vector_store_id | 경로 | 예 | string | |
| api-version | query | 예 | string |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
Content-Type: application/json
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| file_id | string | 벡터 저장소에서 사용해야 하는 파일 ID입니다. 파일에 액세스할 수 있는 file_search와 같은 도구에 유용합니다. |
예 | |
| chunking_strategy | chunkingStrategyRequestParam | 파일을 청크하는 데 사용되는 청크 전략입니다. 설정하지 않으면 auto 전략을 사용합니다. |
아니요 |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | vectorStoreFileObject | 벡터 저장소에 연결된 파일 목록입니다. |
예제
예시
벡터 저장소에 파일을 연결하여 벡터 저장소 파일을 만듭니다.
POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview
{
"file_id": "file-abc123"
}
응답: 상태 코드: 200
{
"body": {
"id": "file-abc123",
"object": "vector_store.file",
"created_at": 1699061776,
"usage_bytes": 1234,
"vector_store_id": "vs_abcd",
"status": "completed",
"last_error": null
}
}
가져오기 - 벡터 저장소 파일
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview
벡터 저장소 파일을 검색합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| vector_store_id | 경로 | 예 | string | |
| file_id | 경로 | 예 | string | |
| api-version | query | 예 | string |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | vectorStoreFileObject | 벡터 저장소에 연결된 파일 목록입니다. |
예제
예시
벡터 저장소 파일을 검색합니다.
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"id": "file-abc123",
"object": "vector_store.file",
"created_at": 1699061776,
"vector_store_id": "vs_abcd",
"status": "completed",
"last_error": null
}
}
삭제 - 벡터 저장소 파일
DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview
벡터 저장소 파일을 삭제합니다. 이렇게 하면 벡터 저장소에서 파일이 제거되지만 파일 자체가 삭제되지는 않습니다. 파일을 삭제하려면 파일 삭제 엔드포인트를 사용합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| vector_store_id | 경로 | 예 | string | |
| file_id | 경로 | 예 | string | |
| api-version | query | 예 | string |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | deleteVectorStoreFileResponse |
예제
예시
벡터 저장소 파일을 삭제합니다. 이렇게 하면 벡터 저장소에서 파일이 제거되지만 파일 자체가 삭제되지는 않습니다. 파일을 삭제하려면 파일 삭제 엔드포인트를 사용합니다.
DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"id": "file_abc123",
"object": "vector_store.file.deleted",
"deleted": true
}
}
만들기 - 벡터 저장소 파일 일괄 처리
POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2024-10-01-preview
벡터 저장소 파일 일괄 처리를 만듭니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| vector_store_id | 경로 | 예 | string | |
| api-version | query | 예 | string |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
요청 본문
Content-Type: application/json
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| file_ids | 배열 | 벡터 저장소에서 사용해야 하는 파일 ID 목록입니다. 파일에 액세스할 수 있는 file_search와 같은 도구에 유용합니다. |
예 | |
| chunking_strategy | chunkingStrategyRequestParam | 파일을 청크하는 데 사용되는 청크 전략입니다. 설정하지 않으면 auto 전략을 사용합니다. |
아니요 |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | vectorStoreFileBatchObject | 벡터 저장소에 연결된 파일의 일괄 처리입니다. |
예제
예시
벡터 저장소 파일 일괄 처리를 만듭니다.
POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2024-10-01-preview
{
"file_ids": [
"file-abc123",
"file-abc456"
]
}
응답: 상태 코드: 200
{
"id": "vsfb_abc123",
"object": "vector_store.file_batch",
"created_at": 1699061776,
"vector_store_id": "vs_abc123",
"status": "in_progress",
"file_counts": {
"in_progress": 1,
"completed": 1,
"failed": 0,
"cancelled": 0,
"total": 0
}
}
가져오기 - 벡터 저장소 파일 일괄 처리
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2024-10-01-preview
벡터 저장소 파일 일괄 처리를 검색합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| vector_store_id | 경로 | 예 | string | |
| batch_id | 경로 | 예 | string | |
| api-version | query | 예 | string |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | vectorStoreFileBatchObject | 벡터 저장소에 연결된 파일의 일괄 처리입니다. |
예제
예시
벡터 저장소 파일 일괄 처리를 검색합니다.
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"id": "vsfb_abc123",
"object": "vector_store.file_batch",
"created_at": 1699061776,
"vector_store_id": "vs_abc123",
"status": "in_progress",
"file_counts": {
"in_progress": 1,
"completed": 1,
"failed": 0,
"cancelled": 0,
"total": 0
}
}
}
취소 - 벡터 저장소 파일 일괄 처리
POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2024-10-01-preview
벡터 저장소 파일 일괄 처리를 취소합니다. 이렇게 하면 가능한 한 빨리 이 일괄 처리의 파일 처리를 취소하려고 시도합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| vector_store_id | 경로 | 예 | string | |
| batch_id | 경로 | 예 | string | |
| api-version | query | 예 | string |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | vectorStoreFileBatchObject | 벡터 저장소에 연결된 파일의 일괄 처리입니다. |
예제
예시
벡터 저장소 파일 일괄 처리를 취소합니다. 이렇게 하면 가능한 한 빨리 이 일괄 처리의 파일 처리를 취소하려고 시도합니다.
POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"id": "vsfb_abc123",
"object": "vector_store.file_batch",
"created_at": 1699061776,
"vector_store_id": "vs_abc123",
"status": "cancelling",
"file_counts": {
"in_progress": 12,
"completed": 3,
"failed": 0,
"cancelled": 0,
"total": 15
}
}
}
나열 - 벡터 저장소 파일 일괄 처리 파일
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2024-10-01-preview
벡터 저장소 파일 목록을 일괄 처리로 반환합니다.
URI 매개 변수
| 이름 | 그런 다음 | 필수 | Type | 설명 |
|---|---|---|---|---|
| endpoint | 경로 | 예 | string URL |
지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com |
| vector_store_id | 경로 | 예 | string | |
| batch_id | 경로 | 예 | string | |
| limit | query | 아니요 | 정수 | |
| order | query | 아니요 | string | |
| after | query | 아니요 | string | |
| before | query | 아니요 | string | |
| 필터링 | query | 아니요 | string | |
| api-version | query | 예 | string |
요청 헤더
| 이름 | 필수 | Type | 설명 |
|---|---|---|---|
| api-key | True | string | 여기에서 Azure OpenAI API 키를 제공합니다. |
응답
상태 코드: 200
설명: 정상
| Content-Type | Type | 설명 |
|---|---|---|
| application/json | listVectorStoreFilesResponse |
예제
예시
벡터 저장소 파일 목록을 반환합니다.
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2024-10-01-preview
응답: 상태 코드: 200
{
"body": {
"object": "list",
"data": [
{
"id": "file-abc123",
"object": "vector_store.file",
"created_at": 1699061776,
"vector_store_id": "vs_abc123"
},
{
"id": "file-abc456",
"object": "vector_store.file",
"created_at": 1699061776,
"vector_store_id": "vs_abc123"
}
],
"first_id": "file-abc123",
"last_id": "file-abc456",
"has_more": false
}
}
구성 요소
errorResponse
| 이름 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| error | error | 아니요 |
errorBase
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 코드 | string | 아니요 | ||
| message | string | 아니요 |
error
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| param | string | 예 | ||
| type | string | 아니요 | ||
| inner_error | innerError | 추가 세부 정보가 포함된 내부 오류입니다. | 아니요 |
innerError
추가 세부 정보가 포함된 내부 오류입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 코드 | innerErrorCode | 내부 오류 개체에 대한 오류 코드입니다. | 아니요 | |
| content_filter_results | contentFilterPromptResults | 콘텐츠 필터링 범주(증오, 성 관련, 폭력, 자해) 및 심각도 수준(유해한 콘텐츠의 강도 및 위험 수준을 결정하는 매우 낮음, 낮음, 중간, 높음)과 필터링되었는지 여부에 대한 정보입니다. 탈옥 콘텐츠 및 욕설, 감지되었는지 여부 및 필터링되었는지 여부에 대한 정보입니다. 또한 고객 차단 목록, 필터링되었는지 여부 및 해당 ID에 대한 정보입니다. | 아니요 |
innerErrorCode
내부 오류 개체에 대한 오류 코드입니다.
설명: 내부 오류 개체에 대한 오류 코드입니다.
형식: string
기본값:
열거형 이름: InnerErrorCode
열거형 값:
| 값 | 설명 |
|---|---|
| ResponsibleAIPolicyViolation | 프롬프트가 더 많은 콘텐츠 필터 규칙 중 하나를 위반했습니다. |
dalleErrorResponse
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| error | dalleError | 아니요 |
dalleError
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| param | string | 예 | ||
| type | string | 아니요 | ||
| inner_error | dalleInnerError | 추가 세부 정보가 포함된 내부 오류입니다. | 아니요 |
dalleInnerError
추가 세부 정보가 포함된 내부 오류입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 코드 | innerErrorCode | 내부 오류 개체에 대한 오류 코드입니다. | 아니요 | |
| content_filter_results | dalleFilterResults | 콘텐츠 필터링 범주(증오, 성 관련, 폭력, 자해) 및 심각도 수준(유해한 콘텐츠의 강도 및 위험 수준을 결정하는 매우 낮음, 낮음, 중간, 높음)과 필터링되었는지 여부에 대한 정보입니다. 탈옥 콘텐츠 및 욕설, 감지되었는지 여부 및 필터링되었는지 여부에 대한 정보입니다. 또한 고객 차단 목록, 필터링되었는지 여부 및 해당 ID에 대한 정보입니다. | 아니요 | |
| revised_prompt | string | 프롬프트에 수정 버전이 있는 경우 이미지를 생성하는 데 사용된 프롬프트입니다. | 아니요 |
contentFilterCompletionTextSpan
생성된 완료 텍스트 내의 범위를 설명합니다. 오프셋 0은 완성 텍스트의 첫 번째 UTF32 코드 포인트입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| completion_start_offset | 정수 | 범위를 시작하는 UTF32 코드 지점의 오프셋입니다. | 예 | |
| completion_end_offset | 정수 | 범위에서 제외되는 첫 번째 UTF32 코드 지점의 오프셋입니다. 이 필드는 빈 범위에 대해 항상 completion_start_offset 같습니다. 이 필드는 항상 비어 있지 않은 범위에 대해 completion_start_offset보다 큽니다. | 예 |
contentFilterResultBase
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| filtered | 부울 값 | 예 |
contentFilterSeverityResult
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| filtered | 부울 값 | 예 | ||
| severity | string | 아니요 |
contentFilterDetectedResult
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| filtered | 부울 값 | 예 | ||
| 감지됨 | 부울 값 | 아니요 |
contentFilterDetectedWithCitationResult
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| citation | 개체 | 아니요 |
citation의 속성
URL
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| URL | string |
license
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| license | string |
contentFilterDetectedWithCompletionTextSpansResult
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| details | 배열 | 아니요 |
contentFilterIdResult
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| filtered | 부울 값 | 예 | ||
| id | string | 아니요 |
contentFilterResultsBase
콘텐츠 필터링 결과에 대한 정보입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 성 관련 | contentFilterSeverityResult | 아니요 | ||
| 폭력 | contentFilterSeverityResult | 아니요 | ||
| 증오 | contentFilterSeverityResult | 아니요 | ||
| 자해 | contentFilterSeverityResult | 아니요 | ||
| 욕설 | contentFilterDetectedResult | 아니요 | ||
| 사용자 지정 차단 목록 | contentFilterDetailedResults | 필터링된 세그먼트에 대한 콘텐츠 필터 ID의 세부 정보가 포함된 콘텐츠 필터링 결과입니다. | 아니요 | |
| error | errorBase | 아니요 |
contentFilterPromptResults
콘텐츠 필터링 범주(증오, 성 관련, 폭력, 자해) 및 심각도 수준(유해한 콘텐츠의 강도 및 위험 수준을 결정하는 매우 낮음, 낮음, 중간, 높음)과 필터링되었는지 여부에 대한 정보입니다. 탈옥 콘텐츠 및 욕설, 감지되었는지 여부 및 필터링되었는지 여부에 대한 정보입니다. 또한 고객 차단 목록, 필터링되었는지 여부 및 해당 ID에 대한 정보입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 성 관련 | contentFilterSeverityResult | 아니요 | ||
| 폭력 | contentFilterSeverityResult | 아니요 | ||
| 증오 | contentFilterSeverityResult | 아니요 | ||
| 자해 | contentFilterSeverityResult | 아니요 | ||
| 욕설 | contentFilterDetectedResult | 아니요 | ||
| 사용자 지정 차단 목록 | contentFilterDetailedResults | 필터링된 세그먼트에 대한 콘텐츠 필터 ID의 세부 정보가 포함된 콘텐츠 필터링 결과입니다. | 아니요 | |
| error | errorBase | 아니요 | ||
| 탈옥 | contentFilterDetectedResult | 아니요 | ||
| 간접적인 공격 | contentFilterDetectedResult | 아니요 |
contentFilterChoiceResults
콘텐츠 필터링 범주(증오, 성 관련, 폭력, 자해) 및 심각도 수준(유해한 콘텐츠의 강도 및 위험 수준을 결정하는 매우 낮음, 낮음, 중간, 높음)과 필터링되었는지 여부에 대한 정보입니다. 타사 텍스트 및 욕설, 감지되었는지 여부 및 필터링되었는지 여부에 대한 정보입니다. 또한 고객 차단 목록, 필터링되었는지 여부 및 해당 ID에 대한 정보입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 성 관련 | contentFilterSeverityResult | 아니요 | ||
| 폭력 | contentFilterSeverityResult | 아니요 | ||
| 증오 | contentFilterSeverityResult | 아니요 | ||
| 자해 | contentFilterSeverityResult | 아니요 | ||
| 욕설 | contentFilterDetectedResult | 아니요 | ||
| 사용자 지정 차단 목록 | contentFilterDetailedResults | 필터링된 세그먼트에 대한 콘텐츠 필터 ID의 세부 정보가 포함된 콘텐츠 필터링 결과입니다. | 아니요 | |
| error | errorBase | 아니요 | ||
| protected_material_text | contentFilterDetectedResult | 아니요 | ||
| protected_material_code | contentFilterDetectedWithCitationResult | 아니요 | ||
| ungrounded_material | contentFilterDetectedWithCompletionTextSpansResult | 아니요 |
contentFilterDetailedResults
필터링된 세그먼트에 대한 콘텐츠 필터 ID의 세부 정보가 포함된 콘텐츠 필터링 결과입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| filtered | 부울 값 | 예 | ||
| details | 배열 | 아니요 |
promptFilterResult
요청의 단일 프롬프트에 대한 콘텐츠 필터링 결과입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| prompt_index | 정수 | 아니요 | ||
| content_filter_results | contentFilterPromptResults | 콘텐츠 필터링 범주(증오, 성 관련, 폭력, 자해) 및 심각도 수준(유해한 콘텐츠의 강도 및 위험 수준을 결정하는 매우 낮음, 낮음, 중간, 높음)과 필터링되었는지 여부에 대한 정보입니다. 탈옥 콘텐츠 및 욕설, 감지되었는지 여부 및 필터링되었는지 여부에 대한 정보입니다. 또한 고객 차단 목록, 필터링되었는지 여부 및 해당 ID에 대한 정보입니다. | 아니요 |
promptFilterResults
요청에서 0개 이상의 프롬프트에 대한 콘텐츠 필터링 결과입니다. 스트리밍 요청에서 다른 프롬프트에 대한 결과는 서로 다른 시간 또는 다른 순서로 도착할 수 있습니다.
이 구성 요소에 대해 정의된 속성이 없습니다.
dalleContentFilterResults
콘텐츠 필터링 결과에 대한 정보입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 성 관련 | contentFilterSeverityResult | 아니요 | ||
| 폭력 | contentFilterSeverityResult | 아니요 | ||
| 증오 | contentFilterSeverityResult | 아니요 | ||
| 자해 | contentFilterSeverityResult | 아니요 |
dalleFilterResults
콘텐츠 필터링 범주(증오, 성 관련, 폭력, 자해) 및 심각도 수준(유해한 콘텐츠의 강도 및 위험 수준을 결정하는 매우 낮음, 낮음, 중간, 높음)과 필터링되었는지 여부에 대한 정보입니다. 탈옥 콘텐츠 및 욕설, 감지되었는지 여부 및 필터링되었는지 여부에 대한 정보입니다. 또한 고객 차단 목록, 필터링되었는지 여부 및 해당 ID에 대한 정보입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 성 관련 | contentFilterSeverityResult | 아니요 | ||
| 폭력 | contentFilterSeverityResult | 아니요 | ||
| 증오 | contentFilterSeverityResult | 아니요 | ||
| 자해 | contentFilterSeverityResult | 아니요 | ||
| 욕설 | contentFilterDetectedResult | 아니요 | ||
| 탈옥 | contentFilterDetectedResult | 아니요 | ||
| 사용자 지정 차단 목록 | contentFilterDetailedResults | 필터링된 세그먼트에 대한 콘텐츠 필터 ID의 세부 정보가 포함된 콘텐츠 필터링 결과입니다. | 아니요 |
chatCompletionsRequestCommon
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 온도 | 번호 | 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. 일반적으로 이를 변경하거나 top_p을(를) 변경하는 것이 좋지만 둘 다 변경하지는 않는 것이 좋습니다. |
아니요 | 1 |
| top_p | 번호 | 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 temperature을(를) 변경하는 것이 좋지만 둘 다 변경하지는 않는 것이 좋습니다. |
아니요 | 1 |
| stream | 부울 값 | 설정되면 ChatGPT의 경우처럼 부분 메시지 델타가 전송됩니다. 토큰은 사용할 수 있게 되면 데이터 전용 서버 전송 이벤트로 전송되고 스트림은 data: [DONE] 메시지로 종료됩니다. |
아니요 | False |
| stop | 문자열 또는 배열 | API가 추가 토큰 생성을 중지하는 최대 4개의 시퀀스입니다. | 아니요 | |
| max_tokens | 정수 | 생성된 답변에 허용되는 최대 토큰 수입니다. 기본적으로 모델이 반환할 수 있는 토큰 수는 (4096 - 프롬프트 토큰)입니다. o1 시리즈 모델과 호환되지 않습니다. | 아니요 | 4096 |
| max_completion_tokens | 정수 | 표시되는 출력 토큰 및 추론 토큰을 포함하여 완료를 위해 생성할 수 있는 토큰 수에 대한 상한입니다. o1 시리즈 모델에서만 지원됩니다. 향후 API 릴리스에서 다른 모델로 지원을 확장합니다. | 아니요 | |
| presence_penalty | number | -2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트에 나타나는지 여부에 따라 새 토큰에 페널티를 부여하여 모델이 새 항목에 대해 이야기할 가능성을 높입니다. | 아니요 | 0 |
| frequency_penalty | number | -2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트의 기존 빈도를 기반으로 새 토큰에 불이익을 주어 모델이 동일한 줄을 그대로 반복할 가능성을 줄입니다. | 아니요 | 0 |
| logit_bias | 개체 | 완료 시 지정된 토큰이 나타날 가능성을 수정합니다. 토큰(토크나이저에서 토큰 ID로 지정)을 -100에서 100 사이의 관련 바이어스 값에 매핑하는 json 개체를 허용합니다. 수학적으로, 바이어스는 샘플링 전에 모델에 의해 생성된 로짓에 추가됩니다. 정확한 효과는 모델마다 다르지만 -1과 1 사이의 값은 선택 가능성을 줄이거나 높여야 합니다. -100 또는 100과 같은 값은 관련 토큰을 금지하거나 독점적으로 선택해야 합니다. | 아니요 | |
| user | string | Azure OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다. | 아니요 |
createCompletionRequest
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| prompt | 문자열 또는 배열 | 문자열, 문자열 배열, 토큰 배열 또는 토큰 배열의 배열로 인코딩된 완료를 생성하라는 프롬프트. <|endoftext|>는 학습 중에 모델이 보는 문서 구분 기호이므로 프롬프트가 지정되지 않은 경우 모델은 새 문서의 시작 부분에서 생성되는 것처럼 생성됩니다. |
예 | |
| best_of | 정수 | 서버 쪽에서 best_of 완료를 생성하고 "최상"(토큰당 로그 확률이 가장 높은 것)을 반환합니다. 결과를 스트리밍할 수 없습니다.n과 함께 사용하면 best_of는 후보 완료 횟수를 제어하고 n은 반환할 횟수를 지정합니다. best_of는 n보다 커야 합니다.참고: 이 매개 변수는 많은 완료를 생성하므로 토큰 할당량을 빠르게 소모할 수 있습니다. 신중하게 사용하고 max_tokens 및 stop에 대한 설정이 적절한지 확인합니다. |
아니요 | 1 |
| echo | 부울 값 | 완료와 함께 프롬프트를 다시 에코합니다. |
아니요 | False |
| frequency_penalty | number | -2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트의 기존 빈도를 기반으로 새 토큰에 불이익을 주어 모델이 동일한 줄을 그대로 반복할 가능성을 줄입니다. |
아니요 | 0 |
| logit_bias | 개체 | 완료 시 지정된 토큰이 나타날 가능성을 수정합니다. 토큰(GPT 토크나이저에서 토큰 ID로 지정)을 -100에서 100 사이의 관련 바이어스 값에 매핑하는 JSON 개체를 허용합니다. 수학적으로, 바이어스는 샘플링 전에 모델에 의해 생성된 로짓에 추가됩니다. 정확한 효과는 모델마다 다르지만 -1과 1 사이의 값은 선택 가능성을 줄이거나 높여야 합니다. -100 또는 100과 같은 값은 관련 토큰을 금지하거나 독점적으로 선택해야 합니다. 예를 들어, {"50256": -100}을 전달하면 <|endoftext|> 토큰이 생성되지 않습니다. |
아니요 | None |
| 로그 문제 | 정수 | 가장 가능성이 높은 logprobs 출력 토큰과 선택한 토큰에 대한 로그 확률을 포함합니다. 예를 들어, logprobs가 5이면 API는 가장 가능성 있는 5개의 토큰 목록을 반환합니다. API는 항상 샘플링된 토큰을 반환 logprob 하므로 응답에 최대 logprobs+1 요소가 있을 수 있습니다.logprobs의 최댓값은 5입니다. |
아니요 | None |
| max_tokens | 정수 | 완료 시 생성할 수 있는 최대 토큰 수입니다. 프롬프트의 토큰 수에 max_tokens를 더한 값은 모델의 컨텍스트 길이를 초과할 수 없습니다. |
아니요 | 16 |
| n | 정수 | 각 프롬프트에 대해 생성할 완료 수입니다. 참고: 이 매개 변수는 많은 완료를 생성하므로 토큰 할당량을 빠르게 소모할 수 있습니다. 신중하게 사용하고 max_tokens 및 stop에 대한 설정이 적절한지 확인합니다. |
아니요 | 1 |
| presence_penalty | number | -2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트에 나타나는지 여부에 따라 새 토큰에 페널티를 부여하여 모델이 새 항목에 대해 이야기할 가능성을 높입니다. |
아니요 | 0 |
| seed | 정수 | 지정된 경우 시스템은 결정론적으로 샘플링하기 위해 최선을 다하므로 동일한 seed 및 매개 변수를 사용하는 반복 요청이 동일한 결과를 반환해야 합니다.결정성은 보장되지 않으며 백 엔드의 변경 내용을 모니터링하려면 system_fingerprint 응답 매개 변수를 참조해야 합니다. |
아니요 | |
| stop | 문자열 또는 배열 | API가 추가 토큰 생성을 중지하는 최대 4개의 시퀀스입니다. 반환된 텍스트에는 중지 시퀀스가 포함되지 않습니다. |
아니요 | |
| stream | 부울 값 | 부분 진행률을 다시 스트리밍할지 여부를 나타냅니다. 설정된 경우 토큰은 데이터 전용 서버 전송 이벤트로 전송되며 스트림은 data: [DONE] 메시지로 종료됩니다." |
아니요 | False |
| 접미사 | string | 삽입된 텍스트가 완료된 뒤에 오는 접미사입니다. 이 매개 변수는 gpt-3.5-turbo-instruct에만 지원됩니다. |
아니요 | None |
| 온도 | 번호 | 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. 일반적으로 이를 변경하거나 top_p을(를) 변경하는 것이 좋지만 둘 다 변경하지는 않는 것이 좋습니다. |
아니요 | 1 |
| top_p | 번호 | 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 temperature을(를) 변경하는 것이 좋지만 둘 다 변경하지는 않는 것이 좋습니다. |
아니요 | 1 |
| user | string | 남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다. |
아니요 |
createCompletionResponse
API의 완료 응답을 나타냅니다. 참고: 스트리밍된 응답 개체와 비스트림 응답 개체는 채팅 엔드포인트와 달리 동일한 셰이프를 공유합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | 완료의 고유 식별자입니다. | 예 | |
| 선택 | 배열 | 입력 프롬프트에 대해 생성된 모델의 완료 선택 목록입니다. | 예 | |
| created | 정수 | 완료가 만들어진 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| model | string | 완료에 사용되는 모델. | 예 | |
| prompt_filter_results | promptFilterResults | 요청에서 0개 이상의 프롬프트에 대한 콘텐츠 필터링 결과입니다. 스트리밍 요청에서 다른 프롬프트에 대한 결과는 서로 다른 시간 또는 다른 순서로 도착할 수 있습니다. | 아니요 | |
| system_fingerprint | string | 이 지문은 모델이 실행되는 백 엔드 구성을 나타냅니다. 결정론에 영향을 미칠 수 있는 백 엔드 변경이 이루어진 시기를 이해하기 위해 seed 요청 매개 변수와 함께 사용할 수 있습니다. |
아니요 | |
| 개체 | enum | 항상 “text_completion”인 개체 형식입니다. 가능한 값: text_completion |
예 | |
| 사용량 | completionUsage | 완료 요청의 사용 통계입니다. | 아니요 |
createChatCompletionRequest
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 온도 | 번호 | 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. 일반적으로 이를 변경하거나 top_p을(를) 변경하는 것이 좋지만 둘 다 변경하지는 않는 것이 좋습니다. |
아니요 | 1 |
| top_p | 번호 | 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 temperature을(를) 변경하는 것이 좋지만 둘 다 변경하지는 않는 것이 좋습니다. |
아니요 | 1 |
| stream | 부울 값 | 설정되면 ChatGPT의 경우처럼 부분 메시지 델타가 전송됩니다. 토큰은 데이터 전용 서버 전송 이벤트로 전송되며 스트림은 data: [DONE] 메시지로 종료됩니다. |
아니요 | False |
| stop | 문자열 또는 배열 | API가 추가 토큰 생성을 중지하는 최대 4개의 시퀀스입니다. |
아니요 | |
| max_tokens | 정수 | 채팅 완료 시 생성할 수 있는 최대 토큰 수입니다. 입력 토큰과 생성된 토큰의 총 길이는 모델의 컨텍스트 길이에 따라 제한됩니다. |
아니요 | |
| max_completion_tokens | 정수 | 표시되는 출력 토큰 및 추론 토큰을 포함하여 완료를 위해 생성할 수 있는 토큰 수에 대한 상한입니다. o1 시리즈 모델에서만 지원됩니다. 향후 API 릴리스에서 다른 모델로 지원을 확장합니다. | 아니요 | |
| presence_penalty | number | -2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트에 나타나는지 여부에 따라 새 토큰에 페널티를 부여하여 모델이 새 항목에 대해 이야기할 가능성을 높입니다. |
아니요 | 0 |
| frequency_penalty | number | -2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트의 기존 빈도를 기반으로 새 토큰에 불이익을 주어 모델이 동일한 줄을 그대로 반복할 가능성을 줄입니다. |
아니요 | 0 |
| logit_bias | 개체 | 완료 시 지정된 토큰이 나타날 가능성을 수정합니다. 토큰(토크나이저에서 토큰 ID로 지정)을 -100에서 100 사이의 관련 바이어스 값에 매핑하는 JSON 개체를 허용합니다. 수학적으로, 바이어스는 샘플링 전에 모델에 의해 생성된 로짓에 추가됩니다. 정확한 효과는 모델마다 다르지만 -1과 1 사이의 값은 선택 가능성을 줄이거나 높여야 합니다. -100 또는 100과 같은 값은 관련 토큰을 금지하거나 독점적으로 선택해야 합니다. |
아니요 | None |
| user | string | 남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다. |
아니요 | |
| messages | 배열 | 지금까지의 대화를 구성하는 메시지 목록입니다. | 예 | |
| data_sources | 배열 | 이를 사용하는 Azure OpenAI 채팅 확장에 대한 구성 항목입니다. 이 추가 사양은 Azure OpenAI와만 호환됩니다. |
아니요 | |
| 로그 문제 | 부울 값 | 출력 토큰의 로그 확률을 반환할지 여부를 나타냅니다. true인 경우 message의 content에 반환된 각 출력 토큰의 로그 확률을 반환합니다. |
아니요 | False |
| top_logprobs | 정수 | 각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. 이 매개 변수를 사용하는 경우 logprobs를 true로 설정해야 합니다. |
아니요 | |
| n | 정수 | 각 입력 메시지에 대해 생성할 채팅 완료 선택 항목 수입니다. 모든 선택 항목에 걸쳐 생성된 토큰 수에 따라 요금이 부과됩니다. 비용을 최소화하려면 n을 1로 유지합니다. |
아니요 | 1 |
| parallel_tool_calls | ParallelToolCalls | 도구를 사용하는 동안 병렬 함수 호출을 사용하도록 설정할지 여부입니다. | 아니요 | True |
| response_format | ResponseFormatText, ResponseFormatJsonObject 또는 ResponseFormatJsonSchema | 모델이 출력해야 하는 형식을 지정하는 개체입니다. GPT-4o, GPT-4o mini, GPT-4 Turbo 및 모든 GPT-3.5 Turbo 모델과 호환됩니다gpt-3.5-turbo-1106.{ "type": "json_schema", "json_schema": {...} }로 설정하면 구조화된 출력이 사용하도록 설정되어 모델이 제공된 JSON 스키마와 일치함이 보장됩니다.{ "type": "json_object" }(으)로 설정하면 모델이 생성하는 메시지가 유효한 JSON임을 보장하는 JSON 모드가 사용하도록 설정됩니다.중요: JSON 모드를 사용하는 경우 시스템 또는 사용자 메시지를 통해 직접 JSON을 생성하도록 모델에 지시해야 합니다. 이렇게 하지 않으면 생성이 토큰 제한에 도달할 때까지 모델은 공백의 끝없는 스트림을 생성하여 장기 실행되고 겉보기에 "중단" 요청이 발생할 수 있습니다. 또한 생성이 max_tokens을(를) 초과했거나 대화가 최대 컨텍스트 길이를 초과했음을 나타내는 finish_reason="length"인 경우 메시지 콘텐츠가 부분적으로 잘릴 수 있습니다. |
아니요 | |
| seed | 정수 | 이 기능은 베타 버전으로 제공됩니다. 지정된 경우 시스템은 결정론적으로 샘플링하기 위해 최선을 다하므로 동일한 seed 및 매개 변수를 사용하는 반복 요청이 동일한 결과를 반환해야 합니다.결정성은 보장되지 않으며 백 엔드의 변경 내용을 모니터링하려면 system_fingerprint 응답 매개 변수를 참조해야 합니다. |
아니요 | |
| stream_options | chatCompletionStreamOptions | 스트리밍 응답에 대한 옵션입니다. 설정할 stream: true때만 설정합니다. |
아니요 | None |
| tools | 배열 | 모델이 호출할 수 있는 도구 목록입니다. 현재 함수만 도구로 지원됩니다. 모델이 JSON 입력을 생성할 수 있는 함수 목록을 제공하려면 이를 사용합니다. 최대 128개의 함수가 지원됩니다. |
아니요 | |
| tool_choice | chatCompletionToolChoiceOption | 모델이 호출하는 도구(있는 경우)를 제어합니다. none은(는) 모델이 도구를 호출하지 않고 대신 메시지를 생성함을 의미합니다. auto은(는) 모델이 메시지 생성 또는 하나 이상의 도구 호출 중에서 선택할 수 있음을 의미합니다. required은(는) 모델이 하나 이상의 도구를 호출해야 함을 의미합니다. {"type": "function", "function": {"name": "my_function"}}을 사용하여 특정 도구를 지정하면 모델이 해당 도구를 강제 호출하게 됩니다. none은(는) 도구가 없는 경우 기본값입니다. auto은(는) 도구가 있는 경우 기본값입니다. |
아니요 | |
| function_call | 문자열 또는 chatCompletionFunctionCallOption | tool_choice에는 더 이상 사용되지 않습니다.모델에서 호출되는 함수(해당하는 경우)를 제어합니다. none은 모델이 함수를 호출하지 않고 대신 메시지를 생성함을 의미합니다.auto는 모델이 메시지 생성 또는 함수 호출 중에서 선택할 수 있음을 의미합니다.{"name": "my_function"}을 통해 특정 함수를 지정하면 모델이 해당 함수를 호출하게 됩니다.함수가 없을 경우 none이 기본값입니다. 함수가 있는 경우 auto가 기본값입니다. |
아니요 | |
| functions | 배열 | tools을(를) 위해 사용되지 않습니다.모델이 JSON 입력을 생성할 수 있는 함수 목록입니다. |
아니요 |
chatCompletionFunctions
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| description | string | 함수를 호출하는 시기와 방법을 선택하기 위해 모델에서 사용하는 함수의 기능에 대한 설명입니다. | 아니요 | |
| 이름 | string | 호출할 함수의 이름입니다. a~z, A~Z, 0~9 또는 밑줄과 대시를 포함해야 하며 최대 길이는 64자여야 합니다. | 예 | |
| 매개 변수 | FunctionParameters | 함수가 허용하는 매개 변수로, JSON 스키마 개체로 설명됩니다. 예를 보려면 가이드](/azure/ai-services/openai/how-to/function-calling)를 참조하고, 형식에 대한 설명서는 JSON 스키마 참조를 참조하세요. parameters를 생략하면 빈 매개 변수 목록이 있는 함수가 정의됩니다. |
아니요 |
chatCompletionFunctionCallOption
{"name": "my_function"}을 통해 특정 함수를 지정하면 모델이 해당 함수를 호출하게 됩니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| name | string | 호출할 함수의 이름입니다. | 예 |
chatCompletionFunctionParameters
함수가 허용하는 매개 변수로, JSON 스키마 개체로 설명됩니다. 예를 보려면 가이드/를 참조하고, 형식에 대한 설명서는 JSON 스키마 참조를 참조하세요.
이 구성 요소에 대해 정의된 속성이 없습니다.
chatCompletionRequestMessage
이 구성 요소는 다음 중 하나일 수 있습니다.
chatCompletionRequestSystemMessage
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| content | 문자열 또는 배열 | 시스템 메시지의 콘텐츠. | 예 | |
| 역할(role) | enum | 메시지 작성자의 역할(이 경우 system)입니다.가능한 값: system |
예 | |
| 이름 | string | 참가자의 선택 이름입니다. 동일한 역할의 참가자를 구별하기 위한 모델 정보를 제공합니다. | 아니요 |
chatCompletionRequestUserMessage
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| content | 문자열 또는 배열 | 사용자 메시지의 콘텐츠. |
예 | |
| 역할(role) | enum | 메시지 작성자의 역할(이 경우 user)입니다.가능한 값: user |
예 | |
| 이름 | string | 참가자의 선택 이름입니다. 동일한 역할의 참가자를 구별하기 위한 모델 정보를 제공합니다. | 아니요 |
chatCompletionRequestAssistantMessage
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| content | 문자열 또는 배열 | 보조 메시지의 콘텐츠입니다. tool_calls 또는 function_call이 지정되지 않은 경우 필수입니다. |
아니요 | |
| 거부 | string | 도우미가 보낸 거절 메시지. | 아니요 | |
| 역할(role) | enum | 메시지 작성자의 역할(이 경우 assistant)입니다.가능한 값: assistant |
예 | |
| 이름 | string | 참가자의 선택 이름입니다. 동일한 역할의 참가자를 구별하기 위한 모델 정보를 제공합니다. | 아니요 | |
| tool_calls | chatCompletionMessageToolCalls | 함수 호출과 같이 모델에서 생성된 도구 호출입니다. | 아니요 | |
| function_call | 개체 | 더 이상 사용되지 않으며 tool_calls로 대체되었습니다. 모델에 의해 생성된 대로 호출되어야 하는 함수의 이름과 인수입니다. |
아니요 |
function_call에 대한 속성
arguments
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| arguments | string | JSON 형식의 모델에 의해 생성된 함수 호출에 사용할 인수입니다. 모델이 항상 유효한 JSON을 생성하지는 않으며 함수 스키마에 의해 정의되지 않은 매개 변수를 생성할 수 있습니다. 함수를 호출하기 전에 코드에서 인수의 유효성을 검사하세요. |
name
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| name | string | 호출할 함수의 이름입니다. |
chatCompletionRequestToolMessage
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 역할(role) | enum | 메시지 작성자의 역할(이 경우 tool)입니다.가능한 값: tool |
예 | |
| content | 문자열 또는 배열 | 도구 메시지의 콘텐츠입니다. | 예 | |
| tool_call_id | string | 이 메시지가 응답하는 도구 호출입니다. | 예 |
chatCompletionRequestFunctionMessage
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 역할(role) | enum | 메시지 작성자의 역할(이 경우 function)입니다.가능한 값: function |
예 | |
| content | string | 함수 메시지의 콘텐츠. | 예 | |
| 이름 | string | 호출할 함수의 이름입니다. | 예 |
chatCompletionRequestSystemMessageContentPart
이 구성 요소는 다음 중 하나일 수 있습니다.
chatCompletionRequestUserMessageContentPart
이 구성 요소는 다음 중 하나일 수 있습니다.
chatCompletionRequestAssistantMessageContentPart
이 구성 요소는 다음 중 하나일 수 있습니다.
chatCompletionRequestToolMessageContentPart
이 구성 요소는 다음 중 하나일 수 있습니다.
chatCompletionRequestMessageContentPartText
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | enum | 콘텐츠 부분의 형식입니다. 가능한 값: text |
예 | |
| text | string | 텍스트 내용입니다. | 예 |
chatCompletionRequestMessageContentPartImage
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | enum | 콘텐츠 부분의 형식입니다. 가능한 값: image_url |
예 | |
| image_url | 개체 | 예 |
image_url의 속성
URL
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| url | string | 이미지의 URL 또는 base64로 인코딩된 이미지 데이터입니다. |
detail
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| detail | string | 이미지의 세부 수준을 지정합니다. 자세한 내용은 비전 가이드에서 확인합니다. | auto |
chatCompletionRequestMessageContentPartRefusal
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | enum | 콘텐츠 부분의 형식입니다. 가능한 값: refusal |
예 | |
| 거부 | string | 모델이 생성한 거부 메시지입니다. | 예 |
azureChatExtensionConfiguration
단일 Azure OpenAI 채팅 확장에 대한 구성 데이터의 표현입니다. Azure OpenAI 채팅 확장을 사용하여 응답 동작을 보강해야 하는 채팅 완성 요청에 사용됩니다. 이 구성의 사용은 Azure OpenAI와만 호환됩니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | azureChatExtensionType | 단일 Azure OpenAI 채팅 확장에 대한 구성 데이터의 표현입니다. Azure OpenAI 채팅 확장을 사용하여 응답 동작을 보강해야 하는 채팅 완성 요청에서 사용됩니다. 이 구성의 사용은 Azure OpenAI와만 호환됩니다. |
예 |
azureChatExtensionType
단일 Azure OpenAI 채팅 확장에 대한 구성 데이터의 표현입니다. Azure OpenAI 채팅 확장을 사용하여 응답 동작을 보강해야 하는 채팅 완성 요청에 사용됩니다. 이 구성의 사용은 Azure OpenAI와만 호환됩니다.
설명: 단일 Azure OpenAI 채팅 확장에 대한 구성 데이터의 표현입니다. Azure OpenAI 채팅 확장을
사용하여 응답 동작을 보강해야 하는 채팅 완성 요청에서 사용됩니다.
이 구성의 사용은 Azure OpenAI와만 호환됩니다.
형식: string
기본값:
열거형 이름: AzureChatExtensionType
열거형 값:
| 값 | 설명 |
|---|---|
| azure_search | Azure Search를 Azure OpenAI 채팅 확장으로 사용하는 것을 나타냅니다. |
| azure_cosmos_db | Azure Cosmos DB를 Azure OpenAI 채팅 확장으로 사용하는 것을 나타냅니다. |
| elasticsearch | Elasticsearch® 인덱스를 Azure OpenAI 채팅 확장으로 사용하는 것을 나타냅니다. |
| mongo_db | Azure OpenAI 채팅 확장 기능으로 Mongo DB를 사용하는 것을 나타냅니다. |
| pinecone | Pinecone 인덱스를 Azure OpenAI 채팅 확장으로 사용하는 것을 나타냅니다. |
azureSearchChatExtensionConfiguration
Azure OpenAI 채팅 확장으로 사용할 때 Azure Search에 대한 구성 가능한 옵션의 특정 표현입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | azureChatExtensionType | 단일 Azure OpenAI 채팅 확장에 대한 구성 데이터의 표현입니다. Azure OpenAI 채팅 확장을 사용하여 응답 동작을 보강해야 하는 채팅 완성 요청에서 사용됩니다. 이 구성의 사용은 Azure OpenAI와만 호환됩니다. |
예 | |
| 매개 변수 | azureSearchChatExtensionParameters | Azure OpenAI 채팅 확장으로 사용되는 경우 Azure Search에 대한 매개 변수입니다. | 아니요 |
azureSearchChatExtensionParameters
Azure OpenAI 채팅 확장으로 사용되는 경우 Azure Search에 대한 매개 변수입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| authentication | onYourDataApiKeyAuthenticationOptions or onYourDataSystemAssignedManagedIdentityAuthenticationOptions, onYourDataUserAssignedManagedIdentityAuthenticationOptions 또는 onYourDataAccessTokenAuthenticationOptions | 예 | ||
| top_n_documents | 정수 | 구성된 쿼리에 대해 기능할 구성된 상위 문서 수입니다. | 아니요 | |
| max_search_queries | 정수 | 다시 작성된 쿼리의 최대 수는 검색 공급자에게 하나의 사용자 메시지를 보내야 합니다. 지정하지 않으면 시스템에서 보낼 쿼리 수를 결정합니다. | 아니요 | |
| allow_partial_result | 부울 값 | true로 지정하면 시스템에서 부분 검색 결과를 사용할 수 있으며 모든 쿼리가 실패하면 요청이 실패합니다. 지정하지 않거나 false로 지정하면 검색 쿼리가 실패하면 요청이 실패합니다. | 아니요 | False |
| in_scope | 부울 값 | 쿼리를 인덱싱된 데이터 사용으로 제한해야 하는지 여부입니다. | 아니요 | |
| 엄격성 | 정수 | 검색 관련성 필터링의 구성된 엄격성입니다. 엄격성이 높을수록 정밀도가 높지만 대답의 재현율이 낮습니다. | 아니요 | |
| endpoint | string | 사용할 Azure Search 리소스의 절대 엔드포인트 경로입니다. | 예 | |
| index_name | string | 참조된 Azure Search 리소스에서 사용할 수 있는 인덱스의 이름입니다. | 예 | |
| fields_mapping | azureSearchIndexFieldMappingOptions | 구성된 Azure Search 리소스를 사용할 때 필드가 처리되는 방식을 제어하는 선택적 설정입니다. | 아니요 | |
| query_type | azureSearchQueryType | Azure OpenAI 채팅 확장으로 사용할 때 실행해야 하는 Azure Search 검색 쿼리의 유형입니다. | 아니요 | |
| semantic_configuration | string | 쿼리에 대한 추가 의미 체계 구성입니다. | 아니요 | |
| 필터 | string | 검색 필터입니다. | 아니요 | |
| embedding_dependency | onYourDataEndpointVectorizationSource or onYourDataDeploymentNameVectorizationSource or onYourDataIntegratedVectorizationSource | 아니요 | ||
| include_contexts | 배열 | 출력 컨텍스트의 포함된 속성입니다. 지정하지 않은 경우 기본값은 citations 및 intent입니다. |
아니요 |
azureSearchIndexFieldMappingOptions
구성된 Azure Search 리소스를 사용할 때 필드가 처리되는 방식을 제어하는 선택적 설정입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| title_field | string | 제목으로 사용할 인덱스 필드의 이름입니다. | 아니요 | |
| url_field | string | URL로 사용할 인덱스 필드의 이름입니다. | 아니요 | |
| filepath_field | string | 파일 경로로 사용할 인덱스 필드의 이름입니다. | 아니요 | |
| content_fields | 배열 | 콘텐츠로 처리해야 하는 인덱스 필드의 이름입니다. | 아니요 | |
| content_fields_separator | string | 콘텐츠 필드에서 사용해야 하는 구분 기호 패턴입니다. | 아니요 | |
| vector_fields | 배열 | 벡터 데이터를 나타내는 필드의 이름입니다. | 아니요 | |
| image_vector_fields | 배열 | 이미지 벡터 데이터를 나타내는 필드의 이름입니다. | 아니요 |
azureSearchQueryType
Azure OpenAI 채팅 확장으로 사용할 때 실행해야 하는 Azure Search 검색 쿼리의 유형입니다.
설명: Azure OpenAI 채팅 확장으로 사용할 때 실행해야 하는 Azure Search 검색 쿼리의 유형입니다.
형식: string
기본값:
열거형 이름: azureSearchQueryType
열거형 값:
| 값 | 설명 |
|---|---|
| 간단한 | 기본 단순 쿼리 파서를 나타냅니다. |
| 의미 체계 | 고급 의미 체계 모델링을 위한 의미 체계 쿼리 파서를 나타냅니다. |
| 벡터 | 계산된 데이터에 대한 벡터 검색을 나타냅니다. |
| vector_simple_hybrid | 벡터 데이터와 간단한 쿼리 전략의 조합을 나타냅니다. |
| vector_semantic_hybrid | 의미 체계 검색 및 벡터 데이터 쿼리의 조합을 나타냅니다. |
azureCosmosDBChatExtensionConfiguration
Azure OpenAI 채팅 확장으로 사용할 때 Azure Cosmos DB에 대한 구성 가능한 옵션의 특정 표현입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | azureChatExtensionType | 단일 Azure OpenAI 채팅 확장에 대한 구성 데이터의 표현입니다. Azure OpenAI 채팅 확장을 사용하여 응답 동작을 보강해야 하는 채팅 완성 요청에서 사용됩니다. 이 구성의 사용은 Azure OpenAI와만 호환됩니다. |
예 | |
| 매개 변수 | azureCosmosDBChatExtensionParameters | Azure Cosmos DB for MongoDB vCore를 사용하여 데이터 채팅 확장에서 Azure OpenAI를 구성할 때 사용할 매개 변수입니다. |
아니요 |
azureCosmosDBChatExtensionParameters
Azure Cosmos DB for MongoDB vCore를 사용할 때 데이터 채팅 확장에서 Azure OpenAI를 구성할 때 사용할 매개 변수입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| authentication | onYourDataConnectionStringAuthenticationOptions | 연결 문자열을 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다. | 예 | |
| top_n_documents | 정수 | 구성된 쿼리에 대해 기능할 구성된 상위 문서 수입니다. | 아니요 | |
| max_search_queries | 정수 | 다시 작성된 쿼리의 최대 수는 검색 공급자에게 하나의 사용자 메시지를 보내야 합니다. 지정하지 않으면 시스템에서 보낼 쿼리 수를 결정합니다. | 아니요 | |
| allow_partial_result | 부울 값 | true로 지정하면 시스템에서 부분 검색 결과를 사용할 수 있으며 모든 쿼리가 실패하면 요청이 실패합니다. 지정하지 않거나 false로 지정하면 검색 쿼리가 실패하면 요청이 실패합니다. | 아니요 | False |
| in_scope | 부울 값 | 쿼리를 인덱싱된 데이터 사용으로 제한해야 하는지 여부입니다. | 아니요 | |
| 엄격성 | 정수 | 검색 관련성 필터링의 구성된 엄격성입니다. 엄격성이 높을수록 정밀도가 높지만 대답의 재현율이 낮습니다. | 아니요 | |
| database_name | string | Azure Cosmos DB와 함께 사용할 MongoDB vCore 데이터베이스 이름입니다. | 예 | |
| container_name | string | Azure Cosmos DB 리소스 컨테이너의 이름입니다. | 예 | |
| index_name | string | Azure Cosmos DB와 함께 사용할 MongoDB vCore 인덱스 이름입니다. | 예 | |
| fields_mapping | azureCosmosDBFieldMappingOptions | 구성된 Azure Cosmos DB 리소스를 사용할 때 필드가 처리되는 방식을 제어하는 선택적 설정입니다. | 예 | |
| embedding_dependency | onYourDataEndpointVectorizationSource 또는 onYourDataDeploymentNameVectorizationSource | 예 | ||
| include_contexts | 배열 | 출력 컨텍스트의 포함된 속성입니다. 지정하지 않은 경우 기본값은 citations 및 intent입니다. |
아니요 |
azureCosmosDBFieldMappingOptions
구성된 Azure Cosmos DB 리소스를 사용할 때 필드가 처리되는 방식을 제어하는 선택적 설정입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| title_field | string | 제목으로 사용할 인덱스 필드의 이름입니다. | 아니요 | |
| url_field | string | URL로 사용할 인덱스 필드의 이름입니다. | 아니요 | |
| filepath_field | string | 파일 경로로 사용할 인덱스 필드의 이름입니다. | 아니요 | |
| content_fields | 배열 | 콘텐츠로 처리해야 하는 인덱스 필드의 이름입니다. | 예 | |
| content_fields_separator | string | 콘텐츠 필드에서 사용해야 하는 구분 기호 패턴입니다. | 아니요 | |
| vector_fields | 배열 | 벡터 데이터를 나타내는 필드의 이름입니다. | 예 |
elasticsearchChatExtensionConfiguration
Azure OpenAI 채팅 확장으로 사용할 때 Elasticsearch에 대한 구성 가능한 옵션의 특정 표현입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | azureChatExtensionType | 단일 Azure OpenAI 채팅 확장에 대한 구성 데이터의 표현입니다. Azure OpenAI 채팅 확장을 사용하여 응답 동작을 보강해야 하는 채팅 완성 요청에서 사용됩니다. 이 구성의 사용은 Azure OpenAI와만 호환됩니다. |
예 | |
| 매개 변수 | elasticsearchChatExtensionParameters | Elasticsearch®를 Azure OpenAI 채팅 확장으로 구성할 때 사용할 매개 변수입니다. | 아니요 |
elasticsearchChatExtensionParameters
Elasticsearch®를 Azure OpenAI 채팅 확장으로 구성할 때 사용할 매개 변수입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| authentication | onYourDataKeyAndKeyIdAuthenticationOptions 또는 onYourDataEncodedApiKeyAuthenticationOptions | 예 | ||
| top_n_documents | 정수 | 구성된 쿼리에 대해 기능할 구성된 상위 문서 수입니다. | 아니요 | |
| max_search_queries | 정수 | 다시 작성된 쿼리의 최대 수는 검색 공급자에게 하나의 사용자 메시지를 보내야 합니다. 지정하지 않으면 시스템에서 보낼 쿼리 수를 결정합니다. | 아니요 | |
| allow_partial_result | 부울 값 | true로 지정하면 시스템에서 부분 검색 결과를 사용할 수 있으며 모든 쿼리가 실패하면 요청이 실패합니다. 지정하지 않거나 false로 지정하면 검색 쿼리가 실패하면 요청이 실패합니다. | 아니요 | False |
| in_scope | 부울 값 | 쿼리를 인덱싱된 데이터 사용으로 제한해야 하는지 여부입니다. | 아니요 | |
| 엄격성 | 정수 | 검색 관련성 필터링의 구성된 엄격성입니다. 엄격성이 높을수록 정밀도가 높지만 대답의 재현율이 낮습니다. | 아니요 | |
| endpoint | string | Elasticsearch®의 엔드포인트입니다. | 예 | |
| index_name | string | Elasticsearch®의 인덱스 이름입니다. | 예 | |
| fields_mapping | elasticsearchIndexFieldMappingOptions | 구성된 Elasticsearch® 리소스를 사용할 때 필드가 처리되는 방식을 제어하는 선택적 설정입니다. | 아니요 | |
| query_type | elasticsearchQueryType | Azure OpenAI 채팅 확장으로 사용할 때 실행해야 하는 Elasticsearch® 검색 쿼리의 유형입니다. | 아니요 | |
| embedding_dependency | onYourDataEndpointVectorizationSource, onYourDataDeploymentNameVectorizationSource 또는 onYourDataModelIdVectorizationSource | 아니요 | ||
| include_contexts | 배열 | 출력 컨텍스트의 포함된 속성입니다. 지정하지 않은 경우 기본값은 citations 및 intent입니다. |
아니요 |
elasticsearchIndexFieldMappingOptions
구성된 Elasticsearch® 리소스를 사용할 때 필드가 처리되는 방식을 제어하는 선택적 설정입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| title_field | string | 제목으로 사용할 인덱스 필드의 이름입니다. | 아니요 | |
| url_field | string | URL로 사용할 인덱스 필드의 이름입니다. | 아니요 | |
| filepath_field | string | 파일 경로로 사용할 인덱스 필드의 이름입니다. | 아니요 | |
| content_fields | 배열 | 콘텐츠로 처리해야 하는 인덱스 필드의 이름입니다. | 아니요 | |
| content_fields_separator | string | 콘텐츠 필드에서 사용해야 하는 구분 기호 패턴입니다. | 아니요 | |
| vector_fields | 배열 | 벡터 데이터를 나타내는 필드의 이름입니다. | 아니요 |
elasticsearchQueryType
Azure OpenAI 채팅 확장으로 사용할 때 실행해야 하는 Elasticsearch® 검색 쿼리의 유형입니다.
설명: Azure OpenAI 채팅 확장으로 사용할 때 실행해야 하는 Elasticsearch® 검색 쿼리의 유형입니다.
형식: string
기본값:
열거형 이름: ElasticsearchQueryType
열거형 값:
| 값 | 설명 |
|---|---|
| 간단한 | 기본 단순 쿼리 파서를 나타냅니다. |
| 벡터 | 계산된 데이터에 대한 벡터 검색을 나타냅니다. |
mongoDBChatExtensionConfiguration
Azure OpenAI 채팅 확장 기능으로 Mongo DB를 사용할 때 구성 가능한 옵션에 대한 구체적인 표현입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | azureChatExtensionType | 단일 Azure OpenAI 채팅 확장에 대한 구성 데이터의 표현입니다. Azure OpenAI 채팅 확장을 사용하여 응답 동작을 보강해야 하는 채팅 완성 요청에서 사용됩니다. 이 구성의 사용은 Azure OpenAI와만 호환됩니다. |
예 | |
| 매개 변수 | mongoDBChatExtensionParameters | Mongo DB를 사용하여 Azure OpenAI On Your Data 채팅 확장을 구성할 때 사용할 매개 변수입니다. | 아니요 |
mongoDBChatExtensionParameters
Mongo DB를 사용하여 Azure OpenAI On Your Data 채팅 확장을 구성할 때 사용할 매개 변수입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| authentication | onYourDataUsernameAndPasswordAuthenticationOptions | 사용자 이름과 암호를 사용할 때 Azure OpenAI On Your Data에 대한 인증 옵션입니다. | 예 | |
| top_n_documents | 정수 | 구성된 쿼리에 대해 기능할 구성된 상위 문서 수입니다. | 아니요 | |
| max_search_queries | 정수 | 다시 작성된 쿼리의 최대 수는 검색 공급자에게 하나의 사용자 메시지를 보내야 합니다. 지정하지 않으면 시스템에서 보낼 쿼리 수를 결정합니다. | 아니요 | |
| allow_partial_result | 부울 값 | true로 지정하면 시스템에서 부분 검색 결과를 사용할 수 있으며 모든 쿼리가 실패하면 요청이 실패합니다. 지정하지 않거나 false로 지정하면 검색 쿼리가 실패하면 요청이 실패합니다. | 아니요 | False |
| in_scope | 부울 값 | 쿼리를 인덱싱된 데이터 사용으로 제한해야 하는지 여부입니다. | 아니요 | |
| 엄격성 | 정수 | 검색 관련성 필터링의 구성된 엄격성입니다. 엄격성이 높을수록 정밀도가 높지만 대답의 재현율이 낮습니다. | 아니요 | |
| endpoint | string | Mongo DB 클러스터 엔드포인트의 이름. | 예 | |
| database_name | string | MongoDB 데이터베이스의 이름. | 예 | |
| collection_name | string | Mongo DB 컬렉션의 이름. | 예 | |
| app_name | string | Mongo DB 애플리케이션의 이름. | 예 | |
| index_name | string | MongoDB 인덱스의 이름. | 예 | |
| fields_mapping | mongoDBFieldMappingOptions | 구성된 Mongo DB 리소스를 사용할 때 필드가 처리되는 방식을 제어하기 위한 선택적 설정입니다. | 예 | |
| embedding_dependency | onYourDataEndpointVectorizationSource 또는 onYourDataDeploymentNameVectorizationSource | 예 | ||
| include_contexts | 배열 | 출력 컨텍스트의 포함된 속성입니다. 지정하지 않은 경우 기본값은 citations 및 intent입니다. |
아니요 |
mongoDBFieldMappingOptions
구성된 Mongo DB 리소스를 사용할 때 필드가 처리되는 방식을 제어하기 위한 선택적 설정입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| title_field | string | 제목으로 사용할 인덱스 필드의 이름입니다. | 아니요 | |
| url_field | string | URL로 사용할 인덱스 필드의 이름입니다. | 아니요 | |
| filepath_field | string | 파일 경로로 사용할 인덱스 필드의 이름입니다. | 아니요 | |
| content_fields | 배열 | 콘텐츠로 처리해야 하는 인덱스 필드의 이름입니다. | 예 | |
| content_fields_separator | string | 콘텐츠 필드에서 사용해야 하는 구분 기호 패턴입니다. | 아니요 | |
| vector_fields | 배열 | 벡터 데이터를 나타내는 필드의 이름입니다. | 예 |
pineconeChatExtensionConfiguration
Azure OpenAI 채팅 확장으로 사용할 때 Pinecone에 대한 구성 가능한 옵션의 특정 표현입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | azureChatExtensionType | 단일 Azure OpenAI 채팅 확장에 대한 구성 데이터의 표현입니다. Azure OpenAI 채팅 확장을 사용하여 응답 동작을 보강해야 하는 채팅 완성 요청에서 사용됩니다. 이 구성의 사용은 Azure OpenAI와만 호환됩니다. |
예 | |
| 매개 변수 | pineconeChatExtensionParameters | Azure OpenAI Pinecone 채팅 확장을 구성하기 위한 매개 변수입니다. | 아니요 |
pineconeChatExtensionParameters
Azure OpenAI Pinecone 채팅 확장을 구성하기 위한 매개 변수입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| authentication | onYourDataApiKeyAuthenticationOptions | API 키를 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다. | 예 | |
| top_n_documents | 정수 | 구성된 쿼리에 대해 기능할 구성된 상위 문서 수입니다. | 아니요 | |
| max_search_queries | 정수 | 다시 작성된 쿼리의 최대 수는 검색 공급자에게 하나의 사용자 메시지를 보내야 합니다. 지정하지 않으면 시스템에서 보낼 쿼리 수를 결정합니다. | 아니요 | |
| allow_partial_result | 부울 값 | true로 지정하면 시스템에서 부분 검색 결과를 사용할 수 있으며 모든 쿼리가 실패하면 요청이 실패합니다. 지정하지 않거나 false로 지정하면 검색 쿼리가 실패하면 요청이 실패합니다. | 아니요 | False |
| in_scope | 부울 값 | 쿼리를 인덱싱된 데이터 사용으로 제한해야 하는지 여부입니다. | 아니요 | |
| 엄격성 | 정수 | 검색 관련성 필터링의 구성된 엄격성입니다. 엄격성이 높을수록 정밀도가 높지만 대답의 재현율이 낮습니다. | 아니요 | |
| environment | string | Pinecone의 환경 이름입니다. | 예 | |
| index_name | string | Pinecone 데이터베이스 인덱스의 이름입니다. | 예 | |
| fields_mapping | pineconeFieldMappingOptions | 구성된 Pinecone 리소스를 사용할 때 필드가 처리되는 방식을 제어하는 선택적 설정입니다. | 예 | |
| embedding_dependency | onYourDataDeploymentNameVectorizationSource | 벡터 검색을 적용하는 경우 Azure OpenAI On Your Data에서 사용하며 동일한 Azure OpenAI 리소스의 내부 포함 모델 배포 이름을 기준으로 하는 벡터화 원본의 세부 정보입니다. |
예 | |
| include_contexts | 배열 | 출력 컨텍스트의 포함된 속성입니다. 지정하지 않은 경우 기본값은 citations 및 intent입니다. |
아니요 |
pineconeFieldMappingOptions
구성된 Pinecone 리소스를 사용할 때 필드가 처리되는 방식을 제어하는 선택적 설정입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| title_field | string | 제목으로 사용할 인덱스 필드의 이름입니다. | 아니요 | |
| url_field | string | URL로 사용할 인덱스 필드의 이름입니다. | 아니요 | |
| filepath_field | string | 파일 경로로 사용할 인덱스 필드의 이름입니다. | 아니요 | |
| content_fields | 배열 | 콘텐츠로 처리해야 하는 인덱스 필드의 이름입니다. | 예 | |
| content_fields_separator | string | 콘텐츠 필드에서 사용해야 하는 구분 기호 패턴입니다. | 아니요 |
onYourDataAuthenticationOptions
Azure OpenAI On Your Data에 대한 인증 옵션입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | onYourDataAuthenticationType | Azure OpenAI On Your Data에서 지원되는 인증 유형입니다. | 예 |
onYourDataContextProperty
컨텍스트 속성입니다.
설명: 컨텍스트 속성입니다.
형식: string
기본값:
열거형 이름: OnYourDataContextProperty
열거형 값:
| 값 | 설명 |
|---|---|
| 인용 | citations 속성 |
| 의도 | intent 속성 |
| all_retrieved_documents | all_retrieved_documents 속성 |
onYourDataAuthenticationType
Azure OpenAI On Your Data에서 지원되는 인증 유형입니다.
설명: Azure OpenAI On Your Data에서 지원되는 인증 유형입니다.
형식: string
기본값:
열거형 이름: OnYourDataAuthenticationType
열거형 값:
| 값 | 설명 |
|---|---|
| api_key | API 키를 통한 인증입니다. |
| connection_string | 연결 문자열을 통한 인증입니다. |
| key_and_key_id | 키 및 키 ID 쌍을 통한 인증입니다. |
| encoded_api_key | 인코딩된 API 키를 통한 인증입니다. |
| access_token | 액세스 토큰을 통한 인증입니다. |
| system_assigned_managed_identity | 시스템 할당 관리 ID를 통한 인증입니다. |
| user_assigned_managed_identity | 사용자 할당 관리 ID를 통한 인증입니다. |
| username_and_password | 사용자 이름과 암호를 통한 인증. |
onYourDataApiKeyAuthenticationOptions
API 키를 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | onYourDataAuthenticationType | Azure OpenAI On Your Data에서 지원되는 인증 유형입니다. | 예 | |
| key | string | 인증에 사용할 API 키입니다. | 아니요 |
onYourDataConnectionStringAuthenticationOptions
연결 문자열을 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | onYourDataAuthenticationType | Azure OpenAI On Your Data에서 지원되는 인증 유형입니다. | 예 | |
| connection_string | string | 인증에 사용할 연결 문자열입니다. | 아니요 |
onYourDataKeyAndKeyIdAuthenticationOptions
Elasticsearch 키 및 키 ID 쌍을 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | onYourDataAuthenticationType | Azure OpenAI On Your Data에서 지원되는 인증 유형입니다. | 예 | |
| key | string | 인증에 사용할 Elasticsearch 키입니다. | 아니요 | |
| key_id | string | 인증에 사용할 Elasticsearch 키 ID입니다. | 아니요 |
onYourDataEncodedApiKeyAuthenticationOptions
Elasticsearch 인코딩된 API 키를 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | onYourDataAuthenticationType | Azure OpenAI On Your Data에서 지원되는 인증 유형입니다. | 예 | |
| encoded_api_key | string | 인증에 사용할 Elasticsearch로 인코딩된 API 키입니다. | 아니요 |
onYourDataAccessTokenAuthenticationOptions
액세스 토큰을 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | onYourDataAuthenticationType | Azure OpenAI On Your Data에서 지원되는 인증 유형입니다. | 예 | |
| access_token | string | 인증에 사용할 액세스 토큰입니다. | 아니요 |
onYourDataSystemAssignedManagedIdentityAuthenticationOptions
시스템 할당 관리 ID를 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | onYourDataAuthenticationType | Azure OpenAI On Your Data에서 지원되는 인증 유형입니다. | 예 |
onYourDataUserAssignedManagedIdentityAuthenticationOptions
사용자 할당 관리 ID를 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | onYourDataAuthenticationType | Azure OpenAI On Your Data에서 지원되는 인증 유형입니다. | 예 | |
| managed_identity_resource_id | string | 인증 시 이용할 사용자가 할당한 관리 ID의 리소스 ID입니다. | 아니요 |
onYourDataUsernameAndPasswordAuthenticationOptions
사용자 이름과 암호를 사용할 때 Azure OpenAI On Your Data에 대한 인증 옵션입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | onYourDataAuthenticationType | Azure OpenAI On Your Data에서 지원되는 인증 유형입니다. | 예 | |
| 사용자 이름 | string | 인증에 사용할 사용자 이름. | 아니요 | |
| password | string | 암호입니다. 인증에 사용합니다. | 아니요 |
onYourDataVectorizationSource
벡터 검색을 사용하여 Azure OpenAI On Your Data에 대한 벡터화 원본의 추상 표현입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | onYourDataVectorizationSourceType | Azure OpenAI On Your Data가 벡터 검색에 사용할 데이터의 벡터화를 구성하는 데 사용할 수 있는 원본을 나타냅니다. |
예 |
onYourDataVectorizationSourceType
Azure OpenAI On Your Data가 벡터 검색에 사용할 데이터의 벡터화를 구성하는 데 사용할 수 있는 원본을 나타냅니다.
설명: Azure OpenAI On Your Data에서 사용할 데이터의 벡터화를 구성하는 데 사용할 수 있는 원본을 나타냅니다.
원본을 나타냅니다.
형식: string
기본값:
열거형 이름: OnYourDataVectorizationSourceType
열거형 값:
| 값 | 설명 |
|---|---|
| endpoint | Azure OpenAI 포함 모델에 대한 공용 서비스 호출에 의해 수행되는 벡터화를 나타냅니다. |
| deployment_name | 사용할 Ada 모델 배포 이름을 나타냅니다. 이 모델 배포는 동일한 Azure OpenAI 리소스에 있어야 하지만 On Your Data에서는 공개 호출이 아닌 내부 호출을 통해 이 모델 배포를 사용하므로 개인 네트워크에서도 벡터 검색을 사용할 수 있습니다. |
| integrated | 검색 리소스 내에 정의된 통합 벡터라이저를 나타냅니다. |
| model_id | 검색 서비스에 정의된 특정 포함 모델 ID를 나타냅니다. 현재 Elasticsearch®에서만 지원됩니다. |
onYourDataEndpointVectorizationSource
벡터 검색을 적용할 때 Azure OpenAI On Your Data에서 사용하며 포함에 대한 Azure OpenAI 엔드포인트 호출을 기준으로 하는 벡터화 원본의 세부 정보입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | onYourDataVectorizationSourceType | Azure OpenAI On Your Data가 벡터 검색에 사용할 데이터의 벡터화를 구성하는 데 사용할 수 있는 원본을 나타냅니다. |
예 | |
| endpoint | string | 포함을 검색할 리소스 엔드포인트 URL을 지정합니다. https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings 형식이어야 합니다. api-version 쿼리 매개 변수는 허용되지 않습니다. | 아니요 | |
| authentication | onYourDataApiKeyAuthenticationOptions 또는 onYourDataAccessTokenAuthenticationOptions | 아니요 | ||
| dimensions | 정수 | 포함에 포함해야 하는 차원의 수입니다. text-embedding-3 이상 모델에서만 지원됩니다. |
아니요 |
onYourDataDeploymentNameVectorizationSource
벡터 검색을 적용할 때 Azure OpenAI On Your Data에서 사용하며 동일한 Azure OpenAI 리소스의 내부 포함 모델 배포 이름을 기준으로 하는 벡터화 원본의 세부 정보입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | onYourDataVectorizationSourceType | Azure OpenAI On Your Data가 벡터 검색에 사용할 데이터의 벡터화를 구성하는 데 사용할 수 있는 원본을 나타냅니다. |
예 | |
| deployment_name | string | 벡터화에 사용할 모델 배포의 이름을 지정합니다. 이 모델 배포는 동일한 Azure OpenAI 리소스에 있어야 하지만 On Your Data는 공용이 아닌 내부 호출을 통해 이 모델 배포를 사용하므로 프라이빗 네트워크에서도 벡터를 검색할 수 있습니다. | 아니요 | |
| dimensions | 정수 | 포함에 포함해야 하는 차원의 수입니다. text-embedding-3 이상 모델에서만 지원됩니다. |
아니요 |
onYourDataIntegratedVectorizationSource
검색 리소스 내에 정의된 통합 벡터라이저를 나타냅니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | onYourDataVectorizationSourceType | Azure OpenAI On Your Data가 벡터 검색에 사용할 데이터의 벡터화를 구성하는 데 사용할 수 있는 원본을 나타냅니다. |
예 |
onYourDataModelIdVectorizationSource
벡터 검색을 적용하는 경우 Azure OpenAI On Your Data에서 사용하며 검색 서비스 모델 ID를 기준으로 하는 벡터화 원본의 세부 정보입니다. 현재 Elasticsearch®에서만 지원됩니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | onYourDataVectorizationSourceType | Azure OpenAI On Your Data가 벡터 검색에 사용할 데이터의 벡터화를 구성하는 데 사용할 수 있는 원본을 나타냅니다. |
예 | |
| model_id | string | 벡터화에 사용할 모델 ID를 지정합니다. 이 모델 ID는 검색 서비스에서 정의해야 합니다. | 아니요 |
azureChatExtensionsMessageContext
Azure OpenAI 채팅 확장 프로그램이 해당 채팅 완료 응답 생성에 관련될 때 사용할 수 있는 추가 컨텍스트 정보의 표현입니다. 이 컨텍스트 정보는 일치하는 확장을 사용하도록 구성된 Azure OpenAI 요청을 사용하는 경우에만 채워집니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 인용 | 배열 | 응답에서 도우미 메시지를 생성하는 데 사용되는 데이터 원본 검색 결과입니다. | 아니요 | |
| 의도 | string | 컨텍스트를 수행하기 위해 다음 턴으로 전달하는 데 사용되는 채팅 기록에서 검색된 의도입니다. | 아니요 | |
| all_retrieved_documents | 배열 | 검색된 모든 문서입니다. | 아니요 |
citation
채팅 완성 응답 메시지에 대한 인용 정보입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| content | string | 인용의 내용입니다. | 예 | |
| title | string | 인용의 제목입니다. | 아니요 | |
| url | string | 인용의 URL입니다. | 아니요 | |
| filepath | string | 인용의 파일 경로입니다. | 아니요 | |
| chunk_id | string | 인용의 청크 ID입니다. | 아니요 | |
| rerank_score | number | 검색된 문서의 순위 다시 매김 점수입니다. | 아니요 |
retrievedDocument
검색된 문서입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| content | string | 인용의 내용입니다. | 예 | |
| title | string | 인용의 제목입니다. | 아니요 | |
| url | string | 인용의 URL입니다. | 아니요 | |
| filepath | string | 인용의 파일 경로입니다. | 아니요 | |
| chunk_id | string | 인용의 청크 ID입니다. | 아니요 | |
| rerank_score | number | 검색된 문서의 순위 다시 매김 점수입니다. | 아니요 | |
| search_queries | 배열 | 문서를 검색하는 데 사용되는 검색 쿼리입니다. | 아니요 | |
| data_source_index | 정수 | 데이터 원본의 인덱스입니다. | 아니요 | |
| original_search_score | number | 검색된 문서의 원래 검색 점수입니다. | 아니요 | |
| filter_reason | filterReason | 검색된 문서의 필터링 이유입니다. | 아니요 |
filterReason
검색된 문서의 필터링 이유입니다.
설명: 검색된 문서의 필터링 이유입니다.
형식: string
기본값:
열거형 이름: FilterReason
열거형 값:
| 값 | 설명 |
|---|---|
| score | 문서는 strictness configure에서 정의한 원래 검색 점수 임계값으로 필터링됩니다. |
| rerank | 문서는 원래 검색 점수 임계값으로 필터링되지 않고 순위 다시 매김 점수 및 top_n_documents configure로 필터링됩니다. |
chatCompletionMessageToolCall
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | 도구 호출의 ID입니다. | 예 | |
| type | toolCallType | 도구 호출의 형식(이 경우 function)입니다. |
예 | |
| function | 개체 | 모델이 호출한 함수입니다. | 예 |
function의 속성
name
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| name | string | 호출할 함수의 이름입니다. |
arguments
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| arguments | string | JSON 형식의 모델에 의해 생성된 함수 호출에 사용할 인수입니다. 모델이 항상 유효한 JSON을 생성하지는 않으며 함수 스키마에 의해 정의되지 않은 매개 변수를 생성할 수 있습니다. 함수를 호출하기 전에 코드에서 인수의 유효성을 검사하세요. |
toolCallType
도구 호출의 형식(이 경우 function)입니다.
설명: 도구 호출의 형식(이 경우 function)입니다.
형식: string
기본값:
열거형 이름: ToolCallType
열거형 값:
| 값 | 설명 |
|---|---|
| function | 도구 호출 형식은 함수입니다. |
chatCompletionRequestMessageTool
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| tool_call_id | string | 이 메시지가 응답하는 도구 호출입니다. | 아니요 | |
| content | string | 메시지의 내용입니다. | 아니요 |
chatCompletionRequestMessageFunction
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 역할(role) | enum | 메시지 작성자의 역할(이 경우 function)입니다.가능한 값: function |
아니요 | |
| 이름 | string | 메시지의 내용입니다. | 아니요 | |
| content | string | 메시지의 내용입니다. | 아니요 |
createChatCompletionResponse
제공된 입력을 기준으로 모델이 반환한 채팅 완료 응답을 나타냅니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | 채팅 완료를 위한 고유 식별자입니다. | 예 | |
| prompt_filter_results | promptFilterResults | 요청에서 0개 이상의 프롬프트에 대한 콘텐츠 필터링 결과입니다. 스트리밍 요청에서 다른 프롬프트에 대한 결과는 서로 다른 시간 또는 다른 순서로 도착할 수 있습니다. | 아니요 | |
| 선택 | 배열 | 채팅 완료 선택 항목 목록입니다. n이 1보다 큰 경우 2개 이상이 될 수 있습니다. |
예 | |
| created | 정수 | 채팅 완료가 만들어진 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| model | string | 채팅 완료에 사용되는 모델입니다. | 예 | |
| system_fingerprint | string | 이 지문은 모델이 실행되는 백 엔드 구성을 나타냅니다. 결정론에 영향을 미칠 수 있는 백 엔드 변경이 이루어진 시기를 이해하기 위해 seed 요청 매개 변수와 함께 사용할 수 있습니다. |
아니요 | |
| 개체 | enum | 항상 chat.completion인 개체 형식입니다.가능한 값: chat.completion |
예 | |
| 사용량 | completionUsage | 완료 요청의 사용 통계입니다. | 아니요 |
createChatCompletionStreamResponse
제공된 입력을 기반으로 모델이 반환한 채팅 완료 응답의 스트리밍된 청크를 나타냅니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | 채팅 완료를 위한 고유 식별자입니다. 각 청크는 동일한 ID를 갖습니다. | 예 | |
| 선택 | 배열 | 채팅 완료 선택 항목 목록입니다. n이 1보다 큰 경우 두 개 이상의 요소를 포함할 수 있습니다. |
예 | |
| created | 정수 | 채팅 완료가 만들어진 시점의 Unix 타임스탬프(초)입니다. 각 청크에는 동일한 타임스탬프가 있습니다. | 예 | |
| model | string | 완료를 생성하는 모델. | 예 | |
| system_fingerprint | string | 이 지문은 모델이 실행되는 백 엔드 구성을 나타냅니다. 결정론에 영향을 미칠 수 있는 백 엔드 변경이 이루어진 시기를 이해하기 위해 seed 요청 매개 변수와 함께 사용할 수 있습니다. |
아니요 | |
| 개체 | enum | 항상 chat.completion.chunk인 개체 형식입니다.가능한 값: chat.completion.chunk |
예 |
chatCompletionStreamResponseDelta
스트리밍된 모델 응답을 통해 생성된 채팅 완료 델타.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| content | string | 청크 메시지의 콘텐츠. | 아니요 | |
| function_call | 개체 | 더 이상 사용되지 않으며 tool_calls로 대체되었습니다. 모델에 의해 생성된 대로 호출되어야 하는 함수의 이름과 인수입니다. |
아니요 | |
| tool_calls | 배열 | 아니요 | ||
| 역할(role) | enum | 이 메시지 작성자의 역할입니다. 가능한 값: system, user, assistant, tool |
아니요 | |
| 거부 | string | 모델이 생성한 거부 메시지입니다. | 아니요 |
function_call에 대한 속성
arguments
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| arguments | string | JSON 형식의 모델에 의해 생성된 함수 호출에 사용할 인수입니다. 모델이 항상 유효한 JSON을 생성하지는 않으며 함수 스키마에 의해 정의되지 않은 매개 변수를 생성할 수 있습니다. 함수를 호출하기 전에 코드에서 인수의 유효성을 검사하세요. |
name
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| name | string | 호출할 함수의 이름입니다. |
chatCompletionMessageToolCallChunk
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 색인 | 정수 | 예 | ||
| id | string | 도구 호출의 ID입니다. | 아니요 | |
| type | enum | 도구의 형식입니다. 현재는 function만 지원됩니다.가능한 값: function |
아니요 | |
| function | 개체 | 아니요 |
function의 속성
name
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| name | string | 호출할 함수의 이름입니다. |
arguments
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| arguments | string | JSON 형식의 모델에 의해 생성된 함수 호출에 사용할 인수입니다. 모델이 항상 유효한 JSON을 생성하지는 않으며 함수 스키마에 의해 정의되지 않은 매개 변수를 생성할 수 있습니다. 함수를 호출하기 전에 코드에서 인수의 유효성을 검사하세요. |
chatCompletionStreamOptions
스트리밍 응답에 대한 옵션입니다. 설정할 stream: true때만 설정합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| include_usage | 부울 값 | 설정된 경우 메시지 전에 data: [DONE] 추가 청크가 스트리밍됩니다. usage 이 청크의 필드는 전체 요청에 대한 토큰 사용 통계를 표시하며 choices 필드는 항상 빈 배열입니다. 다른 모든 청크에도 필드가 usage 포함되지만 null 값이 포함됩니다. |
아니요 |
chatCompletionChoiceLogProbs
선택 항목에 대한 로그 확률 정보입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| content | 배열 | 로그 확률 정보가 포함된 메시지 콘텐츠 토큰 목록입니다. | 예 | |
| 거부 | 배열 | 로그 가능성 정보가 포함된 메시지 거부 토큰 목록. | 아니요 |
chatCompletionTokenLogprob
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| token | string | 토큰입니다. | 예 | |
| logprob | number | 이 토큰의 로그 확률입니다. | 예 | |
| bytes | 배열 | 토큰의 UTF-8 바이트 표현을 나타내는 정수 목록입니다. 문자가 여러 토큰으로 표현되고 해당 바이트 표현이 결합되어 올바른 텍스트 표현을 생성해야 하는 경우에 유용합니다. 토큰에 대한 바이트 표현이 없는 경우 null일 수 있습니다. |
예 | |
| top_logprobs | 배열 | 이 토큰 위치에 있는 가장 가능성이 높은 토큰 및 해당 로그 확률의 목록입니다. 드문 경우지만 반환된 요청 top_logprobs 수보다 적을 수 있습니다. |
예 |
chatCompletionResponseMessage
모델에 의해 생성된 채팅 완료 메시지입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 역할(role) | chatCompletionResponseMessageRole | 응답 메시지 작성자의 역할입니다. | 예 | |
| 거부 | string | 모델이 생성한 거부 메시지입니다. | 예 | |
| content | string | 메시지의 내용입니다. | 예 | |
| tool_calls | 배열 | 함수 호출과 같이 모델에서 생성된 도구 호출입니다. | 아니요 | |
| function_call | chatCompletionFunctionCall | 더 이상 사용되지 않으며 tool_calls로 대체되었습니다. 모델에 의해 생성된 대로 호출되어야 하는 함수의 이름과 인수입니다. |
아니요 | |
| context | azureChatExtensionsMessageContext | Azure OpenAI 채팅 확장이 해당 채팅 완성 응답 생성과 관련될 경우 사용할 수 있는 추가 컨텍스트 정보의 표현입니다. 이 컨텍스트 정보는 일치하는 확장을 사용하도록 구성된 Azure OpenAI 요청을 사용할 때만 채워집니다. |
아니요 |
chatCompletionResponseMessageRole
응답 메시지 작성자의 역할입니다.
설명: 응답 메시지 작성자의 역할입니다.
형식: string
기본값:
열거형 값:
- 도우미
chatCompletionToolChoiceOption
모델이 호출하는 도구(있는 경우)를 제어합니다. none은(는) 모델이 도구를 호출하지 않고 대신 메시지를 생성함을 의미합니다. auto은(는) 모델이 메시지 생성 또는 하나 이상의 도구 호출 중에서 선택할 수 있음을 의미합니다. required은(는) 모델이 하나 이상의 도구를 호출해야 함을 의미합니다. {"type": "function", "function": {"name": "my_function"}}을 사용하여 특정 도구를 지정하면 모델이 해당 도구를 강제 호출하게 됩니다. none은(는) 도구가 없는 경우 기본값입니다. auto은(는) 도구가 있는 경우 기본값입니다.
이 구성 요소는 다음 중 하나일 수 있습니다.
chatCompletionNamedToolChoice
모델에서 사용해야 하는 도구를 지정합니다. 강제로 모델이 특정 함수를 호출하도록 하는 데 사용합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | enum | 도구의 형식입니다. 현재는 function만 지원됩니다.가능한 값: function |
예 | |
| function | 개체 | 예 |
function의 속성
name
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| name | string | 호출할 함수의 이름입니다. |
ParallelToolCalls
도구를 사용하는 동안 병렬 함수 호출을 사용하도록 설정할지 여부입니다.
이 구성 요소에 대해 정의된 속성이 없습니다.
chatCompletionMessageToolCalls
함수 호출과 같이 모델에서 생성된 도구 호출입니다.
이 구성 요소에 대해 정의된 속성이 없습니다.
chatCompletionFunctionCall
더 이상 사용되지 않으며 tool_calls로 대체되었습니다. 모델에 의해 생성된 대로 호출되어야 하는 함수의 이름과 인수입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| name | string | 호출할 함수의 이름입니다. | 예 | |
| arguments | string | JSON 형식의 모델에 의해 생성된 함수 호출에 사용할 인수입니다. 모델이 항상 유효한 JSON을 생성하지는 않으며 함수 스키마에 의해 정의되지 않은 매개 변수를 생성할 수 있습니다. 함수를 호출하기 전에 코드에서 인수의 유효성을 검사하세요. | 예 |
completionUsage
완료 요청의 사용 통계입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| prompt_tokens | 정수 | 프롬프트에 있는 토큰 수입니다. | 예 | |
| completion_tokens | 정수 | 생성된 완료의 토큰 수입니다. | 예 | |
| total_tokens | 정수 | 요청(프롬프트 + 완료)에 사용된 총 토큰 수입니다. | 예 | |
| prompt_tokens_details | 개체 | 프롬프트 토큰의 세부 정보입니다. | 아니요 | |
| completion_tokens_details | 개체 | 완료 시 사용되는 토큰 분석입니다. | 아니요 |
prompt_tokens_details 속성
cached_tokens
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| cached_tokens | 정수 | 캐시된 프롬프트 토큰의 수입니다. |
completion_tokens_details 속성
reasoning_tokens
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| reasoning_tokens | 정수 | 추론을 위해 모델에서 생성한 토큰입니다. |
chatCompletionTool
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | enum | 도구의 형식입니다. 현재는 function만 지원됩니다.가능한 값: function |
예 | |
| function | FunctionObject | 예 |
FunctionParameters
함수가 허용하는 매개 변수로, JSON 스키마 개체로 설명됩니다. 예제에 대한 가이드 와 형식에 대한 설명서는 JSON 스키마 참조를 참조 하세요.
parameters를 생략하면 빈 매개 변수 목록이 있는 함수가 정의됩니다.
이 구성 요소에 대해 정의된 속성이 없습니다.
FunctionObject
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| description | string | 함수를 호출하는 시기와 방법을 선택하기 위해 모델에서 사용하는 함수의 기능에 대한 설명입니다. | 아니요 | |
| 이름 | string | 호출할 함수의 이름입니다. a~z, A~Z, 0~9 또는 밑줄과 대시를 포함해야 하며 최대 길이는 64자여야 합니다. | 예 | |
| 매개 변수 | FunctionParameters | 함수가 허용하는 매개 변수로, JSON 스키마 개체로 설명됩니다. 예제에 대한 가이드 와 형식에 대한 설명서는 JSON 스키마 참조를 참조 하세요. parameters를 생략하면 빈 매개 변수 목록이 있는 함수가 정의됩니다. |
아니요 | |
| strict | 부울 값 | 함수 호출을 생성할 때 엄격한 스키마 준수를 사용하도록 설정할지 여부를 나타냅니다. true로 설정하면 모델은 parameters 필드에 정의된 정확한 스키마를 따릅니다. strict가 true인 경우 JSON 스키마의 하위 집합만 지원됩니다. |
아니요 | False |
ResponseFormatText
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | enum | 정의되는 응답 형식의 형식: text가능한 값: text |
예 |
ResponseFormatJsonObject
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | enum | 정의되는 응답 형식의 형식: json_object가능한 값: json_object |
예 |
ResponseFormatJsonSchemaSchema
JSON 스키마 개체로 설명되는 응답 형식에 대한 스키마입니다.
이 구성 요소에 대해 정의된 속성이 없습니다.
ResponseFormatJsonSchema
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | enum | 정의되는 응답 형식의 형식: json_schema가능한 값: json_schema |
예 | |
| json_schema | 개체 | 예 |
json_schema에 대한 속성
description
| 이름 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| description | string | 모델이 해당 형식에 따라 응답하는 방법을 결정하는 데 사용되는 응답 형식의 설명입니다. |
name
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| name | string | 응답 형식의 이름. a~z, A~Z, 0~9 또는 밑줄과 대시를 포함해야 하며 최대 길이는 64자여야 합니다. |
schema(스키마)
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| schema(스키마) | ResponseFormatJsonSchemaSchema | JSON 스키마 개체로 설명되는 응답 형식에 대한 스키마입니다. |
strict
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| strict | 부울 값 | 출력을 생성할 때 엄격한 스키마 준수를 사용하도록 설정할지 여부를 나타냅니다. true로 설정하면 모델은 항상 schema 필드에 정의된 정확한 스키마를 따릅니다. strict가 true인 경우 JSON 스키마의 하위 집합만 지원됩니다. |
False |
chatCompletionChoiceCommon
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 색인 | 정수 | 아니요 | ||
| finish_reason | string | 아니요 |
createTranslationRequest
번역 요청입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 파일 | string | 번역할 오디오 파일입니다. | 예 | |
| prompt | string | 모델 스타일을 안내하거나 이전 오디오 세그먼트를 계속 진행하기 위한 선택적 텍스트입니다. 프롬프트는 영어로 되어 있어야 합니다. | 아니요 | |
| response_format | audioResponseFormat | 출력의 형식을 정의합니다. | 아니요 | |
| 온도 | number | 샘플링 온도(0에서 1 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. 0으로 설정하면 모델은 로그 확률을 사용하여 특정 임계값에 도달할 때까지 온도를 자동으로 높입니다. | 아니요 | 0 |
audioResponse
response_format이 json일 때 번역 또는 전사 응답
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| text | string | 번역되거나 전사된 텍스트입니다. | 예 |
audioVerboseResponse
response_format이 verbose_json 때 번역 또는 전사 응답
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| text | string | 번역되거나 전사된 텍스트입니다. | 예 | |
| task | string | 오디오 작업의 형식입니다. | 아니요 | |
| language | string | 언어. | 아니요 | |
| duration | number | 기간. | 아니요 | |
| 세그먼트 | 배열 | 아니요 | ||
| 있습니다. | 배열 | 아니요 |
audioResponseFormat
출력의 형식을 정의합니다.
설명: 출력의 형식을 정의합니다.
형식: string
기본값:
열거형 값:
- json
- text
- srt
- verbose_json
- vtt
createTranscriptionRequest
전사 요청입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 파일 | string | 전사할 오디오 파일 개체입니다. | 예 | |
| prompt | string | 모델 스타일을 안내하거나 이전 오디오 세그먼트를 계속 진행하기 위한 선택적 텍스트입니다. 프롬프트는 오디오 언어와 일치해야 합니다. | 아니요 | |
| response_format | audioResponseFormat | 출력의 형식을 정의합니다. | 아니요 | |
| 온도 | number | 샘플링 온도(0에서 1 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. 0으로 설정하면 모델은 로그 확률을 사용하여 특정 임계값에 도달할 때까지 온도를 자동으로 높입니다. | 아니요 | 0 |
| language | string | 입력 오디오의 언어입니다. ISO-639-1 형식으로 입력 언어를 제공하면 정확도와 대기 시간이 향상됩니다. | 아니요 | |
| timestamp_granularities[] | 배열 | 이 대화 내용 기록을 위해 채울 타임스탬프 세분성입니다. 타임스탬프 세분성을 사용하려면 response_format을 verbose_json으로 설정해야 합니다. word 또는 segment 옵션 중 하나 또는 둘 다 지원됩니다. 참고: 세그먼트 타임스탬프에 대한 추가 대기 시간은 없지만 단어 타임스탬프를 생성하면 추가 대기 시간이 발생합니다. |
아니요 | ['segment'] |
audioSegment
전사 또는 번역 세그먼트입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | 정수 | 세그먼트 식별자입니다. | 아니요 | |
| seek | number | 세그먼트의 오프셋입니다. | 아니요 | |
| start | number | 세그먼트 시작 오프셋. | 아니요 | |
| end | number | 세그먼트 끝 오프셋입니다. | 아니요 | |
| text | string | 세그먼트 텍스트입니다. | 아니요 | |
| tokens | 배열 | 텍스트의 토큰입니다. | 아니요 | |
| 온도 | number | 온도입니다. | 아니요 | |
| avg_logprob | number | 평균 로그 확률입니다. | 아니요 | |
| compression_ratio | number | 압축 비율입니다. | 아니요 | |
| no_speech_prob | number | '음성 없음'의 확률입니다. | 아니요 |
audioWord
전사 또는 번역 세그먼트입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| word | string | Word | 아니요 | |
| start | number | 단어 시작 오프셋. | 아니요 | |
| end | number | 단어 끝 오프셋입니다. | 아니요 |
createSpeechRequest
음성 요청입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| input | string | 오디오를 합성할 텍스트입니다. 최대 길이는 4,096자입니다. | 예 | |
| voice | enum | 음성 합성에 사용할 음성입니다. 가능한 값: alloy, echo, fable, onyx, nova, shimmer |
예 | |
| response_format | enum | 오디오를 합성할 형식입니다. 가능한 값: mp3, opus, aac, flac, wav, pcm |
아니요 | |
| 속도 | number | 합성된 오디오의 속도입니다. 0.25~4.0의 값을 선택합니다. 기본값은 1.0입니다. |
아니요 | 1.0 |
imageQuality
생성될 이미지의 품질입니다.
설명: 생성될 이미지의 품질입니다.
형식: string
기본값: standard
열거형 이름: Quality
열거형 값:
| 값 | 설명 |
|---|---|
| 표준 | Standard 품질은 이미지를 표준 품질로 만듭니다. |
| hd | HD 품질은 이미지 전체에서 세부 정보 및 더 높은 일관성을 가진 이미지를 만듭니다. |
imagesResponseFormat
생성된 이미지가 반환되는 형식입니다.
설명: 생성된 이미지가 반환되는 형식입니다.
형식: string
기본값: url
열거형 이름: ImagesResponseFormat
열거형 값:
| 값 | 설명 |
|---|---|
| URL | 생성된 이미지를 다운로드하기 위한 임시 액세스를 제공하는 URL입니다. |
| b64_json | 생성된 이미지는 base64로 인코딩된 문자열로 반환됩니다. |
imageSize
생성된 이미지의 크기입니다.
설명: 생성된 이미지의 크기입니다.
형식: string
기본값: 1024x1024
열거형 이름: Size
열거형 값:
| 값 | 설명 |
|---|---|
| 256x256 | 생성된 이미지의 원하는 크기는 256x256픽셀입니다. dall-e-2에 대해서만 지원됩니다. |
| 512 x 512 | 생성된 이미지의 원하는 크기는 512x512픽셀입니다. dall-e-2에 대해서만 지원됩니다. |
| 1792x1024 | 생성된 이미지의 원하는 크기는 1792x1024픽셀입니다. dall-e-3에 대해서만 지원됩니다. |
| 1024x1792 | 생성된 이미지의 원하는 크기는 1024x1792픽셀입니다. dall-e-3에 대해서만 지원됩니다. |
| 1024 x 1024 | 생성된 이미지의 원하는 크기는 1024x1024픽셀입니다. |
imageStyle
생성된 이미지의 스타일입니다.
설명: 생성된 이미지의 스타일입니다.
형식: string
기본값: vivid
열거형 이름: Style
열거형 값:
| 값 | 설명 |
|---|---|
| vivid | Vivid는 매우 현실적이고 극적인 이미지를 만듭니다. |
| natural | Natural은 더 자연스럽고 덜 사실적인 이미지를 만듭니다. |
imageGenerationsRequest
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| prompt | string | 원하는 이미지에 대한 텍스트 설명입니다. 최대 길이는 4,000자입니다. | 예 | |
| n | 정수 | 생성할 이미지 수입니다. | 아니요 | 1 |
| 크기 | imageSize | 생성된 이미지의 크기입니다. | 아니요 | 1024 x 1024 |
| response_format | imagesResponseFormat | 생성된 이미지가 반환되는 형식입니다. | 아니요 | URL |
| user | string | 남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다. | 아니요 | |
| 품질 | imageQuality | 생성될 이미지의 품질입니다. | 아니요 | 표준 |
| style | imageStyle | 생성된 이미지의 스타일입니다. | 아니요 | vivid |
generateImagesResponse
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| created | 정수 | 작업을 만들 때의 unix 타임스탬프입니다. | 예 | |
| 데이터 | 배열 | 성공한 경우 작업의 결과 데이터입니다. | 예 |
imageResult
성공하면 이미지 URL 또는 인코딩된 이미지이고, 그렇지 않으면 오류가 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| url | string | 이미지 URL입니다. | 아니요 | |
| b64_json | string | base64로 인코딩된 이미지 | 아니요 | |
| content_filter_results | dalleContentFilterResults | 콘텐츠 필터링 결과에 대한 정보입니다. | 아니요 | |
| revised_prompt | string | 프롬프트에 수정 버전이 있는 경우 이미지를 생성하는 데 사용된 프롬프트입니다. | 아니요 | |
| prompt_filter_results | dalleFilterResults | 콘텐츠 필터링 범주(증오, 성 관련, 폭력, 자해) 및 심각도 수준(유해한 콘텐츠의 강도 및 위험 수준을 결정하는 매우 낮음, 낮음, 중간, 높음)과 필터링되었는지 여부에 대한 정보입니다. 탈옥 콘텐츠 및 욕설, 감지되었는지 여부 및 필터링되었는지 여부에 대한 정보입니다. 또한 고객 차단 목록, 필터링되었는지 여부 및 해당 ID에 대한 정보입니다. | 아니요 |
line
단어 및 선택 표시와 같은 인접한 콘텐츠 요소 시퀀스로 구성된 콘텐츠 줄 개체입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| text | string | 예 | ||
| spans | 배열 | 검색된 개체와 해당 경계 상자 정보를 나타내는 범위의 배열입니다. | 예 |
span
검색된 개체와 해당 경계 상자 정보를 나타내는 범위 개체입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| text | string | 검색된 개체를 나타내는 범위의 텍스트 콘텐츠입니다. | 예 | |
| offset | 정수 | 범위가 시작되는 텍스트 내의 문자 오프셋입니다. 이 오프셋은 범위의 첫 번째 문자 위치로 정의되며, 텍스트 시작부터 유니코드 코드포인트로 계산합니다. | 예 | |
| length | 정수 | 유니코드 코드 포인트로 측정되는 문자의 범위 길이입니다. | 예 | |
| polygon | 배열 | 검색된 개체를 묶는 다각형의 점을 나타내는 개체의 배열입니다. | 예 |
runCompletionUsage
실행과 관련된 사용 통계. 실행이 종료 상태가 아닌 경우(예: in_progress, queued 등) 이 값은 null이 됩니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| completion_tokens | 정수 | 실행 과정에서 사용된 완성 토큰 수입니다. | 예 | |
| prompt_tokens | 정수 | 실행 과정에서 사용된 프롬프트 토큰 수입니다. | 예 | |
| total_tokens | 정수 | 사용된 총 토큰 수입니다(프롬프트 + 완성). | 예 |
runStepCompletionUsage
실행 단계와 관련된 사용 통계입니다. 이 값은 실행 단계의 상태가 in_progress인 동안 null이 됩니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| completion_tokens | 정수 | 실행 단계 과정에서 사용된 완성 토큰 수입니다. | 예 | |
| prompt_tokens | 정수 | 실행 단계 과정에서 사용된 프롬프트 토큰 수입니다. | 예 | |
| total_tokens | 정수 | 사용된 총 토큰 수입니다(프롬프트 + 완성). | 예 |
assistantsApiResponseFormatOption
모델이 출력해야 하는 형식을 지정합니다. gpt-3.5-turbo-1106 이후의 GPT-4 Turbo 및 모든 GPT-3.5 Turbo 모델과 호환됩니다.
{ "type": "json_object" }(으)로 설정하면 모델이 생성하는 메시지가 유효한 JSON임을 보장하는 JSON 모드가 사용하도록 설정됩니다.
중요: JSON 모드를 사용하는 경우 시스템 또는 사용자 메시지를 통해 직접 JSON을 생성하도록 모델에 지시해야 합니다. 이렇게 하지 않으면 생성이 토큰 제한에 도달할 때까지 모델은 공백의 끝없는 스트림을 생성하여 장기 실행되고 겉보기에 "중단" 요청이 발생할 수 있습니다. 또한 생성이 max_tokens을(를) 초과했거나 대화가 최대 컨텍스트 길이를 초과했음을 나타내는 finish_reason="length"인 경우 메시지 콘텐츠가 부분적으로 잘릴 수 있습니다.
이 구성 요소는 다음 중 하나일 수 있습니다.
assistantsApiResponseFormat
모델의 예상 출력을 설명하는 개체입니다. json_object인 경우 function 형식 tools만 실행에 전달할 수 있습니다. text인 경우 모델은 텍스트 또는 필요한 값을 반환할 수 있습니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | text 또는 json_object 중 하나여야 합니다. |
아니요 | text |
type 열거형: AssistantsApiResponseFormat
| 값 | 설명 |
|---|---|
| text | |
| json_object |
assistantObject
모델을 호출하고 도구를 사용할 수 있는 assistant를 나타냅니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | API 엔드포인트에서 참조할 수 있는 식별자입니다. | 예 | |
| 개체 | string | 항상 assistant인 개체 형식입니다. |
예 | |
| created_at | 정수 | 도우미가 만들어진 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| 이름 | string | 도우미의 이름입니다. 최대 길이는 256자입니다. |
예 | |
| 설명 | string | 도우미에 대한 설명입니다. 최대 길이는 512자입니다. |
예 | |
| model | string | 사용할 모델의 ID입니다. 사용 가능한 모든 모델을 보려면 모델 목록 API를 사용하면 됩니다. |
예 | |
| 지침 | string | 도우미가 사용하는 시스템 지침입니다. 최대 길이는 256,000자입니다. |
예 | |
| tools | 배열 | 도우미에서 사용하도록 설정된 도구 목록입니다. 도우미당 최대 128개의 도구가 있을 수 있습니다. 도구는 형식 code_interpreter, file_search 또는 function일 수 있습니다. |
예 | [] |
| tool_resources | 개체 | 도우미 도구에서 사용하는 리소스 집합입니다. 리소스는 도구 유형에 따라 다릅니다. 예를 들어 code_interpreter 도구에는 파일 ID 목록이 필요하지만 file_search 도구에는 벡터 저장소 ID 목록이 필요합니다. |
아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
예 | |
| 온도 | 번호 | 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. |
아니요 | 1 |
| top_p | 번호 | 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 온도를 변경하는 것이 좋지만 둘 다 변경하는 것은 권장하지 않습니다. |
아니요 | 1 |
| response_format | assistantsApiResponseFormatOption | 모델이 출력해야 하는 형식을 지정합니다. gpt-3.5-turbo-1106 이후의 GPT-4 Turbo 및 모든 GPT-3.5 Turbo 모델과 호환됩니다.{ "type": "json_object" }(으)로 설정하면 모델이 생성하는 메시지가 유효한 JSON임을 보장하는 JSON 모드가 사용하도록 설정됩니다.중요: JSON 모드를 사용하는 경우 시스템 또는 사용자 메시지를 통해 직접 JSON을 생성하도록 모델에 지시해야 합니다. 이렇게 하지 않으면 생성이 토큰 제한에 도달할 때까지 모델은 공백의 끝없는 스트림을 생성하여 장기 실행되고 겉보기에 "중단" 요청이 발생할 수 있습니다. 또한 생성이 max_tokens을(를) 초과했거나 대화가 최대 컨텍스트 길이를 초과했음을 나타내는 finish_reason="length"인 경우 메시지 콘텐츠가 부분적으로 잘릴 수 있습니다. |
아니요 |
tool_resources의 속성
code_interpreter
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_ids | 배열 | code_interpreter 도구에서 사용할 수 있는 파일 ID 목록입니다. 도구와 연결된 파일은 최대 20개일 수 있습니다. |
[] |
file_search
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| vector_store_ids | 배열 | 이 도우미에 연결된 벡터 저장소의 ID입니다. 도우미에 연결된 벡터 저장소가 최대 1개 있을 수 있습니다. |
object 열거형: AssistantObjectType
| 값 | 설명 |
|---|---|
| 도우미 | 개체 형식으로, 항상 assistant입니다. |
createAssistantRequest
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| model | 예 | |||
| 이름 | string | 도우미의 이름입니다. 최대 길이는 256자입니다. |
아니요 | |
| description | string | 도우미에 대한 설명입니다. 최대 길이는 512자입니다. |
아니요 | |
| 지침 | string | 도우미가 사용하는 시스템 지침입니다. 최대 길이는 256,000자입니다. |
아니요 | |
| tools | 배열 | 도우미에서 사용하도록 설정된 도구 목록입니다. 도우미당 최대 128개의 도구가 있을 수 있습니다. 도구는 형식 code_interpreter, retrieval 또는 function일 수 있습니다. |
아니요 | [] |
| tool_resources | 개체 | 도우미 도구에서 사용하는 리소스 집합입니다. 리소스는 도구 유형에 따라 다릅니다. 예를 들어 code_interpreter 도구에는 파일 ID 목록이 필요하지만 file_search 도구에는 벡터 저장소 ID 목록이 필요합니다. |
아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 | |
| 온도 | 번호 | 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. |
아니요 | 1 |
| top_p | 번호 | 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 온도를 변경하는 것이 좋지만 둘 다 변경하는 것은 권장하지 않습니다. |
아니요 | 1 |
| response_format | assistantsApiResponseFormatOption | 모델이 출력해야 하는 형식을 지정합니다. gpt-3.5-turbo-1106 이후의 GPT-4 Turbo 및 모든 GPT-3.5 Turbo 모델과 호환됩니다.{ "type": "json_object" }(으)로 설정하면 모델이 생성하는 메시지가 유효한 JSON임을 보장하는 JSON 모드가 사용하도록 설정됩니다.중요: JSON 모드를 사용하는 경우 시스템 또는 사용자 메시지를 통해 직접 JSON을 생성하도록 모델에 지시해야 합니다. 이렇게 하지 않으면 생성이 토큰 제한에 도달할 때까지 모델은 공백의 끝없는 스트림을 생성하여 장기 실행되고 겉보기에 "중단" 요청이 발생할 수 있습니다. 또한 생성이 max_tokens을(를) 초과했거나 대화가 최대 컨텍스트 길이를 초과했음을 나타내는 finish_reason="length"인 경우 메시지 콘텐츠가 부분적으로 잘릴 수 있습니다. |
아니요 |
tool_resources의 속성
code_interpreter
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_ids | 배열 | code_interpreter 도구에서 사용할 수 있는 파일 ID 목록입니다. 도구와 연결된 파일은 최대 20개일 수 있습니다. |
[] |
file_search
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| vector_store_ids | 배열 | 이 도우미에 연결된 벡터 저장소입니다. 도우미에 연결된 벡터 저장소가 최대 1개 있을 수 있습니다. |
|
| vector_stores | 배열 | file_ids를 사용하여 벡터 저장소를 만들고 이 도우미에 연결하기 위한 도우미입니다. 도우미에 연결된 벡터 저장소가 최대 1개 있을 수 있습니다. |
modifyAssistantRequest
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| model | 아니요 | |||
| 이름 | string | 도우미의 이름입니다. 최대 길이는 256자입니다. |
아니요 | |
| description | string | 도우미에 대한 설명입니다. 최대 길이는 512자입니다. |
아니요 | |
| 지침 | string | 도우미가 사용하는 시스템 지침입니다. 최대 길이는 32768자입니다. |
아니요 | |
| tools | 배열 | 도우미에서 사용하도록 설정된 도구 목록입니다. 도우미당 최대 128개의 도구가 있을 수 있습니다. 도구는 형식 code_interpreter, retrieval 또는 function일 수 있습니다. |
아니요 | [] |
| tool_resources | 개체 | 도우미 도구에서 사용하는 리소스 집합입니다. 리소스는 도구 유형에 따라 다릅니다. 예를 들어 code_interpreter 도구에는 파일 ID 목록이 필요하지만 file_search 도구에는 벡터 저장소 ID 목록이 필요합니다. |
아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 | |
| 온도 | 번호 | 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. |
아니요 | 1 |
| top_p | 번호 | 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 온도를 변경하는 것이 좋지만 둘 다 변경하는 것은 권장하지 않습니다. |
아니요 | 1 |
| response_format | assistantsApiResponseFormatOption | 모델이 출력해야 하는 형식을 지정합니다. gpt-3.5-turbo-1106 이후의 GPT-4 Turbo 및 모든 GPT-3.5 Turbo 모델과 호환됩니다.{ "type": "json_object" }(으)로 설정하면 모델이 생성하는 메시지가 유효한 JSON임을 보장하는 JSON 모드가 사용하도록 설정됩니다.중요: JSON 모드를 사용하는 경우 시스템 또는 사용자 메시지를 통해 직접 JSON을 생성하도록 모델에 지시해야 합니다. 이렇게 하지 않으면 생성이 토큰 제한에 도달할 때까지 모델은 공백의 끝없는 스트림을 생성하여 장기 실행되고 겉보기에 "중단" 요청이 발생할 수 있습니다. 또한 생성이 max_tokens을(를) 초과했거나 대화가 최대 컨텍스트 길이를 초과했음을 나타내는 finish_reason="length"인 경우 메시지 콘텐츠가 부분적으로 잘릴 수 있습니다. |
아니요 |
tool_resources의 속성
code_interpreter
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_ids | 배열 | code_interpreter 도구에서 사용할 수 있는 파일 ID 목록을 재정의합니다. 도구와 연결된 파일은 최대 20개일 수 있습니다. |
[] |
file_search
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| vector_store_ids | 배열 | 이 도우미에 연결된 벡터 저장소를 재정의합니다. 도우미에 연결된 벡터 저장소가 최대 1개 있을 수 있습니다. |
deleteAssistantResponse
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | 예 | ||
| deleted | 부울 값 | 예 | ||
| 개체 | string | 예 |
object 열거형: DeleteAssistantResponseState
| 값 | 설명 |
|---|---|
| assistant.deleted |
listAssistantsResponse
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 개체 | string | 예 | ||
| 데이터 | 배열 | 예 | ||
| first_id | string | 예 | ||
| last_id | string | 예 | ||
| has_more | 부울 값 | 예 |
assistantToolsCode
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | 정의되는 도구의 형식: code_interpreter |
예 |
type 열거형: assistantToolsCodeType
| 값 | 설명 |
|---|---|
| code_interpreter |
assistantToolsFileSearch
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | 정의되는 도구의 형식: file_search |
예 | |
| file_search | 개체 | 파일 검색 도구에 대한 재정의입니다. | 아니요 |
file_search 속성
max_num_results
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| max_num_results | 정수 | 파일 검색 도구에서 출력해야 하는 최대 결과 수입니다. 기본값은 gpt-4* 모델의 경우 20이고 gpt-3.5-turbo의 경우 5입니다. 이 숫자는 1에서 50 사이여야 합니다. 파일 검색 도구는 결과보다 max_num_results 적게 출력할 수 있습니다. |
type 열거형: assistantToolsFileSearchType
| 값 | 설명 |
|---|---|
| file_search |
assistantToolsFileSearchTypeOnly
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | 정의되는 도구의 형식: file_search |
예 |
type 열거형: assistantToolsFileSearchType
| 값 | 설명 |
|---|---|
| file_search |
assistantToolsFunction
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | 정의되는 도구의 형식: function |
예 | |
| function | 개체 | 함수 정의. | 예 |
function의 속성
description
| 이름 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| description | string | 함수를 호출하는 시기와 방법을 선택하기 위해 모델에서 사용하는 함수의 기능에 대한 설명입니다. |
name
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| name | string | 호출할 함수의 이름입니다. a~z, A~Z, 0~9 또는 밑줄과 대시를 포함해야 하며 최대 길이는 64자여야 합니다. |
매개 변수
| 이름 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| 매개 변수 | chatCompletionFunctionParameters | 함수가 허용하는 매개 변수로, JSON 스키마 개체로 설명됩니다. 예제에 대한 가이드 와 형식에 대한 설명서는 JSON 스키마 참조를 참조 하세요. |
type 열거형: assistantToolsFunction
| 값 | 설명 |
|---|---|
| function |
truncationObject
실행 전에 스레드가 잘리는 방법에 대한 컨트롤입니다. 실행의 초기 컨텍스트 창을 제어하는 데 사용합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | 스레드에 사용할 잘림 전략입니다. 기본값은 auto입니다. last_messages로 설정하면 스레드가 스레드에서 가장 최근의 n개의 메시지로 잘립니다. auto로 설정하면 스레드 중간에 있는 메시지가 모델의 컨텍스트 길이, max_prompt_tokens에 맞게 삭제됩니다. |
예 | |
| last_messages | 정수 | 실행에 대한 컨텍스트를 생성할 때 스레드의 가장 최근 메시지 수입니다. | 아니요 |
type 열거형: TruncationType
| 값 | 설명 |
|---|---|
| auto | |
| last_messages |
assistantsApiToolChoiceOption
모델이 호출하는 도구(있는 경우)를 제어합니다.
none은 모델이 도구를 호출하지 않고 대신 메시지를 생성함을 의미합니다.
auto는 기본값이며 모델이 메시지 생성 또는 도구 호출 중에서 선택할 수 있음을 의미합니다.
{"type": "file_search"} 또는 {"type": "function", "function": {"name": "my_function"}}과 같은 특정 도구를 지정하면 모델이 해당 도구를 호출하게 됩니다.
이 구성 요소는 다음 중 하나일 수 있습니다.
assistantsNamedToolChoice
모델에서 사용해야 하는 도구를 지정합니다. 모델이 강제로 특정 도구를 호출하도록 하는 데 사용합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | 도구의 형식입니다. 형식이 function인 경우 함수 이름을 설정해야 합니다. |
예 | |
| function | 개체 | 아니요 |
function의 속성
name
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| name | string | 호출할 함수의 이름입니다. |
type 열거형: AssistantsNamedToolChoiceType
| 값 | 설명 |
|---|---|
| function | |
| code_interpreter | |
| file_search |
runObject
스레드에서 실행되는 실행을 나타냅니다.
| 이름 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | API 엔드포인트에서 참조할 수 있는 식별자입니다. | 예 | |
| 개체 | string | 항상 thread.run인 개체 형식입니다. |
예 | |
| created_at | 정수 | 실행이 만들어진 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| thread_id | string | 이 실행의 일부로 실행된 스레드의 ID입니다. | 예 | |
| assistant_id | string | 이 실행을 실행하는 데 사용되는 도우미의 ID입니다. | 예 | |
| 상태 | string | 실행 상태는 queued, in_progress, requires_action, cancelling, cancelled, failed, completed 또는 expired일 수 있습니다. |
예 | |
| required_action | 개체 | 실행을 계속하는 데 필요한 작업에 대한 세부 정보입니다. 작업이 필요하지 않으면 null이 됩니다. |
예 | |
| last_error | 개체 | 이 실행과 관련된 마지막 오류입니다. 오류가 없으면 null이 됩니다. |
예 | |
| expires_at | 정수 | 실행이 만료된 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| started_at | 정수 | 실행이 시작된 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| cancelled_at | 정수 | 실행이 취소된 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| failed_at | 정수 | 실행이 실패한 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| completed_at | 정수 | 실행이 완료된 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| incomplete_details | 개체 | 실행이 완료되지 않은 이유에 대한 세부 정보입니다. 실행이 완료되지 않은 경우 null이 됩니다. |
예 | |
| model | string | 도우미가 이 실행에 사용한 모델입니다. | 예 | |
| 지침 | string | 도우미가 이 실행에 사용한 지침입니다. | 예 | |
| tools | 배열 | 도우미가 이 실행에 사용한 도구 목록입니다. | 예 | [] |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
예 | |
| 사용량 | runCompletionUsage | 실행과 관련된 사용 통계. 실행이 종료 상태가 아닌 경우(예: in_progress, queued 등) 이 값은 null이 됩니다. |
예 | |
| 온도 | number | 이 실행에 사용되는 샘플링 온도입니다. 설정하지 않으면 기본값은 1입니다. | 아니요 | |
| top_p | number | 이 실행에 사용되는 핵 샘플링 값입니다. 설정하지 않으면 기본값은 1입니다. | 아니요 | |
| max_prompt_tokens | 정수 | 실행 과정에서 사용되도록 지정된 프롬프트 토큰의 최대 수입니다. |
예 | |
| max_completion_tokens | 정수 | 실행 과정에서 사용되도록 지정된 완료 토큰의 최대 수입니다. |
예 | |
| truncation_strategy | truncationObject | 실행 전에 스레드가 잘리는 방법에 대한 컨트롤입니다. 실행의 초기 컨텍스트 창을 제어하는 데 사용합니다. | 예 | |
| tool_choice | assistantsApiToolChoiceOption | 모델이 호출하는 도구(있는 경우)를 제어합니다.none은 모델이 도구를 호출하지 않고 대신 메시지를 생성함을 의미합니다.auto는 기본값이며 모델이 메시지 생성 또는 도구 호출 중에서 선택할 수 있음을 의미합니다.{"type": "file_search"} 또는 {"type": "function", "function": {"name": "my_function"}}과 같은 특정 도구를 지정하면 모델이 해당 도구를 호출하게 됩니다. |
예 | |
| parallel_tool_calls | ParallelToolCalls | 도구를 사용하는 동안 병렬 함수 호출을 사용하도록 설정할지 여부입니다. | 아니요 | True |
| response_format | assistantsApiResponseFormatOption | 모델이 출력해야 하는 형식을 지정합니다. gpt-3.5-turbo-1106 이후의 GPT-4 Turbo 및 모든 GPT-3.5 Turbo 모델과 호환됩니다.{ "type": "json_object" }(으)로 설정하면 모델이 생성하는 메시지가 유효한 JSON임을 보장하는 JSON 모드가 사용하도록 설정됩니다.중요: JSON 모드를 사용하는 경우 시스템 또는 사용자 메시지를 통해 직접 JSON을 생성하도록 모델에 지시해야 합니다. 이렇게 하지 않으면 생성이 토큰 제한에 도달할 때까지 모델은 공백의 끝없는 스트림을 생성하여 장기 실행되고 겉보기에 "중단" 요청이 발생할 수 있습니다. 또한 생성이 max_tokens을(를) 초과했거나 대화가 최대 컨텍스트 길이를 초과했음을 나타내는 finish_reason="length"인 경우 메시지 콘텐츠가 부분적으로 잘릴 수 있습니다. |
예 |
required_action의 속성
type
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| type | string | 지금은 항상 submit_tool_outputs입니다. |
submit_tool_outputs
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| tool_calls | 배열 | 관련 도구 호출 목록입니다. |
last_error의 속성
코드
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| 코드 | string | server_error 또는 rate_limit_exceeded 중 하나입니다. |
message
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| message | string | 사람이 읽을 수 있는 오류 설명입니다. |
incomplete_details의 속성
reason
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| reason | string | 실행이 완료되지 않은 이유입니다. 실행 과정에서 도달한 특정 토큰 제한을 가리킵니다. |
object 열거형: runObjectType
| 값 | 설명 |
|---|---|
| thread.run | 실행 개체 형식으로, 항상 thread.run입니다. |
status 열거형: RunObjectStatus
| 값 | 설명 |
|---|---|
| queued | 대기 상태 |
| in_progress | in_progress 상태 |
| requires_action | required_action 상태 |
| cancelling | 취소 중 상태 |
| 취소됨 | 취소된 상태 |
| 실패 | 실패 상태 |
| 완료됨 | 완료 상태 |
| 만료됨 | 만료된 상태 |
createRunRequest
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| assistant_id | string | 이 실행을 실행하는 데 사용할 도우미의 ID입니다. | 예 | |
| model | string | 이 실행을 실행하는 데 사용할 모델의 배포 ID입니다. 여기에 값이 제공되면 도우미와 연결된 모델이 재정의됩니다. 그렇지 않은 경우 도우미와 연결된 모델이 사용됩니다. | 아니요 | |
| 지침 | string | 도우미의 기본 시스템 메시지를 대체합니다. 이는 실행별로 동작을 수정하는 데 유용합니다. | 아니요 | |
| additional_instructions | string | 실행 지침 끝에 추가 지침을 추가합니다. 이는 다른 지침을 재정의하지 않고 실행별로 동작을 수정하는 데 유용합니다. | 아니요 | |
| additional_messages | 배열 | 실행을 만들기 전에 스레드에 추가 메시지를 추가합니다. | 아니요 | |
| tools | 배열 | 도우미가 이 실행에 사용할 수 있는 도구를 재정의합니다. 이는 실행별로 동작을 수정하는 데 유용합니다. | 아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 | |
| 온도 | 번호 | 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. |
아니요 | 1 |
| top_p | 번호 | 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 온도를 변경하는 것이 좋지만 둘 다 변경하는 것은 권장하지 않습니다. |
아니요 | 1 |
| stream | 부울 값 | true인 경우, 실행 서버에서 보낸 이벤트 중에 발생하는 이벤트 스트림을 반환하고, data: [DONE] 메시지를 표시하면서 실행이 터미널 상태가 될 때 종료됩니다. |
아니요 | |
| max_prompt_tokens | 정수 | 실행 과정에서 사용할 수 있는 프롬프트 토큰의 최대 수입니다. 이 실행은 여러 번의 실행 동안 지정된 수의 프롬프트 토큰만 사용하려고 최선의 노력을 기울입니다. 실행이 지정된 프롬프트 토큰 수를 초과하면 상태 incomplete로 종료됩니다. 자세한 내용은 incomplete_details를 참조하세요. |
아니요 | |
| max_completion_tokens | 정수 | 실행 과정에서 사용할 수 있는 완료 토큰의 최대 수입니다. 이 실행은 여러 번의 실행 동안 지정된 수의 완성 토큰만 사용하려고 최선의 노력을 기울입니다. 실행이 지정된 완성 토큰 수를 초과하면 상태 incomplete로 종료됩니다. 자세한 내용은 incomplete_details를 참조하세요. |
아니요 | |
| truncation_strategy | truncationObject | 실행 전에 스레드가 잘리는 방법에 대한 컨트롤입니다. 실행의 초기 컨텍스트 창을 제어하는 데 사용합니다. | 아니요 | |
| tool_choice | assistantsApiToolChoiceOption | 모델이 호출하는 도구(있는 경우)를 제어합니다.none은 모델이 도구를 호출하지 않고 대신 메시지를 생성함을 의미합니다.auto는 기본값이며 모델이 메시지 생성 또는 도구 호출 중에서 선택할 수 있음을 의미합니다.{"type": "file_search"} 또는 {"type": "function", "function": {"name": "my_function"}}과 같은 특정 도구를 지정하면 모델이 해당 도구를 호출하게 됩니다. |
아니요 | |
| parallel_tool_calls | ParallelToolCalls | 도구를 사용하는 동안 병렬 함수 호출을 사용하도록 설정할지 여부입니다. | 아니요 | True |
| response_format | assistantsApiResponseFormatOption | 모델이 출력해야 하는 형식을 지정합니다. gpt-3.5-turbo-1106 이후의 GPT-4 Turbo 및 모든 GPT-3.5 Turbo 모델과 호환됩니다.{ "type": "json_object" }(으)로 설정하면 모델이 생성하는 메시지가 유효한 JSON임을 보장하는 JSON 모드가 사용하도록 설정됩니다.중요: JSON 모드를 사용하는 경우 시스템 또는 사용자 메시지를 통해 직접 JSON을 생성하도록 모델에 지시해야 합니다. 이렇게 하지 않으면 생성이 토큰 제한에 도달할 때까지 모델은 공백의 끝없는 스트림을 생성하여 장기 실행되고 겉보기에 "중단" 요청이 발생할 수 있습니다. 또한 생성이 max_tokens을(를) 초과했거나 대화가 최대 컨텍스트 길이를 초과했음을 나타내는 finish_reason="length"인 경우 메시지 콘텐츠가 부분적으로 잘릴 수 있습니다. |
아니요 |
listRunsResponse
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 개체 | string | 예 | ||
| 데이터 | 배열 | 예 | ||
| first_id | string | 예 | ||
| last_id | string | 예 | ||
| has_more | 부울 값 | 예 |
modifyRunRequest
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 |
submitToolOutputsRunRequest
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| tool_outputs | 배열 | 출력이 제출되는 도구 목록입니다. | 예 | |
| stream | 부울 값 | true인 경우, 실행 서버에서 보낸 이벤트 중에 발생하는 이벤트 스트림을 반환하고, data: [DONE] 메시지를 표시하면서 실행이 터미널 상태가 될 때 종료됩니다. |
아니요 |
runToolCallObject
도구 호출 개체
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | 도구 호출의 ID입니다. 엔드포인트를 실행하기 위해 제출 도구 출력을 사용하여 도구 출력을 제출할 때 이 ID를 참조해야 합니다. | 예 | |
| type | string | 출력이 필요한 도구 호출의 형식입니다. 지금은 항상 function입니다. |
예 | |
| function | 개체 | 함수 정의. | 예 |
function의 속성
name
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| name | string | 함수의 이름. |
arguments
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| arguments | string | 모델이 함수에 전달할 것으로 예상하는 인수입니다. |
type 열거형: RunToolCallObjectType
| 값 | 설명 |
|---|---|
| function |
createThreadAndRunRequest
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| assistant_id | string | 이 실행을 실행하는 데 사용할 도우미의 ID입니다. | 예 | |
| 스레드 | createThreadRequest | 아니요 | ||
| model | string | 이 실행에 사용할 모델의 배포 이름입니다. 여기에 값이 제공되면 도우미와 연결된 모델이 재정의됩니다. 그렇지 않은 경우 도우미와 연결된 모델이 사용됩니다. | 아니요 | |
| 지침 | string | 도우미의 기본 시스템 메시지를 대체합니다. 이는 실행별로 동작을 수정하는 데 유용합니다. | 아니요 | |
| tools | 배열 | 도우미가 이 실행에 사용할 수 있는 도구를 재정의합니다. 이는 실행별로 동작을 수정하는 데 유용합니다. | 아니요 | |
| tool_resources | 개체 | 도우미 도구에서 사용하는 리소스 집합입니다. 리소스는 도구 유형에 따라 다릅니다. 예를 들어 code_interpreter 도구에는 파일 ID 목록이 필요하지만 file_search 도구에는 벡터 저장소 ID 목록이 필요합니다. |
아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 | |
| 온도 | 번호 | 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. |
아니요 | 1 |
| top_p | 번호 | 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 온도를 변경하는 것이 좋지만 둘 다 변경하는 것은 권장하지 않습니다. |
아니요 | 1 |
| stream | 부울 값 | true인 경우, 실행 서버에서 보낸 이벤트 중에 발생하는 이벤트 스트림을 반환하고, data: [DONE] 메시지를 표시하면서 실행이 터미널 상태가 될 때 종료됩니다. |
아니요 | |
| stream_options | chatCompletionStreamOptions | 스트리밍 응답에 대한 옵션입니다. 설정할 stream: true때만 설정합니다. |
아니요 | None |
| max_prompt_tokens | 정수 | 실행 과정에서 사용할 수 있는 프롬프트 토큰의 최대 수입니다. 이 실행은 여러 번의 실행 동안 지정된 수의 프롬프트 토큰만 사용하려고 최선의 노력을 기울입니다. 실행이 지정된 프롬프트 토큰 수를 초과하면 상태 incomplete로 종료됩니다. 자세한 내용은 incomplete_details를 참조하세요. |
아니요 | |
| max_completion_tokens | 정수 | 실행 과정에서 사용할 수 있는 완료 토큰의 최대 수입니다. 이 실행은 여러 번의 실행 동안 지정된 수의 완성 토큰만 사용하려고 최선의 노력을 기울입니다. 실행이 지정된 완성 토큰 수를 초과하면 상태 incomplete로 종료됩니다. 자세한 내용은 incomplete_details를 참조하세요. |
아니요 | |
| truncation_strategy | truncationObject | 실행 전에 스레드가 잘리는 방법에 대한 컨트롤입니다. 실행의 초기 컨텍스트 창을 제어하는 데 사용합니다. | 아니요 | |
| tool_choice | assistantsApiToolChoiceOption | 모델이 호출하는 도구(있는 경우)를 제어합니다.none은 모델이 도구를 호출하지 않고 대신 메시지를 생성함을 의미합니다.auto는 기본값이며 모델이 메시지 생성 또는 도구 호출 중에서 선택할 수 있음을 의미합니다.{"type": "file_search"} 또는 {"type": "function", "function": {"name": "my_function"}}과 같은 특정 도구를 지정하면 모델이 해당 도구를 호출하게 됩니다. |
아니요 | |
| parallel_tool_calls | ParallelToolCalls | 도구를 사용하는 동안 병렬 함수 호출을 사용하도록 설정할지 여부입니다. | 아니요 | True |
| response_format | assistantsApiResponseFormatOption | 모델이 출력해야 하는 형식을 지정합니다. gpt-3.5-turbo-1106 이후의 GPT-4 Turbo 및 모든 GPT-3.5 Turbo 모델과 호환됩니다.{ "type": "json_object" }(으)로 설정하면 모델이 생성하는 메시지가 유효한 JSON임을 보장하는 JSON 모드가 사용하도록 설정됩니다.중요: JSON 모드를 사용하는 경우 시스템 또는 사용자 메시지를 통해 직접 JSON을 생성하도록 모델에 지시해야 합니다. 이렇게 하지 않으면 생성이 토큰 제한에 도달할 때까지 모델은 공백의 끝없는 스트림을 생성하여 장기 실행되고 겉보기에 "중단" 요청이 발생할 수 있습니다. 또한 생성이 max_tokens을(를) 초과했거나 대화가 최대 컨텍스트 길이를 초과했음을 나타내는 finish_reason="length"인 경우 메시지 콘텐츠가 부분적으로 잘릴 수 있습니다. |
아니요 |
tool_resources의 속성
code_interpreter
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_ids | 배열 | code_interpreter 도구에서 사용할 수 있는 파일 ID 목록입니다. 도구와 연결된 파일은 최대 20개일 수 있습니다. |
[] |
file_search
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| vector_store_ids | 배열 | 이 도우미에 연결된 벡터 저장소의 ID입니다. 도우미에 연결된 벡터 저장소가 최대 1개 있을 수 있습니다. |
threadObject
메시지를 포함하는 스레드를 나타냅니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | API 엔드포인트에서 참조할 수 있는 식별자입니다. | 예 | |
| 개체 | string | 항상 thread인 개체 형식입니다. |
예 | |
| created_at | 정수 | 스레드가 만들어진 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| tool_resources | 개체 | 이 스레드의 도우미 도구에서 사용할 수 있는 리소스 집합입니다. 리소스는 도구 유형에 따라 다릅니다. 예를 들어 code_interpreter 도구에는 파일 ID 목록이 필요하지만 file_search 도구에는 벡터 저장소 ID 목록이 필요합니다. |
예 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
예 |
tool_resources의 속성
code_interpreter
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_ids | 배열 | code_interpreter 도구에서 사용할 수 있는 파일 ID 목록입니다. 도구와 연결된 파일은 최대 20개일 수 있습니다. |
[] |
file_search
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| vector_store_ids | 배열 | 이 스레드에 연결된 벡터 저장소입니다. 스레드에 연결된 벡터 저장소가 최대 1개 있을 수 있습니다. |
object 열거형: ThreadObjectType
| 값 | 설명 |
|---|---|
| 스레드 | 스레드 개체 형식으로, 항상 thread입니다. |
createThreadRequest
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| messages | 배열 | 스레드를 시작할 메시지 목록입니다. | 아니요 | |
| tool_resources | 개체 | 이 스레드의 도우미 도구에서 사용할 수 있는 리소스 집합입니다. 리소스는 도구 유형에 따라 다릅니다. 예를 들어 code_interpreter 도구에는 파일 ID 목록이 필요하지만 file_search 도구에는 벡터 저장소 ID 목록이 필요합니다. |
아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 |
tool_resources의 속성
code_interpreter
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_ids | 배열 | code_interpreter 도구에서 사용할 수 있는 파일 ID 목록입니다. 도구와 연결된 파일은 최대 20개일 수 있습니다. |
[] |
file_search
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| vector_store_ids | 배열 | 이 스레드에 연결된 벡터 저장소입니다. 스레드에 연결된 벡터 저장소가 최대 1개 있을 수 있습니다. |
|
| vector_stores | 배열 | file_ids를 사용하여 벡터 저장소를 만들고 이 스레드에 연결하기 위한 도우미입니다. 스레드에 연결된 벡터 저장소가 최대 1개 있을 수 있습니다. |
modifyThreadRequest
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| tool_resources | 개체 | 이 스레드의 도우미 도구에서 사용할 수 있는 리소스 집합입니다. 리소스는 도구 유형에 따라 다릅니다. 예를 들어 code_interpreter 도구에는 파일 ID 목록이 필요하지만 file_search 도구에는 벡터 저장소 ID 목록이 필요합니다. |
아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 |
tool_resources의 속성
code_interpreter
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_ids | 배열 | code_interpreter 도구에서 사용할 수 있는 파일 ID 목록입니다. 도구와 연결된 파일은 최대 20개일 수 있습니다. |
[] |
file_search
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| vector_store_ids | 배열 | 이 스레드에 연결된 벡터 저장소입니다. 스레드에 연결된 벡터 저장소가 최대 1개 있을 수 있습니다. |
deleteThreadResponse
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | 예 | ||
| deleted | 부울 값 | 예 | ||
| 개체 | string | 예 |
object 열거형: DeleteThreadResponseObjectState
| 값 | 설명 |
|---|---|
| thread.deleted | 삭제 스레드 응답 개체 상태는 thread.deleted입니다. |
listThreadsResponse
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 개체 | string | 예 | ||
| 데이터 | 배열 | 예 | ||
| first_id | string | 예 | ||
| last_id | string | 예 | ||
| has_more | 부울 값 | 예 |
messageObject
스레드 내의 메시지를 나타냅니다.
| 이름 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | API 엔드포인트에서 참조할 수 있는 식별자입니다. | 예 | |
| 개체 | string | 항상 thread.message인 개체 형식입니다. |
예 | |
| created_at | 정수 | 메시지가 만들어진 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| thread_id | string | 이 메시지가 속한 스레드 ID입니다. | 예 | |
| 상태 | string | 메시지 상태로, in_progress, incomplete 또는 completed일 수 있습니다. |
예 | |
| incomplete_details | 개체 | 불완전한 메시지에서 메시지가 불완전한 이유에 대한 세부 정보입니다. | 예 | |
| completed_at | 정수 | 메시지가 완료된 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| incomplete_at | 정수 | 메시지가 완료로 표시된 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| 역할(role) | string | 메시지를 생성한 엔터티입니다. user 또는 assistant 중 하나입니다. |
예 | |
| content | 배열 | 텍스트 및/또는 이미지 배열에서 메시지의 내용입니다. | 예 | |
| assistant_id | string | 해당하는 경우 이 메시지를 작성한 도우미의 ID입니다. | 예 | |
| run_id | string | 해당하는 경우 이 메시지의 작성과 연결된 실행의 ID입니다. | 예 | |
| 첨부 파일 | 배열 | 메시지에 첨부된 파일 목록 및 추가해야 하는 도구입니다. | 예 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
예 |
incomplete_details의 속성
reason
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| reason | string | 메시지가 완료되지 않은 이유입니다. |
object 열거형: MessageObjectType
| 값 | 설명 |
|---|---|
| thread.message | 메시지 개체 형식 thread.message입니다. |
status 열거형: MessageObjectStatus
| 값 | 설명 |
|---|---|
| in_progress | |
| incomplete | |
| 완료됨 |
role 열거형: MessageObjectRole
| 값 | 설명 |
|---|---|
| user | |
| 도우미 |
messageDeltaObject
메시지 델타, 즉 스트리밍 중에 메시지의 변경된 필드를 나타냅니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | API 엔드포인트에서 참조할 수 있는 메시지의 식별자입니다. | 예 | |
| 개체 | string | 항상 thread.message.delta인 개체 형식입니다. |
예 | |
| delta | 개체 | 메시지에서 변경된 필드가 포함된 델타입니다. | 예 |
delta의 속성
역할(role)
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| 역할(role) | string | 메시지를 생성한 엔터티입니다. user 또는 assistant 중 하나입니다. |
content
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| content | 배열 | 텍스트 및/또는 이미지 배열에서 메시지의 내용입니다. |
object 열거형: MessageDeltaObjectType
| 값 | 설명 |
|---|---|
| thread.message.delta |
createMessageRequest
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 역할(role) | string | 메시지를 만드는 엔터티의 역할입니다. 허용되는 값은 다음과 같습니다. - user: 메시지가 실제 사용자에 의해 전송되었으며 대부분의 경우 사용자 생성 메시지를 나타내는 데 사용되어야 함을 나타냅니다.- assistant: 메시지가 도우미에 의해 생성되었음을 나타냅니다. 도우미의 메시지를 대화에 삽입하려면 이 값을 사용합니다. |
예 | |
| content | string | 메시지의 내용입니다. | 예 | |
| 첨부 파일 | 배열 | 메시지에 첨부된 파일 목록 및 추가해야 하는 도구입니다. | 아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 |
role 열거형: CreateMessageRequestRole
| 값 | 설명 |
|---|---|
| user | |
| 도우미 |
modifyMessageRequest
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 |
deleteMessageResponse
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | 예 | ||
| deleted | 부울 값 | 예 | ||
| 개체 | string | 예 |
object 열거형: DeleteMessageResponseObject
| 값 | 설명 |
|---|---|
| thread.message.deleted | 삭제된 메시지 응답 개체 상태입니다. |
listMessagesResponse
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 개체 | string | 예 | ||
| 데이터 | 배열 | 예 | ||
| first_id | string | 예 | ||
| last_id | string | 예 | ||
| has_more | 부울 값 | 예 |
messageContentImageFileObject
메시지 콘텐츠에서 이미지 파일을 참조합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | 항상 image_file입니다. |
예 | |
| image_file | 개체 | 예 |
image_file의 속성
file_id
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_id | string | 메시지 콘텐츠에 있는 이미지의 파일 ID입니다. |
type 열거형: MessageContentImageFileObjectType
| 값 | 설명 |
|---|---|
| image_file | 메시지 콘텐츠 이미지 파일 형식 |
messageContentTextObject
메시지의 일부인 텍스트 콘텐츠입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | 항상 text입니다. |
예 | |
| text | 개체 | 예 |
text의 속성
value
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| value | string | 텍스트를 구성하는 데이터입니다. |
annotations
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| annotations | 배열 |
type 열거형: messageContentTextObjectType
| 값 | 설명 |
|---|---|
| text | 메시지 콘텐츠 텍스트 개체 형식 |
messageContentTextAnnotationsFileCitationObject
도우미 또는 메시지와 연결된 특정 파일의 특정 인용을 가리키는 메시지 내의 인용입니다. 도우미가 "retrieval" 도구를 사용하여 파일을 검색할 때 생성됩니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | 항상 file_citation입니다. |
예 | |
| text | string | 바꿔야 하는 메시지 콘텐츠의 텍스트입니다. | 예 | |
| file_citation | 개체 | 예 | ||
| start_index | 정수 | 예 | ||
| end_index | 정수 | 예 |
file_citation의 속성
file_id
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_id | string | 인용의 원본인 특정 파일의 ID입니다. |
type 열거형: FileCitationObjectType
| 값 | 설명 |
|---|---|
| file_citation | 파일 인용 개체 형식 |
messageContentTextAnnotationsFilePathObject
도우미가 code_interpreter 도구를 사용하여 파일을 생성할 때 생성되는 파일의 URL입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | 항상 file_path입니다. |
예 | |
| text | string | 바꿔야 하는 메시지 콘텐츠의 텍스트입니다. | 예 | |
| file_path | 개체 | 예 | ||
| start_index | 정수 | 예 | ||
| end_index | 정수 | 예 |
file_path의 속성
file_id
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_id | string | 생성된 파일의 ID입니다. |
type 열거형: FilePathObjectType
| 값 | 설명 |
|---|---|
| file_path | 파일 경로 개체 형식 |
messageDeltaContentImageFileObject
메시지 콘텐츠에서 이미지 파일을 참조합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 색인 | 정수 | 메시지의 콘텐츠 부분에 대한 인덱스입니다. | 예 | |
| type | string | 항상 image_file입니다. |
예 | |
| image_file | 개체 | 아니요 |
image_file의 속성
file_id
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_id | string | 메시지 콘텐츠에 있는 이미지의 파일 ID입니다. |
type 열거형: MessageDeltaContentImageFileObjectType
| 값 | 설명 |
|---|---|
| image_file |
messageDeltaContentTextObject
메시지의 일부인 텍스트 콘텐츠입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 색인 | 정수 | 메시지의 콘텐츠 부분에 대한 인덱스입니다. | 예 | |
| type | string | 항상 text입니다. |
예 | |
| text | 개체 | 아니요 |
text의 속성
value
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| value | string | 텍스트를 구성하는 데이터입니다. |
annotations
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| annotations | 배열 |
type 열거형: MessageDeltaContentTextObjectType
| 값 | 설명 |
|---|---|
| text |
messageDeltaContentTextAnnotationsFileCitationObject
도우미 또는 메시지와 연결된 특정 파일의 특정 인용을 가리키는 메시지 내의 인용입니다. 도우미가 "file_search" 도구를 사용하여 파일을 검색할 때 생성됩니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 색인 | 정수 | 텍스트 콘텐츠 부분에 있는 주석의 인덱스입니다. | 예 | |
| type | string | 항상 file_citation입니다. |
예 | |
| text | string | 바꿔야 하는 메시지 콘텐츠의 텍스트입니다. | 아니요 | |
| file_citation | 개체 | 아니요 | ||
| start_index | 정수 | 아니요 | ||
| end_index | 정수 | 아니요 |
file_citation의 속성
file_id
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_id | string | 인용의 원본인 특정 파일의 ID입니다. |
견적
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| 견적 | string | 파일의 특정 인용입니다. |
type 열거형: MessageDeltaContentTextAnnotationsFileCitationObjectType
| 값 | 설명 |
|---|---|
| file_citation |
messageDeltaContentTextAnnotationsFilePathObject
도우미가 code_interpreter 도구를 사용하여 파일을 생성할 때 생성되는 파일의 URL입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 색인 | 정수 | 텍스트 콘텐츠 부분에 있는 주석의 인덱스입니다. | 예 | |
| type | string | 항상 file_path입니다. |
예 | |
| text | string | 바꿔야 하는 메시지 콘텐츠의 텍스트입니다. | 아니요 | |
| file_path | 개체 | 아니요 | ||
| start_index | 정수 | 아니요 | ||
| end_index | 정수 | 아니요 |
file_path의 속성
file_id
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_id | string | 생성된 파일의 ID입니다. |
type 열거형: MessageDeltaContentTextAnnotationsFilePathObjectType
| 값 | 설명 |
|---|---|
| file_path |
runStepObject
실행 수행의 단계를 나타냅니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | API 엔드포인트에서 참조할 수 있는 실행 단계의 식별자입니다. | 예 | |
| 개체 | string | 항상 assistant.run.step인 개체 형식입니다. |
예 | |
| created_at | 정수 | 실행 단계가 만들어진 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| assistant_id | string | 실행 단계와 연결된 도우미의 ID입니다. | 예 | |
| thread_id | string | 실행된 스레드의 ID입니다. | 예 | |
| run_id | string | 이 실행 단계가 포함된 실행의 ID입니다. | 예 | |
| type | string | 실행 단계의 형식으로, message_creation 또는 tool_calls일 수 있습니다. |
예 | |
| 상태 | string | 실행 상태로, in_progress, cancelled, failed, completed 또는 expired일 수 있습니다. |
예 | |
| step_details | runStepDetailsMessageCreationObject 또는 runStepDetailsToolCallsObject | 실행 단계의 세부 정보입니다. | 예 | |
| last_error | 개체 | 이 실행 단계와 관련된 마지막 오류입니다. 오류가 없으면 null이 됩니다. |
예 | |
| expired_at | 정수 | 실행 단계가 만료된 시점의 Unix 타임스탬프(초)입니다. 부모 실행이 만료되면 단계가 만료된 것으로 간주됩니다. | 예 | |
| cancelled_at | 정수 | 실행 단계가 취소된 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| failed_at | 정수 | 실행 단계가 실패한 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| completed_at | 정수 | 실행 단계가 완료된 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
예 |
last_error의 속성
코드
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| 코드 | string | server_error 또는 rate_limit_exceeded 중 하나입니다. |
message
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| message | string | 사람이 읽을 수 있는 오류 설명입니다. |
object 열거형: RunStepObjectType
| 값 | 설명 |
|---|---|
| assistant.run.step | 항상 assistant.run.step인 개체 형식입니다. |
type 열거형: RunStepObjectType
| 값 | 설명 |
|---|---|
| message_creation | message_creation 실행 단계 |
| tool_calls | tool_calls 실행 단계 |
status 열거형: RunStepObjectStatus
| 값 | 설명 |
|---|---|
| in_progress | in_progress 실행 상태 |
| 취소됨 | cancelled 실행 상태 |
| 실패 | cancelled 실행 상태 |
| 완료됨 | cancelled 실행 상태 |
| 만료됨 | cancelled 실행 상태 |
runStepDeltaObject
실행 단계 델타, 즉, 스트리밍 중에 실행 단계에서 변경된 필드를 나타냅니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | API 엔드포인트에서 참조할 수 있는 실행 단계의 식별자입니다. | 예 | |
| 개체 | string | 항상 thread.run.step.delta인 개체 형식입니다. |
예 | |
| delta | 개체 | 실행 단계에서 변경된 필드가 포함된 델타입니다. | 예 |
delta의 속성
step_details
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| step_details | runStepDeltaStepDetailsMessageCreationObject 또는 runStepDeltaStepDetailsToolCallsObject | 실행 단계의 세부 정보입니다. |
object 열거형: RunStepDeltaObjectType
| 값 | 설명 |
|---|---|
| thread.run.step.delta |
listRunStepsResponse
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 개체 | string | 예 | ||
| 데이터 | 배열 | 예 | ||
| first_id | string | 예 | ||
| last_id | string | 예 | ||
| has_more | 부울 값 | 예 |
runStepDetailsMessageCreationObject
실행 단계의 메시지 생성 세부 정보입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | 항상 message_creation입니다. |
예 | |
| message_creation | 개체 | 예 |
message_creation의 속성
message_id
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| message_id | string | 이 실행 단계에서 만든 메시지의 ID입니다. |
type 열거형: RunStepDetailsMessageCreationObjectType
| 값 | 설명 |
|---|---|
| message_creation |
runStepDeltaStepDetailsMessageCreationObject
실행 단계의 메시지 생성 세부 정보입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | 항상 message_creation입니다. |
예 | |
| message_creation | 개체 | 아니요 |
message_creation의 속성
message_id
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| message_id | string | 이 실행 단계에서 만든 메시지의 ID입니다. |
type 열거형: RunStepDeltaStepDetailsMessageCreationObjectType
| 값 | 설명 |
|---|---|
| message_creation |
runStepDetailsToolCallsObject
도구 호출의 세부 정보입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | 항상 tool_calls입니다. |
예 | |
| tool_calls | 배열 | 실행 단계가 관련된 도구 호출의 배열입니다. 세 가지 도구 형식 code_interpreter, retrieval 또는 function 중 하나와 연결될 수 있습니다. |
예 |
type 열거형: RunStepDetailsToolCallsObjectType
| 값 | 설명 |
|---|---|
| tool_calls |
runStepDeltaStepDetailsToolCallsObject
도구 호출의 세부 정보입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | 항상 tool_calls입니다. |
예 | |
| tool_calls | 배열 | 실행 단계가 관련된 도구 호출의 배열입니다. 세 가지 도구 형식 code_interpreter, file_search 또는 function 중 하나와 연결될 수 있습니다. |
아니요 |
type 열거형: RunStepDeltaStepDetailsToolCallsObjectType
| 값 | 설명 |
|---|---|
| tool_calls |
runStepDetailsToolCallsCodeObject
실행 단계가 관련된 코드 인터프리터 도구 호출의 세부 정보입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | 도구 호출의 ID입니다. | 예 | |
| type | string | 도구 호출의 형식입니다. 이러한 형식의 도구 호출에는 항상 code_interpreter이(가) 됩니다. |
예 | |
| code_interpreter | 개체 | 코드 인터프리터 도구 호출 정의입니다. | 예 |
code_interpreter의 속성
input
| 이름 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| input | string | 코드 인터프리터 도구 호출에 대한 입력입니다. |
outputs
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| outputs | 배열 | 코드 인터프리터 도구 호출의 출력입니다. 코드 인터프리터는 텍스트(logs) 또는 이미지(image)를 포함하는 하나 이상의 항목을 출력할 수 있습니다. 이러한 각 항목은 서로 다른 개체 형식으로 표시됩니다. |
type 열거형: RunStepDetailsToolCallsCodeObjectType
| 값 | 설명 |
|---|---|
| code_interpreter |
runStepDeltaStepDetailsToolCallsCodeObject
실행 단계가 관련된 코드 인터프리터 도구 호출의 세부 정보입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 색인 | 정수 | 도구 호출 배열의 도구 호출 인덱스입니다. | 예 | |
| id | string | 도구 호출의 ID입니다. | 아니요 | |
| type | string | 도구 호출의 형식입니다. 이러한 형식의 도구 호출에는 항상 code_interpreter이(가) 됩니다. |
예 | |
| code_interpreter | 개체 | 코드 인터프리터 도구 호출 정의입니다. | 아니요 |
code_interpreter의 속성
input
| 이름 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| input | string | 코드 인터프리터 도구 호출에 대한 입력입니다. |
outputs
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| outputs | 배열 | 코드 인터프리터 도구 호출의 출력입니다. 코드 인터프리터는 텍스트(logs) 또는 이미지(image)를 포함하는 하나 이상의 항목을 출력할 수 있습니다. 이러한 각 항목은 서로 다른 개체 형식으로 표시됩니다. |
type 열거형: RunStepDeltaStepDetailsToolCallsCodeObjectType
| 값 | 설명 |
|---|---|
| code_interpreter |
runStepDetailsToolCallsCodeOutputLogsObject
실행 단계의 일부인 코드 인터프리터 도구 호출의 텍스트 출력입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | 항상 logs입니다. |
예 | |
| 로그 | string | 코드 인터프리터 도구 호출의 텍스트 출력입니다. | 예 |
type 열거형: RunStepDetailsToolCallsCodeOutputLogsObjectType
| 값 | 설명 |
|---|---|
| 로그 |
runStepDeltaStepDetailsToolCallsCodeOutputLogsObject
실행 단계의 일부인 코드 인터프리터 도구 호출의 텍스트 출력입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 색인 | 정수 | 출력 배열의 출력 인덱스입니다. | 예 | |
| type | string | 항상 logs입니다. |
예 | |
| 로그 | string | 코드 인터프리터 도구 호출의 텍스트 출력입니다. | 아니요 |
type 열거형: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType
| 값 | 설명 |
|---|---|
| 로그 |
runStepDetailsToolCallsCodeOutputImageObject
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | 항상 image입니다. |
예 | |
| 이미지 | 개체 | 예 |
image의 속성
file_id
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_id | string | 이미지의 파일 ID입니다. |
type 열거형: RunStepDetailsToolCallsCodeOutputImageObjectType
| 값 | 설명 |
|---|---|
| 이미지 |
runStepDeltaStepDetailsToolCallsCodeOutputImageObject
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 색인 | 정수 | 출력 배열의 출력 인덱스입니다. | 예 | |
| type | string | 항상 image입니다. |
예 | |
| 이미지 | 개체 | 아니요 |
image의 속성
file_id
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| file_id | string | 이미지의 파일 ID입니다. |
type 열거형: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject
| 값 | 설명 |
|---|---|
| 이미지 |
runStepDetailsToolCallsFileSearchObject
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | 도구 호출 개체의 ID입니다. | 예 | |
| type | string | 도구 호출의 형식입니다. 이러한 형식의 도구 호출에는 항상 file_search이(가) 됩니다. |
예 | |
| file_search | 개체 | 지금은 항상 빈 개체가 됩니다. | 예 |
type 열거형: RunStepDetailsToolCallsFileSearchObjectType
| 값 | 설명 |
|---|---|
| file_search |
runStepDeltaStepDetailsToolCallsFileSearchObject
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 색인 | 정수 | 도구 호출 배열의 도구 호출 인덱스입니다. | 예 | |
| id | string | 도구 호출 개체의 ID입니다. | 아니요 | |
| type | string | 도구 호출의 형식입니다. 이러한 형식의 도구 호출에는 항상 retrieval이(가) 됩니다. |
예 | |
| file_search | 개체 | 지금은 항상 빈 개체가 됩니다. | 예 |
type 열거형: RunStepDeltaStepDetailsToolCallsFileSearchObjectType
| 값 | 설명 |
|---|---|
| file_search |
runStepDetailsToolCallsFunctionObject
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | 도구 호출 개체의 ID입니다. | 예 | |
| type | string | 도구 호출의 형식입니다. 이러한 형식의 도구 호출에는 항상 function이(가) 됩니다. |
예 | |
| function | 개체 | 호출된 함수의 정의입니다. | 예 |
function의 속성
name
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| name | string | 함수의 이름. |
arguments
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| arguments | string | 함수에 전달된 인수입니다. |
output
| 이름 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| output | string | 함수의 출력입니다. 출력이 아직 제출되지 않은 경우 null이 됩니다. |
type 열거형: RunStepDetailsToolCallsFunctionObjectType
| 값 | 설명 |
|---|---|
| function |
runStepDeltaStepDetailsToolCallsFunctionObject
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 색인 | 정수 | 도구 호출 배열의 도구 호출 인덱스입니다. | 예 | |
| id | string | 도구 호출 개체의 ID입니다. | 아니요 | |
| type | string | 도구 호출의 형식입니다. 이러한 형식의 도구 호출에는 항상 function이(가) 됩니다. |
예 | |
| function | 개체 | 호출된 함수의 정의입니다. | 아니요 |
function의 속성
name
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| name | string | 함수의 이름. |
arguments
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| arguments | string | 함수에 전달된 인수입니다. |
output
| 이름 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| output | string | 함수의 출력입니다. 출력이 아직 제출되지 않은 경우 null이 됩니다. |
type 열거형: RunStepDetailsToolCallsFunctionObjectType
| 값 | 설명 |
|---|---|
| function |
vectorStoreExpirationAfter
벡터 저장소에 대한 만료 정책입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| anchor | string | 만료 정책이 적용되는 앵커 타임스탬프입니다. 지원되는 앵커: last_active_at. |
예 | |
| 일 | 정수 | 벡터 저장소가 만료되는 앵커 시간 이후의 일 수입니다. | 예 |
anchor 열거형: VectorStoreExpirationAfterAnchor
| 값 | 설명 |
|---|---|
| last_active_at | 만료 정책이 적용되는 앵커 타임스탬프입니다. |
vectorStoreObject
벡터 저장소는 file_search 도구에서 사용할 수 있는 처리된 파일의 컬렉션입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | API 엔드포인트에서 참조할 수 있는 식별자입니다. | 예 | |
| 개체 | enum | 항상 vector_store인 개체 형식입니다.가능한 값: vector_store |
예 | |
| created_at | 정수 | 벡터 저장소가 만들어진 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| 이름 | string | 벡터 저장소의 이름입니다. | 예 | |
| usage_bytes | 정수 | 벡터 저장소의 파일에 사용되는 총 바이트 수입니다. | 예 | |
| file_counts | 개체 | 예 | ||
| 상태 | string | 벡터 저장소의 상태로, expired, in_progress 또는 completed일 수 있습니다. completed의 상태는 벡터 저장소를 사용할 준비가 되었음을 나타냅니다. |
예 | |
| expires_after | vectorStoreExpirationAfter | 벡터 저장소에 대한 만료 정책입니다. | 아니요 | |
| expires_at | 정수 | 벡터 저장소가 만료될 시점의 Unix 타임스탬프(초)입니다. | 아니요 | |
| last_active_at | 정수 | 벡터 저장소가 마지막으로 활성 상태였던 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
예 |
file_counts의 속성
in_progress
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| in_progress | 정수 | 현재 처리 중인 파일 수입니다. |
완료됨
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| 완료됨 | 정수 | 성공적으로 처리된 파일 수입니다. |
실패
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| 실패 | 정수 | 처리하지 못한 파일 수입니다. |
취소됨
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| 취소됨 | 정수 | 취소된 파일 수입니다. |
total
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| total | 정수 | 총 파일 수입니다. |
status 열거형: VectorStoreObjectStatus
| 값 | 설명 |
|---|---|
| 만료됨 | |
| in_progress | |
| 완료됨 |
createVectorStoreRequest
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| file_ids | 배열 | 벡터 저장소에서 사용해야 하는 파일 ID 목록입니다. 파일에 액세스할 수 있는 file_search와 같은 도구에 유용합니다. |
아니요 | |
| 이름 | string | 벡터 저장소의 이름입니다. | 아니요 | |
| expires_after | vectorStoreExpirationAfter | 벡터 저장소에 대한 만료 정책입니다. | 아니요 | |
| chunking_strategy | autoChunkingStrategyRequestParam 또는 staticChunkingStrategyRequestParam | 파일을 청크하는 데 사용되는 청크 전략입니다. 설정하지 않으면 auto 전략을 사용합니다. 비어 있지 않은 경우에만 file_ids 적용할 수 있습니다. |
아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 |
updateVectorStoreRequest
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| name | string | 벡터 저장소의 이름입니다. | 아니요 | |
| expires_after | vectorStoreExpirationAfter | 벡터 저장소에 대한 만료 정책입니다. | 아니요 | |
| metadata | 개체 | 개체에 연결할 수 있는 16개의 키-값 쌍 집합입니다. 이는 구조화된 형식으로 개체에 대한 추가 정보를 저장하는 데 유용할 수 있습니다. 키의 길이는 최대 64자이고 값은 최대 512자까지 가능합니다. |
아니요 |
listVectorStoresResponse
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 개체 | string | 예 | ||
| 데이터 | 배열 | 예 | ||
| first_id | string | 예 | ||
| last_id | string | 예 | ||
| has_more | 부울 값 | 예 |
deleteVectorStoreResponse
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | 예 | ||
| deleted | 부울 값 | 예 | ||
| 개체 | string | 예 |
object 열거형: DeleteVectorStoreResponseObject
| 값 | 설명 |
|---|---|
| vector_store.deleted | 삭제된 벡터 저장소 응답 개체 상태입니다. |
vectorStoreFileObject
벡터 저장소에 연결된 파일 목록입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | API 엔드포인트에서 참조할 수 있는 식별자입니다. | 예 | |
| 개체 | string | 항상 vector_store.file인 개체 형식입니다. |
예 | |
| usage_bytes | 정수 | 총 벡터 저장소 사용량(바이트)입니다. 원래 파일 크기와 다를 수 있습니다. | 예 | |
| created_at | 정수 | 벡터 저장소 파일이 만들어진 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| vector_store_id | string | 파일이 연결된 벡터 저장소의 ID입니다. | 예 | |
| 상태 | string | 벡터 저장소 파일의 상태로, in_progress, completed, cancelled 또는 failed일 수 있습니다. completed 상태는 벡터 저장소 파일을 사용할 준비가 되었음을 나타냅니다. |
예 | |
| last_error | 개체 | 이 벡터 저장소 파일과 연결된 마지막 오류입니다. 오류가 없으면 null이 됩니다. |
예 | |
| chunking_strategy | autoChunkingStrategyRequestParam 또는 staticChunkingStrategyRequestParam | 파일을 청크하는 데 사용되는 청크 전략입니다. 설정하지 않으면 auto 전략을 사용합니다. 비어 있지 않은 경우에만 file_ids 적용할 수 있습니다. |
아니요 |
last_error의 속성
코드
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| 코드 | string | server_error 또는 rate_limit_exceeded 중 하나입니다. |
message
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| message | string | 사람이 읽을 수 있는 오류 설명입니다. |
object 열거형: VectorStoreFileObjectType
| 값 | 설명 |
|---|---|
| vector_store.file |
status 열거형: VectorStoreFileObjectStatus
| 값 | 설명 |
|---|---|
| in_progress | |
| 완료됨 | |
| 취소됨 | |
| 실패 |
otherChunkingStrategyResponseParam
청크 전략을 알 수 없는 경우 반환됩니다. 일반적으로 이는 chunking_strategy 개념이 API에 도입되기 전에 파일이 인덱싱되었기 때문입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | 항상 other입니다. |
예 |
형식 열거형: OtherChunkingStrategyResponseParamType
| 값 | 설명 |
|---|---|
| 기타 |
staticChunkingStrategyResponseParam
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | string | 항상 static입니다. |
예 | |
| static | staticChunkingStrategy | 예 |
형식 열거형: StaticChunkingStrategyResponseParamType
| 값 | 설명 |
|---|---|
| static |
staticChunkingStrategy
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| max_chunk_size_tokens | 정수 | 각 청크의 최대 토큰 수입니다. 기본값은 800입니다. 최솟값은 100이고 최댓값은 4096입니다. |
예 | |
| chunk_overlap_tokens | 정수 | 청크 간에 겹치는 토큰 수입니다. 기본값은 400입니다.겹침은 max_chunk_size_tokens의 절반을 초과할 수 없습니다. |
예 |
autoChunkingStrategyRequestParam
기본 전략. 이 전략은 현재 800의 max_chunk_size_tokens 및 400의 chunk_overlap_tokens을 사용합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | enum | 항상 auto입니다.가능한 값: auto |
예 |
staticChunkingStrategyRequestParam
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| type | enum | 항상 static입니다.가능한 값: 정적 |
예 | |
| static | staticChunkingStrategy | 예 |
chunkingStrategyRequestParam
파일을 청크하는 데 사용되는 청크 전략입니다. 설정하지 않으면 auto 전략을 사용합니다.
이 구성 요소는 다음 중 하나일 수 있습니다.
createVectorStoreFileRequest
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| file_id | string | 벡터 저장소에서 사용해야 하는 파일 ID입니다. 파일에 액세스할 수 있는 file_search와 같은 도구에 유용합니다. |
예 | |
| chunking_strategy | chunkingStrategyRequestParam | 파일을 청크하는 데 사용되는 청크 전략입니다. 설정하지 않으면 auto 전략을 사용합니다. |
아니요 |
listVectorStoreFilesResponse
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 개체 | string | 예 | ||
| 데이터 | 배열 | 예 | ||
| first_id | string | 예 | ||
| last_id | string | 예 | ||
| has_more | 부울 값 | 예 |
deleteVectorStoreFileResponse
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | 예 | ||
| deleted | 부울 값 | 예 | ||
| 개체 | string | 예 |
object 열거형: DeleteVectorStoreFileResponseObject
| 값 | 설명 |
|---|---|
| vector_store.file.deleted |
vectorStoreFileBatchObject
벡터 저장소에 연결된 파일의 일괄 처리입니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| id | string | API 엔드포인트에서 참조할 수 있는 식별자입니다. | 예 | |
| 개체 | string | 항상 vector_store.file_batch인 개체 형식입니다. |
예 | |
| created_at | 정수 | 벡터 저장소 파일 일괄 처리가 만들어진 시점의 Unix 타임스탬프(초)입니다. | 예 | |
| vector_store_id | string | 파일이 연결된 벡터 저장소의 ID입니다. | 예 | |
| 상태 | string | 벡터 저장소 파일 일괄 처리의 상태로, in_progress, completed, cancelled 또는 failed일 수 있습니다. |
예 | |
| file_counts | 개체 | 예 |
file_counts의 속성
in_progress
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| in_progress | 정수 | 현재 처리 중인 파일 수입니다. |
완료됨
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| 완료됨 | 정수 | 처리된 파일 수입니다. |
실패
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| 실패 | 정수 | 처리하지 못한 파일 수입니다. |
취소됨
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| 취소됨 | 정수 | 취소된 파일 수입니다. |
total
| 속성 | 형식 | 설명 | 기본값 |
|---|---|---|---|
| total | 정수 | 총 파일 수입니다. |
object 열거형: VectorStoreFileBatchObjectType
| 값 | 설명 |
|---|---|
| vector_store.files_batch |
status 열거형: VectorStoreFileBatchObjectStatus
| 값 | 설명 |
|---|---|
| in_progress | |
| 완료됨 | |
| 취소됨 | |
| 실패 |
createVectorStoreFileBatchRequest
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| file_ids | 배열 | 벡터 저장소에서 사용해야 하는 파일 ID 목록입니다. 파일에 액세스할 수 있는 file_search와 같은 도구에 유용합니다. |
예 | |
| chunking_strategy | chunkingStrategyRequestParam | 파일을 청크하는 데 사용되는 청크 전략입니다. 설정하지 않으면 auto 전략을 사용합니다. |
아니요 |
assistantStreamEvent
실행을 스트리밍할 때 발생하는 이벤트를 나타냅니다.
서버에서 보낸 이벤트 스트림의 각 이벤트에는 event 및 data 속성이 있습니다.
event: thread.created
data: {"id": "thread_123", "object": "thread", ...}
새 개체가 만들어지거나, 새 상태로 전환되거나, 부분(델타)으로 스트리밍될 때마다 이벤트를 내보냅니다. 예를 들어, 새 실행이 만들어지면 thread.run.created를 내보내고, 실행이 완료되면 thread.run.completed를 내보냅니다. 도우미가 실행 중에 메시지 만들기를 선택하면 thread.message.created event 이벤트, thread.message.in_progress 이벤트, 많은 thread.message.delta 이벤트, 마지막으로 thread.message.completed 이벤트를 차례로 내보냅니다.
시간이 지남에 따라 이벤트를 추가할 수 있으므로 코드에서 알 수 없는 이벤트를 정상적으로 처리하는 것이 좋습니다.
이 구성 요소는 다음 중 하나일 수 있습니다.
threadStreamEvent
이 구성 요소는 다음 중 하나일 수 있습니다.
thread.created
새 스레드가 만들어질 때 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | threadObject | 메시지를 포함하는 스레드를 나타냅니다. | 예 |
데이터: threadObject
Event 열거형: ThreadStreamEventEnum
| 값 | 설명 |
|---|---|
| thread.created | 스레드 생성 이벤트입니다. |
runStreamEvent
이 구성 요소는 다음 중 하나일 수 있습니다.
thread.run.created
새 실행이 만들어지면 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | runObject | 스레드에서 실행되는 실행을 나타냅니다. | 예 |
데이터: runObject
Event 열거형: RunStreamEventCreated
| 값 | 설명 |
|---|---|
| thread.run.created |
thread.run.queued
실행이 queued 상태로 이동할 때 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | runObject | 스레드에서 실행되는 실행을 나타냅니다. | 예 |
데이터: runObject
Event 열거형: RunStreamEventQueued
| 값 | 설명 |
|---|---|
| thread.run.queued |
thread.run.in_progress
실행이 in_progress 상태로 이동할 때 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | runObject | 스레드에서 실행되는 실행을 나타냅니다. | 예 |
데이터: runObject
Event 열거형: RunStreamEventInProgress
| 값 | 설명 |
|---|---|
| thread.run.in_progress |
thread.run.requires_action
실행이 requires_action 상태로 이동할 때 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | runObject | 스레드에서 실행되는 실행을 나타냅니다. | 예 |
데이터: runObject
Event 열거형: RunStreamEventRequiresAction
| 값 | 설명 |
|---|---|
| thread.run.requires_action |
thread.run.completed
실행이 완료되면 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | runObject | 스레드에서 실행되는 실행을 나타냅니다. | 예 |
데이터: runObject
Event 열거형: RunStreamEventCompleted
| 값 | 설명 |
|---|---|
| thread.run.completed |
thread.run.failed
실행이 실패할 때 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | runObject | 스레드에서 실행되는 실행을 나타냅니다. | 예 |
데이터: runObject
Event 열거형: RunStreamEventFailed
| 값 | 설명 |
|---|---|
| thread.run.failed |
thread.run.cancelling
실행이 cancelling 상태로 이동할 때 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | runObject | 스레드에서 실행되는 실행을 나타냅니다. | 예 |
데이터: runObject
Event 열거형: RunStreamEventCancelling
| 값 | 설명 |
|---|---|
| thread.run.cancelling |
thread.run.cancelled
실행이 취소되면 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | runObject | 스레드에서 실행되는 실행을 나타냅니다. | 예 |
데이터: runObject
Event 열거형: RunStreamEventCancelled
| 값 | 설명 |
|---|---|
| thread.run.cancelled |
thread.run.expired
실행이 만료되면 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | runObject | 스레드에서 실행되는 실행을 나타냅니다. | 예 |
데이터: runObject
Event 열거형: RunStreamEventExpired
| 값 | 설명 |
|---|---|
| thread.run.expired |
runStepStreamEvent
이 구성 요소는 다음 중 하나일 수 있습니다.
thread.run.step.created
실행 단계가 만들어지면 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | runStepObject | 실행 수행의 단계를 나타냅니다. |
예 |
데이터: runStepObject
Event 열거형: RunStepStreamEventCreated
| 값 | 설명 |
|---|---|
| thread.run.step.created |
thread.run.step.in_progress
실행 단계가 in_progress 상태로 이동할 때 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | runStepObject | 실행 수행의 단계를 나타냅니다. |
예 |
데이터: runStepObject
Event 열거형: RunStepStreamEventInProgress
| 값 | 설명 |
|---|---|
| thread.run.step.in_progress |
thread.run.step.delta
실행 단계의 일부가 스트리밍될 때 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | runStepDeltaObject | 실행 단계 델타, 즉, 스트리밍 중에 실행 단계에서 변경된 필드를 나타냅니다. |
예 |
데이터: runStepDeltaObject
Event 열거형: RunStepStreamEventDelta
| 값 | 설명 |
|---|---|
| thread.run.step.delta |
thread.run.step.completed
실행 단계가 완료되면 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | runStepObject | 실행 수행의 단계를 나타냅니다. |
예 |
데이터: runStepObject
Event 열거형: RunStepStreamEventCompleted
| 값 | 설명 |
|---|---|
| thread.run.step.completed |
thread.run.step.failed
실행 단계가 실패하면 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | runStepObject | 실행 수행의 단계를 나타냅니다. |
예 |
데이터: runStepObject
Event 열거형: RunStepStreamEventFailed
| 값 | 설명 |
|---|---|
| thread.run.step.failed |
thread.run.step.cancelled
실행 단계가 취소되면 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | runStepObject | 실행 수행의 단계를 나타냅니다. |
예 |
데이터: runStepObject
Event 열거형: RunStepStreamEventCancelled
| 값 | 설명 |
|---|---|
| thread.run.step.cancelled |
thread.run.step.expired
실행 단계가 만료되면 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | runStepObject | 실행 수행의 단계를 나타냅니다. |
예 |
데이터: runStepObject
Event 열거형: RunStepStreamEventExpired
| 값 | 설명 |
|---|---|
| thread.run.step.expired |
messageStreamEvent
이 구성 요소는 다음 중 하나일 수 있습니다.
thread.message.created
메시지가 만들어질 때 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | messageObject | 스레드 내의 메시지를 나타냅니다. | 예 |
데이터: messageObject
Event 열거형: MessageStreamEventCreated
| 값 | 설명 |
|---|---|
| thread.message.created |
thread.message.in_progress
메시지가 in_progress 상태로 이동할 때 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | messageObject | 스레드 내의 메시지를 나타냅니다. | 예 |
데이터: messageObject
Event 열거형: MessageStreamEventInProgress
| 값 | 설명 |
|---|---|
| thread.message.in_progress |
thread.message.delta
메시지의 일부가 스트리밍될 때 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | messageDeltaObject | 메시지 델타, 즉 스트리밍 중에 메시지의 변경된 필드를 나타냅니다. |
예 |
데이터: messageDeltaObject
Event 열거형: MessageStreamEventDelta
| 값 | 설명 |
|---|---|
| thread.message.delta |
thread.message.completed
메시지가 완료되면 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | messageObject | 스레드 내의 메시지를 나타냅니다. | 예 |
데이터: messageObject
Event 열거형: MessageStreamEventCompleted
| 값 | 설명 |
|---|---|
| thread.message.completed |
thread.message.incomplete
메시지가 완료되기 전에 종료되면 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | messageObject | 스레드 내의 메시지를 나타냅니다. | 예 |
데이터: messageObject
Event 열거형: MessageStreamEventIncomplete
| 값 | 설명 |
|---|---|
| thread.message.incomplete |
errorEvent
오류가 발생하면 발생합니다. 이는 내부 서버 오류 또는 시간 제한으로 인해 발생할 수 있습니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | error | 예 |
event 열거형: ErrorEventEnum
| 값 | 설명 |
|---|---|
| error |
doneEvent
스트림이 종료되면 발생합니다.
| 속성 | 형식 | 설명 | 필수 항목 | 기본값 |
|---|---|---|---|---|
| 이벤트 | string | 예 | ||
| 데이터 | string | 예 |
event 열거형: DoneEventEnum
| 값 | 설명 |
|---|---|
| 완료 |
data 열거형: DoneEventDataEnum
| 값 | 설명 |
|---|---|
| [DONE] |
다음 단계
모델 및 REST API를 사용한 미세 조정에 대해 알아보세요. Azure OpenAI를 지원하는 기본 모델에 대해 자세히 알아봅니다.