معرفی

یک پلتفرم برای بارگذاری سند و پرسیدن سؤال از آن. پاسخ فقط از سندهای خودتان می‌آید و منبعش را نشان می‌دهد.

با API دانشیار سندهایتان را در یک فضای کاری بارگذاری می‌کنید و بعد از آن‌ها سؤال می‌پرسید. پاسخ فقط از همین سندها ساخته می‌شود و برای هر ادعا ارجاعی دارد به همان بخشی از سند که از آن آمده است. این همان موتور بازیابی‌ای است که کنسول دانشیار روی آن کار می‌کند و حالا برای محصول خودتان در دسترس است.

هر درخواست با کلید محرمانهٔ اپ شما (sk_…) احراز هویت می‌شود که یکی از اپ‌هایتان را مشخص می‌کند. در هیچ نشانی‌ای شناسهٔ اپ نمی‌بینید: کلید خودش اپ را معرفی می‌کند، پس مسیرها از فضای کاری شروع می‌شوند.

کلید محرمانهٔ شما به‌عنوان مالک اپ احراز هویت می‌شود و می‌تواند فضای کاری بسازد و حذف کند، سند بارگذاری و حذف کند، و هر فایل ذخیره‌شده را بخواند. این API را فقط از سمت سرور صدا بزنید — هرگز از مرورگر، اپ موبایل، یا هر جایی که کاربر بتواند کلید را ببیند. کلید عمومی ابزارک اینجا کار نمی‌کند.

چه چیزهایی می‌شود ساخت

این API عمداً کوچک است. با چهار مسیر می‌توانید:

به پرسش‌های پشتیبانی با محتوای مرکز راهنمای خودتان پاسخ بدهید، با لینک به مقالهٔ منبع.
به هر مشتری، بیمار یا دانشجو یک فضای کاری اختصاصی بدهید تا پاسخ‌ها هرگز بینشان جابه‌جا نشوند.
یک دستیار داخلی روی سندهای سیاست‌گذاری، قرارداد یا پژوهش بسازید که از حساب شما بیرون نمی‌رود.
به محصولی که همین حالا دارید یک جعبهٔ پرسش با پاسخ‌های مستند اضافه کنید، بدون این‌که خودتان بازیابی بنویسید.

بخش‌ها چطور کنار هم می‌نشینند

چهار شیء، در سلسله‌مراتبی دقیق:

اپ — یکپارچه‌سازی شما. دو کلید دارد — یک کلید محرمانه برای این API و یک کلید عمومی برای ابزارک — و همهٔ فضاهای کاری زیرش را در اختیار دارد. اپ‌ها را در کنسول می‌سازید، نه از طریق این API.
فضای کاری — مجموعه‌ای از سندها که با هم پاسخ می‌دهند. این واحد جداسازی است — پرسشی که در یک فضای کاری پرسیده می‌شود هرگز نمی‌تواند از فضای دیگری بازیابی کند.
سند — یک فایل بارگذاری‌شده. پیش از آن‌که بشود از آن پاسخ گرفت، از خط پردازشی می‌گذرد که متنش را استخراج، تکه‌تکه و بردارسازی می‌کند.
گفت‌وگو — یک پرسش روی یک فضای کاری. سرور نزدیک‌ترین بخش‌ها را از سندهای پردازش شده همان فضا بازیابی می‌کند، از رویشان پاسخ می‌دهد و ارجاع‌ها را برمی‌گرداند.

ساختار فضاهای کاری مهم‌ترین تصمیم طراحی‌ای است که با این API می‌گیرید — یکی به‌ازای هر مشتری، هر تیم، یا هر موضوع. پیش از آن‌که تصمیم بگیرید، صفحهٔ مفاهیم را بخوانید.

نشانی پایه

همهٔ مسیرهای این مرجع نسبت به همین نشانی پایه‌اند. روی همان میزبانی است که کنسول با آن حرف می‌زند، فقط در یک فضای نام نسخه‌دار جدا:

https://api.daneshyar.info/api/v1

مسیرها اسلش پایانی دارند. سرور شکل بدون اسلش را تغییر مسیر می‌دهد، و این کار POST را به GET تبدیل می‌کند و بدنهٔ درخواستتان بی‌سروصدا از دست می‌رود — پس همیشه اسلش را بگذارید.

در این مسیرها هیچ شناسهٔ اپی نمی‌بینید. اگر دارید کدی را از API خود کنسول منتقل می‌کنید، تفاوت اصلی همین است: کلید محرمانه اپ را مشخص می‌کند، پس /v1/workspaces/ از پیش یعنی «فضاهای کاری اپی که این کلید به آن تعلق دارد».

قدم بعدی

شروع سریعبا چهار درخواست، یک سند بارگذاری کنید و اولین پاسخ ارجاع‌دار را بگیرید.احراز هویتیک هدر روی هر درخواست، و این‌که اگر اشتباه باشد چه می‌شود.اپ، فضای کاری، سندسه شیئی که بقیهٔ چیزها رویشان ساخته شده‌اند.گفت‌وگوپرسشی بفرستید و پاسخی بگیرید که بر سندهای همان فضای کاری تکیه دارد.ابزارک سایتبا یک تگ اسکریپت، گفت‌وگو را به سایتتان اضافه کنید. فقط از روی اسناد یک فضای کاری پاسخ می‌دهد.امنیتهر کدام از دو کلید شما کجا می‌تواند باشد، چه چیزی از آن محافظت می‌کند، و چک‌لیست پیش از راه‌اندازی.

یک OpenAPI schema هم به‌صورت خودکار روی /api/v1/schema/ تولید می‌شود، با Swagger UI روی /api/v1/docs/. آن مرجع نهایی نوع فیلدهاست؛ این سایت جایی است که استدلال پشت آن‌ها را می‌خوانید.