درخواست مشاوره

assistants

[vc_row el_id=”assistants”][vc_column][vc_column_text]

دستیاران (بتا)

دستیارهایی بسازید که بتوانند مدل‌ها را فراخوانی کرده و از ابزارها برای انجام وظایف استفاده کنند.

با API دستیارها شروع کنید.[/vc_column_text][/vc_column][/vc_row][vc_row][vc_column][vc_separator css=”.vc_custom_1741337159432{padding-top: 40px !important;padding-bottom: 20px !important;}”][/vc_column][/vc_row][vc_row el_id=”Threads”][vc_column][vc_column_text]

رشته ها (Threads) (بتا)

رشته‌هایی (Threads) ایجاد کنید که دستیارها (Assistant) بتوانند با آن‌ها تعامل داشته باشند.

راهنمای مرتبط: دستیارها[/vc_column_text][vc_separator css=”.vc_custom_1741337159432{padding-top: 40px !important;padding-bottom: 20px !important;}”][vc_row_inner el_id=”Create-thread”][vc_column_inner][vc_column_text]

ساخت رشته ها (Threads) (بتا)

post      https://rest2.payamak-panel.com/api/ai/assistant/threads/

یک رشته (Thread) بسازید.

بدنه درخواست

یک لیست از پیام ها (messages) که رشته با آن شروع شود.

↓ نمایش ویژگی‌ها
  • نقش  string الزامی

نقشی که پیام را ایجاد می‌کند. مقادیر مجاز شامل:

User: نشان می‌دهد که پیام توسط یک کاربر واقعی ارسال شده است و معمولاً برای پیام‌های تولیدشده توسط کاربر استفاده می‌شود.

Assistant: نشان می‌دهد که پیام توسط دستیار تولید شده است. از این مقدار برای افزودن پیام‌های دستیار به مکالمه استفاده کنید.

  •  محتوا string یا array الزامی
↓ انواع ممکن

محتوای متنی String
محتوای متنی پیام

آرایه‌ای از بخش‌های محتوا array
یک آرایه از بخش‌های محتوا با نوع مشخص، که هر بخش می‌تواند از نوع متن باشد یا تصاویر را با image_url یا image_file ارسال کند. انواع تصویر فقط در مدل‌های سازگار با Vision پشتیبانی می‌شوند.

↓ انواع ممکن

 _ فایل تصویر object
به یک فایل تصویر در محتوای پیام ارجاع می‌دهد.

↓ ویژگی ها

نوع string الزامی
همیشه image_file

فایل تصویر object الزامی

↓ ویژگی ها
  • شناسه فایل string الزامی
    شناسه فایل (File ID) تصویر در محتوای پیام. اگر نیاز دارید محتوای فایل را بعداً نمایش دهید هنگام آپلود فایل، مقدار "purpose="vision را تنظیم کنید.
  • جزئیات string اختیاری
    String اختیاری به‌طور پیش‌فرض روی auto تنظیم می‌شود. سطح جزئیات تصویر را در صورت تعیین توسط کاربر مشخص می‌کند. مقدار low از توکن‌های کمتری استفاده می‌کند، و می‌توانید با انتخاب مقدار high از وضوح بالاتر استفاده کنید.

 _ URL تصویر object
به یک URL تصویر در محتوای پیام ارجاع می‌دهد.

↓ ویژگی ها

نوع string الزامی
نوع بخش محتوا.

URL تصویر object الزامی

↓ ویژگی ها
  • URL (آدرس) string الزامی
    آدرس URL خارجی تصویر، که باید از انواع تصویر پشتیبانی‌شده باشد: jpeg، jpg، png، gif و webp.
  • جزئیات string اختیاری
    String اختیاری به‌طور پیش‌فرض روی auto تنظیم می‌شود. سطح جزئیات تصویر را مشخص می‌کند. مقدار low  از توکن‌های کمتری استفاده می‌کند، و می‌توانید با انتخاب مقدار high  وضوح بالاتر را فعال کنید. مقدار پیش‌فرض auto  است.

 _ متن (text)
محتوای متنی که بخشی از یک پیام است.

↓ ویژگی ها

نوع string الزامی
همیشه به صورت text

متن string الزامی
محتوای متنی که برای مدل ارسال می‌شود.

  • پیوست ها (attachments) آرایه یا مقدار null اختیاری

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

↓ ویژگی ها
  • شناسه فایل (File_Id) string اختیاری
    شناسه (ID) فایل برای پیوست شدن به پیام
  • ابزار (tools) array اختیاری
    ابزارهایی که باید این فایل به آنها اضافه شود.
↓ انواع قابل قبول
  • ابزار تفسیر کد (Code interpreter tool) object
↓ ویژگی ها
  • تایپ string الزامی
    نوع ابزاری که تعریف شده است: code_interpreter
  • ابزار جستجوی فایل (FileSearch tool) object
↓ ویژگی ها
  • تایپ string الزامی
    نوع ابزاری که تعریف شده است: file_search
  • فراداده (metadata) map اختیاری

مجموعه‌ای از ۱۶ جفت کلید-مقدار که می‌توان به یک شیء متصل کرد. این قابلیت برای ذخیره اطلاعات اضافی درباره شیء در یک قالب ساختاریافته و جستجوی اشیا از طریق API یا داشبورد مفید است.

