کتابخانه‌ی استاندارد · پایگاه داده

میلی‌سرچ `db/meilisearch`

کارخواه Meilisearch: نمایه، سند، جستجوی متنی، وجهی، ترکیبی و فدرال، تنظیمات، کارها و کلیدهای API.

واردسازی دیتابیس.میلیسرچ

در این صفحه

آموزش: جستجوی فیلم در یازده گام
۱. اتصال
۲. ساخت نمایه و افزودن سند
۳. جستجو
۴. فیلتر، مرتب‌سازی و شمارش وجه
۵. برجسته‌سازی، برش و صفحه‌بندی
۶. تنظیم ربط نتیجه‌ها
۷. جستجو در چند نمایه با هم
۸. جستجوی برداری و ترکیبی
۹. کلیدهای API و توکن مستاجر
۱۰. به‌روزرسانی و حذف سند
۱۱. کارها و شکست‌ها
بیشتر
گونه‌ها
پایاها و متغیرها
تابع‌ها

میلی‌سرچ یک موتور جستجوی سریع با تحمل غلط تایپی، فیلتر، وجه و جستجوی ترکیبی هوشمند است. این بسته مستقیم و با net.http با API آن کار می‌کند و همه‌ی آن را پوشش می‌دهد: نمایه‌ها، سندها به شکل JSON، NDJSON یا CSV، همه‌ی پارامترهای جستجو، جستجوی چندگانه و فدرال، جستجوی وجه، سندهای مشابه، همه‌ی تنظیمات نمایه، کارها و دسته‌ها، کلیدهای API و توکن مستاجر، وب‌هوک‌ها، قاعده‌های جستجوی پویا و فضاهای گفتگو. این صفحه با یک آموزش شروع می‌شود و مرجع کامل همه‌ی تابع‌ها و گونه‌ها پس از آن می‌آید.

آموزش: جستجوی فیلم در یازده گام

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

اول یک سرور راه بیندازید. با داکر یک فرمان کافی است؛ بدون داکر، فایل اجرایی meilisearch را از صفحه‌ی انتشارهای میلی‌سرچ بگیرید و با همان کلید اجرا کنید:

docker run -p 7700:7700 -e MEILI_MASTER_KEY=masterKey getmeili/meilisearch:v1.55.0

برنامه‌ها نشانی http://127.0.0.1:7700 و کلید اصلی masterKey را فرض می‌کنند. در محیط واقعی کلید اصلی بلند و تصادفی است و برنامه‌ها کلیدهای محدودتری می‌گیرند، همان‌طور که گام ۹ نشان می‌دهد.

۱. اتصال

جدید یک کارخواه می‌سازد: یک مقدار ساده با نشانی و کلید که نخ‌ها می‌توانند با هم به کار ببرند. با مهلت رونوشتی برمی‌گرداند که پس از چند میلی‌ثانیه از انتظار دست می‌کشد؛ بدون آن، درخواست هر قدر سرور طول بدهد صبر می‌کند. هر فراخوانی که ممکن است شکست بخورد یک خطا را به عنوان آخرین آرگومان می‌گیرد. موفق می‌گوید فراخوانی کار کرد یا نه و متن خطا خطا را در یک خط می‌نویسد.

meili-connect.salam

واردسازی دیتابیس.میلیسرچ

تابع ریشه:
    کارخواه := میلیسرچ.با مهلت(میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")، 5000)
    اگر وارونه میلیسرچ.سالم است(کارخواه):
        سرچاپ "میلی‌سرچ اجرا نیست در " + کارخواه.میزبان
        برگشت 1
    پایان
    ناپایا اشکال := میلیسرچ.خطا {}
    نسخه := میلیسرچ.دریافت نسخه(کارخواه، اشکال)
    سرچاپ "وصل شد به میلی‌سرچ " + نسخه.شماره نسخه

    میلیسرچ.دریافت نمایه(کارخواه، "no_such_index"، اشکال)
    اگر وارونه میلیسرچ.موفق(اشکال):
        سرچاپ میلیسرچ.متن خطا(اشکال)
    پایان
    برگشت 0
پایان

خروجیوصل شد به میلی‌سرچ 1.55.0 meilisearch 404 [index_not_found]: Index `no_such_index` not found.

خطا هر چه میلی‌سرچ فرستاده را نگه می‌دارد: وضعیت HTTP، کد برای تصمیم‌گیری در برنامه (این‌جا index_not_found)، پیام و پیوند مستندات آن. اگر اصلاً به سرور نرسیم، کد برابر communication_error است و اگر مهلت تمام شود timeout.

۲. ساخت نمایه و افزودن سند

نمایه مجموعه‌ای نام‌دار از سندهاست که هر کدام یک کلید اصلی یکتا دارند. سندها می‌توانند ساختارهای سلام باشند: افزودن سندهای نوع هر کدام را به JSON تبدیل می‌کند و نام فیلدهای فارسی ساختار همان نام فیلدهای سند می‌شوند. افزودن سندها متن JSON می‌گیرد و افزودن سندهای ان‌دی‌جیسون و افزودن سندهای سی‌اس‌وی آن قالب‌ها را.

meili-index.salam

واردسازی دیتابیس.میلیسرچ

ساختار فیلم:
    همگانی شناسه: صحیح = 0
    همگانی عنوان: رشته = ""
    همگانی ژانر: رشته = ""
    همگانی سال: صحیح = 0
    همگانی خلاصه: رشته = ""
پایان

تابع اثر(شناسه: صحیح، عنوان: رشته، ژانر: رشته، سال: صحیح، خلاصه: رشته): فیلم:
    برگشت فیلم { شناسه = شناسه، عنوان = عنوان، ژانر = ژانر، سال = سال، خلاصه = خلاصه }
پایان

تابع ریشه:
    کارخواه := میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")
    ناپایا اشکال := میلیسرچ.خطا {}

    میلیسرچ.انتظار(کارخواه، میلیسرچ.ایجاد نمایه(کارخواه، "movies"، "شناسه"، اشکال)، اشکال)

    ناپایا فیلم‌ها := وکتور {} برگردان وکتور<فیلم>
    فیلم‌ها.بیفزا(اثر(1، "مخمصه"، "جنایی"، 1995، "یک کارآگاه در لس‌آنجلس دنبال خدمه‌ای از دزدان حرفه‌ای است."))
    فیلم‌ها.بیفزا(اثر(2، "موانا"، "خانوادگی"، 2016، "دختری برای نجات جزیره‌اش از اقیانوس می‌گذرد."))
    فیلم‌ها.بیفزا(اثر(3، "بیگانه"، "ترسناک"، 1979، "خدمه یک کشتی باری فضایی با موجودی مرگبار روبه‌رو می‌شوند."))
    فیلم‌ها.بیفزا(اثر(4، "بالا"، "خانوادگی"، 2009، "پیرمردی خانه‌اش را با هزاران بادکنک به پرواز درمی‌آورد."))
    فیلم‌ها.بیفزا(اثر(5، "ورود"، "درام"، 2016، "یک زبان‌شناس یاد می‌گیرد با مهمانانی از جهانی دیگر حرف بزند."))
    فیلم‌ها.بیفزا(اثر(6، "تلماسه"، "ماجرایی"، 2021، "یک اشراف‌زاده جوان برای سیاره‌ای بیابانی می‌جنگد."))
    فیلم‌ها.بیفزا(اثر(7، "میان‌ستاره‌ای"، "درام"، 2014، "کاوشگران از یک کرم‌چاله می‌گذرند تا خانه‌ای تازه پیدا کنند."))
    فیلم‌ها.بیفزا(اثر(8، "کوکو"، "خانوادگی"، 2017، "پسری برای یافتن خانواده‌اش به سرزمین مردگان می‌رود."))

    کار := میلیسرچ.انتظار(کارخواه، میلیسرچ.افزودن سندهای نوع(کارخواه، "movies"، فیلم‌ها، "شناسه"، اشکال)، اشکال)
    اگر وارونه میلیسرچ.موفق(اشکال):
        سرچاپ میلیسرچ.متن خطا(اشکال)
        برگشت 1
    پایان
    سرچاپ "نمایه‌سازی: " + کار.وضعیت
    آمار := میلیسرچ.دریافت آمار نمایه(کارخواه، "movies"، اشکال)
    سرچاپ "سندهای movies: " + آمار.تعداد سندها
    برگشت 0
پایان

خروجینمایه‌سازی: succeeded سندهای movies: 8

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

۳. جستجو

پرسش چند واژه را با گزینه‌های پیش‌فرض جستجو می‌کند. نتیجه‌ها به شکل متن JSON برمی‌گردند و نتایج به نوع آن‌ها را درون ساختار خودتان می‌خواند. ساختاری که فیلدهای کمتری از سند دارد اشکالی ندارد: فیلدهای اضافه نادیده گرفته می‌شوند.

meili-search.salam

واردسازی دیتابیس.میلیسرچ

ساختار فیلم:
    همگانی شناسه: صحیح = 0
    همگانی عنوان: رشته = ""
    همگانی سال: صحیح = 0
پایان

تابع ریشه:
    کارخواه := میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")
    ناپایا اشکال := میلیسرچ.خطا {}

    نتیجه := میلیسرچ.پرسش(کارخواه، "movies"، "فظایی"، اشکال)
    سرچاپ "نتیجه‌ها برای \"" + نتیجه.پرسش + "\": " + نتیجه.تخمین کل نتایج
    ناپایا فیلم‌ها := وکتور {} برگردان وکتور<فیلم>
    اگر میلیسرچ.نتایج به نوع(نتیجه، فیلم‌ها، اشکال):
        هر نمونه در فیلم‌ها:
            سرچاپ "  " + نمونه.عنوان + " (" + نمونه.سال + ")"
        پایان
    پایان
    برگشت 0
پایان

خروجینتیجه‌ها برای "فظایی": 1 بیگانه (1979)

پرسش عمداً غلط نوشته شده است: فظایی باز هم فیلمی را پیدا می‌کند که در خلاصه‌اش فضایی آمده، چون میلی‌سرچ از همان ابتدا غلط تایپی را تحمل می‌کند.

۴. فیلتر، مرتب‌سازی و شمارش وجه

فیلتر و مرتب‌سازی باید برای فیلدهای مورد نظر روشن شوند؛ این تنظیمی از نمایه است و به‌روزرسانی تنظیمات چند تنظیم را در یک کار تغییر می‌دهد. یک درخواست جستجو همه‌ی گزینه‌های جستجو را نگه می‌دارد و فقط آن‌هایی را که تعیین کنید می‌فرستد. نام فیلدهای فارسی در عبارت فیلتر هم کار می‌کنند.

meili-filter.salam

واردسازی دیتابیس.میلیسرچ

تابع ریشه:
    کارخواه := میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")
    ناپایا اشکال := میلیسرچ.خطا {}

    تنظیمات := `{"filterableAttributes": ["ژانر", "سال"], "sortableAttributes": ["سال"]}`
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی تنظیمات(کارخواه، "movies"، تنظیمات، اشکال)، اشکال)

    ناپایا جستار := میلیسرچ.درخواست جستجو { فیلتر = "ژانر = خانوادگی AND سال > 2010" }
    جستار.مرتب‌سازی.بیفزا("سال:desc")
    جستار.وجه‌ها.بیفزا("ژانر")
    جستار.ویژگی‌های بازیابی.بیفزا("عنوان")
    جستار.ویژگی‌های بازیابی.بیفزا("سال")
    نتیجه := میلیسرچ.جستجو(کارخواه، "movies"، جستار، اشکال)
    اگر وارونه میلیسرچ.موفق(اشکال):
        سرچاپ میلیسرچ.متن خطا(اشکال)
        برگشت 1
    پایان
    هر یافته در نتیجه.نتایج:
        سرچاپ یافته
    پایان

    همه := میلیسرچ.جستجو(کارخواه، "movies"، میلیسرچ.درخواست جستجو { وجه‌ها = جستار.وجه‌ها، حد = 0 }، اشکال)
    سرچاپ "ژانرها: " + همه.توزیع وجه
    برگشت 0
پایان

خروجی{"عنوان":"کوکو","سال":2017} {"عنوان":"موانا","سال":2016} ژانرها: {"ژانر":{"ترسناک":1,"جنایی":1,"خانوادگی":3,"درام":2,"ماجرایی":1}}

وجه‌ها می‌پرسد چند نتیجه هر مقدار یک فیلد را دارند؛ صفحه‌ی جستجو گزینه‌های فیلتر را با شمارشان همین‌طور نشان می‌دهد. ویژگی‌های بازیابی نتیجه‌ها را کوچک نگه می‌دارد، چون فقط فیلدهای لازم را برمی‌گرداند.

۵. برجسته‌سازی، برش و صفحه‌بندی

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

meili-highlight.salam

واردسازی دیتابیس.میلیسرچ
واردسازی کدگذاری.جیسون

تابع ریشه:
    کارخواه := میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")
    ناپایا اشکال := میلیسرچ.خطا {}

    ناپایا جستار := میلیسرچ.درخواست جستجو { پرسش = "خدمه"، نتایج صفحه = 1، شماره صفحه = 1 }
    جستار.ویژگی‌های برجسته.بیفزا("خلاصه")
    جستار.برچسب پیش از برجسته = "["
    جستار.برچسب پس از برجسته = "]"
    جستار.ویژگی‌های برش.بیفزا("خلاصه")
    جستار.طول برش = 6
    نتیجه := میلیسرچ.جستجو(کارخواه، "movies"، جستار، اشکال)
    سرچاپ "صفحه " + نتیجه.شماره صفحه + " از " + نتیجه.کل صفحه‌ها + "، " + نتیجه.کل نتایج + " نتیجه"
    هر یافته در نتیجه.نتایج:
        قالب‌بندی‌شده := جیسون.دریافت(یافته، "_formatted")
        سرچاپ جیسون.دریافت(یافته، "عنوان") + ": " + جیسون.دریافت(قالب‌بندی‌شده، "خلاصه")
    پایان
    برگشت 0
پایان

خروجیصفحه 1 از 2، 2 نتیجه بیگانه: [خدمه] یک کشتی باری فضایی با…

۶. تنظیم ربط نتیجه‌ها

هر تنظیم نمایه تابع‌های دریافت، به‌روزرسانی و بازنشانی خودش را دارد. مترادف‌ها باعث می‌شوند واژه‌های متفاوت همدیگر را پیدا کنند، کلمات توقف در پرسش نادیده گرفته می‌شوند و ویژگی‌های قابل جستجو تعیین می‌کنند کدام فیلدها جستجو شوند و هر کدام چه وزنی داشته باشد.

meili-settings.salam

واردسازی دیتابیس.میلیسرچ

