معرفی
یک REST API برای بارگذاری سند و گرفتن پاسخهایی که از دل همان سندها میآیند، همراه با ارجاع.
با API دانشیار میتوانید سند را در یک فضای کاری بارگذاری کنید و بعد پرسشهایی مطرح کنید که از دل همان سندها پاسخ میگیرند — همراه با ارجاعهایی که به همان بخشی برمیگردند که هر ادعا از آن آمده است. این همان موتور بازیابیای است که کنسول دانشیار روی آن کار میکند و حالا برای محصول خودتان در دسترس است.
هر درخواست با یک کلید API احراز هویت میشود که یکی از اپهای شما را مشخص میکند. در هیچ نشانیای شناسهٔ اپ نمیبینید: کلید خودش اپ را معرفی میکند، پس مسیرها از فضای کاری شروع میشوند.
چه چیزهایی میشود ساخت
این API عمداً کوچک است. با چهار مسیر میتوانید:
- به پرسشهای پشتیبانی از دل مرکز راهنمای خودتان پاسخ بدهید، با لینک به مقالهٔ منبع.
- به هر مشتری، بیمار یا دانشجو یک فضای کاری اختصاصی بدهید تا پاسخها هرگز بینشان جابهجا نشوند.
- یک دستیار داخلی روی سندهای سیاستگذاری، قرارداد یا پژوهش بسازید که از حساب شما بیرون نمیرود.
- به محصولی که همین حالا دارید یک جعبهٔ پرسش با پاسخهای مستند اضافه کنید، بدون اینکه خودتان بازیابی بنویسید.
بخشها چطور کنار هم مینشینند
چهار شیء، در سلسلهمراتبی دقیق:
- اپ — یکپارچهسازی شما. دقیقاً یک کلید API و همهٔ فضاهای کاری زیرش را در اختیار دارد. اپها را در کنسول میسازید، نه از طریق این API.
- فضای کاری — مجموعهای از سندها که با هم پاسخ میدهند. این واحد جداسازی است — پرسشی که در یک فضای کاری پرسیده میشود هرگز نمیتواند از فضای دیگری بازیابی کند.
- سند — یک فایل بارگذاریشده. پیش از آنکه بشود از آن پاسخ گرفت، از خط پردازشی میگذرد که متنش را استخراج، تکهتکه و بردارسازی میکند.
- گفتوگو — یک پرسش روی یک فضای کاری. سرور نزدیکترین بخشها را از سندهای پردازش شده همان فضا بازیابی میکند، از رویشان پاسخ میدهد و ارجاعها را برمیگرداند.
ساختار فضاهای کاری مهمترین تصمیم طراحیای است که با این API میگیرید — یکی بهازای هر مشتری، هر تیم، یا هر موضوع. پیش از آنکه تصمیم بگیرید، صفحهٔ مفاهیم را بخوانید.
نشانی پایه
همهٔ مسیرهای این مرجع نسبت به همین نشانی پایهاند. روی همان میزبانی است که کنسول با آن حرف میزند، فقط در یک فضای نام نسخهدار جدا:
https://api.daneshyar.info/api/v1مسیرها اسلش پایانی دارند. سرور شکل بدون اسلش را تغییر مسیر میدهد، و این کار POST را به GET تبدیل میکند و بدنهٔ درخواستتان بیسروصدا از دست میرود — پس همیشه اسلش را بگذارید.
/v1/workspaces/ از پیش یعنی «فضاهای کاری اپی که این کلید به آن تعلق دارد».قدم بعدی
یک OpenAPI schema هم بهصورت خودکار روی /api/v1/schema/ تولید میشود، با Swagger UI روی /api/v1/docs/. آن مرجع نهایی نوع فیلدهاست؛ این سایت جایی است که استدلال پشت آنها را میخوانید.