کلیدها (keys) رشته‌هایی با حداکثر طول ۶۴ کاراکتر هستند. مقدارها (values) رشته‌هایی با حداکثر طول ۵۱۲ کاراکتر هستند.

مجموعه‌ای از منابع که برای ابزارهای دستیار در این رشته در دسترس قرار می‌گیرند. این منابع بسته به نوع ابزار متفاوت هستند.

↓ نمایش ویژگی‌ها
  • مفسر کد (code_interpreter) object اختیاری
↓ ویژگی ها
  • شناسه فایل (file_ids) Array اختیاری   مقدار پیش‌فرض:  [](آرایه خالی)

لیستی از شناسه‌های فایل (file IDs) که برای ابزار code_interpreter در دسترس قرار می‌گیرند. حداکثر ۲۰ فایل می‌تواند به این ابزار متصل شود.

  • جستجوی فایل (file_search)  اختیاری
↓ ویژگی ها
  • شناسه های ذخیره ساز برداری Array اختیاری

ذخیره‌ساز برداری متصل به این رشته  (thread). حداکثر یک ذخیره‌ساز برداری می‌تواند به این رشته متصل شود.

  • ذخیره سازهای برداری (vector_stores) Array اختیاری

یک ابزار کمکی برای ایجاد یک ذخیره‌ساز برداری (vector store) با file_ids  و اتصال آن به این رشته (thread).  حداکثر یک ذخیره‌ساز برداری می‌تواند به این رشته متصل شود.

↓ ویژگی ها
  • شناسه فایل (file_ids) Array اختیاری

فهرستی از شناسه‌های فایل برای افزودن به فروشگاه برداری. حداکثر می‌توان ۱۰,۰۰۰ فایل در یک فروشگاه برداری ذخیره کرد.

  • استراتژی تقسیم بندی (chunking_strategy) object اختیاری

استراتژی تکه‌بندی مورد استفاده برای بخش‌بندی فایل(ها). اگر تنظیم نشود، به‌صورت auto از استراتژی پیش‌فرض استفاده خواهد شد.

↓ ویژگی ها
  • استراتژی تقسیم بندی خودکار (Auto Chunking Strategy) object

استراتژی پیش‌فرض است. این استراتژی در حال حاضر از max_chunk_size_tokens  برابر با 800  و chunk_overlap_tokens برابر با 400 استفاده می‌کند.

↓ ویژگی ها
  • تایپ string الزامی

همیشه auto

  • استاتیک object الزامی
↓ ویژگی ها

 

  • حداکثر اندازه ی بخش بر حسب توکن (max_chunk_size_tokens) Integer الزامی

حداکثر تعداد توکن‌ها در هر بخش. مقدار پیش‌فرض 800 است. مقدار حداقل 100 و مقدار حداکثر 4096 می‌باشد.

  • تعداد توکن های همپوشانی بین بخش ها (chunk_overlap_tokens) Integer الزامی

تعداد توکن‌هایی که بین بخش‌ها همپوشانی دارند. مقدار پیش‌فرض 400 است. توجه داشته باشید که مقدار همپوشانی نباید بیشتر از نصف مقدار max_chunk_size_tokens باشد.

 
  • متا دیتا (metadata) اختیاری

مجموعه‌ای از ۱۶ جفت کلید-مقدار که می‌توان به یک شیء متصل کرد. این قابلیت برای ذخیره اطلاعات اضافی درباره شیء در یک قالب ساختاریافته و جستجوی اشیا از طریق API یا داشبورد مفید است.

کلیدها (keys) رشته‌هایی با حداکثر طول 64 کاراکتر هستند. مقدارها (values) رشته‌هایی با حداکثر طول 512 کاراکتر هستند.

یک شیء رشته (thread)[/vc_column_text][/vc_column_inner][/vc_row_inner][/vc_column][/vc_row][vc_row disable_element=”yes” el_id=”Messages”][vc_column][vc_column_text]

پیام ها (Messages)

پیام ها (Messages)
ایجاد پیام ها درون رشته ها (threads)
[/vc_column_text][vc_row_inner el_id=”Create-message”][vc_column_inner][vc_column_text]

1. ساخت پیام (Create message)

post     https://rest2.payamak-panel.com/api/ai/assistant/threads/{thread_id}/messages

یک رشته (Thread) بسازید.

 

بدنه درخواست

پیام ها

Array اختیاری
یک لیست از پیام ها (messages) که رشته با آن شروع شود.

 

ویژگی ها

نقش

String الزامی

نقشی که پیام را ایجاد می‌کند. مقادیر مجاز شامل:

محتوا

String یا Array الزامی

انواع ممکن

محتوای متنی

String

محتوای متنی پیام

آرایه‌ای از بخش‌های محتوا

Array

یک آرایه از بخش‌های محتوا با نوع مشخص، که هر بخش می‌تواند از نوع متن باشد یا تصاویر را با image_url یا image_file ارسال کند. انواع تصویر فقط در مدل‌های سازگار با Vision پشتیبانی می‌شوند.

 

انواع ممکن

فایل تصویر

Object
به یک فایل تصویر در محتوای پیام ارجاع می‌دهد.[/vc_column_text][/vc_column_inner][/vc_row_inner][/vc_column][/vc_row]