From f6055b0ec70ad00f85e375b16e950f90ce4195ce Mon Sep 17 00:00:00 2001 From: Ayub Kokabi Date: Sat, 27 Jan 2024 16:12:46 +0330 Subject: [PATCH] some minor edit in replai docs --- apib/replai.apib | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/apib/replai.apib b/apib/replai.apib index 7903a9b..0352ae0 100644 --- a/apib/replai.apib +++ b/apib/replai.apib @@ -3,15 +3,15 @@ FORMAT: 1A HOST: https://replai.roshan-ai.ir # ریپلای -ریپلای یک دستیار گفتگوی هوشمند است. این ابزار در نقش یک نیروی پشتیبانیِ همیشه آنلاین، پیام‌های ارسالی کاربران را در هر ساعت از شبانه‌روز می‌گیرد و بعد از درک مفهوم پیام، از میان پاسخ‌های از پیش آماده شده، پاسخ مناسبی را برای کاربر ارسال یا تولید می‌کند. در محیط دموی این پروژه کاربر می‌تواند فضای تست اختصاصی خود را داشته باشد، اطلاعات آن را شخصی‌سازی کند و این فضا را از طریق واسط گرافیکی یا API ارزیابی کند. -برای ارزیابی فضا در محیط کاربری گرافیکی بایستی نام کاربر و گذرواژه و برای ارزیابی از طریق API بایستی کلید اتصال به آن را از تیم فروشِ روشن دریافت کنید. +ریپلای یک دستیار گفتگوی هوشمند است. این ابزار در نقش یک نیروی پشتیبانِ همیشه آنلاین، پیام‌های ارسالی کاربران را در هر ساعت از شبانه‌روز می‌گیرد و بعد از درک مفهوم پیام، از میان پاسخ‌های از پیش آماده شده، پاسخ مناسبی را برای کاربر ارسال یا تولید می‌کند. در محیط دموی این پروژه کاربر می‌تواند فضای تست اختصاصی خود را داشته باشد، اطلاعات آن را شخصی‌سازی کند و این فضا را از طریق واسط گرافیکی یا API ارزیابی کند. +برای ارزیابی فضا در محیط کاربری گرافیکی بایستی نام کاربری و گذرواژه و برای ارزیابی از طریق API بایستی کلید اتصال به آن را از تیم فروشِ روشن دریافت کنید. ## آشنایی با اصطلاحات برای کار با ریپلای ابتدا لازم است با اصطلاحات مرتبط با این ابزار آشنا شوید. در این بخش، این اصطلاحات معرفی شده است. ### فضای کار (Workspace) -فضاهای کار، محیط تست نسخه‌های مختلف ابزار ما هستند که به شیوه‌های مختلفی توسعه پیدا کرده‌اند یا داده‌های مختلفی برای پاسخگویی به پرسش‌ها در نظر می‌گیرند.در محیط کاربری گرافیکی به شما دسترسی یک یا چند فضای کار داده شده که قابل مشاهده و تغییر است و در API از طریق واسط مخصوص می‌توانید اطلاعات فضاهای کاری که دسترسی دارید را دریافت کنید. +فضاهای کار، محیط تست نسخه‌های مختلف ابزار ما هستند که به شیوه‌های مختلفی توسعه پیدا کرده‌اند یا داده‌های مختلفی برای پاسخگویی به پرسش‌ها در نظر می‌گیرند. در محیط کاربری گرافیکی به شما دسترسی یک یا چند فضای کار داده شده که قابل مشاهده و تغییر است و در API از طریق واسط مخصوص می‌توانید اطلاعات فضاهای کاری که دسترسی دارید را دریافت کنید. ### گفتگو (Chat) @@ -19,10 +19,10 @@ HOST: https://replai.roshan-ai.ir ### پیام (Message) -پیام‌ها، متن‌های ارسالی از سوی کاربر هستند که ریپلای برای هر کدام از آن‌ها یک پاسخ تولید می‌کند. پاسخ به یک پیام جز مشخصات همان پیام است و برای ذخیرهٔ پاسخ، یک پیام جدید تولید نمی‌شود. +پیام‌ها، متن‌های ارسالی از سوی کاربر هستند که ریپلای برای هر کدام از آن‌ها یک پاسخ تولید می‌کند. پاسخ به یک پیام، جزو مشخصات همان پیام است و برای ذخیرهٔ پاسخ، یک پیام جدید تولید نمی‌شود. ## فهرست فضاهای کار موجود [/api/workspaces] -فهرست فضاهای کاری منتصب به کاربر جاری را برمی‌گرداند..در پاسخ برگشتی، `id`بیانگر شناسهٔ فضای کاری است، `title` عنوان فضای کاری، `version` نسخه فضای کاری، `texts` نمونه پیام‌های ارسالی برای گفتگو و `icon` تصاویر پروفایل فضای کاری است. +فهرست فضاهای کاری منتصب به کاربر جاری را برمی‌گرداند..در پاسخ برگشتی، `id` بیانگر شناسهٔ فضای کاری است، `title` عنوان فضای کاری، `version` نسخه فضای کاری، `texts` نمونه پیام‌های ارسالی برای گفتگو و `icon` تصویر پروفایل فضای کاری است. ### مثال [GET] + Request (application/json) @@ -42,7 +42,7 @@ HOST: https://replai.roshan-ai.ir ] ## فهرست گفتگوهای فضای کار [/api/{workspaces_id}/chats] -فهرست گفتگوهای یک فضای کاری مشخص را برمی‌گرداند..در پاسخ برگشتی، `date`بیانگر تاریخ شروع گفتگو است، `chats` لیست گفتگوهای یک تاریخ خاص، `id` شناسه گفتگو و `title` عنوان گفتگو است. مقدار فیلد title به صورت خودکار توسط سامانه تولید می‌شود. +فهرست گفتگوهای یک فضای کاری مشخص را برمی‌گرداند..در پاسخ برگشتی، `date`بیانگر تاریخ شروع گفتگو است، `chats` لیست گفتگوها در این تاریخ، `id` شناسه گفتگو و `title` عنوان گفتگو است. مقدار فیلد title به صورت خودکار توسط سامانه تولید می‌شود. + Parameters + workspaces_id: (required, number) - شناسهٔ فضای کاری‌ای که می‌خواهید فهرست گفتگوهای آن دریافت کنید. @@ -102,7 +102,7 @@ HOST: https://replai.roshan-ai.ir + Parameters + chat_id: (required, number) - شناسهٔ گفتگویی که می‌خواهید فهرست پیام‌های آن را دریافت کنید. -### نمونه [GET] +### مثال [GET] + Request (application/json) + Headers Authorization: Token TOKEN_KEY @@ -132,7 +132,7 @@ HOST: https://replai.roshan-ai.ir + Parameters + chat_id: (required, number) - شناسهٔ گفتگویی که می‌خواهید یک پیام جدید در آن ایجاد کنید. -### نمونه [POST] +### مثال [POST] + Request (application/json) + Headers Authorization: Token TOKEN_KEY