ایجاد یک پاسخ متنی
از API پاسخهای ShareAI برای تولید متن بدون حالت، تاریخچه مکالمه صریح و رویدادهای جریان پاسخها استفاده کنید.
در این صفحه
https://api.shareai.now/api/v1/responsesتولید یک پاسخ متنی از یک درخواست یا مکالمه.
- URL پایه
https://api.shareai.now- احراز هویت
- کلید API Bearer یا توکن دسترسی OAuth تأییدشده
این API را زمانی انتخاب کنید که برنامه شما از فرمت پیام متنی پاسخها استفاده میکند. مکالمه را در هر درخواست ارائه دهید؛ پاسخها برای بازیابی بعدی ذخیره نمیشوند.
ارسال یک درخواست#
cURL
curl --fail-with-body --request POST \
"https://api.shareai.now/api/v1/responses" \
-H "Authorization: Bearer $SHAREAI_API_KEY" \
-H "Content-Type: application/json" \
--data '{
"model": "YOUR_CHAT_MODEL",
"input": "Explain semantic search in two sentences.",
"instructions": "Use plain language.",
"store": false,
"stream": false
}'
Python
import json
import os
import urllib.request
headers = {"Authorization": "Bearer " + os.environ["SHAREAI_API_KEY"]}
headers["Content-Type"] = "application/json"
payload = {'model': 'YOUR_CHAT_MODEL', 'input': 'Explain semantic search in two sentences.', 'instructions': 'Use plain language.', 'store': False, 'stream': False}
data = json.dumps(payload).encode()
request = urllib.request.Request('https://api.shareai.now/api/v1/responses', data=data, headers=headers, method='POST')
with urllib.request.urlopen(request, timeout=60) as response:
print(json.load(response))
TypeScript
const url = "https://api.shareai.now/api/v1/responses";
const headers: Record = {
Authorization: `Bearer ${process.env.SHAREAI_API_KEY}`,
};
headers["Content-Type"] = "application/json";
const payload = {
"model": "YOUR_CHAT_MODEL",
"input": "Explain semantic search in two sentences.",
"instructions": "Use plain language.",
"store": false,
"stream": false
};
const response = await fetch(url, { method: "POST", headers, body: JSON.stringify(payload) });
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
console.log(await response.json());
فیلدهای درخواست#
| فیلد | ارزش |
|---|---|
model | یک مدل چت موجود که توسط اعتبارنامه شما مجاز باشد. |
input | یک رشته غیرخالی، یا تا 256 پیام متنی. |
instructions | دستورالعملهای سیستمی اختیاری که به مکالمه اضافه میشوند. |
store | false؛ ذخیره پاسخها پشتیبانی نمیشود. |
stream | false برای JSON یا true برای رویدادهای SSE پاسخها. |
ادامه مکالمه#
ارسال پیامهای قبلی در input همراه با پیام بعدی کاربر. نقشهای پشتیبانیشده عبارتند از user, assistant, system و developer. دستورالعملهای توسعهدهنده از نقش سیستم بهصورت داخلی استفاده میکنند. محتوای پیام میتواند متن یا input_text/output_text بخشها باشد.
JSON
{
"model": "YOUR_CHAT_MODEL",
"input": [
{
"role": "user",
"content": "What is semantic search?"
},
{
"role": "assistant",
"content": "It finds results by meaning rather than exact words."
},
{
"role": "user",
"content": "Give one example."
}
],
"store": false
}
خواندن نتیجه#
پاسخ JSON یک response شیء است. متن دستیار را از output[].content[] ورودیها با نوع output_text. بخوانید. وضعیت پاسخ را بررسی کنید: completed یک پاسخ کامل است؛ incomplete میتواند نشاندهنده محدودیت توکن باشد. عمومی usage در حال حاضر null است؛ از استفاده کنسول برای بررسی استفاده پردازششده استفاده کنید.
یک پاسخ را جریان دهید#
تنظیم کنید stream: true و تجزیه SSE. رویدادها شامل response.created, response.output_text.delta و یک وضعیت پایانی response.completed, response.incomplete یا response.failed. هستند. دلتاهای متن را به ترتیب اضافه کنید و وضعیت پایانی را بهطور صریح مدیریت کنید.
زیرمجموعه پشتیبانیشده#
این نقطه پایانی از تولید متن پشتیبانی میکند. پاسخهای ذخیرهشده، previous_response_id، بازیابی/حذف، ابزارها، ورودی تصویر، درخواستهای پسزمینه و تنظیمات تولید مانند temperature پشتیبانی نمیشوند و رد میشوند. برای تنظیمات تولید مبتنی بر پیام که توسط Chat Completions پشتیبانی میشوند، از تکمیلهای چت.
از یک توکن دسترسی OAuth استفاده کنید#
کلید API را در هدر Authorization با یک توکن دسترسی OAuth تایید شده جایگزین کنید. surcharge دامنه و طرح استفاده پذیرفته شده برای استنتاج تأمینشده توسط حساب مورد نیاز است. دامنههای فقط هویت مجوز هزینه را صادر نمیکنند. مشاهده کنید دامنهها و مجوزها.
آخرین بهروزرسانی سپتامبر 15, 2026