تابع ریشه:
    کارخواه := میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")
    ناپایا اشکال := میلیسرچ.خطا {}

    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی مترادف‌ها(کارخواه، "movies"، `{"کارتون": ["دختری", "پسری"], "فضا": ["سیاره", "کرم‌چاله"]}`، اشکال)، اشکال)
    ناپایا کلمات توقف := وکتور {} برگردان وکتور<رشته>
    کلمات توقف.بیفزا("یک")
    کلمات توقف.بیفزا("از")
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی کلمات توقف(کارخواه، "movies"، کلمات توقف، اشکال)، اشکال)
    ناپایا قابل جستجو := وکتور {} برگردان وکتور<رشته>
    قابل جستجو.بیفزا("عنوان")
    قابل جستجو.بیفزا("خلاصه")
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی ویژگی‌های قابل جستجو(کارخواه، "movies"، قابل جستجو، اشکال)، اشکال)

    نتیجه := میلیسرچ.پرسش(کارخواه، "movies"، "کارتون"، اشکال)
    سرچاپ "نتیجه‌ها برای \"کارتون\"، مترادف دختری و پسری: " + نتیجه.تخمین کل نتایج
    نتیجه فضا := میلیسرچ.پرسش(کارخواه، "movies"، "فضا"، اشکال)
    سرچاپ "نتیجه‌ها برای \"فضا\": " + نتیجه فضا.تخمین کل نتایج
    سرچاپ "قابل جستجو: " + میلیسرچ.دریافت تنظیم(کارخواه، "movies"، "searchable-attributes"، اشکال)
    برگشت 0
پایان

خروجینتیجه‌ها برای "کارتون"، مترادف دختری و پسری: 2 نتیجه‌ها برای "فضا": 3 قابل جستجو: ["عنوان","خلاصه"]

مترادف با واژه‌ی کامل جور می‌شود. این‌جا کارتون به دختری و پسری اشاره می‌کند، دو واژه‌ای که به همین شکل در خلاصه‌ی موانا و کوکو آمده‌اند؛ واژه‌ای مثل خانوادگی با خانواده‌اش جور نمی‌شود. تنظیم‌های دیگر هم همین الگو را دارند: به‌روزرسانی قواعد رتبه‌بندی، به‌روزرسانی تحمل غلط تایپی، به‌روزرسانی ویژگی متمایز، به‌روزرسانی صفحه‌بندی، به‌روزرسانی وجه‌بندی، به‌روزرسانی واژه‌نامه و بقیه در مرجع زیر. دریافت تنظیم و به‌روزرسانی تنظیم هر تنظیمی را با نام مسیرش می‌گیرند، حتی تنظیم‌هایی که از این بسته تازه‌ترند.

۷. جستجو در چند نمایه با هم

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

meili-multi.salam

واردسازی دیتابیس.میلیسرچ

تابع ریشه:
    کارخواه := میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")
    ناپایا اشکال := میلیسرچ.خطا {}

    میلیسرچ.انتظار(کارخواه، میلیسرچ.افزودن سندها(کارخواه، "books"، `[{"شناسه": 1, "عنوان": "تلماسه", "نویسنده": "فرانک هربرت"}, {"شناسه": 2, "عنوان": "کوکو و ماه", "نویسنده": "یک نویسنده"}]`، "شناسه"، اشکال)، اشکال)

    ناپایا پرسش‌ها := وکتور {} برگردان وکتور<میلیسرچ.پرسش چندگانه>
    پرسش‌ها.بیفزا(میلیسرچ.پرسش چندگانه { نمایه = "movies"، درخواست = میلیسرچ.درخواست جستجو { پرسش = "تلماسه" } })
    پرسش‌ها.بیفزا(میلیسرچ.پرسش چندگانه { نمایه = "books"، درخواست = میلیسرچ.درخواست جستجو { پرسش = "تلماسه" } })
    هر مسیرها در میلیسرچ.جستجوی چندگانه(کارخواه، پرسش‌ها، اشکال):
        سرچاپ مسیرها.نمایه + ": " + مسیرها.نتایج.طول() + " نتیجه"
    پایان

    ادغام‌شده := میلیسرچ.جستجوی فدرال(کارخواه، پرسش‌ها، میلیسرچ.فدراسیون { حد = 5 }، اشکال)
    سرچاپ "فدرال: " + ادغام‌شده.نتایج.طول() + " نتیجه در یک فهرست"

    ژانرها := میلیسرچ.جستجوی وجه(کارخواه، "movies"، میلیسرچ.درخواست جستجوی وجه { نام وجه = "ژانر"، پرسش وجه = "خان" }، اشکال)
    هر ژانری در ژانرها.نتایج:
        سرچاپ "ژانر " + ژانری.مقدار + ": " + ژانری.شمار
    پایان
    برگشت 0
پایان

خروجیmovies: 1 نتیجه books: 1 نتیجه فدرال: 2 نتیجه در یک فهرست ژانر خانوادگی: 3

۸. جستجوی برداری و ترکیبی

میلی‌سرچ بر پایه‌ی معنا هم جستجو می‌کند. یک جاساز سندها را به بردار تبدیل می‌کند؛ می‌تواند مدلی مثل OpenAI یا Hugging Face را صدا بزند یا بردارهایی را بگیرد که خودتان ساخته‌اید، همان کاری که منبع userProvided در این گام می‌کند. جستجو با جاساز ترکیبی نتیجه‌های واژه‌ای و برداری را می‌آمیزد؛ نسبت معنایی برابر ۱ فقط از بردارها استفاده می‌کند. سندهای مشابه نزدیک‌ترین سندها به سندی را که دارید پیدا می‌کند.

meili-vectors.salam

واردسازی دیتابیس.میلیسرچ

تابع ریشه:
    کارخواه := میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")
    ناپایا اشکال := میلیسرچ.خطا {}

    میلیسرچ.انتظار(کارخواه، میلیسرچ.ایجاد نمایه(کارخواه، "movies_ai"، "شناسه"، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی جاسازها(کارخواه، "movies_ai"، `{"manual": {"source": "userProvided", "dimensions": 3}}`، اشکال)، اشکال)
    اگر وارونه میلیسرچ.موفق(اشکال):
        سرچاپ میلیسرچ.متن خطا(اشکال)
        برگشت 1
    پایان
    سندها := `[
        {"شناسه": 2, "عنوان": "موانا", "_vectors": {"manual": [0.9, 0.1, 0.0]}},
        {"شناسه": 4, "عنوان": "بالا", "_vectors": {"manual": [0.8, 0.2, 0.1]}},
        {"شناسه": 5, "عنوان": "ورود", "_vectors": {"manual": [0.1, 0.9, 0.3]}},
        {"شناسه": 6, "عنوان": "تلماسه", "_vectors": {"manual": [0.2, 0.8, 0.4]}},
        {"شناسه": 7, "عنوان": "میان‌ستاره‌ای", "_vectors": {"manual": [0.1, 0.8, 0.5]}},
        {"شناسه": 8, "عنوان": "کوکو", "_vectors": {"manual": [0.9, 0.0, 0.1]}}
    ]`
    کار := میلیسرچ.انتظار(کارخواه، میلیسرچ.افزودن سندها(کارخواه، "movies_ai"، سندها، ""، اشکال)، اشکال)
    سرچاپ "بردارها ذخیره شد: " + کار.وضعیت

    ناپایا جستار := میلیسرچ.درخواست جستجو { جاساز ترکیبی = "manual"، نسبت معنایی = 1.0، حد = 2 }
    جستار.بردار.بیفزا(0.15)
    جستار.بردار.بیفزا(0.85)
    جستار.بردار.بیفزا(0.4)
    جستار.ویژگی‌های بازیابی.بیفزا("عنوان")
    نتیجه := میلیسرچ.جستجو(کارخواه، "movies_ai"، جستار، اشکال)
    اگر وارونه میلیسرچ.موفق(اشکال):
        سرچاپ میلیسرچ.متن خطا(اشکال)
        برگشت 1
    پایان
    هر یافته در نتیجه.نتایج:
        سرچاپ "نزدیک به پرسش: " + یافته
    پایان

    ناپایا شبیه := میلیسرچ.درخواست مشابه { شناسه = "2"، جاساز = "manual"، حد = 2 }
    شبیه.ویژگی‌های بازیابی.بیفزا("عنوان")
    هر یافته در میلیسرچ.سندهای مشابه(کارخواه، "movies_ai"، شبیه، اشکال).نتایج:
        سرچاپ "شبیه موانا: " + یافته
    پایان
    برگشت 0
پایان

خروجیبردارها ذخیره شد: succeeded نزدیک به پرسش: {"عنوان":"تلماسه"} نزدیک به پرسش: {"عنوان":"ورود"} شبیه موانا: {"عنوان":"کوکو"} شبیه موانا: {"عنوان":"بالا"}

جاساز userProvided در هر سند یک بردار می‌خواهد، پس این گام نمایه‌ی جداگانه‌ی خودش را دارد. جاساز را وقتی نمایه هنوز خالی است بیفزایید و بردار هر سند را زیر _vectors بفرستید.

۹. کلیدهای API و توکن مستاجر

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

meili-keys.salam

واردسازی دیتابیس.میلیسرچ
واردسازی زمان

تابع ریشه:
    مدیر := میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")
    ناپایا اشکال := میلیسرچ.خطا {}

    ناپایا مسیرها := میلیسرچ.درخواست کلید { نام = "ویترین فروشگاه"، توضیح = "فقط جستجو در نمایه movies" }
    مسیرها.کنش‌ها.بیفزا("search")
    مسیرها.نمایه‌های مجاز.بیفزا("movies")
    کلید := میلیسرچ.ایجاد کلید(مدیر، مسیرها، اشکال)
    سرچاپ "کلید تازه " + کلید.نام + " می‌تواند: " + کلید.کنش‌ها.بگیر(0)

    قاعده‌ها := `{"movies": {"filter": "ژانر = خانوادگی"}}`
    توکن := میلیسرچ.توکن مستاجر(کلید.شناسه یکتا، کلید.کلید، قاعده‌ها، زمان.اکنون() + 3600، اشکال)
    کودکان := میلیسرچ.جدید("http://127.0.0.1:7700"، توکن)
    نتیجه := میلیسرچ.پرسش(کودکان، "movies"، ""، اشکال)
    سرچاپ "توکن می‌بیند: " + نتیجه.تخمین کل نتایج + " فیلم خانوادگی"

    میلیسرچ.پرسش(کودکان، "books"، ""، اشکال)
    سرچاپ "books با توکن: " + اشکال.کد

    سرچاپ "کلید حذف شد: " + میلیسرچ.حذف کلید(مدیر، کلید.شناسه یکتا، اشکال)
    برگشت 0
پایان

خروجیکلید تازه ویترین فروشگاه می‌تواند: search توکن می‌بیند: 3 فیلم خانوادگی books با توکن: invalid_api_key کلید حذف شد: true

۱۰. به‌روزرسانی و حذف سند

افزودن سندها سند هم‌شناسه را کامل جایگزین می‌کند؛ به‌روزرسانی سندها فقط فیلدهایی را که می‌فرستید تغییر می‌دهد. سندها را می‌توان یکی‌یکی، با فهرستی از شناسه‌ها، با فیلتر یا همه با هم حذف کرد.

meili-update.salam

واردسازی دیتابیس.میلیسرچ

ساختار فیلم:
    همگانی شناسه: صحیح = 0
    همگانی عنوان: رشته = ""
    همگانی سال: صحیح = 0
پایان

تابع ریشه:
    کارخواه := میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")
    ناپایا اشکال := میلیسرچ.خطا {}

    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی سندها(کارخواه، "movies"، `[{"شناسه": 6, "عنوان": "تلماسه: بخش یک"}]`، ""، اشکال)، اشکال)
    ناپایا تلماسه := فیلم {}
    اگر میلیسرچ.دریافت سند به نوع(کارخواه، "movies"، "6"، تلماسه، اشکال):
        سرچاپ "نام تازه: " + تلماسه.عنوان + " (" + تلماسه.سال + ")"
    پایان

    میلیسرچ.انتظار(کارخواه، میلیسرچ.حذف سند(کارخواه، "movies"، "3"، اشکال)، اشکال)
    میلیسرچ.دریافت سند(کارخواه، "movies"، "3"، وکتور {} برگردان وکتور<رشته>، اشکال)
    سرچاپ "پس از حذف: " + اشکال.کد

    حذف‌شده := میلیسرچ.انتظار(کارخواه، میلیسرچ.حذف سندها با فیلتر(کارخواه، "movies"، "سال < 2000"، اشکال)، اشکال)
    سرچاپ "حذف با فیلتر: " + حذف‌شده.وضعیت + " " + حذف‌شده.جزئیات
    سرچاپ "مانده: " + میلیسرچ.دریافت آمار نمایه(کارخواه، "movies"، اشکال).تعداد سندها
    برگشت 0
پایان

خروجینام تازه: تلماسه: بخش یک (2021) پس از حذف: document_not_found حذف با فیلتر: succeeded {"providedIds":0,"deletedDocuments":1,"originalFilter":"\"سال < 2000\""} مانده: 6

۱۱. کارها و شکست‌ها

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

meili-tasks.salam

واردسازی دیتابیس.میلیسرچ

تابع ریشه:
    کارخواه := میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")
    ناپایا اشکال := میلیسرچ.خطا {}

    رسید := میلیسرچ.افزودن سندها(کارخواه، "movies"، `[{"عنوان": "بدون شناسه"}]`، ""، اشکال)
    سرچاپ "کار در صف " + رسید.شناسه کار + ": " + رسید.وضعیت
    کار := میلیسرچ.انتظار برای کار(کارخواه، رسید.شناسه کار، 10000، 50، اشکال)
    سرچاپ "پایان با وضعیت " + کار.وضعیت
    اگر وارونه میلیسرچ.موفق(اشکال):
        سرچاپ "چرا: " + اشکال.کد
    پایان

    ناپایا پرسش := میلیسرچ.پرسش کار { حد = 3 }
    پرسش.نمایه‌ها.بیفزا("movies")
    پرسش.وضعیت‌ها.بیفزا(میلیسرچ.وضعیت موفق)
    صفحه := میلیسرچ.دریافت کارها(کارخواه، پرسش، اشکال)
    سرچاپ "کارهای موفق اخیر روی movies:"
    هر رسیدی در صفحه.نتیجه‌ها:
        سرچاپ "  " + رسیدی.نوع
    پایان
    برگشت 0
پایان

خروجیکار در صف 13: enqueued پایان با وضعیت failed چرا: missing_document_id کارهای موفق اخیر روی movies: documentDeletion documentDeletion documentAdditionOrUpdate

بیشتر

بقیه‌ی API هم همین‌طور کار می‌کند و مرجع زیر هر تابع را توضیح می‌دهد. چند نشانی:

ایجاد وب هوک نشانی‌ای ثبت می‌کند که میلی‌سرچ پس از پایان کارها صدا می‌زند، تا لازم نباشد مدام بپرسید.
به‌روزرسانی قاعده جستجو سندهای انتخابی را برای پرسش‌های انتخابی سنجاق یا تقویت می‌کند، مثل یک بنر حراج برای پرسش حراج؛ ویژگی آزمایشی dynamicSearchRules لازم است.
به‌روزرسانی تنظیمات گفتگو و تکمیل گفتگو با کمک یک مدل زبانی به پرسش‌های زبان طبیعی از روی نمایه‌های شما پاسخ می‌دهند؛ ویژگی chatCompletions لازم است.
با فراداده هر نوشتن سند را با برچسبی نشان می‌زند که روی کار برمی‌گردد، تا یک ورود داده را در فهرست کارها دنبال کنید.
ایجاد دامپ، ایجاد اسنپ‌شات، دریافت آمار، دریافت معیارها و تنظیم گزارش خطای استاندارد برای نگهداری سرورند.
برای مسیری که تابع جداگانه ندارد، درخواست هر روش، مسیر و بدنه‌ی JSON را می‌فرستد.

