Function Calling

Function calling permite que um modelo escolha chamadas de ferramentas estruturadas que sua aplicação pode executar. O próprio modelo não executa a função. Ele retorna o nome da função e os argumentos, seu código executa a função e você envia o resultado de volta ao modelo. Use function calling quando o modelo precisar de dados em tempo real, ações da aplicação, consultas a bancos de dados ou cálculos determinísticos.

Definição Básica de Ferramenta

Defina ferramentas com o array tools compatível com OpenAI:

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["VENICE_API_KEY"],
    base_url="https://api.venice.ai/api/v1",
)

tools = [
    {
        "type": "function",
        "function": {
            "name": "get_weather",
            "description": "Get the current weather in a location",
            "parameters": {
                "type": "object",
                "properties": {
                    "location": {
                        "type": "string",
                        "description": "City and state, such as San Francisco, CA",
                    }
                },
                "required": ["location"],
            },
        },
    }
]

response = client.chat.completions.create(
    model="zai-org-glm-5",
    messages=[{"role": "user", "content": "What is the weather in San Francisco?"}],
    tools=tools,
)

print(response.choices[0].message.tool_calls)

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.VENICE_API_KEY,
  baseURL: "https://api.venice.ai/api/v1",
});

const tools = [
  {
    type: "function",
    function: {
      name: "get_weather",
      description: "Get the current weather in a location",
      parameters: {
        type: "object",
        properties: {
          location: {
            type: "string",
            description: "City and state, such as San Francisco, CA",
          },
        },
        required: ["location"],
      },
    },
  },
];

const response = await client.chat.completions.create({
  model: "zai-org-glm-5",
  messages: [{ role: "user", content: "What is the weather in San Francisco?" }],
  tools,
});

console.log(response.choices[0].message.tool_calls);

curl https://api.venice.ai/api/v1/chat/completions \
  -H "Authorization: Bearer $VENICE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "zai-org-glm-5",
    "messages": [
      {"role": "user", "content": "What is the weather in San Francisco?"}
    ],
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_weather",
          "description": "Get the current weather in a location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "City and state, such as San Francisco, CA"
              }
            },
            "required": ["location"]
          }
        }
      }
    ]
  }'

Executar a Ferramenta

Quando o modelo escolhe uma ferramenta, inspecione message.tool_calls, faça o parse dos argumentos, execute a função da sua aplicação e envie o resultado de volta como uma mensagem tool.

Python

import json

message = response.choices[0].message
tool_call = message.tool_calls[0]
arguments = json.loads(tool_call.function.arguments)

weather = get_weather(arguments["location"])

follow_up = client.chat.completions.create(
    model="zai-org-glm-5",
    messages=[
        {"role": "user", "content": "What is the weather in San Francisco?"},
        message.model_dump(),
        {
            "role": "tool",
            "tool_call_id": tool_call.id,
            "content": json.dumps(weather),
        },
    ],
    tools=tools,
)

print(follow_up.choices[0].message.content)

Escolha um Modelo

O suporte a function calling é específico de cada modelo. Use a página Modelos de Texto ou a API de Modelos para encontrar modelos com supportsFunctionCalling.

Trate os argumentos das ferramentas como entrada não confiável. Valide os argumentos antes de usá-los em consultas a bancos de dados, comandos shell, pagamentos ou outras operações com efeitos colaterais.

Dicas de Design

Mantenha nomes e descrições de ferramentas curtos e literais.
Use JSON Schema para facilitar a produção de argumentos válidos pelo modelo.
Prefira ferramentas específicas com entradas claras a uma única ferramenta ampla com muitos comportamentos opcionais.
Retorne resultados concisos das ferramentas para que a resposta final tenha contexto suficiente sem desperdiçar tokens.

Documentação

Primeiros passos

Texto e chat

Imagem, vídeo e áudio

Agentes e integrações

Ferramentas de código

Ferramentas para agentes

SDKs e frameworks

Definição Básica de Ferramenta

Executar a Ferramenta

Escolha um Modelo

Dicas de Design

Recursos Relacionados

​Definição Básica de Ferramenta

​Executar a Ferramenta

​Escolha um Modelo

​Dicas de Design

​Recursos Relacionados

Definição Básica de Ferramenta

Executar a Ferramenta

Escolha um Modelo

Dicas de Design

Recursos Relacionados