मुख्य सामग्री पर जाएं
POST
जवाब बनाएँ

सर्वर टूल का उपयोग करें

tools में अपने function टूल के साथ एक phaseo: टूल जोड़ें, और जब मॉडल उसे कॉल करता है तो Phaseo उसे चलाता है। /v1/responses हर सर्वर टूल स्वीकार करता है, जिसमें phaseo:apply_patch भी शामिल है, जिसे सिर्फ़ यही एंडपॉइंट सपोर्ट करता है; सर्वर टूल गाइड में उनकी सूची है।
हर सर्वर टूल कॉल usage.server_tool_use में गिनी जाती है: पुराना gateway:datetime टाइप अब भी काम करता है। stream: true के साथ, Phaseo टूल टर्न खुद चलाता है, फिर आगे का उत्तर आपको एक ही स्ट्रीम में भेजता है।

टूल लूप में रीज़निंग

OpenAI, Azure OpenAI और xAI पर, Phaseo Responses अनुरोध अपस्ट्रीम में store: false के साथ भेजता है, इसलिए टूल लूप के चरणों के बीच मॉडल की रीज़निंग सिर्फ़ reasoning आउटपुट items के ज़रिए जारी रहती है। हर reasoning item में id, summary और content होते हैं। जब प्रदाता रीज़निंग स्थिति लौटाता है, तो item में encrypted_content भी होता है, जिसमें इनमें से एक होता है:
  • OpenAI, Azure OpenAI और xAI की encrypted reasoning। रीज़निंग मॉडल के लिए Phaseo इसे include: ["reasoning.encrypted_content"] के साथ मांगता है।
  • Claude thinking signatures और redacted thinking।
  • Gemini thought signatures, जिनमें एक अलग reasoning item भी शामिल है जो उस function call के ठीक पहले रखा जाता है जिससे signature जुड़ा है।
  • वह प्रयास लेवल जिस पर Claude का जवाब चला, आउटपुट के आखिरी reasoning item में, जिसमें कोई टेक्स्ट नहीं होता।
स्ट्रीमिंग प्रतिक्रियाएं यही items response.output_item.done और response.completed पर भेजती हैं।
हर आउटपुट item को हर अनुरोध पर input में बिना बदले वापस भेजें, सिर्फ़ टूल लूप में नहीं। reasoning items को कभी न हटाएं, न बदलें, न उनका क्रम बदलें, चाहे उनमें encrypted_content हो या न हो, बिना टेक्स्ट वाले items समेत।
encrypted_content अपारदर्शी है और उसे बनाने वाले प्रदाता और मॉडल को दर्ज करता है। Phaseo इसे सिर्फ़ उसी प्रदाता परिवार और मॉडल को भेजता है, इसलिए किसी दूसरे प्रदाता पर फ़ॉलबैक होने पर यह विफल होने के बजाय हटा दिया जाता है। इसके बिना, Claude टूल लूप के चरणों के बीच अपनी रीज़निंग खो देता है, और reasoning.effort बदलने पर Claude का प्रॉम्प्ट कैश दोबारा शुरू हो जाता है; बातचीत के बीच में रीज़निंग प्रयास बदलें देखें।

प्राधिकरण

Authorization
string
header
आवश्यक

Bearer टोकन से प्रमाणीकरण

बॉडी

application/json

null के रूप में भेजे गए किसी वैकल्पिक शीर्ष-स्तरीय फ़ील्ड को सेट न किया गया माना जाता है, ठीक वैसे ही जैसे उसे छोड़ दिया गया हो।

model
string
आवश्यक
input
आवश्यक
models
string[]

