OpenAI API参考文档 | OpenAI开发文档|OpenAI中文官方文档|ChatGPT中文版|ChatGPT教程

创建线程并运行
试用版

帖子 https://api.openai.com/v1/threads/runs

创建一个线程并在一个请求中运行它。source

请求正文

assistant_id

字符串source

必填

用于执行此运行的助手的 ID。source

线程

对象source

自选

MODEL

字符串source

自选

用于执行此运行的 Model 的 ID。如果此处提供了值，它将覆盖与助手关联的模型。否则，将使用与助手关联的模型。source

指示

string 或 nullsource

自选

覆盖助手的默认系统消息。这对于修改每次运行的行为非常有用。source

工具

array 或 nullsource

自选

覆盖助手可用于此运行的工具。这对于修改每次运行的行为非常有用。source

tool_resources

object 或 nullsource

自选

助手的工具使用的一组资源。这些资源特定于工具类型。例如，code_interpreter工具需要文件 ID 列表，而file_search工具需要矢量存储 ID 列表。source

元数据

地图source

自选

一组 16 个可附加到对象的键值对。这对于以结构化格式存储有关对象的其他信息非常有用。键的长度最大为 64 个字符，值的长度最大为 512 个字符。source

温度

number 或 nullsource

自选

默认为 1

要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更加随机，而较低的值（如 0.2）将使其更加集中和确定。source

top_p

number 或 nullsource

自选

默认为 1

使用温度进行采样的替代方法，称为核抽样，其中模型考虑具有top_p概率质量的标记的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的 token。source

我们通常建议更改此温度或温度，但不能同时更改两者。source

流

boolean 或 nullsource

自选

如果true返回在 Run as server-sent 事件期间发生的事件流，当 Run 进入带有data: [DONE]消息。source

max_prompt_tokens

整数或 nullsource

自选

在运行过程中可以使用的提示令牌的最大数量。运行将尽最大努力在运行的多个轮次中仅使用指定的提示令牌数。如果运行超过指定的提示令牌数，则运行将以 status 结束incomplete.看incomplete_details了解更多信息。source

max_completion_tokens

整数或 nullsource

自选

在运行过程中可以使用的完成令牌的最大数量。运行将尽最大努力在运行的多个轮次中仅使用指定的完成令牌数。如果运行超过指定的完成令牌数，则运行将以 status 结束incomplete.看incomplete_details了解更多信息。source

truncation_strategy

对象source

自选

控制线程在运行之前如何被截断。使用此选项可控制运行的初始上下文窗口。source

tool_choice

字符串或对象source

自选

控制模型调用哪个（如果有）工具。none表示模型不会调用任何工具，而是生成一条消息。auto是默认值，这意味着模型可以在生成消息或调用一个或多个工具之间进行选择。required表示模型在响应用户之前必须调用一个或多个工具。指定特定工具，如{"type": "file_search"}或{"type": "function", "function": {"name": "my_function"}}强制模型调用该工具。source

parallel_tool_calls

布尔source

自选

默认为 true

是否在工具使用过程中启用并行函数调用。source

response_format

“auto” 或 objectsource

自选

指定模型必须输出的格式。兼容 GPT-4o、GPT-4 Turbo 和所有 GPT-3.5 Turbo 型号gpt-3.5-turbo-1106.source

设置为{ "type": "json_schema", "json_schema": {...} }启用结构化输出，以确保模型与您提供的 JSON 架构匹配。在结构化输出指南中了解更多信息。source

设置为{ "type": "json_object" }启用 JSON 模式，以确保模型生成的消息是有效的 JSON。source

重要提示：使用 JSON 模式时，还必须通过系统或用户消息指示模型自行生成 JSON。否则，模型可能会生成无休止的空格流，直到生成达到令牌限制，从而导致长时间运行且似乎“卡住”的请求。另请注意，如果出现以下情况，消息内容可能会被部分截断finish_reason="length"，这表示已超过代数max_tokens或对话超过了最大上下文长度。source

run 对象。source

示例请求

1
2
3
4
5
6
7
8
9
10
11
12
curl https://api.openai.com/v1/threads/runs \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "Content-Type: application/json" \
  -H "OpenAI-Beta: assistants=v2" \
  -d '{
      "assistant_id": "asst_abc123",
      "thread": {
        "messages": [
          {"role": "user", "content": "Explain deep learning to a 5 year old."}
        ]
      }
    }'

1
2
3
4
5
6
7
8
9
10
11
12
13
from openai import OpenAI
client = OpenAI()

run = client.beta.threads.create_and_run(
  assistant_id="asst_abc123",
  thread={
    "messages": [
      {"role": "user", "content": "Explain deep learning to a 5 year old."}
    ]
  }
)

print(run)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
import OpenAI from "openai";

const openai = new OpenAI();

async function main() {
  const run = await openai.beta.threads.createAndRun({
    assistant_id: "asst_abc123",
    thread: {
      messages: [
        { role: "user", content: "Explain deep learning to a 5 year old." },
      ],
    },
  });

  console.log(run);
}

main();

响应

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
  "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-4o",
  "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",
  "parallel_tool_calls": true
}

创建线程并运行试用版

请求正文

返回

创建线程并运行
试用版