Messages（函数调用） - 302.AI API文档

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

Accept

string

必需

示例值:

application/json

Authorization

string

可选

示例值:

Bearer {{YOUR_API_KEY}}

Body 参数application/json

model

string

必需

要使用的模型的 ID。有关哪些模型适用于聊天 API 的详细信息，请参阅模型端点兼容性表。

max_tokens

integer

必需

聊天完成时生成的最大令牌数。输入标记和生成标记的总长度受模型上下文长度的限制。

tools

array [object {3}]

必需

工具调用Tool Use传递工具参数

name

string

可选

description

string

可选

input_schema

object

可选

tool_choice

object

设置工具调用的模式

可选

type

string

必需

messages

array [object {2}]

必需

以聊天格式生成聊天完成的消息。

role

string

可选

content

string

可选

stop_sequences

string

可选

API 将停止生成更多令牌的最多 4 个序列。

temperature

number

可选

使用什么采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更加随机，而较低的值（如 0.2）将使输出更加集中和确定。我们通常建议改变这个或top_p但不是两者。

top_p

integer

可选

一种替代温度采样的方法，称为核采样，其中模型考虑具有 top_p 概率质量的标记的结果。所以 0.1 意味着只考虑构成前 10% 概率质量的标记。我们通常建议改变这个或temperature但不是两者。

top_k

string

可选

一种替代温度采样的方法

stream

boolean

可选

如果设置，将发送部分消息增量，就像在 ChatGPT 中一样。当令牌可用时，令牌将作为纯数据服务器发送事件data: [DONE]发送，流由消息终止。有关示例代码，请参阅 OpenAI Cookbook 。

system

string

系统提示词

可选

示例

{
    "model": "claude-3-5-sonnet-20241022",
    "max_tokens": 1024,
    "tools": [
      {
        "name": "get_weather",
        "description": "Get the current weather in a given location",
        "input_schema": {
          "type": "object",
          "properties": {
            "location": {
              "type": "string",
              "description": "The city and state, e.g. San Francisco, CA"
            }
          },
          "required": ["location"]
        }
      }
    ],
    "tool_choice":{"type": "auto"},
    "messages": [
      {
        "role": "user",
        "content": "What is the weather like in San Francisco?"
      }
    ]
  }

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.302.ai/v1/messages' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "claude-3-5-sonnet-20241022",
    "max_tokens": 1024,
    "tools": [
      {
        "name": "get_weather",
        "description": "Get the current weather in a given location",
        "input_schema": {
          "type": "object",
          "properties": {
            "location": {
              "type": "string",
              "description": "The city and state, e.g. San Francisco, CA"
            }
          },
          "required": ["location"]
        }
      }
    ],
    "tool_choice":{"type": "auto"},
    "messages": [
      {
        "role": "user",
        "content": "What is the weather like in San Francisco?"
      }
    ]
  }'

返回响应

🟢200OK

application/json

Body

id

string

必需

type

string

必需

role

string

必需

model

string

必需

content

array [object {2}]

必需

type

string

可选

text

string

可选

stop_reason

string

必需

stop_sequence

null

必需

usage

object

必需

input_tokens

integer

必需

cache_creation_input_tokens

integer

必需

cache_read_input_tokens

integer

必需

output_tokens

integer

必需

示例

{
    "id": "msg_01QyXuu5DMbJWUN22Ys6Kvoh",
    "type": "message",
    "role": "assistant",
    "model": "claude-3-5-sonnet-20240620",
    "content": [
        {
            "type": "text",
            "text": "Hello! How can I assist you today? Feel free to ask me any questions or let me know if you need help with anything."
        }
    ],
    "stop_reason": "end_turn",
    "stop_sequence": null,
    "usage": {
        "input_tokens": 10,
        "cache_creation_input_tokens": 0,
        "cache_read_input_tokens": 0,
        "output_tokens": 30
    }
}