راهنمای ادغام
احراز هویت، جستجو و خواندن نتایج.
1. احراز هویت
از سرور خود با api-key و هدر Content-Type: application/json تماس بگیرید. کلید خود را خصوصی نگه دارید
کلیدهای API را باز کنید2. درخواست پارامترها
درخواست ها فقط از پرس و جو، شمارش و search_lang پشتیبانی می کنند. query یک سوال یا کلمات کلیدی به زبان طبیعی را می پذیرد.
| میدان | نوع | مورد نیاز | توضیحات |
|---|---|---|---|
| query | string | بله | یک سوال جستجو یا کلمات کلیدی نباید خالی باشه |
| count | integer | خیر | تعداد نتایج مورد نظر برای استفاده از پیشفرض سرویس، 0 را حذف یا پاس کنید. |
| search_lang | string | خیر | زبان جستجو، به عنوان مثال zh-hans. این سرویس zh را به zh-hans عادی می کند. برای لیست پشتیبانی شده روی این ردیف کلیک کنید. |
3. جستجو را API صدا کنید
https://api.starsg.ai/api/product/websearch/searchYOUR_API_KEY را جایگزین کنید و پرس و جو را روی متن جستجوی خود تنظیم کنید. شمارش و search_lang اختیاری هستند.
curl -X POST 'https://api.starsg.ai/api/product/websearch/search' \
-H 'api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"query": "北京今天的天气",
"count": 5,
"search_lang": "zh-hans"
}'ارسال یک شی JSON به طور مستقیم، بدون پوشش بدن یا /v1. اضافی
4. نتیجه را بخوانید
ابتدا موفقیت را بررسی کنید در مورد موفقیت، data.references و data.data را بخوانید. در صورت شکست، errorCode و errorMsg را بررسی کنید. محتوای وب زیر گویا است.
{
"success": true,
"data": {
"references": [
{
"website": "example.com",
"logo": "https://example.com/favicon.ico",
"title": "نمونه اخبار خانه هوشمند",
"url": "https://example.com/article",
"summary": "خلاصه نتایج جستجو در اینجا قرار می گیرد.",
"published": "",
"extra": {}
}
],
"data": [
"خلاصه نتایج جستجو در اینجا قرار می گیرد."
]
},
"errorCode": null,
"errorMsg": null
}data.references | مراجع وب با عنوان، پیوند و خلاصه. |
data.data | فهرست متن نتیجه، تو در تو در داخل شی داده بیرونی. |
references[].website / logo | نام وب سایت یا دامنه و آرم URL. |
references[].title / url / summary | عنوان نتیجه، صفحه اصلی URL و خلاصه. |
references[].published / extra | تاریخ انتشار و اطلاعات اضافی ممکنه خالی باشه |
success=true با ارجاعات خالی و آرایه های داده به این معنی است که هیچ نتیجه معتبری پیدا نشد. کلمات کلیدی مختلف یا یک زبان جستجوی متفاوت را امتحان کنید. آن را به عنوان یک شکست API تلقی نکنید.
{
"success": false,
"data": null,
"errorCode": "PARAM_INVALID",
"errorMsg": "query is required"
}خطاهای رایج و مراحل بعدی
PARAM_INVALID | JSON و پرس و جو را بررسی کنید. قبل از تلاش مجدد، پارامترها را تصحیح کنید. |
SEARCH_FAILED | جستجو شکست خورد. بعداً با محدودیت تلاش دوباره امتحان کنید. برای خرابی های مداوم، زمان تماس و درخواست شناسه برای پشتیبانی را ذخیره کنید. |