شما ها
ChatCompletionRequest
modelآیدی یکی از مدلهای چت از GET /models.
گفتوگو تا این لحظه، از قدیمیترین پیام به جدیدترین.
max_tokensبیشترین تعداد توکنی که پاسخ میتواند مصرف کند، با احتساب reasoning. مقدار
پیشفرض 8,192 است، یا max_output_tokens مدل اگر کمتر باشد. مقدار بیشتر
از سقف مدل رد میشود. با نام max_completion_tokens هم پذیرفته میشود و
اگر هر دو فرستاده شوند، مقدار آن اولویت دارد.
max_completion_tokensهمان max_tokens.
temperaturetop_pحداکثر 4 stop sequence که مدل با رسیدن به هر کدام، تولید متن را متوقف میکند.
seedpresence_penaltyfrequency_penaltyیکی از none، auto، required یا یک فانکشن مشخص. فقط همراه با
tools مجاز است.
parallel_tool_callsفقط همراه با tools مجاز است.
reasoning_effortمیزان reasoning مدل پیش از پاسخ دادن. مدلهایی که همیشه فکر میکنند
none را نمیپذیرند (reasoning_can_be_disabled را ببینید). اگر این
فیلد را نفرستید، مقدار پیشفرض مدل به کار میرود.
streamفقط همراه با stream: true مجاز است.
userآیدیای برای کاربر نهایی شما. این آیدی پیش از رسیدن به پرووایدر مدل هش میشود و کمک میکند سوءاستفاده به همان کاربر نسبت داده شود، نه به کل حساب شما.
nفقط تولید یک پاسخ (choice) پشتیبانی میشود.
logprobsلگاریتم احتمالها (log probabilities) پشتیبانی نمیشود.
Message
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: role, content | |
| type = object · requires: role, content | |
| type = object · requires: role | |
| type = object · requires: role, tool_call_id, content |
rolerole developer مانند system در نظر گرفته میشود.
nameSystemMessage
rolerole developer مانند system در نظر گرفته میشود.
nameAssistantMessage
roleTextContent
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = string | |
| type = array |
ResponseFormat
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: type | |
| type = object · requires: type | |
| type = object · requires: type, json_schema |
typeChatCompletion
idobjectcreatedmodelsystem_fingerprintReplyMessage
rolecontentrefusalreasoning_contentreasoning خوانای مدل، اگر آن را در اختیار بگذارد.
بلوکهای opaque reasoning که میتوانید در درخواست بعدی دوباره بفرستید.
ChatCompletionChunk
idobjectcreatedmodelدر chunk پایانی که usage را دارد، خالی است.
system_fingerprintUsage
prompt_tokenscompletion_tokensتوکنهای خروجی، با احتساب reasoning.
total_tokenscost_creditsهزینه دقیق این درخواست بر حسب اعتبار.
ModelList
objectModel
idobjectcreatedowned_bynamecontext_lengthبیشترین تعداد توکن ورودی که مدل میپذیرد.
max_output_tokensبزرگترین مقدار max_tokens که این مدل میپذیرد.
input_modalitiesreasoning_can_be_disabledاینکه reasoning_effort مقدار none را میپذیرد یا نه.
supports_json_schemaاینکه response_format مقدار json_schema را میپذیرد یا نه.
supported_parametersnotesDecisionRequest
modelآیدی یک مدل تصمیم.
محتوایی که باید ارزیابی شود، به صورت string یا آبجکت یا آرایه JSON.
سؤالها با نامی که خودتان انتخاب میکنید، 1 تا 128 کاراکتر. هر پاسخ با همان نام برمیگردد.
تصویرها با string رفرنس که هر جا تصویر لازم است در state،
instructions یا criteria مینویسید. به هر asset باید دستکم یک
بار رفرنس داده شود.
userآیدیای برای کاربر نهایی شما. پیش از رسیدن به پرووایدر مدل هش میشود.
Guidance
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = string | |
| type = object | |
| type = array |
DecisionQuestion
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: type, instructions | |
| type = object · requires: type, instructions, criteria | |
| type = object · requires: type, instructions, criteria | |
| type = object · requires: type, instructions |
typeیک string ساده، یا آبجکت یا آرایه JSON از راهنمایی ساختاریافته.
اینکه چه چیزی پاسخ را بله و چه چیزی آن را خیر میکند.
NoulQuestion
typeیک string ساده، یا آبجکت یا آرایه JSON از راهنمایی ساختاریافته.
اینکه چه چیزی پاسخ را بله و چه چیزی آن را خیر میکند.
ChoiceQuestion
typeیک string ساده، یا آبجکت یا آرایه JSON از راهنمایی ساختاریافته.
هر گزینه، همراه با معنای آن.
ScoreQuestion
typeیک string ساده، یا آبجکت یا آرایه JSON از راهنمایی ساختاریافته.
سطحهای مقیاس، از پایینترین سطح.
BoxQuestion
typeیک string ساده، یا آبجکت یا آرایه JSON از راهنمایی ساختاریافته.
ImageAsset
formatdata_base64فایل به base64 استاندارد، بدون prefix data URL.
typeDecision
idmodelیک پاسخ برای هر سؤال، با نام همان سؤال.
DecisionAnswer
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: type, noul | |
| type = object · requires: type, choice | |
| type = object · requires: type, score | |
| type = object · requires: type, box |
typenoulاحتمال درست بودن گزاره، از 0 تا 1.
NoulAnswer
typenoulاحتمال درست بودن گزاره، از 0 تا 1.
ChoiceAnswer
typechoiceconfidenceScoreAnswer
typescoreسطح مورد انتظار، از 0 برای اولین سطح.
confidencelegendشماره هر سطح، همراه با معیار آن.