model के बाद आज़माए जाने वाले वैकल्पिक, क्रमबद्ध फ़ॉलबैक मॉडल। model आवश्यक है और हमेशा प्राथमिक मॉडल होता है। जब कोई प्रयास 429, 500, 502, 503 या 504 के साथ विफल होता है, तो अगली प्रविष्टि आज़माई जाती है; अन्य त्रुटियाँ बिना बदलाव के लौटाई जाती हैं। अधिकतम 25 मॉडल ID या प्रीसेट स्वीकार करता है; डुप्लिकेट और model के समान प्रविष्टियाँ अनदेखी की जाती हैं। हर प्रयास को अलग अनुरोध के रूप में सत्यापित, लॉग और बिल किया जाता है, और प्रतिक्रिया का model फ़ील्ड तथा रूटिंग ट्रेस उस मॉडल को दिखाते हैं जिसने अनुरोध पूरा किया। स्ट्रीमिंग अनुरोध केवल पहले बाइट से पहले फ़ॉलबैक करते हैं, और वीडियो तथा संगीत जॉब केवल सबमिशन के समय। Batch, realtime और council अनुरोध models को अस्वीकार करते हैं। डायनामिक रूट पर सेट किए गए फ़ॉलबैक को प्राथमिकता मिलती है, और phaseo/auto को models के साथ नहीं जोड़ा जा सकता।

Required array length: 1 - 25 elements
Minimum string length: 1
उदाहरण:
prompt
object

किसी प्रीसेट पर सहेजे गए प्रॉम्प्ट टेम्पलेट को भरता है। model छोड़ दें या उसे इसी संदर्भ पर सेट करें, और खाली बातचीत भेजें या वे टर्न भेजें जो टेम्पलेट के बाद जोड़ने हैं।

background
boolean
include
string[]
instructions
string
max_output_tokens
integer
आवश्यक सीमा: x >= 1
metadata
object
session_id
string

ऑब्ज़र्वेबिलिटी के लिए संबंधित अनुरोधों (जैसे बातचीत या एजेंट वर्कफ़्लो) को समूहित करने वाला विशिष्ट पहचानकर्ता।

Maximum string length: 256
parallel_tool_calls
boolean
previous_response_id
string

समर्थित नहीं। Phaseo जवाबों को संग्रहीत नहीं करता, इसलिए previous_response_id या conversation सेट करने वाले अनुरोध 400 unsupported_param लौटाते हैं। पूरी बातचीत input में भेजें।

reasoning
object
service_tier
enum<string> | null

समर्थित रूटिंग या मूल्य स्तर चुनता है। auto (या null) कोई खास स्तर नहीं माँगता और उसे ऐसे रूट और बिल किया जाता है मानो फ़ील्ड सेट ही न हो; scale को default, यानी मानक स्तर, माना जाता है।

उपलब्ध विकल्प:
standard,
default,
fast,
ultrafast,
priority,
flex,
batch,
auto,
scale
store
boolean
stream
boolean
temperature
number
आवश्यक सीमा: 0 <= x <= 2
text
object
plugins
object[]

इस अनुरोध के लिए गेटवे प्लगइन। web किसी भी मॉडल में वेब खोज और web-fetch पेज पढ़ना जोड़ता है; response-healing बिना स्ट्रीमिंग वाले स्ट्रक्चर्ड रिस्पॉन्स में खराब JSON ठीक करता है। वर्कस्पेस और प्रीसेट के डिफ़ॉल्ट इस सूची के साथ मिलाए जाते हैं। अज्ञात प्लगइन id पर 400 unknown_gateway_plugin लौटता है।

अनुरोध में phaseo:web_search सर्वर टूल जोड़ता है, ताकि कोई भी मॉडल वेब खोज सके। अनुरोध ठीक वैसे ही चलता है, और खोजें वैसे ही गिनी और बिल की जाती हैं, जैसे phaseo:web_search टूल के साथ। यदि अनुरोध में पहले से वेब खोज टूल है, तो प्लगइन कुछ नहीं जोड़ता। अन्य विकल्पों को अनदेखा किया जाता है।

tool_choice