مخزن سلام برای هر بخش API یک نمونه‌ی اجراشدنی دارد، به فارسی در tests/fa/stdlib/meilisearch/examples و به انگلیسی در tests/en/stdlib/meilisearch/examples.

گونه‌ها

درخواست جستجو `SearchRequest`

ساختار درخواست جستجو

هر چیزی که یک جستجو می‌تواند بخواهد. فقط فیلدهایی که تعیین کنید فرستاده می‌شوند: متن و فهرست خالی، عدد -۱ و پرچم نادرست فرستاده نمی‌شوند.

نام	انگلیسی	گونه	توضیح
پرسش	`query`	`رشته = ""`	واژه‌های جستجو؛ خالی یعنی همه‌ی سندها.
جابجایی	`offset`	`صحیح = -1`	تعداد نتیجه‌هایی که رد می‌شوند.
حد	`limit`	`صحیح = -1`	تعداد نتیجه‌هایی که برگردانده می‌شوند؛ پیش‌فرض ۲۰.
شماره صفحه	`page`	`صحیح = -1`	شماره‌ی صفحه، برای صفحه‌بندی شماره‌دار با تعداد دقیق.
نتایج صفحه	`hits_per_page`	`صحیح = -1`	تعداد نتیجه‌ها در هر صفحه‌ی شماره‌دار.
فیلتر	`filter`	`رشته = ""`	یک عبارت فیلتر مثل `year > 2000 AND genre = Drama`، یا آرایه‌ی JSON از آن‌ها.
وجه‌ها	`facets`	`وکتور<رشته>`	مقدارهای این فیلدها را میان نتیجه‌ها بشمار.
ویژگی‌های بازیابی	`attributes_to_retrieve`	`وکتور<رشته>`	فقط این فیلدها برگردانده شوند.
ویژگی‌های برش	`attributes_to_crop`	`وکتور<رشته>`	این فیلدها پیرامون واژه‌های پیداشده بریده شوند.
طول برش	`crop_length`	`صحیح = -1`	تعداد واژه‌هایی که فیلد بریده‌شده نگه می‌دارد.
نشان برش	`crop_marker`	`رشته = ""`	متنی که جای بریدن را نشان می‌دهد.
ویژگی‌های برجسته	`attributes_to_highlight`	`وکتور<رشته>`	واژه‌های پیداشده در این فیلدها میان برچسب قرار گیرند.
برچسب پیش از برجسته	`highlight_pre_tag`	`رشته = ""`	برچسب پیش از واژه‌ی پیداشده؛ پیش‌فرض `<em>`.
برچسب پس از برجسته	`highlight_post_tag`	`رشته = ""`	برچسب پس از واژه‌ی پیداشده.
نمایش جای تطبیق	`show_matches_position`	`منطقی = نادرست`	جای هر واژه‌ی پیداشده برگردانده شود.
مرتب‌سازی	`sort`	`وکتور<رشته>`	قاعده‌های مرتب‌سازی مثل `year:desc`.
راهبرد تطبیق	`matching_strategy`	`رشته = ""`	یکی از مقدارهای `تطبیق`.
نمایش امتیاز	`show_ranking_score`	`منطقی = نادرست`	امتیاز ربط هر نتیجه برگردانده شود.
نمایش جزئیات امتیاز	`show_ranking_score_details`	`منطقی = نادرست`	جزئیات ساخت امتیاز برگردانده شود.
آستانه امتیاز	`ranking_score_threshold`	`اعشار۶۴ = -1`	نتیجه‌های با امتیاز کمتر از این، از ۰ تا ۱، کنار گذاشته شوند.
ویژگی‌های جستجو	`attributes_to_search_on`	`وکتور<رشته>`	فقط در این فیلدها جستجو شود.
متمایز	`distinct`	`رشته = ""`	برای هر مقدار این فیلد حداکثر یک نتیجه برگردانده شود.
زبان‌ها	`locales`	`وکتور<رشته>`	زبان‌های پرسش، مثل `fas`.
بردار	`vector`	`وکتور<اعشار۶۴>`	جستجو با این بردار.
جاساز ترکیبی	`hybrid_embedder`	`رشته = ""`	جاسازِ جستجوی هوشمند؛ تعیین آن جستجوی ترکیبی را روشن می‌کند.
نسبت معنایی	`hybrid_semantic_ratio`	`اعشار۶۴ = -1`	میزان برتری معنا بر واژه‌ها، از ۰ تا ۱.
بازیابی بردارها	`retrieve_vectors`	`منطقی = نادرست`	بردارهای ذخیره‌شده هم برگردانده شوند.
رسانه	`media`	`رشته = ""`	رسانه‌ی JSON خام برای جستجوی چندرسانه‌ای، مثل یک تصویر.
نمایش جزئیات کارایی	`show_performance_details`	`منطقی = نادرست`	مدت هر گام جستجو برگردانده شود.
استفاده از شبکه	`use_network`	`منطقی = نادرست`	در همه‌ی سرورهای یک شبکه‌ی چندتکه جستجو شود.
شخصی‌سازی	`personalize`	`رشته = ""`	گزینه‌های شخصی‌سازی به شکل JSON خام، مثل `{"userContext": "..."}`.
قاعده درجا	`inline_rule`	`رشته = ""`	یک قاعده‌ی جستجوی پویا فقط برای همین جستجو، به شکل JSON خام.
افزوده	`extra`	`رشته = ""`	یک شیء JSON خام که فیلدهایش به درخواست افزوده می‌شوند، برای پارامترهایی که این ساختار هنوز ندارد.

db-meilisearch-Search.salam

واردسازی دیتابیس.میلیسرچ

ساختار فیلم:
    همگانی شناسه: صحیح = 0
    همگانی عنوان: رشته = ""
پایان

تابع ریشه:
    کارخواه := میلیسرچ.جدید("http://127.0.0.1:7700"، "searchKey")
    ناپایا اشکال := میلیسرچ.خطا {}

    سریع := میلیسرچ.پرسش(کارخواه، "movies"، "botman"، اشکال)
    سرچاپ سریع.پرسش، سریع.تخمین کل نتایج، سریع.زمان پردازش

    ناپایا مسیرها := میلیسرچ.درخواست جستجو { پرسش = "space"، حد = 10، جابجایی = 0، فیلتر = "year > 2000 AND genre = Drama" }
    مسیرها.وجه‌ها.بیفزا("ژانر")
    مسیرها.مرتب‌سازی.بیفزا("سال:desc")
    مسیرها.ویژگی‌های بازیابی.بیفزا("شناسه")
    مسیرها.ویژگی‌های بازیابی.بیفزا("عنوان")
    مسیرها.ویژگی‌های برجسته.بیفزا("عنوان")
    مسیرها.برچسب پیش از برجسته = "<mark>"
    مسیرها.برچسب پس از برجسته = "</mark>"
    مسیرها.ویژگی‌های برش.بیفزا("overview")
    مسیرها.طول برش = 20
    مسیرها.نشان برش = "..."
    مسیرها.راهبرد تطبیق = میلیسرچ.تطبیق همه
    مسیرها.نمایش امتیاز = درست
    مسیرها.نمایش جزئیات امتیاز = نادرست
    مسیرها.نمایش جای تطبیق = نادرست
    مسیرها.آستانه امتیاز = 0.2
    مسیرها.ویژگی‌های جستجو.بیفزا("عنوان")
    مسیرها.زبان‌ها.بیفزا("eng")
    مسیرها.متمایز = "studio"
    نتیجه := میلیسرچ.جستجو(کارخواه، "movies"، مسیرها، اشکال)
    اگر وارونه میلیسرچ.موفق(اشکال):
        سرچاپ میلیسرچ.متن خطا(اشکال)
        برگشت
    پایان
    سرچاپ نتیجه.نمایه، نتیجه.جابجایی، نتیجه.حد، نتیجه.توزیع وجه، نتیجه.آمار وجه، نتیجه.خام.طول()
    هر یافته در نتیجه.نتایج:
        سرچاپ یافته
    پایان
    ناپایا فیلم‌ها := وکتور {} برگردان وکتور<فیلم>
    اگر میلیسرچ.نتایج به نوع(نتیجه، فیلم‌ها، اشکال):
        سرچاپ فیلم‌ها.طول()
    پایان

    برگه‌ها := میلیسرچ.جستجو(کارخواه، "movies"، میلیسرچ.درخواست جستجو { پرسش = "space"، شماره صفحه = 2، نتایج صفحه = 20 }، اشکال)
    سرچاپ برگه‌ها.شماره صفحه، برگه‌ها.نتایج صفحه، برگه‌ها.کل نتایج، برگه‌ها.کل صفحه‌ها

    ناپایا ترکیبی := میلیسرچ.درخواست جستجو { پرسش = "a sad robot"، جاساز ترکیبی = "default"، نسبت معنایی = 0.7، بازیابی بردارها = نادرست، راهبرد تطبیق = میلیسرچ.تطبیق آخر }
    ترکیبی.بردار.بیفزا(0.1)
    ترکیبی.رسانه = `{"image": "https://example.com/robot.png"}`
    ترکیبی.افزوده = `{"showPerformanceDetails": true}`
    سرچاپ میلیسرچ.جستجو(کارخواه، "movies"، ترکیبی، اشکال).شمار نتایج معنایی، میلیسرچ.تطبیق فراوانی

    ناپایا پرسش‌ها := وکتور {} برگردان وکتور<میلیسرچ.پرسش چندگانه>
    پرسش‌ها.بیفزا(میلیسرچ.پرسش چندگانه { نمایه = "movies"، درخواست = میلیسرچ.درخواست جستجو { پرسش = "moana" } })
    پرسش‌ها.بیفزا(میلیسرچ.پرسش چندگانه { نمایه = "books"، درخواست = میلیسرچ.درخواست جستجو { پرسش = "moana" }، وزن = 0.5، سرور دور = "" })
    هر تک در میلیسرچ.جستجوی چندگانه(کارخواه، پرسش‌ها، اشکال):
        سرچاپ تک.نمایه، تک.نتایج.طول()
    پایان
    فدرال := میلیسرچ.جستجوی فدرال(کارخواه، پرسش‌ها، میلیسرچ.فدراسیون { جابجایی = 0، حد = 20، شماره صفحه = -1، نتایج صفحه = -1، وجه‌های نمایه‌ها = `{"movies": ["ژانر"]}`، ادغام وجه‌ها = `{}` }، اشکال)
    سرچاپ فدرال.نتایج.طول()

    ناپایا درخواست وجه := میلیسرچ.درخواست جستجوی وجه { نام وجه = "ژانر"، پرسش وجه = "dra"، پرسش = "space"، فیلتر = "year > 2000"، راهبرد تطبیق = میلیسرچ.تطبیق همه، شمارش کامل وجه = درست }
    درخواست وجه.ویژگی‌های جستجو.بیفزا("عنوان")
    نتیجه وجه := میلیسرچ.جستجوی وجه(کارخواه، "movies"، درخواست وجه، اشکال)
    سرچاپ نتیجه وجه.پرسش وجه، نتیجه وجه.زمان پردازش
    هر دستگیره در نتیجه وجه.نتایج:
        سرچاپ دستگیره.مقدار، دستگیره.شمار
    پایان

    ناپایا درخواست مشابه := میلیسرچ.درخواست مشابه { شناسه = "143"، جاساز = "default"، حد = 5، جابجایی = 0، فیلتر = "year > 2000"، نمایش امتیاز = درست، نمایش جزئیات امتیاز = نادرست، آستانه امتیاز = 0.5، بازیابی بردارها = نادرست }
    درخواست مشابه.ویژگی‌های بازیابی.بیفزا("عنوان")
    سرچاپ میلیسرچ.سندهای مشابه(کارخواه، "movies"، درخواست مشابه، اشکال).نتایج.طول()

    ناپایا بیشتر := میلیسرچ.درخواست جستجو { پرسش = "space"، نمایش جزئیات کارایی = درست، استفاده از شبکه = نادرست، شخصی‌سازی = `{"userContext": "likes old films"}`، قاعده درجا = `{"actions": {"pin": [{"شناسه": "1", "position": 0}]}}` }
    بیشتر.زبان‌ها.بیفزا("eng")
    مفصل := میلیسرچ.جستجو(کارخواه، "movies"، بیشتر، اشکال)
    سرچاپ مفصل.شناسه درخواست، مفصل.جزئیات کارایی، مفصل.بردار پرسش، مفصل.خطاهای دور، مفصل.فراداده، مفصل.وجه‌های نمایه‌ها
    ناپایا پرسش وجه := میلیسرچ.درخواست جستجوی وجه { نام وجه = "ژانر"، آستانه امتیاز = 0.1، جاساز ترکیبی = "default"، نسبت معنایی = 0.5، رسانه = ""، استفاده از شبکه = نادرست }
    پرسش وجه.زبان‌ها.بیفزا("eng")
    پرسش وجه.بردار.بیفزا(0.2)
    سرچاپ میلیسرچ.جستجوی وجه(کارخواه، "movies"، پرسش وجه، اشکال).خطاهای دور
    ناپایا پرسش‌های جایگاه := وکتور {} برگردان وکتور<میلیسرچ.پرسش چندگانه>
    پرسش‌های جایگاه.بیفزا(میلیسرچ.پرسش چندگانه { نمایه = "movies"، درخواست = میلیسرچ.درخواست جستجو { پرسش = "up" }، جایگاه پرسش = 0 })
    سرچاپ میلیسرچ.جستجوی فدرال(کارخواه، پرسش‌های جایگاه، میلیسرچ.فدراسیون { متمایز = "studio"، شخصی‌سازی = ""، نمایش جزئیات کارایی = درست }، اشکال).نتایج.طول()
    سرچاپ میلیسرچ.سندهای مشابه(کارخواه، "movies"، میلیسرچ.درخواست مشابه { شناسه = "1"، جاساز = "default"، نمایش جزئیات کارایی = درست }، اشکال).نتایج.طول()
پایان

نتیجه جستجو `SearchResult`

ساختار نتیجه جستجو

پاسخ یک جستجو. عددهایی که سرور نفرستاده -۱ هستند.

