رفتن به محتوا
دانشیارمستندات
ورود
  • اپ، فضای کاری، سند
  • پردازش سند
  • گفت‌وگو و نشست‌ها
  • ارجاع‌ها
  • مهارت‌ها
  1. مستندات
  2. مفاهیم
  3. اپ، فضای کاری، سند

اپ، فضای کاری، سند

سه شیئی که بقیهٔ چیزها رویشان ساخته شده‌اند.

سه شیء، با تودرتویی دقیق. تقریباً هر پرسش طراحی با این API به این برمی‌گردد که دامنهٔ خودتان را چطور روی شیء میانی نگاشت می‌کنید.

اپ‌ها

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

وقتی واقعاً یکپارچه‌سازی‌های جدایی دارید که نباید اعتبارنامهٔ مشترک داشته باشند، بیش از یک اپ بسازید — مثلاً محیط staging، یا محصول دوم. هر چیزی درون یک اپ با یک کلید در دسترس است.

فضاهای کاری

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

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

سندها

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

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

انتخاب ساختار فضای کاری

سه ساختار تقریباً همهٔ یکپارچه‌سازی‌ها را پوشش می‌دهند. با این پرسش انتخاب کنید: چه کسی هرگز نباید سندهای چه کسی را ببیند؟

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

در این صفحه

  • اپ‌ها
  • فضاهای کاری
  • سندها
  • انتخاب ساختار فضای کاری

همهٔ نمونه‌های این مستندات روی API واقعی اجرا می‌شوند. اگر نمونه‌ای کار نکرد، به ما بگویید؛ آن یک باگ در مستندات است.

گفت‌وگو با ما