Responses API en function_call_output
Op deze pagina
De Responses API: het nieuwe eindpunt
De Responses API is het nieuwe primaire eindpunt van xAI, onderscheiden van het OpenAI-compatibele Chat Completions-eindpunt. Het introduceert een ander formaat voor het aanroepen van functies, waarbij het type function_call_output wordt gebruikt om tool-resultaten terug te geven.
Verschillen met Chat Completions
Het Chat Completions-eindpunt (OpenAI-compatibel) gebruikt berichten met de rol tool om resultaten terug te geven. De Responses API hanteert een ander formaat, gestructureerd rond gebeurtenistypen.
Chat Completions (verouderd formaat)
# Geef het resultaat terug via een bericht met de rol "tool"
messages.append({
"role": "tool",
"tool_call_id": "call_abc123",
"content": {temp: 22, city: Paris}
})
Responses API (nieuw formaat)
# Geef het resultaat terug via een function_call_output-object
{
"type": "function_call_output",
"call_id": "call_abc123",
"output": {temp: 22, city: Paris}
}
Belangrijkste verschillen:
type: "function_call_output"vervangtrole: "tool"call_idvervangttool_call_idoutputvervangtcontent
De Responses API gebruiken met de OpenAI SDK
U kunt de OpenAI SDK gebruiken om de Responses API van xAI aan te roepen:
from openai import OpenAI
client = OpenAI(
api_key="votre-cle-api",
base_url="https://api.x.ai/v1"
)
# Maak een respons met tools
response = client.responses.create(
model="grok-4.5",
input="What's the weather like in Paris?",
tools=[{
"type": "function",
"name": "get_weather",
"description": "Get the weather for a city",
"parameters": {
"type": "object",
"properties": {
"city": {"type": "string"}
},
"required": ["city"]
}
}]
)
Merk op dat de Responses API input gebruikt in plaats van messages, en dat de structuur van de tools licht afwijkt (geen genest function-object).
De respons verwerken
De respons van de Responses API bevat een output-array met gebeurtenissen:
for item in response.output:
if item.type == "function_call":
print(f"Function: {item.name}")
print(f"Arguments: {item.arguments}")
print(f"Call ID: {item.call_id}")
# Voer de functie uit
result = get_weather(city="Paris")
# Ga verder met het gesprek met het resultaat
follow_up = client.responses.create(
model="grok-4.5",
input=[
{"type": "function_call_output",
"call_id": item.call_id,
"output": json.dumps(result)}
],
tools=tools,
previous_response_id=response.id
)
Het veld previous_response_id
De Responses API introduceert een mechanisme voor het ketenen van gesprekken via previous_response_id. In plaats van de volledige berichtengeschiedenis opnieuw te verzenden, verwijst u eenvoudigweg naar de vorige respons:
# Eerste verzoek
response1 = client.responses.create(
model="grok-4.5",
input="Look up the weather in Paris"
)
# Tweede verzoek (geketend)
response2 = client.responses.create(
model="grok-4.5",
input=[{
"type": "function_call_output",
"call_id": response1.output[0].call_id,
"output": {temp: 22}
}],
previous_response_id=response1.id
)
Dit vereenvoudigt contextbeheer en verkleint de grootte van de verzoeken.
Berichtopslag aan serverzijde
Met store_messages=True slaat xAI berichten op hun servers op:
response = client.responses.create(
model="grok-4.5",
input="User question",
tools=tools,
store_messages=True
)
In combinatie met previous_response_id kunt u hiermee lange gesprekken onderhouden zonder bij elk verzoek de volledige geschiedenis opnieuw te verzenden.
Wanneer gebruikt u de Responses API?
Voor een nieuw project dat specifiek is gebouwd op xAI, is de Responses API de standaardkeuze, om verschillende cumulatieve redenen. Innovaties komen hier als eerste binnen; nieuwe functies worden toegevoegd aan de Responses API voordat ze ergens anders beschikbaar zijn, soms zelfs exclusief. Bepaalde ingebouwde servertools zijn alleen via dit kanaal beschikbaar. En voor lange gesprekken is ketenen via previous_response_id structureel efficiënter dan het bij elke beurt opnieuw verzenden van de volledige geschiedenis: er worden minder tokens overgedragen en u heeft minder code nodig voor statusbeheer aan uw kant.
Chat Completions behoudt twee sterke gebruiksscenario’s: bestaande code die is geschreven voor de OpenAI API, die direct werkt door alleen de base URL aan te passen, en projecten met meerdere providers waar portabiliteit voorrang heeft. In deze situaties weegt compatibiliteit zwaarder dan exclusieve functies.
Belangrijkste punten
- De Responses API gebruikt
function_call_outputin plaats van de roltool - Velden wijzigen:
call_idin plaats vantool_call_id,outputin plaats vancontent - Met
previous_response_idkunt u gesprekken ketenen zonder de geschiedenis opnieuw te verzenden store_messages=Trueschakelt opslag aan serverzijde in- De Responses API is het aanbevolen eindpunt voor nieuwe xAI-projecten
- Chat Completions blijft beschikbaar voor backward-compatibiliteit met OpenAI