نام	انگلیسی	گونه	توضیح
نمایه	`index_uid`	`رشته = ""`	نمایه، در نتیجه‌های جستجوی چندگانه.
نتایج	`hits`	`وکتور<رشته>`	هر نتیجه به شکل یک متن JSON جدا؛ با `نتایج به نوع` آن‌ها را در ساختار بخوانید.
پرسش	`query`	`رشته = ""`	پرسشی که اجرا شد.
زمان پردازش	`processing_time_ms`	`صحیح۶۴ = 0`	مدت جستجو، به میلی‌ثانیه.
جابجایی	`offset`	`صحیح۶۴ = -1`	تعداد نتیجه‌های ردشده.
حد	`limit`	`صحیح۶۴ = -1`	اندازه‌ی صفحه.
تخمین کل نتایج	`estimated_total_hits`	`صحیح۶۴ = -1`	تعداد تقریبی سندهای منطبق.
شماره صفحه	`page`	`صحیح۶۴ = -1`	شماره‌ی صفحه، در صفحه‌بندی شماره‌دار.
نتایج صفحه	`hits_per_page`	`صحیح۶۴ = -1`	تعداد نتیجه در هر صفحه.
کل نتایج	`total_hits`	`صحیح۶۴ = -1`	تعداد دقیق سندهای منطبق، در صفحه‌بندی شماره‌دار.
کل صفحه‌ها	`total_pages`	`صحیح۶۴ = -1`	تعداد صفحه‌ها.
توزیع وجه	`facet_distribution`	`رشته = ""`	شمارش مقدارهای وجه‌های خواسته‌شده، به شکل JSON خام.
آمار وجه	`facet_stats`	`رشته = ""`	کمینه و بیشینه‌ی وجه‌های عددی، به شکل JSON خام.
شمار نتایج معنایی	`semantic_hit_count`	`صحیح۶۴ = -1`	تعداد نتیجه‌هایی که از معنا و نه از واژه‌ها آمدند.
جزئیات کارایی	`performance_details`	`رشته = ""`	مدت هر گام، به شکل JSON خام.
بردار پرسش	`query_vector`	`رشته = ""`	برداری که پرسش به آن تبدیل شد، به شکل JSON خام.
خطاهای دور	`remote_errors`	`رشته = ""`	خطاهای سرورهای دیگر یک شبکه‌ی چندتکه، به شکل JSON خام.
شناسه درخواست	`request_uid`	`رشته = ""`	شناسه‌ی این درخواست جستجو.
فراداده	`metadata`	`رشته = ""`	اطلاعات بیشتر درباره‌ی پرسش، به شکل JSON خام.
وجه‌های نمایه‌ها	`facets_by_index`	`رشته = ""`	وجه‌های هر نمایه، در جستجوی فدرال.
خام	`raw`	`رشته = ""`	کل بدنه‌ی پاسخ.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Search.salam

پرسش چندگانه `MultiQuery`

ساختار پرسش چندگانه

یک جستجو درون جستجوی چندگانه.

نام	انگلیسی	گونه	توضیح
نمایه	`index_uid`	`رشته = ""`	نمایه‌ای که جستجو می‌شود.
درخواست	`request`	`درخواست جستجو`	خود جستجو.
وزن	`weight`	`اعشار۶۴ = -1`	در جستجوی فدرال، وزن این پرسش؛ -۱ یعنی فرستاده نشود.
سرور دور	`remote`	`رشته = ""`	در جستجوی فدرال میان چند سرور، سروری که پرسیده می‌شود.
جایگاه پرسش	`query_position`	`صحیح = -1`	در جستجوی فدرال، جایگاهی که برای برابری امتیازها به کار می‌رود؛ -۱ یعنی فرستاده نشود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Search.salam

فدراسیون `Federation`

ساختار فدراسیون

این‌که جستجوی فدرال پرسش‌هایش را چگونه در یک فهرست ادغام کند.

نام	انگلیسی	گونه	توضیح
جابجایی	`offset`	`صحیح = -1`	تعداد نتیجه‌های ادغام‌شده‌ای که رد می‌شوند.
حد	`limit`	`صحیح = -1`	تعداد نتیجه‌های ادغام‌شده‌ای که برگردانده می‌شوند.
شماره صفحه	`page`	`صحیح = -1`	شماره‌ی صفحه.
نتایج صفحه	`hits_per_page`	`صحیح = -1`	تعداد نتیجه در هر صفحه.
وجه‌های نمایه‌ها	`facets_by_index`	`رشته = ""`	وجه‌هایی که برای هر نمایه شمرده می‌شوند، به شکل JSON خام.
ادغام وجه‌ها	`merge_facets`	`رشته = ""`	شیوه‌ی ادغام آن وجه‌ها، به شکل JSON خام.
متمایز	`distinct`	`رشته = ""`	برای هر مقدار این فیلد حداکثر یک نتیجه‌ی ادغام‌شده برگردانده شود.
شخصی‌سازی	`personalize`	`رشته = ""`	گزینه‌های شخصی‌سازی فهرست ادغام‌شده، به شکل JSON خام.
نمایش جزئیات کارایی	`show_performance_details`	`منطقی = نادرست`	مدت هر گام برگردانده شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Search.salam

درخواست جستجوی وجه `FacetSearchRequest`

ساختار درخواست جستجوی وجه

جستجو میان مقدارهای یک وجه.

نام	انگلیسی	گونه	توضیح
نام وجه	`facet_name`	`رشته = ""`	فیلد وجه.
پرسش وجه	`facet_query`	`رشته = ""`	متنی که مقدارها باید با آن شروع شوند.
پرسش	`query`	`رشته = ""`	فقط سندهای منطبق با این جستجو شمرده شوند.
فیلتر	`filter`	`رشته = ""`	فقط سندهای منطبق با این فیلتر شمرده شوند.
راهبرد تطبیق	`matching_strategy`	`رشته = ""`	یکی از مقدارهای `تطبیق`.
ویژگی‌های جستجو	`attributes_to_search_on`	`وکتور<رشته>`	فقط در این فیلدها جستجو شود.
شمارش کامل وجه	`exhaustive_facet_count`	`منطقی = نادرست`	شمارش دقیق، که کندتر است.
آستانه امتیاز	`ranking_score_threshold`	`اعشار۶۴ = -1`	فقط سندهای با امتیاز دست کم این مقدار شمرده شوند.
زبان‌ها	`locales`	`وکتور<رشته>`	زبان‌های پرسش.
بردار	`vector`	`وکتور<اعشار۶۴>`	جستجو با این بردار.
جاساز ترکیبی	`hybrid_embedder`	`رشته = ""`	جاساز جستجوی ترکیبی.
نسبت معنایی	`hybrid_semantic_ratio`	`اعشار۶۴ = -1`	میزان برتری معنا بر واژه‌ها.
رسانه	`media`	`رشته = ""`	رسانه‌ی JSON خام برای جستجوی چندرسانه‌ای.
استفاده از شبکه	`use_network`	`منطقی = نادرست`	از همه‌ی سرورهای یک شبکه‌ی چندتکه پرسیده شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Search.salam

نتیجه وجه `FacetHit`

ساختار نتیجه وجه

یک مقدار وجه.

نام	انگلیسی	گونه	توضیح
مقدار	`value`	`رشته = ""`	مقدار.
شمار	`count`	`صحیح۶۴ = 0`	تعداد سندهای دارای آن.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Search.salam

نتیجه جستجوی وجه `FacetSearchResult`

ساختار نتیجه جستجوی وجه

پاسخ جستجوی وجه.

نام	انگلیسی	گونه	توضیح
نتایج	`hits`	`وکتور<نتیجه وجه>`	مقدارهای منطبق.
پرسش وجه	`facet_query`	`رشته = ""`	پرسش وجهی که اجرا شد.
زمان پردازش	`processing_time_ms`	`صحیح۶۴ = 0`	مدت اجرا، به میلی‌ثانیه.
خطاهای دور	`remote_errors`	`رشته = ""`	خطاهای سرورهای دیگر، به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Search.salam

درخواست مشابه `SimilarRequest`

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

سندهای شبیه یک سند، بر پایه‌ی بردارهایش.

نام	انگلیسی	گونه	توضیح
شناسه	`id`	`رشته = ""`	سندی که با آن مقایسه می‌شود.
جاساز	`embedder`	`رشته = ""`	جاسازی که بردارهایش مقایسه می‌شوند.
جابجایی	`offset`	`صحیح = -1`	تعداد نتیجه‌هایی که رد می‌شوند.
حد	`limit`	`صحیح = -1`	تعداد نتیجه‌هایی که برگردانده می‌شوند.
فیلتر	`filter`	`رشته = ""`	فقط سندهای منطبق با این فیلتر.
ویژگی‌های بازیابی	`attributes_to_retrieve`	`وکتور<رشته>`	فقط این فیلدها برگردانده شوند.
نمایش امتیاز	`show_ranking_score`	`منطقی = نادرست`	امتیاز شباهت برگردانده شود.
نمایش جزئیات امتیاز	`show_ranking_score_details`	`منطقی = نادرست`	جزئیات ساخت امتیاز برگردانده شود.
آستانه امتیاز	`ranking_score_threshold`	`اعشار۶۴ = -1`	نتیجه‌های با امتیاز کمتر از این کنار گذاشته شوند.
بازیابی بردارها	`retrieve_vectors`	`منطقی = نادرست`	بردارهای ذخیره‌شده هم برگردانده شوند.
نمایش جزئیات کارایی	`show_performance_details`	`منطقی = نادرست`	مدت هر گام برگردانده شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Search.salam

وب هوک `Webhook`

ساختار وب هوک

یک وب‌هوک: نشانی‌ای که میلی‌سرچ هر بار که کاری تمام می‌شود صدا می‌زند.

نام	انگلیسی	گونه	توضیح
شناسه جهانی	`uuid`	`رشته = ""`	شناسه‌ی آن.
نشانی	`url`	`رشته = ""`	نشانی‌ای که صدا زده می‌شود.
سرآیندها	`headers`	`رشته = ""`	سرآیندهایی که با هر فراخوانی فرستاده می‌شوند، به شکل JSON خام؛ مقدارهای مخفی پوشیده برمی‌گردند.
قابل ویرایش	`is_editable`	`منطقی = نادرست`	قابل تغییر است؛ وب‌هوک‌هایی که از خط فرمان تعیین شده‌اند نیستند.

db-meilisearch-CreateWebhook.salam

واردسازی دیتابیس.میلیسرچ

تابع ریشه:
    کارخواه := میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")
    ناپایا اشکال := میلیسرچ.خطا {}

    هوک := میلیسرچ.ایجاد وب هوک(کارخواه، "https://example.com/meilisearch-hook"، `{"Authorization": "Bearer hook-secret"}`، اشکال)
    اگر وارونه میلیسرچ.موفق(اشکال):
        سرچاپ میلیسرچ.متن خطا(اشکال)
        برگشت
    پایان
    سرچاپ هوک.شناسه جهانی، هوک.نشانی، هوک.سرآیندها، هوک.قابل ویرایش
    سرچاپ میلیسرچ.دریافت وب هوک(کارخواه، هوک.شناسه جهانی، اشکال).نشانی
    سرچاپ میلیسرچ.به‌روزرسانی وب هوک(کارخواه، هوک.شناسه جهانی، "https://example.com/v2/hook"، ""، اشکال).نشانی
    هر هوکی در میلیسرچ.فهرست وب هوک‌ها(کارخواه، اشکال):
        سرچاپ هوکی.شناسه جهانی، هوکی.نشانی
    پایان
    سرچاپ میلیسرچ.حذف وب هوک(کارخواه، هوک.شناسه جهانی، اشکال)
پایان

اطلاعات کار `TaskInfo`

ساختار اطلاعات کار

رسید یک تغییر. میلی‌سرچ هر نوشتن را بعدا و به ترتیب انجام می‌دهد؛ با انتظار منتظرش بمانید.

نام	انگلیسی	گونه	توضیح
شناسه کار	`task_uid`	`صحیح۶۴ = -1`	شماره‌ی کار؛ اگر فراخوانی ناموفق بود -۱.
نمایه	`index_uid`	`رشته = ""`	نمایه‌ای که تغییر می‌دهد، اگر باشد.
وضعیت	`status`	`رشته = ""`	وضعیت در لحظه‌ی ورود به صف.
نوع	`kind`	`رشته = ""`	نوع کار، مثل `documentAdditionOrUpdate`.
زمان صف	`enqueued_at`	`رشته = ""`	زمان ورود به صف.
فراداده سفارشی	`custom_metadata`	`رشته = ""`	فراداده‌ای که نوشتن با آن برچسب خورده بود.

db-meilisearch-GetTasks.salam

واردسازی دیتابیس.میلیسرچ

تابع ریشه:
    کارخواه := میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")
    ناپایا اشکال := میلیسرچ.خطا {}

    رسید := میلیسرچ.حذف نمایه(کارخواه، "old_movies"، اشکال)
    رسیدی := میلیسرچ.انتظار برای کار(کارخواه، رسید.شناسه کار، 30000، 100، اشکال)
    سرچاپ رسیدی.شناسه یکتا، رسیدی.شناسه دسته، رسیدی.نمایه، رسیدی.وضعیت، رسیدی.نوع، رسیدی.لغو با، رسیدی.جزئیات، رسیدی.مدت
    سرچاپ رسیدی.زمان صف، رسیدی.زمان شروع، رسیدی.زمان اتمام
    اگر رسیدی.وضعیت برابر میلیسرچ.وضعیت ناموفق:
        سرچاپ رسیدی.خطا.کد، رسیدی.خطا.پیام
    پایان
    سرچاپ میلیسرچ.دریافت کار(کارخواه، رسید.شناسه کار، اشکال).وضعیت

    ناپایا پرسش := میلیسرچ.پرسش کار { حد = 20، از = -1، وارون = درست، صف پس از = "2025-01-01T00:00:00Z" }
    پرسش.وضعیت‌ها.بیفزا(میلیسرچ.وضعیت موفق)
    پرسش.وضعیت‌ها.بیفزا(میلیسرچ.وضعیت ناموفق)
    پرسش.نمایه‌ها.بیفزا("movies")
    پرسش.نوع‌ها.بیفزا("documentAdditionOrUpdate")
    پرسش.شناسه‌های یکتا.بیفزا(1)
    پرسش.شناسه‌های دسته.بیفزا(1)
    پرسش.لغو با.بیفزا(2)
    پرسش.صف پیش از = "2030-01-01T00:00:00Z"
    پرسش.شروع پیش از = "2030-01-01T00:00:00Z"
    پرسش.شروع پس از = "2025-01-01T00:00:00Z"
    پرسش.اتمام پیش از = "2030-01-01T00:00:00Z"
    پرسش.اتمام پس از = "2025-01-01T00:00:00Z"
    صفحه := میلیسرچ.دریافت کارها(کارخواه، پرسش، اشکال)
    سرچاپ صفحه.کل، صفحه.حد، صفحه.از، صفحه.بعدی
    هر کار در صفحه.نتیجه‌ها:
        سرچاپ کار.شناسه یکتا، کار.نوع، کار.وضعیت
    پایان

    ناپایا معوق := میلیسرچ.پرسش کار {}
    معوق.وضعیت‌ها.بیفزا(میلیسرچ.وضعیت در صف)
    معوق.وضعیت‌ها.بیفزا(میلیسرچ.وضعیت در حال پردازش)
    سرچاپ میلیسرچ.لغو کارها(کارخواه، معوق، اشکال).شناسه کار
    ناپایا تمام‌شده := میلیسرچ.پرسش کار {}
    تمام‌شده.وضعیت‌ها.بیفزا(میلیسرچ.وضعیت لغو شده)
    سرچاپ میلیسرچ.حذف کارها(کارخواه، تمام‌شده، اشکال).شناسه کار

    دسته‌ها := میلیسرچ.دریافت دسته‌ها(کارخواه، میلیسرچ.پرسش کار { حد = 5 }، اشکال)
    سرچاپ دسته‌ها.کل، دسته‌ها.حد، دسته‌ها.از، دسته‌ها.بعدی
    هر دسته‌ای در دسته‌ها.نتیجه‌ها:
        تک := میلیسرچ.دریافت دسته(کارخواه، دسته‌ای.شناسه یکتا، اشکال)
        سرچاپ تک.شناسه یکتا، تک.راهبرد دسته، تک.جزئیات، تک.آمار، تک.پیشرفت، تک.مدت، تک.زمان شروع، تک.زمان اتمام
    پایان

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

کار `Task`

ساختار کار

یک کار با نتیجه‌ی آن.

