工具调用(function call)

POST

/v1/chat/completions

使用function call
不是所有对话模型都可使用此接口，目前可以使用的是openai模型
模型列表请参考问问平台：https://api.wenwen-ai.com/pricing
BASE_URL: https://api.wenwen-ai.com

请求参数

Header 参数

Authorization

string

必需

示例值:

Bearer {YOUR_API_KEY}

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

model

string

要使用的模型的名字

必需

messages

array [object {2}]

必需

至今为止对话所包含的消息列表。参考右边json示例

role

string

可选

content

string

可选

tools

array [object {2}]

必需

模型可以调用的一组工具列表。目前,只支持作为工具的函数。使用此功能来提供模型可以为之生成 JSON 输入的函数列表。

type

string

必需

type的值需要填写function

function

object

必需

示例

{
  "model": "gpt-4o-2024-08-06",
  "messages": [
    {
      "role": "user",
      "content": "What's the weather like in Boston today?"
    }
  ],
  "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"
          ]
        }
      }
    }
  ]
}

示例代码

HTTP

Shell

JavaScript

Java

Swift

PHP

Python

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.wenwen-ai.com/v1/chat/completions' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "model": "gpt-4o-2024-08-06",
  "messages": [
    {
      "role": "user",
      "content": "What'\''s the weather like in Boston today?"
    }
  ],
  "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"
          ]
        }
      }
    }
  ]
}'

返回响应

🟢200成功

application/json

Body

string

必需

object

string

必需

created

integer

必需

model

string

必需

choices

array [object {4}]

必需

index

integer

可选

message

object

可选

logprobs

null

可选

finish_reason

string

可选

usage

object

必需

prompt_tokens

integer

必需

completion_tokens

integer

必需

total_tokens

integer

必需

prompt_tokens_details

object

必需

completion_tokens_details

object

必需

system_fingerprint

string

必需

示例

{
  "id": "chatcmpl-Bg4N1ruuaSdAVkayKQz6OAbmUy4kQ",
  "object": "chat.completion",
  "created": 1749366275,
  "model": "gpt-4o-2024-08-06",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": null,
        "tool_calls": [
          {
            "id": "call_4yKljCtGceYj1heJY8G9h3te",
            "type": "function",
            "function": {
              "name": "get_current_weather",
              "arguments": "{\"location\":\"Boston, MA\",\"unit\":\"celsius\"}"
            }
          }
        ],
        "refusal": null,
        "annotations": []
      },
      "logprobs": null,
      "finish_reason": "tool_calls"
    }
  ],
  "usage": {
    "prompt_tokens": 80,
    "completion_tokens": 23,
    "total_tokens": 103,
    "prompt_tokens_details": {
      "cached_tokens": 0,
      "audio_tokens": 0
    },
    "completion_tokens_details": {
      "reasoning_tokens": 0,
      "audio_tokens": 0,
      "accepted_prediction_tokens": 0,
      "rejected_prediction_tokens": 0
    }
  },
  "system_fingerprint": "fp_ee1d74bde0"
}

修改于 2025-06-11 08:25:18

结构化输出

分析图片