टूल चयन रणनीति। Phaseo सर्वर-टूल प्रकार स्वीकार किए जाते हैं और upstream फ़ंक्शन/टूल लक्ष्यों में बदले जाते हैं। allowed_tools ऑब्जेक्ट सभी टूल के साथ OpenAI को बिना बदलाव भेजा जाता है। अन्य प्रदाताओं को केवल अनुमत टूल और उसका मोड (auto या required) भेजा जाता है, या जब required ठीक एक टूल की अनुमति देता है तो उस टूल की अनिवार्य कॉल। यदि allowed_tools में ऐसा टूल है जिसे tools परिभाषित नहीं करता, तो केवल OpenAI अनुरोध पूरा कर सकता है; अन्यथा 400 त्रुटि लौटाई जाती है।

उपलब्ध विकल्प:
auto,
none,
required,
phaseo:datetime,
phaseo:web_search,
phaseo:web_fetch,
phaseo:subagent,
phaseo:fusion,
phaseo:search_models,
gateway:datetime,
gateway:web_search,
gateway:web_fetch
tools
object[]

मॉडल फ़ंक्शन कॉल और गेटवे सर्वर टूल के लिए टूल परिभाषाएँ। गेटवे के अंतर्निहित सर्वर टूल हैं gateway:datetime, gateway:web_search और gateway:web_fetch।

top_p
number
आवश्यक सीमा: 0 <= x <= 1
truncation
enum<string>
उपलब्ध विकल्प:
auto,
disabled
user
string
prompt_cache_key
string | null

संबंधित अनुरोधों को समूहित करता है, ताकि वे उसी प्रदाता पर रहें जिसके पास उनका प्रॉम्प्ट कैश है। Phaseo प्रदाता को आपके वर्कस्पेस और इस कुंजी का हैश भेजता है, कच्ची कुंजी कभी नहीं।

prompt_cache_retention
enum<string>

GPT-5.6 से पहले के OpenAI और Azure OpenAI मॉडलों के लिए प्रॉम्प्ट कैश प्रतिधारण। provider_options.openai.prompt_cache_retention पर प्राथमिकता पाता है।

उपलब्ध विकल्प:
in_memory,
24h
prompt_cache_options
object

GPT-5.6 और बाद के OpenAI और Azure OpenAI मॉडलों (ttl 30m, या OpenAI पर 12h) तथा DeepInfra (ttl 5m या 1h) के लिए प्रॉम्प्ट कैश मोड और TTL। अन्य प्रदाताओं के लिए हटा दिया जाता है।

cache_control
object

प्रॉम्प्ट कैश नियंत्रण। type ephemeral के साथ वैकल्पिक ttl 5m या 1h उपयोग करें। scope केवल शीर्ष-स्तरीय Claude कैश नीति पर लागू होता है। Amazon Bedrock और Google Vertex AI, Claude 3.7 Sonnet, 3.5 Sonnet और 3 Opus को केवल 5 मिनट के लिए कैश करते हैं; वहाँ ttl हटा दिया जाता है, और हटाया गया 1h X-Phaseo-Dropped-Params में cache_control.ttl के रूप में रिपोर्ट किया जाता है।

safety_identifier
string | null
modalities
enum<string>[]
उपलब्ध विकल्प:
text,
image,
audio
image_config
object
provider_options
object

वैकल्पिक प्रदाता-विशिष्ट विकल्प।

usage
boolean
meta
boolean
echo_upstream_request
boolean
debug
object

गेटवे डिबग नियंत्रण। ये फ़्लैग कभी भी प्रदाता को फ़ॉरवर्ड नहीं किए जाते।

provider
object

गेटवे चयन के लिए प्रदाता रूटिंग प्राथमिकताएँ।

प्रतिक्रिया

जवाब

id
string
object
string
created
integer
model
string
provider
string
provider_id
string
nativeResponseId
string | null
status
enum<string>
उपलब्ध विकल्प:
completed,
failed,
incomplete
finish_reason
string | null
meta
object
cost_nanos
number
cost_cents
integer
currency
string
pricing_lines
object[]
output
object[]
output_items
object[]
content
object[]
role
string
stop_reason
string
type
string
usage
object
अंतिम संशोधन 12 नवंबर 2026