نام	انگلیسی	گونه	توضیح
شناسه یکتا	`uid`	`صحیح۶۴ = -1`	شماره‌ی کار.
شناسه دسته	`batch_uid`	`صحیح۶۴ = -1`	دسته‌ای که در آن اجرا شد؛ پیش از اجرا -۱.
نمایه	`index_uid`	`رشته = ""`	نمایه‌ای که تغییر می‌دهد.
وضعیت	`status`	`رشته = ""`	یکی از مقدارهای `وضعیت`.
نوع	`kind`	`رشته = ""`	نوع کار.
لغو با	`canceled_by`	`صحیح۶۴ = -1`	کاری که آن را لغو کرد؛ اگر نباشد -۱.
جزئیات	`details`	`رشته = ""`	جزئیاتی که به نوع کار بستگی دارد، به شکل JSON خام.
خطا	`error`	`خطا`	دلیل شکست.
مدت	`duration`	`رشته = ""`	مدت اجرا، به شکل بازه‌ی ISO 8601.
زمان صف	`enqueued_at`	`رشته = ""`	زمان ورود به صف.
زمان شروع	`started_at`	`رشته = ""`	زمان شروع.
زمان اتمام	`finished_at`	`رشته = ""`	زمان پایان.
فراداده سفارشی	`custom_metadata`	`رشته = ""`	فراداده‌ای که نوشتن با آن برچسب خورده بود.
شبکه	`network`	`رشته = ""`	خاستگاه کار در یک شبکه‌ی چندتکه، به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

پرسش کار `TaskQuery`

ساختار پرسش کار

این‌که کدام کارها فهرست، لغو یا حذف شوند. فیلدهای خالی فرستاده نمی‌شوند.

نام	انگلیسی	گونه	توضیح
شناسه‌های یکتا	`uids`	`وکتور<صحیح۶۴>`	فقط این کارها.
شناسه‌های دسته	`batch_uids`	`وکتور<صحیح۶۴>`	فقط کارهای این دسته‌ها.
لغو با	`canceled_by`	`وکتور<صحیح۶۴>`	فقط کارهایی که این کارها لغوشان کرده‌اند.
وضعیت‌ها	`statuses`	`وکتور<رشته>`	فقط این وضعیت‌ها.
نوع‌ها	`types`	`وکتور<رشته>`	فقط این نوع کارها.
نمایه‌ها	`index_uids`	`وکتور<رشته>`	فقط کارهای این نمایه‌ها.
حد	`limit`	`صحیح = 0`	اندازه‌ی صفحه؛ ۰ برای پیش‌فرض. فقط برای فهرست.
از	`from`	`صحیح۶۴ = -1`	شروع از این شماره‌ی کار؛ -۱ برای جدیدترین. فقط برای فهرست.
وارون	`reverse`	`منطقی = نادرست`	قدیمی‌ترین اول. فقط برای فهرست.
صف پیش از	`before_enqueued_at`	`رشته = ""`	پیش از این تاریخ وارد صف شده.
صف پس از	`after_enqueued_at`	`رشته = ""`	پس از این تاریخ وارد صف شده.
شروع پیش از	`before_started_at`	`رشته = ""`	پیش از این تاریخ شروع شده.
شروع پس از	`after_started_at`	`رشته = ""`	پس از این تاریخ شروع شده.
اتمام پیش از	`before_finished_at`	`رشته = ""`	پیش از این تاریخ تمام شده.
اتمام پس از	`after_finished_at`	`رشته = ""`	پس از این تاریخ تمام شده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

فشرده‌سازی کارها `TaskCompaction`

ساختار فشرده‌سازی کارها

نتیجه‌ی فشرده‌سازی صف کارها.

نام	انگلیسی	گونه	توضیح
وضعیت	`status`	`رشته = ""`	نتیجه.
اندازه قبل	`pre_size`	`رشته = ""`	اندازه‌ی پیش از آن.
اندازه بعد	`post_size`	`رشته = ""`	اندازه‌ی پس از آن.
اقدام لازم	`action_required`	`رشته = ""`	کاری که باید بکنید؛ میلی‌سرچ راه‌اندازی دوباره می‌خواهد.
پیام خطا	`error_message`	`رشته = ""`	دلیل شکست، اگر شکست خورد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

صفحه کار `TaskPage`

ساختار صفحه کار

یک صفحه از کارها.

نام	انگلیسی	گونه	توضیح
نتیجه‌ها	`results`	`وکتور<کار>`	کارها، جدیدترین اول.
حد	`limit`	`صحیح۶۴ = 0`	اندازه‌ی صفحه.
از	`from`	`صحیح۶۴ = -1`	شماره‌ی نخستین کار این صفحه.
بعدی	`next`	`صحیح۶۴ = -1`	برای صفحه‌ی بعد این را به عنوان `from` بدهید؛ در صفحه‌ی آخر -۱.
کل	`total`	`صحیح۶۴ = 0`	تعداد کارهای منطبق.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

دسته `Batch`

ساختار دسته

یک دسته: کارهایی که میلی‌سرچ با هم اجرا کرد.

نام	انگلیسی	گونه	توضیح
شناسه یکتا	`uid`	`صحیح۶۴ = -1`	شماره‌ی دسته.
جزئیات	`details`	`رشته = ""`	جزئیات کارهای آن، به شکل JSON خام.
آمار	`stats`	`رشته = ""`	شمارش بر پایه‌ی وضعیت، نوع و نمایه، به شکل JSON خام.
پیشرفت	`progress`	`رشته = ""`	پیشرفت در حین اجرا، به شکل JSON خام؛ پس از پایان خالی.
راهبرد دسته	`batch_strategy`	`رشته = ""`	دلیل این‌که کارها این‌گونه دسته شدند.
مدت	`duration`	`رشته = ""`	مدت اجرا.
زمان شروع	`started_at`	`رشته = ""`	زمان شروع.
زمان اتمام	`finished_at`	`رشته = ""`	زمان پایان.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

صفحه دسته `BatchPage`

ساختار صفحه دسته

یک صفحه از دسته‌ها.

نام	انگلیسی	گونه	توضیح
نتیجه‌ها	`results`	`وکتور<دسته>`	دسته‌ها.
حد	`limit`	`صحیح۶۴ = 0`	اندازه‌ی صفحه.
از	`from`	`صحیح۶۴ = -1`	شماره‌ی نخستین دسته‌ی این صفحه.
بعدی	`next`	`صحیح۶۴ = -1`	برای صفحه‌ی بعد این را به عنوان `from` بدهید؛ در صفحه‌ی آخر -۱.
کل	`total`	`صحیح۶۴ = 0`	تعداد دسته‌های منطبق.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

نمایه `Index`

ساختار نمایه

یک نمایه: مجموعه‌ای نام‌دار از سندها.

نام	انگلیسی	گونه	توضیح
شناسه یکتا	`uid`	`رشته = ""`	نام نمایه.
کلید اصلی	`primary_key`	`رشته = ""`	فیلدی که هر سند را مشخص می‌کند؛ تا وقتی معلوم نشده خالی است.
زمان ساخت	`created_at`	`رشته = ""`	زمان ساخت نمایه.
زمان تغییر	`updated_at`	`رشته = ""`	زمان آخرین تغییر آن.

db-meilisearch-CreateIndex.salam

واردسازی دیتابیس.میلیسرچ

تابع ریشه:
    کارخواه := میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")
    ناپایا اشکال := میلیسرچ.خطا {}

    رسید := میلیسرچ.ایجاد نمایه(کارخواه، "movies"، "شناسه"، اشکال)
    سرچاپ رسید.شناسه کار، رسید.نمایه، رسید.وضعیت، رسید.نوع، رسید.زمان صف
    انجام‌شده := میلیسرچ.انتظار(کارخواه، رسید، اشکال)
    اگر وارونه میلیسرچ.موفق(اشکال):
        سرچاپ میلیسرچ.متن خطا(اشکال)
        برگشت
    پایان
    سرچاپ انجام‌شده.وضعیت

    شماره := میلیسرچ.دریافت نمایه(کارخواه، "movies"، اشکال)
    سرچاپ شماره.شناسه یکتا، شماره.کلید اصلی، شماره.زمان ساخت، شماره.زمان تغییر
    صفحه := میلیسرچ.فهرست نمایه‌ها(کارخواه، 0، 20، اشکال)
    سرچاپ صفحه.کل، صفحه.جابجایی، صفحه.حد
    هر نمایه‌ای در صفحه.نتیجه‌ها:
        سرچاپ نمایه‌ای.شناسه یکتا
    پایان

    میلیسرچ.انتظار برای کار(کارخواه، میلیسرچ.به‌روزرسانی نمایه(کارخواه، "movies"، "movie_id"، اشکال).شناسه کار، 10000، 50، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.تغییر نام نمایه(کارخواه، "movies"، "films"، اشکال)، اشکال)

    ناپایا جابجایی‌ها := وکتور {} برگردان وکتور<میلیسرچ.جابجایی نمایه>
    جابجایی‌ها.بیفزا(میلیسرچ.جابجایی نمایه { نخست = "films"، دوم = "films_next" })
    جابجایی‌ها.بیفزا(میلیسرچ.جابجایی نمایه { نخست = "drafts"، دوم = "drafts_v2"، تغییر نام = درست })
    میلیسرچ.انتظار(کارخواه، میلیسرچ.جابجایی نمایه‌ها(کارخواه، جابجایی‌ها، اشکال)، اشکال)

    سرور := میلیسرچ.دریافت آمار نمایه(کارخواه، "films"، اشکال)
    سرچاپ سرور.تعداد سندها، سرور.اندازه خام سندها، سرور.میانگین اندازه سند، سرور.نمایه‌سازی جاری
    سرچاپ سرور.تعداد بردارها، سرور.تعداد سندهای جاسازی‌شده، سرور.توزیع فیلد

    میلیسرچ.انتظار(کارخواه، میلیسرچ.فشرده‌سازی نمایه(کارخواه، "movies"، اشکال)، اشکال)
    ناپایا پرسش وجه := میلیسرچ.پرسش فیلدها { جابجایی = 0، حد = 50، فیلتر = `{"filterable": true}` }
    پرسش وجه.الگوهای ویژگی.بیفزا("*")
    فیلدها := میلیسرچ.فهرست فیلدها(کارخواه، "movies"، پرسش وجه، اشکال)
    سرچاپ فیلدها.کل، فیلدها.جابجایی، فیلدها.حد
    هر ف در فیلدها.نتیجه‌ها:
        سرچاپ ف.نام، ف.نمایشی، ف.قابل جستجو، ف.قابل مرتب‌سازی، ف.متمایز، ف.قابل فیلتر، ف.قاعده رتبه‌بندی، ف.محلی، ف.خام.طول()
    پایان
    سرچاپ سرور.اندازه نمایه، سرور.اندازه به کار رفته نمایه، سرور.اندازه پایگاه‌های درونی
    میلیسرچ.انتظار(کارخواه، میلیسرچ.حذف نمایه(کارخواه، "films"، اشکال)، اشکال)
پایان

صفحه نمایه `IndexPage`

ساختار صفحه نمایه

یک صفحه از نمایه‌ها.

نام	انگلیسی	گونه	توضیح
نتیجه‌ها	`results`	`وکتور<نمایه>`	نمایه‌های این صفحه.
جابجایی	`offset`	`صحیح۶۴ = 0`	تعداد ردشده‌ها.
حد	`limit`	`صحیح۶۴ = 0`	اندازه‌ی صفحه.
کل	`total`	`صحیح۶۴ = 0`	تعداد کل نمایه‌ها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-CreateIndex.salam

آمار نمایه `IndexStats`

ساختار آمار نمایه

آمار یک نمایه.

نام	انگلیسی	گونه	توضیح
تعداد سندها	`number_of_documents`	`صحیح۶۴ = 0`	تعداد سندهای آن.
اندازه خام سندها	`raw_document_db_size`	`صحیح۶۴ = 0`	اندازه‌ی سندهای ذخیره‌شده، به بایت.
میانگین اندازه سند	`avg_document_size`	`صحیح۶۴ = 0`	میانگین اندازه‌ی سند، به بایت.
نمایه‌سازی جاری	`is_indexing`	`منطقی = نادرست`	همین حالا کاری در حال تغییر آن است.
تعداد بردارها	`number_of_embeddings`	`صحیح۶۴ = 0`	تعداد بردارهای آن.
تعداد سندهای جاسازی‌شده	`number_of_embedded_documents`	`صحیح۶۴ = 0`	تعداد سندهایی که دست کم یک بردار دارند.
توزیع فیلد	`field_distribution`	`رشته = ""`	تعداد سندهای دارای هر فیلد، به شکل JSON خام.
اندازه نمایه	`index_size`	`صحیح۶۴ = 0`	اندازه‌ی نمایه روی دیسک، به بایت.
اندازه به کار رفته نمایه	`used_index_size`	`صحیح۶۴ = 0`	بایت‌هایی از نمایه که واقعا به کار رفته‌اند.
اندازه پایگاه‌های درونی	`internal_database_sizes`	`رشته = ""`	اندازه‌ی هر پایگاه داده‌ی درونی، به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-CreateIndex.salam

جابجایی نمایه `IndexSwap`

ساختار جابجایی نمایه

دو نمایه برای جابجایی نمایه‌ها.

نام	انگلیسی	گونه	توضیح
نخست	`first`	`رشته = ""`	نمایه‌ی اول.
دوم	`second`	`رشته = ""`	نمایه‌ی دوم.
تغییر نام	`rename`	`منطقی = نادرست`	به جای جابجایی، اگر `second` وجود نداشته باشد، `first` را به آن تغییر نام بده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-CreateIndex.salam

فیلد `Field`

ساختار فیلد

یک فیلد نمایه و کاربردهای آن.

نام	انگلیسی	گونه	توضیح
نام	`name`	`رشته = ""`	نام فیلد.
نمایشی	`displayed`	`منطقی = نادرست`	در نتیجه‌ها برگردانده می‌شود.
قابل جستجو	`searchable`	`منطقی = نادرست`	در آن جستجو می‌شود.
قابل مرتب‌سازی	`sortable`	`منطقی = نادرست`	می‌توان بر پایه‌ی آن مرتب کرد.
متمایز	`distinct`	`منطقی = نادرست`	ویژگی متمایز است.
قابل فیلتر	`filterable`	`منطقی = نادرست`	می‌توان روی آن فیلتر کرد.
قاعده رتبه‌بندی	`ranking_rule`	`رشته = ""`	تنظیمات قاعده‌ی رتبه‌بندی آن، به شکل JSON خام.
محلی	`localized`	`رشته = ""`	زبان‌های آن، به شکل JSON خام.
خام	`raw`	`رشته = ""`	کل ورودی فیلد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-CreateIndex.salam

پرسش فیلدها `FieldsQuery`

ساختار پرسش فیلدها

این‌که فهرست فیلدها کدام فیلدها را برگرداند.

نام	انگلیسی	گونه	توضیح
جابجایی	`offset`	`صحیح = -1`	تعداد ردشده‌ها؛ -۱ یعنی فرستاده نشود.
حد	`limit`	`صحیح = -1`	تعداد برگشتی؛ -۱ یعنی فرستاده نشود.
الگوهای ویژگی	`attribute_patterns`	`وکتور<رشته>`	فقط فیلدهای منطبق با این الگوها، مثل `title` یا `*_date`.
فیلتر	`filter`	`رشته = ""`	شرط‌های بیشتر به شکل شیء JSON، مثل `{"filterable": true}`.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-CreateIndex.salam

