도우미 수정(v1)

POST

https://api.openai.com/v1/assistants/asst_abc123

어시스턴트를 수정합니다.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.openai.com/v1/assistants/asst_abc123' \
--header 'Authorization: Bearer $OPENAI_API_KEY' \
--header 'OpenAI-Beta: assistants=v1' \
--header 'Content-Type: application/json' \
--data-raw '{
      "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": "retrieval"}],
      "model": "gpt-4-turbo",
      "file_ids": ["file-abc123", "file-abc456"]
    }'

Response Example

{
  "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. Always response with info from either of the files.",
  "tools": [
    {
      "type": "retrieval"
    }
  ],
  "file_ids": [
    "file-abc123",
    "file-abc456"
  ],
  "metadata": {},
  "top_p": 1,
  "temperature": 1,
  "response_format": "auto"
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Content-Type

string

required

Example:

application/json

Authorization

string

required

Example:

Bearer $OPENAI_API_KEY

OpenAI-Beta

string

required

Example:

assistants=v1

Body Params application/json

instructions

string

required

tools

array [object {1}]

required

type

string

optional

model

string

required

file_ids

array[string]

required

Examples

Responses

🟢200Success

application/json

Body

string

required

object

string

required

created_at

integer

required

name

string

required

어시스턴트의 이름입니다. 최대 길이는 256자입니다.

description

null

required

어시스턴트에 대한 설명입니다. 최대 길이는 512자입니다.

model

string

required

사용할 모델의 ID입니다. 모델 목록 API를 사용하여 사용 가능한 모든 모델을 확인하거나 모델 개요 에서 해당 모델에 대한 설명을 볼 수 있습니다. 유형: 문자열

instructions

string

required

어시스턴트가 사용하는 시스템 지침입니다. 최대 길이는 256,000자입니다.

tools

array [object {1}]

required

어시스턴트에서 활성화된 도구 목록입니다. 보조자당 최대 128개의 도구가 있을 수 있습니다. 도구는 code_interpreter , retrieval 또는 function 유형일 수 있습니다.

type

string

optional

file_ids

array[string]

required

이 어시스턴트에 첨부된 파일 ID 목록입니다. 어시스턴트에는 최대 20개의 파일을 첨부할 수 있습니다. 파일은 생성 날짜를 기준으로 오름차순으로 정렬됩니다. 이전에 목록에 첨부된 파일이 목록에 표시되지 않으면 보조자에서 삭제됩니다.

metadata

object

required

객체에 연결할 수 있는 16개의 키-값 쌍 세트입니다. 이는 개체에 대한 추가 정보를 구조화된 형식으로 저장하는 데 유용할 수 있습니다. 키는 최대 64자, 값은 최대 512자까지 가능합니다.

top_p

integer

required

핵 샘플링이라고 하는 온도 샘플링의 대안으로, 모델은 확률 질량이 top_p인 토큰의 결과를 고려합니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려된다는 의미입니다.We generally recommend altering this or temperature but not both.
일반적으로 이 온도나 온도를 변경하는 것이 좋지만 둘 다 변경하는 것은 권장되지 않습니다.

temperature

integer

required

사용할 샘플링 온도는 0에서 2 사이입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 더욱 집중적이고 결정적이게 됩니다.

response_format

string

required

모델이 출력해야 하는 형식을 지정합니다. GPT-4o , GPT-4 Turbo 및 gpt-3.5-turbo-1106 이후의 모든 GPT-3.5 Turbo 모델과 호환됩니다.

{ "type": "json_object" } 로 설정하면 모델이 생성하는 메시지가 유효한 JSON임을 보장하는 JSON 모드가 활성화됩니다.

중요: JSON 모드를 사용하는 경우 시스템 또는 사용자 메시지를 통해 JSON을 직접 생성하도록 모델에 지시 해야 합니다 . 이것이 없으면 모델은 생성이 토큰 제한에 도달할 때까지 끝없는 공백 스트림을 생성하여 오래 실행되고 겉보기에 "중단"된 요청이 발생할 수 있습니다. 또한 finish_reason="length" 인 경우 메시지 내용이 부분적으로 잘릴 수 있습니다. 이는 생성이 max_tokens 초과했거나 대화가 최대 컨텍스트 길이를 초과했음을 나타냅니다.

Modified at 2024-12-13 06:23:45

보조 파일 검색(v1)

어시스턴트 삭제(v1)