صفحه فیلد `FieldPage`

ساختار صفحه فیلد

یک صفحه از فیلدها.

نام	انگلیسی	گونه	توضیح
نتیجه‌ها	`results`	`وکتور<فیلد>`	فیلدها.
جابجایی	`offset`	`صحیح۶۴ = 0`	تعداد ردشده‌ها.
حد	`limit`	`صحیح۶۴ = 0`	اندازه‌ی صفحه.
کل	`total`	`صحیح۶۴ = 0`	تعداد فیلدهای منطبق.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-CreateIndex.salam

کلاینت `Client`

ساختار کلاینت

نشانی سرور و کلیدی که به کار می‌رود. یک مقدار ساده است؛ آن را با جدید بسازید و هر جا خواستید به کار ببرید.

نام	انگلیسی	گونه	توضیح
میزبان	`host`	`رشته = ""`	نشانی سرور، مثل `http://127.0.0.1:7700`، بدون اسلش پایانی.
کلید دسترسی	`api_key`	`رشته = ""`	کلید API که به شکل `Authorization: Bearer` فرستاده می‌شود؛ اگر خالی باشد سرآیندی فرستاده نمی‌شود.
عامل	`agent`	`رشته = ""`	متنی که به سرآیند کارخواه افزوده می‌شود، مثل نام برنامه‌ی شما.
مهلت	`timeout_ms`	`صحیح = 0`	اگر پاسخ در این تعداد میلی‌ثانیه نرسد، درخواست با کد `timeout` رها می‌شود؛ ۰ یعنی هر قدر طول بکشد صبر کن.
فراداده	`metadata`	`رشته = ""`	متنی که به عنوان `customMetadata` به هر نوشتن سند پیوست می‌شود و روی کار برمی‌گردد.

db-meilisearch-Client.salam

واردسازی دیتابیس.میلیسرچ

تابع ریشه:
    کارخواه := میلیسرچ.با عامل(میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")، "my-app/1.0")
    ناپایا اشکال := میلیسرچ.خطا {}
    اگر وارونه میلیسرچ.سالم است(کارخواه):
        سرچاپ "Meilisearch is not reachable at " + کارخواه.میزبان
        برگشت
    پایان
    سرچاپ میلیسرچ.سلامت(کارخواه، اشکال)، میلیسرچ.نسخه کلاینت

    نسخه سرور := میلیسرچ.دریافت نسخه(کارخواه، اشکال)
    سرچاپ نسخه سرور.شماره نسخه، نسخه سرور.شناسه کامیت، نسخه سرور.تاریخ کامیت
    آمار کل := میلیسرچ.دریافت آمار(کارخواه، اشکال)
    سرچاپ آمار کل.اندازه پایگاه داده، آمار کل.اندازه به کار رفته، آمار کل.آخرین تغییر، آمار کل.نمایه‌های مجاز

    دامپ := میلیسرچ.ایجاد دامپ(کارخواه، اشکال)
    سرچاپ دامپ.شناسه کار، میلیسرچ.ایجاد اسنپ‌شات(کارخواه، اشکال).وضعیت
    سرچاپ میلیسرچ.دریافت ویژگی‌های آزمایشی(کارخواه، اشکال)
    سرچاپ میلیسرچ.به‌روزرسانی ویژگی‌های آزمایشی(کارخواه، `{"metrics": true}`، اشکال)
    سرچاپ میلیسرچ.دریافت معیارها(کارخواه، اشکال).طول()
    سرچاپ میلیسرچ.دریافت شبکه(کارخواه، اشکال)
    سرچاپ میلیسرچ.به‌روزرسانی شبکه(کارخواه، `{"self": "ms-0"}`، اشکال)
    سرچاپ میلیسرچ.صدور(کارخواه، `{"url": "http://backup:7700", "apiKey": "key"}`، اشکال).نوع

    بدنه := میلیسرچ.درخواست(کارخواه، "GET"، "/indexes?limit=1"، ""، اشکال)
    اگر وارونه میلیسرچ.موفق(اشکال):
        سرچاپ میلیسرچ.متن خطا(اشکال)
        سرچاپ اشکال.وضعیت، اشکال.کد، اشکال.نوع، اشکال.پیام، اشکال.پیوند
        برگشت
    پایان
    سرچاپ بدنه
    سرچاپ میلیسرچ.درخواست با نوع(کارخواه، "POST"، "/indexes/movies/documents"، "application/x-ndjson"، "{\"id\": 1}\n"، اشکال)
    برگه := میلیسرچ.صفحه {}
    سرچاپ برگه.نتیجه‌ها.طول()، برگه.جابجایی، برگه.حد، برگه.کل، برگه.از، برگه.بعدی، کارخواه.کلید دسترسی.طول() بزرگتر 0، کارخواه.عامل

    سریع := میلیسرچ.با مهلت(کارخواه، 2000)
    سرچاپ سریع.مهلت، میلیسرچ.سالم است(سریع)
    برچسب‌خورده := میلیسرچ.با فراداده(کارخواه، "nightly-import")
    سرچاپ برچسب‌خورده.فراداده
    سرچاپ میلیسرچ.تنظیم گزارش خطای استاندارد(کارخواه، "info"، اشکال)
    سرچاپ میلیسرچ.اجرای قالب(کارخواه، `{"template": {"kind": "inlineDocumentTemplate", "inline": "{{doc.title}}"}, "input": {"kind": "inlineDocument", "inline": {"عنوان": "Up"}}}`، اشکال)
    سرچاپ میلیسرچ.کنترل شبکه(کارخواه، `{"origin": {"remoteName": "ms-0", "taskUid": 1}, "message": {"type": "exportNoIndexForRemote", "remote": "ms-1"}}`، اشکال)
پایان

خطا `Error`

ساختار خطا

توضیح خطا. code خالی یعنی فراخوانی موفق بود؛ هر تابع پیش از شروع آن را پاک می‌کند.

نام	انگلیسی	گونه	توضیح
وضعیت	`status`	`صحیح = 0`	وضعیت HTTP؛ اگر به سرور نرسیدیم یا خطا در خود کارخواه بود، ۰ است.
کد	`code`	`رشته = ""`	کد خطای میلی‌سرچ، مثل `index_not_found`، یا کدهای خود کارخواه: `communication_error`، `timeout` و `decode_error`.
نوع	`kind`	`رشته = ""`	نوع خطا: `invalid_request`، `auth`، `internal` و مانند آن.
پیام	`message`	`رشته = ""`	پیام خوانا برای انسان.
پیوند	`link`	`رشته = ""`	پیوند صفحه‌ی مستندات میلی‌سرچ درباره‌ی این خطا.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Client.salam

صفحه `Page`

ساختار صفحه

یک صفحه از سندهای JSON خام، خروجی دریافت سندها.

نام	انگلیسی	گونه	توضیح
نتیجه‌ها	`results`	`وکتور<رشته>`	هر سند به شکل یک متن JSON جدا.
جابجایی	`offset`	`صحیح۶۴ = 0`	تعداد سندهایی که رد شدند.
حد	`limit`	`صحیح۶۴ = 0`	اندازه‌ی صفحه.
کل	`total`	`صحیح۶۴ = 0`	تعداد کل سندهای منطبق.
از	`from`	`صحیح۶۴ = -1`	برای سندها به کار نمی‌رود؛ -۱.
بعدی	`next`	`صحیح۶۴ = -1`	برای سندها به کار نمی‌رود؛ -۱.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Client.salam

کلید `Key`

ساختار کلید

یک کلید API.

نام	انگلیسی	گونه	توضیح
شناسه یکتا	`uid`	`رشته = ""`	شناسه‌ی کلید، یک UUID.
کلید	`key`	`رشته = ""`	مقدار مخفی کلید که فرستاده می‌شود.
نام	`name`	`رشته = ""`	نام آن.
توضیح	`description`	`رشته = ""`	توضیح آن.
کنش‌ها	`actions`	`وکتور<رشته>`	کارهایی که مجاز است، مثل `search` یا `*` برای همه.
نمایه‌های مجاز	`indexes`	`وکتور<رشته>`	نمایه‌هایی که مجاز است؛ `*` برای همه.
زمان انقضا	`expires_at`	`رشته = ""`	زمان از کار افتادن؛ خالی یعنی هرگز.
زمان ساخت	`created_at`	`رشته = ""`	زمان ساخت.
زمان تغییر	`updated_at`	`رشته = ""`	زمان آخرین تغییر.

db-meilisearch-CreateKey.salam

واردسازی دیتابیس.میلیسرچ
واردسازی زمان

تابع ریشه:
    مدیر := میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")
    ناپایا اشکال := میلیسرچ.خطا {}

    ناپایا مسیرها := میلیسرچ.درخواست کلید { نام = "Front end search"، توضیح = "Used by the web app"، زمان انقضا = "2030-01-01T00:00:00Z"، شناسه یکتا = "" }
    مسیرها.کنش‌ها.بیفزا("search")
    مسیرها.نمایه‌های مجاز.بیفزا("movies")
    کلید ساخته‌شده := میلیسرچ.ایجاد کلید(مدیر، مسیرها، اشکال)
    اگر وارونه میلیسرچ.موفق(اشکال):
        سرچاپ میلیسرچ.متن خطا(اشکال)
        برگشت
    پایان
    سرچاپ کلید ساخته‌شده.شناسه یکتا، کلید ساخته‌شده.کلید، کلید ساخته‌شده.نام، کلید ساخته‌شده.توضیح، کلید ساخته‌شده.زمان انقضا، کلید ساخته‌شده.زمان ساخت، کلید ساخته‌شده.زمان تغییر
    سرچاپ کلید ساخته‌شده.کنش‌ها.طول()، کلید ساخته‌شده.نمایه‌های مجاز.طول()

    سرچاپ میلیسرچ.دریافت کلید(مدیر، کلید ساخته‌شده.شناسه یکتا، اشکال).نام
    صفحه := میلیسرچ.دریافت کلیدها(مدیر، 0، 20، اشکال)
    سرچاپ صفحه.کل، صفحه.جابجایی، صفحه.حد
    هر تک در صفحه.نتیجه‌ها:
        سرچاپ تک.نام
    پایان
    سرچاپ میلیسرچ.به‌روزرسانی کلید(مدیر، کلید ساخته‌شده.شناسه یکتا، "جستجوی وب"، "فقط جستجو، فقط movies"، اشکال).نام

    قاعده‌ها := `{"movies": {"filter": "user_id = 42"}}`
    توکن := میلیسرچ.توکن مستاجر(کلید ساخته‌شده.شناسه یکتا، کلید ساخته‌شده.کلید، قاعده‌ها، زمان.اکنون() + 3600، اشکال)
    کاربر := میلیسرچ.جدید("http://127.0.0.1:7700"، توکن)
    سرچاپ میلیسرچ.پرسش(کاربر، "movies"، ""، اشکال).نتایج.طول()

    سرچاپ میلیسرچ.حذف کلید(مدیر، کلید ساخته‌شده.شناسه یکتا، اشکال)
پایان

درخواست کلید `KeyRequest`

ساختار درخواست کلید

یک کلید API تازه.

نام	انگلیسی	گونه	توضیح
شناسه یکتا	`uid`	`رشته = ""`	یک UUID برای شناسه؛ خالی یعنی سرور انتخاب کند.
نام	`name`	`رشته = ""`	نام آن.
توضیح	`description`	`رشته = ""`	توضیح آن.
کنش‌ها	`actions`	`وکتور<رشته>`	کارهایی که مجاز است.
نمایه‌های مجاز	`indexes`	`وکتور<رشته>`	نمایه‌هایی که مجاز است.
زمان انقضا	`expires_at`	`رشته = ""`	تاریخی به شکل RFC 3339 برای از کار افتادن؛ خالی یعنی هرگز.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-CreateKey.salam

صفحه کلید `KeyPage`

ساختار صفحه کلید

یک صفحه از کلیدها.

نام	انگلیسی	گونه	توضیح
نتیجه‌ها	`results`	`وکتور<کلید>`	کلیدها.
جابجایی	`offset`	`صحیح۶۴ = 0`	تعداد ردشده‌ها.
حد	`limit`	`صحیح۶۴ = 0`	اندازه‌ی صفحه.
کل	`total`	`صحیح۶۴ = 0`	تعداد کل کلیدها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-CreateKey.salam

قاعده جستجو `SearchRule`

ساختار قاعده جستجو

یک قاعده‌ی جستجوی پویا: وقتی شرط‌هایش برقرار باشد، کنش‌هایش سندها را سنجاق یا تقویت می‌کنند.

نام	انگلیسی	گونه	توضیح
شناسه یکتا	`uid`	`رشته = ""`	نام قاعده.
زمان آخرین تغییر	`last_updated_at`	`رشته = ""`	زمان آخرین تغییر.
اولویت	`precedence`	`صحیح۶۴ = -1`	این‌که وقتی چند قاعده منطبق‌اند کدام برنده است؛ اگر تعیین نشده -۱.
فعال	`active`	`منطقی = نادرست`	روشن است.
شرط‌ها	`conditions`	`رشته = ""`	زمان اعمال، به شکل JSON خام: یک بازه‌ی زمانی، واژه‌های پرسش یا مقدارهای فیلتر.
کنش‌ها	`actions`	`رشته = ""`	کاری که می‌کند، به شکل JSON خام: `pin` و `scale`.
خام	`raw`	`رشته = ""`	کل قاعده.

db-meilisearch-UpdateSearchRule.salam

واردسازی دیتابیس.میلیسرچ

تابع ریشه:
    کارخواه := میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")
    ناپایا اشکال := میلیسرچ.خطا {}
    میلیسرچ.به‌روزرسانی ویژگی‌های آزمایشی(کارخواه، `{"dynamicSearchRules": true}`، اشکال)

    قاعده := `{"active": true, "precedence": 1, "conditions": {"query": {"words": "sale"}}, "actions": {"pin": [{"شناسه": "42", "position": 0}]}}`
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی قاعده جستجو(کارخواه، "black-friday"، قاعده، اشکال)، اشکال)
    مسیرها := میلیسرچ.دریافت قاعده جستجو(کارخواه، "black-friday"، اشکال)
    سرچاپ مسیرها.شناسه یکتا، مسیرها.فعال، مسیرها.اولویت، مسیرها.زمان آخرین تغییر، مسیرها.شرط‌ها، مسیرها.کنش‌ها، مسیرها.خام.طول()

    صفحه := میلیسرچ.فهرست قاعده‌های جستجو(کارخواه، میلیسرچ.پرسش قاعده جستجو { جابجایی = 0، حد = 20، پرسش = "sale"، فعال = 1 }، اشکال)
    سرچاپ صفحه.کل، صفحه.جابجایی، صفحه.حد
    هر تک در صفحه.نتیجه‌ها:
        سرچاپ تک.شناسه یکتا
    پایان
    میلیسرچ.انتظار(کارخواه، میلیسرچ.حذف قاعده جستجو(کارخواه، "black-friday"، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.حذف همه قاعده‌های جستجو(کارخواه، اشکال)، اشکال)
پایان

پرسش قاعده جستجو `SearchRuleQuery`

ساختار پرسش قاعده جستجو

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

نام	انگلیسی	گونه	توضیح
جابجایی	`offset`	`صحیح = -1`	تعداد ردشده‌ها؛ -۱ یعنی فرستاده نشود.
حد	`limit`	`صحیح = -1`	تعداد برگشتی؛ -۱ یعنی فرستاده نشود.
پرسش	`query`	`رشته = ""`	فقط قاعده‌های منطبق با این متن.
فعال	`active`	`صحیح = -1`	۱ فقط قاعده‌های روشن، ۰ فقط خاموش، -۱ هر دو.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-UpdateSearchRule.salam

صفحه قاعده جستجو `SearchRulePage`

ساختار صفحه قاعده جستجو

یک صفحه از قاعده‌ها.

نام	انگلیسی	گونه	توضیح
نتیجه‌ها	`results`	`وکتور<قاعده جستجو>`	قاعده‌ها.
جابجایی	`offset`	`صحیح۶۴ = 0`	تعداد ردشده‌ها.
حد	`limit`	`صحیح۶۴ = 0`	اندازه‌ی صفحه.
کل	`total`	`صحیح۶۴ = 0`	تعداد قاعده‌های منطبق.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-UpdateSearchRule.salam

نسخه `Version`

ساختار نسخه

نسخه‌ی سرور.

نام	انگلیسی	گونه	توضیح
شماره نسخه	`pkg_version`	`رشته = ""`	شماره‌ی نسخه، مثل `1.15.2`.
شناسه کامیت	`commit_sha`	`رشته = ""`	کامیتی که سرور از آن ساخته شده است.
تاریخ کامیت	`commit_date`	`رشته = ""`	تاریخ آن کامیت.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Client.salam

آمار `Stats`

ساختار آمار

آمار کل سرور.

نام	انگلیسی	گونه	توضیح
اندازه پایگاه داده	`database_size`	`صحیح۶۴ = 0`	اندازه‌ی پایگاه داده روی دیسک، به بایت.
اندازه به کار رفته	`used_database_size`	`صحیح۶۴ = 0`	بایت‌هایی که واقعا به کار رفته‌اند.
آخرین تغییر	`last_update`	`رشته = ""`	زمان آخرین تغییر.
نمایه‌های مجاز	`indexes`	`رشته = ""`	آمار هر نمایه، به شکل JSON خام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Client.salam

صفحه فضای گفتگو `ChatWorkspacePage`

ساختار صفحه فضای گفتگو

یک صفحه از نام فضاهای گفتگو.

نام	انگلیسی	گونه	توضیح
نتیجه‌ها	`results`	`وکتور<رشته>`	نام فضاها.
جابجایی	`offset`	`صحیح۶۴ = 0`	تعداد ردشده‌ها.
حد	`limit`	`صحیح۶۴ = 0`	اندازه‌ی صفحه.
کل	`total`	`صحیح۶۴ = 0`	تعداد کل فضاها.

db-meilisearch-ChatCompletion.salam

واردسازی دیتابیس.میلیسرچ

تابع ریشه:
    کارخواه := میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")
    ناپایا اشکال := میلیسرچ.خطا {}
    میلیسرچ.به‌روزرسانی ویژگی‌های آزمایشی(کارخواه، `{"chatCompletions": true}`، اشکال)

    تنظیمات := `{"source": "openAi", "apiKey": "sk-your-key", "prompts": {"system": "You answer questions about our movie catalog."}}`
    سرچاپ میلیسرچ.به‌روزرسانی تنظیمات گفتگو(کارخواه، "support"، تنظیمات، اشکال)
    سرچاپ میلیسرچ.دریافت تنظیمات گفتگو(کارخواه، "support"، اشکال)
    فضاها := میلیسرچ.فهرست فضاهای گفتگو(کارخواه، 0، 20، اشکال)
    سرچاپ فضاها.کل، فضاها.جابجایی، فضاها.حد
    هر فضا در فضاها.نتیجه‌ها:
        سرچاپ فضا، میلیسرچ.دریافت فضای گفتگو(کارخواه، فضا، اشکال)
    پایان

    درخواست گفتگو := `{"model": "gpt-4o-mini", "stream": true, "messages": [{"role": "user", "content": "Which space movies do you have?"}]}`
    سرچاپ میلیسرچ.تکمیل گفتگو(کارخواه، "support"، درخواست گفتگو، اشکال)
    اگر وارونه میلیسرچ.موفق(اشکال):
        سرچاپ میلیسرچ.متن خطا(اشکال)
    پایان
    سرچاپ میلیسرچ.بازنشانی تنظیمات گفتگو(کارخواه، "support"، اشکال)
    سرچاپ میلیسرچ.حذف فضای گفتگو(کارخواه، "support"، اشکال)
پایان

پرسش سند `DocumentsQuery`

ساختار پرسش سند

این‌که دریافت سندها کدام سندها را برگرداند. مقدار صفر و فهرست خالی فرستاده نمی‌شوند.

نام	انگلیسی	گونه	توضیح
جابجایی	`offset`	`صحیح = 0`	تعداد سندهایی که رد می‌شوند.
حد	`limit`	`صحیح = 0`	تعداد سندهایی که برگردانده می‌شوند.
فیلدها	`fields`	`وکتور<رشته>`	فقط این فیلدها برگردانده شوند.
فیلتر	`filter`	`رشته = ""`	یک عبارت فیلتر، یا آرایه‌ی JSON از آن‌ها؛ فیلدها باید قابل فیلتر باشند.
شناسه‌ها	`ids`	`وکتور<رشته>`	فقط این سندها برگردانده شوند.
مرتب‌سازی	`sort`	`وکتور<رشته>`	قاعده‌های مرتب‌سازی مثل `year:desc`؛ فیلدها باید قابل مرتب‌سازی باشند.
بازیابی بردارها	`retrieve_vectors`	`منطقی = نادرست`	بردارهای ذخیره‌شده هم برگردانده شوند.
استفاده از شبکه	`use_network`	`منطقی = نادرست`	از همه‌ی سرورهای یک شبکه‌ی چندتکه پرسیده شود.

db-meilisearch-AddDocuments.salam

واردسازی دیتابیس.میلیسرچ

ساختار فیلم:
    همگانی شناسه: صحیح = 0
    همگانی عنوان: رشته = ""
    همگانی سال: صحیح = 0
پایان

تابع ریشه:
    کارخواه := میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")
    ناپایا اشکال := میلیسرچ.خطا {}

    سندها := `[{"شناسه": 1, "عنوان": "Carol", "سال": 2015}, {"شناسه": 2, "عنوان": "Moana", "سال": 2016}]`
    میلیسرچ.انتظار(کارخواه، میلیسرچ.افزودن سندها(کارخواه، "movies"، سندها، "شناسه"، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی سندها(کارخواه، "movies"، `[{"شناسه": 2, "سال": 2017}]`، ""، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.افزودن سندهای ان‌دی‌جیسون(کارخواه، "movies"، "{\"id\": 3, \"title\": \"Heat\"}\n"، ""، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی سندهای ان‌دی‌جیسون(کارخواه، "movies"، "{\"id\": 3, \"year\": 1995}\n"، ""، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.افزودن سندهای سی‌اس‌وی(کارخواه، "movies"، "id:number;title\n4;Up\n"، ""، ";"، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی سندهای سی‌اس‌وی(کارخواه، "movies"، "id:number,year:number\n4,2009\n"، ""، ""، اشکال)، اشکال)

    ناپایا نوع‌دار := وکتور {} برگردان وکتور<فیلم>
    نوع‌دار.بیفزا(فیلم { شناسه = 5، عنوان = "Alien"، سال = 1979 })
    میلیسرچ.انتظار(کارخواه، میلیسرچ.افزودن سندهای نوع(کارخواه، "movies"، نوع‌دار، "شناسه"، اشکال)، اشکال)

    ناپایا انبوه := وکتور {} برگردان وکتور<رشته>
    تکرار 2500 در شماره:
        انبوه.بیفزا(`{"شناسه": ` + (100 + شماره) + `, "عنوان": "Movie ` + شماره + `"}`)
    پایان
    کارها := میلیسرچ.افزودن سندها در دسته‌ها(کارخواه، "movies"، انبوه، 1000، "شناسه"، اشکال)
    هر رسیدی در کارها:
        میلیسرچ.انتظار(کارخواه، رسیدی، اشکال)
    پایان

    ناپایا فیلدها := وکتور {} برگردان وکتور<رشته>
    فیلدها.بیفزا("عنوان")
    سرچاپ میلیسرچ.دریافت سند(کارخواه، "movies"، "1"، فیلدها، اشکال)
    ناپایا نمونه := فیلم {}
    اگر میلیسرچ.دریافت سند به نوع(کارخواه، "movies"، "2"، نمونه، اشکال):
        سرچاپ نمونه.عنوان، نمونه.سال
    پایان

    ناپایا پرسش := میلیسرچ.پرسش سند { حد = 10، فیلتر = "year > 2000"، بازیابی بردارها = نادرست }
    پرسش.فیلدها.بیفزا("شناسه")
    پرسش.فیلدها.بیفزا("عنوان")
    پرسش.مرتب‌سازی.بیفزا("سال:desc")
    پرسش.شناسه‌ها.بیفزا("1")
    پرسش.شناسه‌ها.بیفزا("2")
    صفحه := میلیسرچ.دریافت سندها(کارخواه، "movies"، میلیسرچ.پرسش سند { جابجایی = 0، حد = 20 }، اشکال)
    ناپایا فیلم‌ها := وکتور {} برگردان وکتور<فیلم>
    اگر میلیسرچ.سندها به نوع(صفحه، فیلم‌ها، اشکال):
        سرچاپ فیلم‌ها.طول()، صفحه.کل
    پایان
    سرچاپ میلیسرچ.دریافت سندها(کارخواه، "movies"، پرسش، اشکال).نتیجه‌ها.طول()

    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی سندها با اسکریپت(کارخواه، "movies"، "doc.title = doc.title.to_upper()"، "id < 10"، ""، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.حذف سند(کارخواه، "movies"، "5"، اشکال)، اشکال)
    ناپایا شناسه‌ها := وکتور {} برگردان وکتور<رشته>
    شناسه‌ها.بیفزا("3")
    شناسه‌ها.بیفزا("4")
    میلیسرچ.انتظار(کارخواه، میلیسرچ.حذف سندها(کارخواه، "movies"، شناسه‌ها، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.حذف سندها با فیلتر(کارخواه، "movies"، "id >= 100"، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.حذف همه سندها(کارخواه، "movies"، اشکال)، اشکال)
    سرچاپ میلیسرچ.متن خطا(اشکال)

    برچسب‌خورده := میلیسرچ.با فراداده(کارخواه، "import-2026-10-16")
    گزینه‌ها := میلیسرچ.گزینه‌های سند { نوع محتوا = "application/x-ndjson"، ادغام = درست، کلید اصلی = "شناسه"، جداکننده ستون = ""، بدون ساخت = درست }
    میلیسرچ.انتظار(کارخواه، میلیسرچ.افزودن سندها با گزینه(برچسب‌خورده، "movies"، "{\"id\": 1, \"year\": 2016}\n"، گزینه‌ها، اشکال)، اشکال)
    سرچاپ میلیسرچ.دریافت سند با گزینه(کارخواه، "movies"، "1"، میلیسرچ.پرسش سند { بازیابی بردارها = درست، استفاده از شبکه = نادرست }، اشکال)
پایان

گزینه‌های سند `DocumentOptions`

ساختار گزینه‌های سند

این‌که افزودن سندها با گزینه سندها را چگونه بفرستد.

نام	انگلیسی	گونه	توضیح
نوع محتوا	`content_type`	`رشته = ""`	`application/json` (پیش‌فرض)، `application/x-ndjson` یا `text/csv`.
ادغام	`update`	`منطقی = نادرست`	به جای جایگزینی، با سندهای موجود ادغام شود.
کلید اصلی	`primary_key`	`رشته = ""`	کلید اصلی، اگر نمایه هنوز آن را ندارد.
جداکننده ستون	`csv_delimiter`	`رشته = ""`	جداکننده‌ی CSV؛ خالی یعنی ویرگول.
بدون ساخت	`skip_creation`	`منطقی = نادرست`	فقط سندهای موجود تغییر کنند؛ شناسه‌های تازه نادیده گرفته می‌شوند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-AddDocuments.salam

پایاها و متغیرها

تطبیق آخر `MATCH_LAST`

پایا تطبیق آخر: رشته = "last"

راهبرد تطبیق: واژه‌های پرسش را از آخر کنار بگذار تا سند کافی پیدا شود. پیش‌فرض.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Search.salam

تطبیق همه `MATCH_ALL`

پایا تطبیق همه: رشته = "all"

راهبرد تطبیق: همه‌ی واژه‌های پرسش باید پیدا شوند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Search.salam

تطبیق فراوانی `MATCH_FREQUENCY`

پایا تطبیق فراوانی: رشته = "frequency"

راهبرد تطبیق: پرتکرارترین واژه‌ها اول کنار گذاشته شوند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Search.salam

وضعیت در صف `STATUS_ENQUEUED`

پایا وضعیت در صف: رشته = "enqueued"

وضعیت کار: در صف انتظار.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

وضعیت در حال پردازش `STATUS_PROCESSING`

پایا وضعیت در حال پردازش: رشته = "processing"

وضعیت کار: در حال اجرا.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

وضعیت موفق `STATUS_SUCCEEDED`

پایا وضعیت موفق: رشته = "succeeded"

وضعیت کار: انجام شده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

وضعیت ناموفق `STATUS_FAILED`

پایا وضعیت ناموفق: رشته = "failed"

وضعیت کار: ناموفق؛ خطای آن را ببینید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

وضعیت لغو شده `STATUS_CANCELED`

پایا وضعیت لغو شده: رشته = "canceled"

وضعیت کار: لغو شده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

نسخه کلاینت `VERSION`

پایا نسخه کلاینت: رشته = "1.0.0"

نسخه‌ی این کارخواه که در سرآیند X-Meilisearch-Client به سرور فرستاده می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Client.salam

تابع‌ها

جستجو `Search`

تابع جستجو(c: کلاینت، uid: رشته، r: درخواست جستجو، err &: خطا): نتیجه جستجو

در یک نمایه جستجو می‌کند. در صورت خطا نتیجه خالی است و خطا پر می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Search.salam

پرسش `Query`

تابع پرسش(c: کلاینت، uid: رشته، q: رشته، err &: خطا): نتیجه جستجو

در یک نمایه چند واژه را با گزینه‌های پیش‌فرض جستجو می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Search.salam

نتایج به نوع `HitsAs`

تابع نتایج به نوع<T>(r: نتیجه جستجو، out &: وکتور<T>، err &: خطا): منطقی

همه‌ی نتیجه‌ها را درون ساختارهای سلام می‌خواند؛ فیلدهایی مثل _formatted که ساختار ندارد نادیده گرفته می‌شوند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Search.salam

جستجوی چندگانه `MultiSearch`

تابع جستجوی چندگانه(c: کلاینت، queries: وکتور<پرسش چندگانه>، err &: خطا): وکتور<نتیجه جستجو>

چند جستجو را در یک درخواست اجرا می‌کند و برای هر کدام یک نتیجه برمی‌گرداند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Search.salam

جستجوی فدرال `FederatedSearch`

تابع جستجوی فدرال(c: کلاینت، queries: وکتور<پرسش چندگانه>، f: فدراسیون، err &: خطا): نتیجه جستجو

چند جستجو را اجرا می‌کند و نتیجه‌هایشان را در یک فهرست رتبه‌بندی‌شده ادغام می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Search.salam

جستجوی وجه `FacetSearch`

تابع جستجوی وجه(c: کلاینت، uid: رشته، r: درخواست جستجوی وجه، err &: خطا): نتیجه جستجوی وجه

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

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Search.salam

سندهای مشابه `SimilarDocuments`

تابع سندهای مشابه(c: کلاینت، uid: رشته، r: درخواست مشابه، err &: خطا): نتیجه جستجو

سندهای شبیه یک سند مشخص؛ نمایه باید جاساز داشته باشد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Search.salam

فهرست وب هوک‌ها `ListWebhooks`

تابع فهرست وب هوک‌ها(c: کلاینت، err &: خطا): وکتور<وب هوک>

همه‌ی وب‌هوک‌ها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-CreateWebhook.salam

ایجاد وب هوک `CreateWebhook`

تابع ایجاد وب هوک(c: کلاینت، url: رشته، headers: رشته، err &: خطا): وب هوک

یک وب‌هوک می‌افزاید؛ سرآیندها یک شیء JSON یا خالی است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-CreateWebhook.salam

دریافت وب هوک `GetWebhook`

تابع دریافت وب هوک(c: کلاینت، uuid: رشته، err &: خطا): وب هوک

یک وب‌هوک.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-CreateWebhook.salam

به‌روزرسانی وب هوک `UpdateWebhook`

تابع به‌روزرسانی وب هوک(c: کلاینت، uuid: رشته، url: رشته، headers: رشته، err &: خطا): وب هوک

نشانی یا سرآیندهای یک وب‌هوک را تغییر می‌دهد؛ مقدارهای خالی دست نمی‌خورند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-CreateWebhook.salam

حذف وب هوک `DeleteWebhook`

تابع حذف وب هوک(c: کلاینت، uuid: رشته، err &: خطا): منطقی

یک وب‌هوک را حذف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-CreateWebhook.salam

دریافت کار `GetTask`

تابع دریافت کار(c: کلاینت، uid: صحیح۶۴، err &: خطا): کار

یک کار.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

دریافت کارها `GetTasks`

تابع دریافت کارها(c: کلاینت، q: پرسش کار، err &: خطا): صفحه کار

یک صفحه از کارها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

انتظار برای کار `WaitForTask`

تابع انتظار برای کار(c: کلاینت، uid: صحیح۶۴، timeout_ms: صحیح، interval_ms: صحیح، err &: خطا): کار

هر چند میلی‌ثانیه وضعیت کار را می‌پرسد تا تمام شود. کار ناموفق خطای خودش را در خطا می‌گذارد؛ گذشتن از مهلت کد timeout می‌دهد. مهلت ۰ یعنی انتظار بی‌پایان.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

انتظار `Wait`

تابع انتظار(c: کلاینت، info: اطلاعات کار، err &: خطا): کار

تا پنج ثانیه منتظر کار یک نوشتن می‌ماند؛ اگر خود نوشتن ناموفق بوده کاری نمی‌کند، پس می‌توانید آن را پشت سر هم به کار ببرید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

لغو کارها `CancelTasks`

تابع لغو کارها(c: کلاینت، q: پرسش کار، err &: خطا): اطلاعات کار

کارهای منطبقی را که در صف یا در حال اجرا هستند لغو می‌کند؛ دست کم یک فیلتر لازم است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

حذف کارها `DeleteTasks`

تابع حذف کارها(c: کلاینت، q: پرسش کار، err &: خطا): اطلاعات کار

کارهای تمام‌شده را از تاریخچه حذف می‌کند؛ دست کم یک فیلتر لازم است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

دریافت دسته `GetBatch`

تابع دریافت دسته(c: کلاینت، uid: صحیح۶۴، err &: خطا): دسته

یک دسته.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

دریافت دسته‌ها `GetBatches`

تابع دریافت دسته‌ها(c: کلاینت، q: پرسش کار، err &: خطا): صفحه دسته

یک صفحه از دسته‌ها، با همان فیلترهای کارها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

دریافت سندهای کار `GetTaskDocuments`

تابع دریافت سندهای کار(c: کلاینت، uid: صحیح۶۴، err &: خطا): رشته

سندهایی که یک کار در صف یا در حال اجرا می‌افزاید، به شکل NDJSON؛ کار تمام‌شده task_file_not_found می‌دهد. ویژگی getTaskDocumentsRoute باید روشن باشد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

فشرده‌سازی صف کارها `CompactTasks`

تابع فشرده‌سازی صف کارها(c: کلاینت، err &: خطا): فشرده‌سازی کارها

صف کارها را روی دیسک کوچک می‌کند. سرور تا وقتی دوباره راه‌اندازی نشود نوشتن را نمی‌پذیرد، همان‌طور که action_required می‌گوید. ویژگی taskQueueCompactionRoute باید روشن باشد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-GetTasks.salam

دریافت تنظیمات `GetSettings`

تابع دریافت تنظیمات(c: کلاینت، uid: رشته، err &: خطا): رشته

همه‌ی تنظیمات یک نمایه، به شکل JSON خام.

db-meilisearch-UpdateSettings.salam

واردسازی دیتابیس.میلیسرچ

تابع نمایش(موارد: وکتور<رشته>):
    هر سرور در موارد:
        چاپ سرور + " "
    پایان
    سرچاپ ""
پایان

تابع ریشه:
    کارخواه := میلیسرچ.جدید("http://127.0.0.1:7700"، "masterKey")
    ناپایا اشکال := میلیسرچ.خطا {}
    سرچاپ میلیسرچ.دریافت تنظیمات(کارخواه، "movies"، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی تنظیمات(کارخواه، "movies"، `{"rankingRules": ["words", "typo"], "stopWords": ["the"]}`، اشکال)، اشکال)
    سرچاپ میلیسرچ.دریافت تنظیم(کارخواه، "movies"، "ranking-rules"، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی تنظیم(کارخواه، "movies"، "pagination"، `{"maxTotalHits": 5000}`، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی تنظیم(کارخواه، "movies"، "pagination"، اشکال)، اشکال)

    ناپایا قاعده‌های رتبه‌بندی := وکتور {} برگردان وکتور<رشته>
    قاعده‌های رتبه‌بندی.بیفزا("words")
    قاعده‌های رتبه‌بندی.بیفزا("typo")
    قاعده‌های رتبه‌بندی.بیفزا("proximity")
    قاعده‌های رتبه‌بندی.بیفزا("attribute")
    قاعده‌های رتبه‌بندی.بیفزا("sort")
    قاعده‌های رتبه‌بندی.بیفزا("exactness")
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی قواعد رتبه‌بندی(کارخواه، "movies"، قاعده‌های رتبه‌بندی، اشکال)، اشکال)
    نمایش(میلیسرچ.دریافت قواعد رتبه‌بندی(کارخواه، "movies"، اشکال))
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی قواعد رتبه‌بندی(کارخواه، "movies"، اشکال)، اشکال)

    ناپایا ویژگی‌های قابل جستجو := وکتور {} برگردان وکتور<رشته>
    ویژگی‌های قابل جستجو.بیفزا("عنوان")
    ویژگی‌های قابل جستجو.بیفزا("overview")
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی ویژگی‌های قابل جستجو(کارخواه، "movies"، ویژگی‌های قابل جستجو، اشکال)، اشکال)
    نمایش(میلیسرچ.دریافت ویژگی‌های قابل جستجو(کارخواه، "movies"، اشکال))
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی ویژگی‌های قابل جستجو(کارخواه، "movies"، اشکال)، اشکال)

    ناپایا ویژگی‌های نمایشی := وکتور {} برگردان وکتور<رشته>
    ویژگی‌های نمایشی.بیفزا("*")
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی ویژگی‌های نمایشی(کارخواه، "movies"، ویژگی‌های نمایشی، اشکال)، اشکال)
    نمایش(میلیسرچ.دریافت ویژگی‌های نمایشی(کارخواه، "movies"، اشکال))
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی ویژگی‌های نمایشی(کارخواه، "movies"، اشکال)، اشکال)

    ناپایا ویژگی‌های قابل فیلتر := وکتور {} برگردان وکتور<رشته>
    ویژگی‌های قابل فیلتر.بیفزا("ژانر")
    ویژگی‌های قابل فیلتر.بیفزا("سال")
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی ویژگی‌های قابل فیلتر(کارخواه، "movies"، ویژگی‌های قابل فیلتر، اشکال)، اشکال)
    نمایش(میلیسرچ.دریافت ویژگی‌های قابل فیلتر(کارخواه، "movies"، اشکال))
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی ویژگی‌های قابل فیلتر(کارخواه، "movies"، اشکال)، اشکال)

    ناپایا ویژگی‌های قابل مرتب‌سازی := وکتور {} برگردان وکتور<رشته>
    ویژگی‌های قابل مرتب‌سازی.بیفزا("سال")
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی ویژگی‌های قابل مرتب‌سازی(کارخواه، "movies"، ویژگی‌های قابل مرتب‌سازی، اشکال)، اشکال)
    نمایش(میلیسرچ.دریافت ویژگی‌های قابل مرتب‌سازی(کارخواه، "movies"، اشکال))
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی ویژگی‌های قابل مرتب‌سازی(کارخواه، "movies"، اشکال)، اشکال)

    ناپایا کلمات توقف := وکتور {} برگردان وکتور<رشته>
    کلمات توقف.بیفزا("the")
    کلمات توقف.بیفزا("a")
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی کلمات توقف(کارخواه، "movies"، کلمات توقف، اشکال)، اشکال)
    نمایش(میلیسرچ.دریافت کلمات توقف(کارخواه، "movies"، اشکال))
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی کلمات توقف(کارخواه، "movies"، اشکال)، اشکال)

    ناپایا واژه‌نامه := وکتور {} برگردان وکتور<رشته>
    واژه‌نامه.بیفزا("J. R. R.")
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی واژه‌نامه(کارخواه، "movies"، واژه‌نامه، اشکال)، اشکال)
    نمایش(میلیسرچ.دریافت واژه‌نامه(کارخواه، "movies"، اشکال))
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی واژه‌نامه(کارخواه، "movies"، اشکال)، اشکال)

    ناپایا نشانه‌های جداکننده := وکتور {} برگردان وکتور<رشته>
    نشانه‌های جداکننده.بیفزا("|")
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی نشانه‌های جداکننده(کارخواه، "movies"، نشانه‌های جداکننده، اشکال)، اشکال)
    نمایش(میلیسرچ.دریافت نشانه‌های جداکننده(کارخواه، "movies"، اشکال))
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی نشانه‌های جداکننده(کارخواه، "movies"، اشکال)، اشکال)

    ناپایا نشانه‌های غیر جداکننده := وکتور {} برگردان وکتور<رشته>
    نشانه‌های غیر جداکننده.بیفزا("@")
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی نشانه‌های غیر جداکننده(کارخواه، "movies"، نشانه‌های غیر جداکننده، اشکال)، اشکال)
    نمایش(میلیسرچ.دریافت نشانه‌های غیر جداکننده(کارخواه، "movies"، اشکال))
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی نشانه‌های غیر جداکننده(کارخواه، "movies"، اشکال)، اشکال)

    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی ویژگی متمایز(کارخواه، "movies"، "sku"، اشکال)، اشکال)
    سرچاپ میلیسرچ.دریافت ویژگی متمایز(کارخواه، "movies"، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی ویژگی متمایز(کارخواه، "movies"، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی دقت مجاورت(کارخواه، "movies"، "byAttribute"، اشکال)، اشکال)
    سرچاپ میلیسرچ.دریافت دقت مجاورت(کارخواه، "movies"، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی دقت مجاورت(کارخواه، "movies"، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی جستجوی پیشوندی(کارخواه، "movies"، "indexingTime"، اشکال)، اشکال)
    سرچاپ میلیسرچ.دریافت جستجوی پیشوندی(کارخواه، "movies"، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی جستجوی پیشوندی(کارخواه، "movies"، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی مهلت جستجو(کارخواه، "movies"، 150، اشکال)، اشکال)
    سرچاپ میلیسرچ.دریافت مهلت جستجو(کارخواه، "movies"، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی مهلت جستجو(کارخواه، "movies"، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی جستجوی وجه(کارخواه، "movies"، درست، اشکال)، اشکال)
    سرچاپ میلیسرچ.دریافت جستجوی وجه(کارخواه، "movies"، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی جستجوی وجه(کارخواه، "movies"، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی مترادف‌ها(کارخواه، "movies"، `{"logan": ["wolverine"], "wolverine": ["logan"]}`، اشکال)، اشکال)
    سرچاپ میلیسرچ.دریافت مترادف‌ها(کارخواه، "movies"، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی مترادف‌ها(کارخواه، "movies"، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی تحمل غلط املایی(کارخواه، "movies"، `{"minWordSizeForTypos": {"oneTypo": 4, "twoTypos": 10}}`، اشکال)، اشکال)
    سرچاپ میلیسرچ.دریافت تحمل غلط املایی(کارخواه، "movies"، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی تحمل غلط املایی(کارخواه، "movies"، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی صفحه‌بندی(کارخواه، "movies"، `{"maxTotalHits": 5000}`، اشکال)، اشکال)
    سرچاپ میلیسرچ.دریافت صفحه‌بندی(کارخواه، "movies"، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی صفحه‌بندی(کارخواه، "movies"، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی وجه‌بندی(کارخواه، "movies"، `{"maxValuesPerFacet": 200}`، اشکال)، اشکال)
    سرچاپ میلیسرچ.دریافت وجه‌بندی(کارخواه، "movies"، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی وجه‌بندی(کارخواه، "movies"، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی جاسازها(کارخواه، "movies"، `{"default": {"source": "userProvided", "dimensions": 3}}`، اشکال)، اشکال)
    سرچاپ میلیسرچ.دریافت جاسازها(کارخواه، "movies"، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی جاسازها(کارخواه، "movies"، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی ویژگی‌های محلی(کارخواه، "movies"، `[{"attributePatterns": ["*_fa"], "locales": ["fas"]}]`، اشکال)، اشکال)
    سرچاپ میلیسرچ.دریافت ویژگی‌های محلی(کارخواه، "movies"، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی ویژگی‌های محلی(کارخواه، "movies"، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی گفتگو(کارخواه، "movies"، `{"description": "A movie catalog"}`، اشکال)، اشکال)
    سرچاپ میلیسرچ.دریافت گفتگو(کارخواه، "movies"، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی گفتگو(کارخواه، "movies"، اشکال)، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی تنظیمات(کارخواه، "movies"، اشکال)، اشکال)
    سرچاپ میلیسرچ.متن خطا(اشکال)

    میلیسرچ.انتظار(کارخواه، میلیسرچ.به‌روزرسانی کلیدهای خارجی(کارخواه، "movies"، `[{"foreignIndexUid": "actors", "fieldName": "actor_ids"}]`، اشکال)، اشکال)
    سرچاپ میلیسرچ.دریافت کلیدهای خارجی(کارخواه، "movies"، اشکال)
    میلیسرچ.انتظار(کارخواه، میلیسرچ.بازنشانی کلیدهای خارجی(کارخواه، "movies"، اشکال)، اشکال)
پایان