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

میلی‌سرچ db/meilisearch

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

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

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

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

گونه‌ها

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

ساختار درخواست جستجو
هر چیزی که یک جستجو می‌تواند بخواهد. فقط فیلدهایی که تعیین کنید فرستاده می‌شوند: متن و فهرست خالی، عدد -۱ و پرچم نادرست فرستاده نمی‌شوند.
نامانگلیسیگونهتوضیح
queryqueryرشته = ""واژه‌های جستجو؛ خالی یعنی همه‌ی سندها.
offsetoffsetصحیح = -1تعداد نتیجه‌هایی که رد می‌شوند.
limitlimitصحیح = -1تعداد نتیجه‌هایی که برگردانده می‌شوند؛ پیش‌فرض ۲۰.
pagepageصحیح = -1شماره‌ی صفحه، برای صفحه‌بندی شماره‌دار با تعداد دقیق.
hits_per_pagehits_per_pageصحیح = -1تعداد نتیجه‌ها در هر صفحه‌ی شماره‌دار.
filterfilterرشته = ""یک عبارت فیلتر مثل year > 2000 AND genre = Drama، یا آرایه‌ی JSON از آن‌ها.
facetsfacetsوکتور<رشته>مقدارهای این فیلدها را میان نتیجه‌ها بشمار.
attributes_to_retrieveattributes_to_retrieveوکتور<رشته>فقط این فیلدها برگردانده شوند.
attributes_to_cropattributes_to_cropوکتور<رشته>این فیلدها پیرامون واژه‌های پیداشده بریده شوند.
crop_lengthcrop_lengthصحیح = -1تعداد واژه‌هایی که فیلد بریده‌شده نگه می‌دارد.
crop_markercrop_markerرشته = ""متنی که جای بریدن را نشان می‌دهد.
attributes_to_highlightattributes_to_highlightوکتور<رشته>واژه‌های پیداشده در این فیلدها میان برچسب قرار گیرند.
highlight_pre_taghighlight_pre_tagرشته = ""برچسب پیش از واژه‌ی پیداشده؛ پیش‌فرض <em>.
highlight_post_taghighlight_post_tagرشته = ""برچسب پس از واژه‌ی پیداشده.
show_matches_positionshow_matches_positionمنطقی = نادرستجای هر واژه‌ی پیداشده برگردانده شود.
sortsortوکتور<رشته>قاعده‌های مرتب‌سازی مثل year:desc.
matching_strategymatching_strategyرشته = ""یکی از مقدارهای تطبیق.
show_ranking_scoreshow_ranking_scoreمنطقی = نادرستامتیاز ربط هر نتیجه برگردانده شود.
show_ranking_score_detailsshow_ranking_score_detailsمنطقی = نادرستجزئیات ساخت امتیاز برگردانده شود.
ranking_score_thresholdranking_score_thresholdاعشار۶۴ = -1نتیجه‌های با امتیاز کمتر از این، از ۰ تا ۱، کنار گذاشته شوند.
attributes_to_search_onattributes_to_search_onوکتور<رشته>فقط در این فیلدها جستجو شود.
distinctdistinctرشته = ""برای هر مقدار این فیلد حداکثر یک نتیجه برگردانده شود.
localeslocalesوکتور<رشته>زبان‌های پرسش، مثل fas.
vectorvectorوکتور<اعشار۶۴>جستجو با این بردار.
hybrid_embedderhybrid_embedderرشته = ""جاسازِ جستجوی هوشمند؛ تعیین آن جستجوی ترکیبی را روشن می‌کند.
hybrid_semantic_ratiohybrid_semantic_ratioاعشار۶۴ = -1میزان برتری معنا بر واژه‌ها، از ۰ تا ۱.
retrieve_vectorsretrieve_vectorsمنطقی = نادرستبردارهای ذخیره‌شده هم برگردانده شوند.
mediamediaرشته = ""رسانه‌ی JSON خام برای جستجوی چندرسانه‌ای، مثل یک تصویر.
extraextraرشته = ""یک شیء JSON خام که فیلدهایش به درخواست افزوده می‌شوند، برای پارامترهایی که این ساختار هنوز ندارد.
db-meilisearch-Search.salam
واردسازی دیتابیس.میلیسرچ

ساختار Movie:
    همگانی id: صحیح = 0
    همگانی title: رشته = ""
پایان

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

    quick := میلیسرچ.پرسش(ک، "movies"، "botman"، خ)
    سرچاپ quick.query، quick.estimated_total_hits، quick.processing_time_ms

    ناپایا r := میلیسرچ.درخواست جستجو { query = "space"، limit = 10، offset = 0، filter = "year > 2000 AND genre = Drama" }
    r.facets.بیفزا("genre")
    r.sort.بیفزا("year:desc")
    r.attributes_to_retrieve.بیفزا("id")
    r.attributes_to_retrieve.بیفزا("title")
    r.attributes_to_highlight.بیفزا("title")
    r.highlight_pre_tag = "<mark>"
    r.highlight_post_tag = "</mark>"
    r.attributes_to_crop.بیفزا("overview")
    r.crop_length = 20
    r.crop_marker = "..."
    r.matching_strategy = میلیسرچ.تطبیق همه
    r.show_ranking_score = درست
    r.show_ranking_score_details = نادرست
    r.show_matches_position = نادرست
    r.ranking_score_threshold = 0.2
    r.attributes_to_search_on.بیفزا("title")
    r.locales.بیفزا("eng")
    r.distinct = "studio"
    نتیجه := میلیسرچ.جستجو(ک، "movies"، r، خ)
    اگر وارونه میلیسرچ.موفق(خ):
        سرچاپ میلیسرچ.متن خطا(خ)
        برگشت
    پایان
    سرچاپ نتیجه.index_uid، نتیجه.offset، نتیجه.limit، نتیجه.facet_distribution، نتیجه.facet_stats، نتیجه.raw.طول()
    هر hit در نتیجه.hits:
        سرچاپ hit
    پایان
    ناپایا movies := وکتور {} برگردان وکتور<Movie>
    اگر میلیسرچ.نتایج به نوع(نتیجه، movies، خ):
        سرچاپ movies.طول()
    پایان

    pages := میلیسرچ.جستجو(ک، "movies"، میلیسرچ.درخواست جستجو { query = "space"، page = 2، hits_per_page = 20 }، خ)
    سرچاپ pages.page، pages.hits_per_page، pages.total_hits، pages.total_pages

    ناپایا hybrid := میلیسرچ.درخواست جستجو { query = "a sad robot"، hybrid_embedder = "default"، hybrid_semantic_ratio = 0.7، retrieve_vectors = نادرست، matching_strategy = میلیسرچ.تطبیق آخر }
    hybrid.vector.بیفزا(0.1)
    hybrid.media = `{"image": "https://example.com/robot.png"}`
    hybrid.extra = `{"showPerformanceDetails": true}`
    سرچاپ میلیسرچ.جستجو(ک، "movies"، hybrid، خ).semantic_hit_count، میلیسرچ.تطبیق فراوانی

    ناپایا queries := وکتور {} برگردان وکتور<میلیسرچ.پرسش چندگانه>
    queries.بیفزا(میلیسرچ.پرسش چندگانه { index_uid = "movies"، request = میلیسرچ.درخواست جستجو { query = "moana" } })
    queries.بیفزا(میلیسرچ.پرسش چندگانه { index_uid = "books"، request = میلیسرچ.درخواست جستجو { query = "moana" }، weight = 0.5، remote = "" })
    هر one در میلیسرچ.جستجوی چندگانه(ک، queries، خ):
        سرچاپ one.index_uid، one.hits.طول()
    پایان
    fed := میلیسرچ.جستجوی فدرال(ک، queries، میلیسرچ.فدراسیون { offset = 0، limit = 20، page = -1، hits_per_page = -1، facets_by_index = `{"movies": ["genre"]}`، merge_facets = `{}` }، خ)
    سرچاپ fed.hits.طول()

    ناپایا fr := میلیسرچ.درخواست جستجوی وجه { facet_name = "genre"، facet_query = "dra"، query = "space"، filter = "year > 2000"، matching_strategy = میلیسرچ.تطبیق همه، exhaustive_facet_count = درست }
    fr.attributes_to_search_on.بیفزا("title")
    fs := میلیسرچ.جستجوی وجه(ک، "movies"، fr، خ)
    سرچاپ fs.facet_query، fs.processing_time_ms
    هر h در fs.hits:
        سرچاپ h.value، h.count
    پایان

    ناپایا sr := میلیسرچ.درخواست مشابه { id = "143"، embedder = "default"، limit = 5، offset = 0، filter = "year > 2000"، show_ranking_score = درست، show_ranking_score_details = نادرست، ranking_score_threshold = 0.5، retrieve_vectors = نادرست }
    sr.attributes_to_retrieve.بیفزا("title")
    سرچاپ میلیسرچ.سندهای مشابه(ک، "movies"، sr، خ).hits.طول()
پایان

نتیجه جستجو SearchResult

ساختار نتیجه جستجو
پاسخ یک جستجو. عددهایی که سرور نفرستاده -۱ هستند.
نامانگلیسیگونهتوضیح
index_uidindex_uidرشته = ""نمایه، در نتیجه‌های جستجوی چندگانه.
hitshitsوکتور<رشته>هر نتیجه به شکل یک متن JSON جدا؛ با نتایج به نوع آن‌ها را در ساختار بخوانید.
queryqueryرشته = ""پرسشی که اجرا شد.
processing_time_msprocessing_time_msصحیح۶۴ = 0مدت جستجو، به میلی‌ثانیه.
offsetoffsetصحیح۶۴ = -1تعداد نتیجه‌های ردشده.
limitlimitصحیح۶۴ = -1اندازه‌ی صفحه.
estimated_total_hitsestimated_total_hitsصحیح۶۴ = -1تعداد تقریبی سندهای منطبق.
pagepageصحیح۶۴ = -1شماره‌ی صفحه، در صفحه‌بندی شماره‌دار.
hits_per_pagehits_per_pageصحیح۶۴ = -1تعداد نتیجه در هر صفحه.
total_hitstotal_hitsصحیح۶۴ = -1تعداد دقیق سندهای منطبق، در صفحه‌بندی شماره‌دار.
total_pagestotal_pagesصحیح۶۴ = -1تعداد صفحه‌ها.
facet_distributionfacet_distributionرشته = ""شمارش مقدارهای وجه‌های خواسته‌شده، به شکل JSON خام.
facet_statsfacet_statsرشته = ""کمینه و بیشینه‌ی وجه‌های عددی، به شکل JSON خام.
semantic_hit_countsemantic_hit_countصحیح۶۴ = -1تعداد نتیجه‌هایی که از معنا و نه از واژه‌ها آمدند.
rawrawرشته = ""کل بدنه‌ی پاسخ.

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

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

ساختار پرسش چندگانه
یک جستجو درون جستجوی چندگانه.
نامانگلیسیگونهتوضیح
index_uidindex_uidرشته = ""نمایه‌ای که جستجو می‌شود.
requestrequestدرخواست جستجوخود جستجو.
weightweightاعشار۶۴ = -1در جستجوی فدرال، وزن این پرسش؛ -۱ یعنی فرستاده نشود.
remoteremoteرشته = ""در جستجوی فدرال میان چند سرور، سروری که پرسیده می‌شود.

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

فدراسیون Federation

ساختار فدراسیون
این‌که جستجوی فدرال پرسش‌هایش را چگونه در یک فهرست ادغام کند.
نامانگلیسیگونهتوضیح
offsetoffsetصحیح = -1تعداد نتیجه‌های ادغام‌شده‌ای که رد می‌شوند.
limitlimitصحیح = -1تعداد نتیجه‌های ادغام‌شده‌ای که برگردانده می‌شوند.
pagepageصحیح = -1شماره‌ی صفحه.
hits_per_pagehits_per_pageصحیح = -1تعداد نتیجه در هر صفحه.
facets_by_indexfacets_by_indexرشته = ""وجه‌هایی که برای هر نمایه شمرده می‌شوند، به شکل JSON خام.
merge_facetsmerge_facetsرشته = ""شیوه‌ی ادغام آن وجه‌ها، به شکل JSON خام.

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

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

ساختار درخواست جستجوی وجه
جستجو میان مقدارهای یک وجه.
نامانگلیسیگونهتوضیح
facet_namefacet_nameرشته = ""فیلد وجه.
facet_queryfacet_queryرشته = ""متنی که مقدارها باید با آن شروع شوند.
queryqueryرشته = ""فقط سندهای منطبق با این جستجو شمرده شوند.
filterfilterرشته = ""فقط سندهای منطبق با این فیلتر شمرده شوند.
matching_strategymatching_strategyرشته = ""یکی از مقدارهای تطبیق.
attributes_to_search_onattributes_to_search_onوکتور<رشته>فقط در این فیلدها جستجو شود.
exhaustive_facet_countexhaustive_facet_countمنطقی = نادرستشمارش دقیق، که کندتر است.

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

نتیجه وجه FacetHit

ساختار نتیجه وجه
یک مقدار وجه.
نامانگلیسیگونهتوضیح
valuevalueرشته = ""مقدار.
countcountصحیح۶۴ = 0تعداد سندهای دارای آن.

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

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

ساختار نتیجه جستجوی وجه
پاسخ جستجوی وجه.
نامانگلیسیگونهتوضیح
hitshitsوکتور<نتیجه وجه>مقدارهای منطبق.
facet_queryfacet_queryرشته = ""پرسش وجهی که اجرا شد.
processing_time_msprocessing_time_msصحیح۶۴ = 0مدت اجرا، به میلی‌ثانیه.

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

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

ساختار درخواست مشابه
سندهای شبیه یک سند، بر پایه‌ی بردارهایش.
نامانگلیسیگونهتوضیح
ididرشته = ""سندی که با آن مقایسه می‌شود.
embedderembedderرشته = ""جاسازی که بردارهایش مقایسه می‌شوند.
offsetoffsetصحیح = -1تعداد نتیجه‌هایی که رد می‌شوند.
limitlimitصحیح = -1تعداد نتیجه‌هایی که برگردانده می‌شوند.
filterfilterرشته = ""فقط سندهای منطبق با این فیلتر.
attributes_to_retrieveattributes_to_retrieveوکتور<رشته>فقط این فیلدها برگردانده شوند.
show_ranking_scoreshow_ranking_scoreمنطقی = نادرستامتیاز شباهت برگردانده شود.
show_ranking_score_detailsshow_ranking_score_detailsمنطقی = نادرستجزئیات ساخت امتیاز برگردانده شود.
ranking_score_thresholdranking_score_thresholdاعشار۶۴ = -1نتیجه‌های با امتیاز کمتر از این کنار گذاشته شوند.
retrieve_vectorsretrieve_vectorsمنطقی = نادرستبردارهای ذخیره‌شده هم برگردانده شوند.

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

نسخه Version

ساختار نسخه
نسخه‌ی سرور.
نامانگلیسیگونهتوضیح
pkg_versionpkg_versionرشته = ""شماره‌ی نسخه، مثل 1.15.2.
commit_shacommit_shaرشته = ""کامیتی که سرور از آن ساخته شده است.
commit_datecommit_dateرشته = ""تاریخ آن کامیت.
db-meilisearch-Client.salam
واردسازی دیتابیس.میلیسرچ

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

    v := میلیسرچ.دریافت نسخه(ک، خ)
    سرچاپ v.pkg_version، v.commit_sha، v.commit_date
    st := میلیسرچ.دریافت آمار(ک، خ)
    سرچاپ st.database_size، st.used_database_size، st.last_update، st.indexes

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

    body := میلیسرچ.درخواست(ک، "GET"، "/indexes?limit=1"، ""، خ)
    اگر وارونه میلیسرچ.موفق(خ):
        سرچاپ میلیسرچ.متن خطا(خ)
        سرچاپ خ.status، خ.code، خ.kind، خ.message، خ.link
        برگشت
    پایان
    سرچاپ body
    سرچاپ میلیسرچ.درخواست با نوع(ک، "POST"، "/indexes/movies/documents"، "application/x-ndjson"، "{\"id\": 1}\n"، خ)
    p := میلیسرچ.صفحه {}
    سرچاپ p.results.طول()، p.offset، p.limit، p.total، p.from، p.next، ک.api_key.طول() بزرگتر 0، ک.agent
پایان

آمار Stats

ساختار آمار
آمار کل سرور.
نامانگلیسیگونهتوضیح
database_sizedatabase_sizeصحیح۶۴ = 0اندازه‌ی پایگاه داده روی دیسک، به بایت.
used_database_sizeused_database_sizeصحیح۶۴ = 0بایت‌هایی که واقعا به کار رفته‌اند.
last_updatelast_updateرشته = ""زمان آخرین تغییر.
indexesindexesرشته = ""آمار هر نمایه، به شکل JSON خام.

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

کلاینت Client

ساختار کلاینت
نشانی سرور و کلیدی که به کار می‌رود. یک مقدار ساده است؛ آن را با جدید بسازید و هر جا خواستید به کار ببرید.
نامانگلیسیگونهتوضیح
hosthostرشته = ""نشانی سرور، مثل http://127.0.0.1:7700، بدون اسلش پایانی.
api_keyapi_keyرشته = ""کلید API که به شکل Authorization: Bearer فرستاده می‌شود؛ اگر خالی باشد سرآیندی فرستاده نمی‌شود.
agentagentرشته = ""متنی که به سرآیند کارخواه افزوده می‌شود، مثل نام برنامه‌ی شما.

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

خطا Error

ساختار خطا
توضیح خطا. code خالی یعنی فراخوانی موفق بود؛ هر تابع پیش از شروع آن را پاک می‌کند.
نامانگلیسیگونهتوضیح
statusstatusصحیح = 0وضعیت HTTP؛ اگر به سرور نرسیدیم یا خطا در خود کارخواه بود، ۰ است.
codecodeرشته = ""کد خطای میلی‌سرچ، مثل index_not_found، یا کدهای خود کارخواه: communication_error، timeout و decode_error.
kindkindرشته = ""نوع خطا: invalid_request، auth، internal و مانند آن.
messagemessageرشته = ""پیام خوانا برای انسان.
linklinkرشته = ""پیوند صفحه‌ی مستندات میلی‌سرچ درباره‌ی این خطا.

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

صفحه Page

ساختار صفحه
یک صفحه از سندهای JSON خام، خروجی دریافت سندها.
نامانگلیسیگونهتوضیح
resultsresultsوکتور<رشته>هر سند به شکل یک متن JSON جدا.
offsetoffsetصحیح۶۴ = 0تعداد سندهایی که رد شدند.
limitlimitصحیح۶۴ = 0اندازه‌ی صفحه.
totaltotalصحیح۶۴ = 0تعداد کل سندهای منطبق.
fromfromصحیح۶۴ = -1برای سندها به کار نمی‌رود؛ -۱.
nextnextصحیح۶۴ = -1برای سندها به کار نمی‌رود؛ -۱.

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

اطلاعات کار TaskInfo

ساختار اطلاعات کار
رسید یک تغییر. میلی‌سرچ هر نوشتن را بعدا و به ترتیب انجام می‌دهد؛ با انتظار منتظرش بمانید.
نامانگلیسیگونهتوضیح
task_uidtask_uidصحیح۶۴ = -1شماره‌ی کار؛ اگر فراخوانی ناموفق بود -۱.
index_uidindex_uidرشته = ""نمایه‌ای که تغییر می‌دهد، اگر باشد.
statusstatusرشته = ""وضعیت در لحظه‌ی ورود به صف.
kindkindرشته = ""نوع کار، مثل documentAdditionOrUpdate.
enqueued_atenqueued_atرشته = ""زمان ورود به صف.
db-meilisearch-GetTasks.salam
واردسازی دیتابیس.میلیسرچ

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

    اطلاعات := میلیسرچ.حذف نمایه(ک، "old_movies"، خ)
    t := میلیسرچ.انتظار برای کار(ک، اطلاعات.task_uid، 30000، 100، خ)
    سرچاپ t.uid، t.batch_uid، t.index_uid، t.status، t.kind، t.canceled_by، t.details، t.duration
    سرچاپ t.enqueued_at، t.started_at، t.finished_at
    اگر t.status برابر میلیسرچ.وضعیت ناموفق:
        سرچاپ t.error.code، t.error.message
    پایان
    سرچاپ میلیسرچ.دریافت کار(ک، اطلاعات.task_uid، خ).status

    ناپایا q := میلیسرچ.پرسش کار { limit = 20، from = -1، reverse = درست، after_enqueued_at = "2025-01-01T00:00:00Z" }
    q.statuses.بیفزا(میلیسرچ.وضعیت موفق)
    q.statuses.بیفزا(میلیسرچ.وضعیت ناموفق)
    q.index_uids.بیفزا("movies")
    q.types.بیفزا("documentAdditionOrUpdate")
    q.uids.بیفزا(1)
    q.batch_uids.بیفزا(1)
    q.canceled_by.بیفزا(2)
    q.before_enqueued_at = "2030-01-01T00:00:00Z"
    q.before_started_at = "2030-01-01T00:00:00Z"
    q.after_started_at = "2025-01-01T00:00:00Z"
    q.before_finished_at = "2030-01-01T00:00:00Z"
    q.after_finished_at = "2025-01-01T00:00:00Z"
    page := میلیسرچ.دریافت کارها(ک، q، خ)
    سرچاپ page.total، page.limit، page.from، page.next
    هر task در page.results:
        سرچاپ task.uid، task.kind، task.status
    پایان

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

    batches := میلیسرچ.دریافت دسته‌ها(ک، میلیسرچ.پرسش کار { limit = 5 }، خ)
    سرچاپ batches.total، batches.limit، batches.from، batches.next
    هر b در batches.results:
        one := میلیسرچ.دریافت دسته(ک، b.uid، خ)
        سرچاپ one.uid، one.details، one.stats، one.progress، one.duration، one.started_at، one.finished_at
    پایان
پایان

کار Task

ساختار کار
یک کار با نتیجه‌ی آن.
نامانگلیسیگونهتوضیح
uiduidصحیح۶۴ = -1شماره‌ی کار.
batch_uidbatch_uidصحیح۶۴ = -1دسته‌ای که در آن اجرا شد؛ پیش از اجرا -۱.
index_uidindex_uidرشته = ""نمایه‌ای که تغییر می‌دهد.
statusstatusرشته = ""یکی از مقدارهای وضعیت.
kindkindرشته = ""نوع کار.
canceled_bycanceled_byصحیح۶۴ = -1کاری که آن را لغو کرد؛ اگر نباشد -۱.
detailsdetailsرشته = ""جزئیاتی که به نوع کار بستگی دارد، به شکل JSON خام.
errorerrorخطادلیل شکست.
durationdurationرشته = ""مدت اجرا، به شکل بازه‌ی ISO 8601.
enqueued_atenqueued_atرشته = ""زمان ورود به صف.
started_atstarted_atرشته = ""زمان شروع.
finished_atfinished_atرشته = ""زمان پایان.

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

پرسش کار TaskQuery

ساختار پرسش کار
این‌که کدام کارها فهرست، لغو یا حذف شوند. فیلدهای خالی فرستاده نمی‌شوند.
نامانگلیسیگونهتوضیح
uidsuidsوکتور<صحیح۶۴>فقط این کارها.
batch_uidsbatch_uidsوکتور<صحیح۶۴>فقط کارهای این دسته‌ها.
canceled_bycanceled_byوکتور<صحیح۶۴>فقط کارهایی که این کارها لغوشان کرده‌اند.
statusesstatusesوکتور<رشته>فقط این وضعیت‌ها.
typestypesوکتور<رشته>فقط این نوع کارها.
index_uidsindex_uidsوکتور<رشته>فقط کارهای این نمایه‌ها.
limitlimitصحیح = 0اندازه‌ی صفحه؛ ۰ برای پیش‌فرض. فقط برای فهرست.
fromfromصحیح۶۴ = -1شروع از این شماره‌ی کار؛ -۱ برای جدیدترین. فقط برای فهرست.
reversereverseمنطقی = نادرستقدیمی‌ترین اول. فقط برای فهرست.
before_enqueued_atbefore_enqueued_atرشته = ""پیش از این تاریخ وارد صف شده.
after_enqueued_atafter_enqueued_atرشته = ""پس از این تاریخ وارد صف شده.
before_started_atbefore_started_atرشته = ""پیش از این تاریخ شروع شده.
after_started_atafter_started_atرشته = ""پس از این تاریخ شروع شده.
before_finished_atbefore_finished_atرشته = ""پیش از این تاریخ تمام شده.
after_finished_atafter_finished_atرشته = ""پس از این تاریخ تمام شده.

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

صفحه کار TaskPage

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

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

دسته Batch

ساختار دسته
یک دسته: کارهایی که میلی‌سرچ با هم اجرا کرد.
نامانگلیسیگونهتوضیح
uiduidصحیح۶۴ = -1شماره‌ی دسته.
detailsdetailsرشته = ""جزئیات کارهای آن، به شکل JSON خام.
statsstatsرشته = ""شمارش بر پایه‌ی وضعیت، نوع و نمایه، به شکل JSON خام.
progressprogressرشته = ""پیشرفت در حین اجرا، به شکل JSON خام؛ پس از پایان خالی.
durationdurationرشته = ""مدت اجرا.
started_atstarted_atرشته = ""زمان شروع.
finished_atfinished_atرشته = ""زمان پایان.

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

صفحه دسته BatchPage

ساختار صفحه دسته
یک صفحه از دسته‌ها.
نامانگلیسیگونهتوضیح
resultsresultsوکتور<دسته>دسته‌ها.
limitlimitصحیح۶۴ = 0اندازه‌ی صفحه.
fromfromصحیح۶۴ = -1شماره‌ی نخستین دسته‌ی این صفحه.
nextnextصحیح۶۴ = -1برای صفحه‌ی بعد این را به عنوان from بدهید؛ در صفحه‌ی آخر -۱.
totaltotalصحیح۶۴ = 0تعداد دسته‌های منطبق.

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

کلید Key

ساختار کلید
یک کلید API.
نامانگلیسیگونهتوضیح
uiduidرشته = ""شناسه‌ی کلید، یک UUID.
keykeyرشته = ""مقدار مخفی کلید که فرستاده می‌شود.
namenameرشته = ""نام آن.
descriptiondescriptionرشته = ""توضیح آن.
actionsactionsوکتور<رشته>کارهایی که مجاز است، مثل search یا * برای همه.
indexesindexesوکتور<رشته>نمایه‌هایی که مجاز است؛ * برای همه.
expires_atexpires_atرشته = ""زمان از کار افتادن؛ خالی یعنی هرگز.
created_atcreated_atرشته = ""زمان ساخت.
updated_atupdated_atرشته = ""زمان آخرین تغییر.
db-meilisearch-CreateKey.salam
واردسازی دیتابیس.میلیسرچ
واردسازی زمان

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

    ناپایا r := میلیسرچ.درخواست کلید { name = "Front end search"، description = "Used by the web app"، expires_at = "2030-01-01T00:00:00Z"، uid = "" }
    r.actions.بیفزا("search")
    r.indexes.بیفزا("movies")
    k := میلیسرچ.ایجاد کلید(مدیر، r، خ)
    اگر وارونه میلیسرچ.موفق(خ):
        سرچاپ میلیسرچ.متن خطا(خ)
        برگشت
    پایان
    سرچاپ k.uid، k.key، k.name، k.description، k.expires_at، k.created_at، k.updated_at
    سرچاپ k.actions.طول()، k.indexes.طول()

    سرچاپ میلیسرچ.دریافت کلید(مدیر، k.uid، خ).name
    page := میلیسرچ.دریافت کلیدها(مدیر، 0، 20، خ)
    سرچاپ page.total، page.offset، page.limit
    هر one در page.results:
        سرچاپ one.name
    پایان
    سرچاپ میلیسرچ.به‌روزرسانی کلید(مدیر، k.uid، "Web search"، "Search only, movies only"، خ).name

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

    سرچاپ میلیسرچ.حذف کلید(مدیر، k.uid، خ)
پایان

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

ساختار درخواست کلید
یک کلید API تازه.
نامانگلیسیگونهتوضیح
uiduidرشته = ""یک UUID برای شناسه؛ خالی یعنی سرور انتخاب کند.
namenameرشته = ""نام آن.
descriptiondescriptionرشته = ""توضیح آن.
actionsactionsوکتور<رشته>کارهایی که مجاز است.
indexesindexesوکتور<رشته>نمایه‌هایی که مجاز است.
expires_atexpires_atرشته = ""تاریخی به شکل RFC 3339 برای از کار افتادن؛ خالی یعنی هرگز.

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

صفحه کلید KeyPage

ساختار صفحه کلید
یک صفحه از کلیدها.
نامانگلیسیگونهتوضیح
resultsresultsوکتور<کلید>کلیدها.
offsetoffsetصحیح۶۴ = 0تعداد ردشده‌ها.
limitlimitصحیح۶۴ = 0اندازه‌ی صفحه.
totaltotalصحیح۶۴ = 0تعداد کل کلیدها.

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

نمایه Index

ساختار نمایه
یک نمایه: مجموعه‌ای نام‌دار از سندها.
نامانگلیسیگونهتوضیح
uiduidرشته = ""نام نمایه.
primary_keyprimary_keyرشته = ""فیلدی که هر سند را مشخص می‌کند؛ تا وقتی معلوم نشده خالی است.
created_atcreated_atرشته = ""زمان ساخت نمایه.
updated_atupdated_atرشته = ""زمان آخرین تغییر آن.
db-meilisearch-CreateIndex.salam
واردسازی دیتابیس.میلیسرچ

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

    اطلاعات := میلیسرچ.ایجاد نمایه(ک، "movies"، "id"، خ)
    سرچاپ اطلاعات.task_uid، اطلاعات.index_uid، اطلاعات.status، اطلاعات.kind، اطلاعات.enqueued_at
    done := میلیسرچ.انتظار(ک، اطلاعات، خ)
    اگر وارونه میلیسرچ.موفق(خ):
        سرچاپ میلیسرچ.متن خطا(خ)
        برگشت
    پایان
    سرچاپ done.status

    i := میلیسرچ.دریافت نمایه(ک، "movies"، خ)
    سرچاپ i.uid، i.primary_key، i.created_at، i.updated_at
    page := میلیسرچ.فهرست نمایه‌ها(ک، 0، 20، خ)
    سرچاپ page.total، page.offset، page.limit
    هر idx در page.results:
        سرچاپ idx.uid
    پایان

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

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

    s := میلیسرچ.دریافت آمار نمایه(ک، "films"، خ)
    سرچاپ s.number_of_documents، s.raw_document_db_size، s.avg_document_size، s.is_indexing
    سرچاپ s.number_of_embeddings، s.number_of_embedded_documents، s.field_distribution
    میلیسرچ.انتظار(ک، میلیسرچ.حذف نمایه(ک، "films"، خ)، خ)
پایان

صفحه نمایه IndexPage

ساختار صفحه نمایه
یک صفحه از نمایه‌ها.
نامانگلیسیگونهتوضیح
resultsresultsوکتور<نمایه>نمایه‌های این صفحه.
offsetoffsetصحیح۶۴ = 0تعداد ردشده‌ها.
limitlimitصحیح۶۴ = 0اندازه‌ی صفحه.
totaltotalصحیح۶۴ = 0تعداد کل نمایه‌ها.

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

آمار نمایه IndexStats

ساختار آمار نمایه
آمار یک نمایه.
نامانگلیسیگونهتوضیح
number_of_documentsnumber_of_documentsصحیح۶۴ = 0تعداد سندهای آن.
raw_document_db_sizeraw_document_db_sizeصحیح۶۴ = 0اندازه‌ی سندهای ذخیره‌شده، به بایت.
avg_document_sizeavg_document_sizeصحیح۶۴ = 0میانگین اندازه‌ی سند، به بایت.
is_indexingis_indexingمنطقی = نادرستهمین حالا کاری در حال تغییر آن است.
number_of_embeddingsnumber_of_embeddingsصحیح۶۴ = 0تعداد بردارهای آن.
number_of_embedded_documentsnumber_of_embedded_documentsصحیح۶۴ = 0تعداد سندهایی که دست کم یک بردار دارند.
field_distributionfield_distributionرشته = ""تعداد سندهای دارای هر فیلد، به شکل JSON خام.

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

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

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

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

پرسش سند DocumentsQuery

ساختار پرسش سند
این‌که دریافت سندها کدام سندها را برگرداند. مقدار صفر و فهرست خالی فرستاده نمی‌شوند.
نامانگلیسیگونهتوضیح
offsetoffsetصحیح = 0تعداد سندهایی که رد می‌شوند.
limitlimitصحیح = 0تعداد سندهایی که برگردانده می‌شوند.
fieldsfieldsوکتور<رشته>فقط این فیلدها برگردانده شوند.
filterfilterرشته = ""یک عبارت فیلتر، یا آرایه‌ی JSON از آن‌ها؛ فیلدها باید قابل فیلتر باشند.
idsidsوکتور<رشته>فقط این سندها برگردانده شوند.
sortsortوکتور<رشته>قاعده‌های مرتب‌سازی مثل year:desc؛ فیلدها باید قابل مرتب‌سازی باشند.
retrieve_vectorsretrieve_vectorsمنطقی = نادرستبردارهای ذخیره‌شده هم برگردانده شوند.
db-meilisearch-AddDocuments.salam
واردسازی دیتابیس.میلیسرچ

ساختار Movie:
    همگانی id: صحیح = 0
    همگانی title: رشته = ""
    همگانی year: صحیح = 0
پایان

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

    سندها := `[{"id": 1, "title": "Carol", "year": 2015}, {"id": 2, "title": "Moana", "year": 2016}]`
    میلیسرچ.انتظار(ک، میلیسرچ.افزودن سندها(ک، "movies"، سندها، "id"، خ)، خ)
    میلیسرچ.انتظار(ک، میلیسرچ.به‌روزرسانی سندها(ک، "movies"، `[{"id": 2, "year": 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"، ""، ""، خ)، خ)

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

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

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

    ناپایا q := میلیسرچ.پرسش سند { limit = 10، filter = "year > 2000"، retrieve_vectors = نادرست }
    q.fields.بیفزا("id")
    q.fields.بیفزا("title")
    q.sort.بیفزا("year:desc")
    q.ids.بیفزا("1")
    q.ids.بیفزا("2")
    page := میلیسرچ.دریافت سندها(ک، "movies"، میلیسرچ.پرسش سند { offset = 0، limit = 20 }، خ)
    ناپایا movies := وکتور {} برگردان وکتور<Movie>
    اگر میلیسرچ.سندها به نوع(page، movies، خ):
        سرچاپ movies.طول()، page.total
    پایان
    سرچاپ میلیسرچ.دریافت سندها(ک، "movies"، q، خ).results.طول()

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

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

تطبیق آخر MATCH_LAST

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

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

تطبیق همه MATCH_ALL

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

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

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

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

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

نسخه کلاینت VERSION

پایا نسخه کلاینت: رشته = "1.0.0"
نسخه‌ی این کارخواه که در سرآیند X-Meilisearch-Client به سرور فرستاده می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Client.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

تابع‌ها

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

تابع دریافت تنظیمات(c: کلاینت، uid: رشته، err &: خطا): رشته
همه‌ی تنظیمات یک نمایه، به شکل JSON خام.
db-meilisearch-UpdateSettings.salam
واردسازی دیتابیس.میلیسرچ

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

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

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

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

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

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

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

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

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

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

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

به‌روزرسانی تنظیمات UpdateSettings

تابع به‌روزرسانی تنظیمات(c: کلاینت، uid: رشته، settings: رشته، err &: خطا): اطلاعات کار
چند تنظیم را با هم تغییر می‌دهد؛ یک شیء JSON فقط با تنظیم‌هایی که تغییر می‌کنند بدهید.

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

بازنشانی تنظیمات ResetSettings

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

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

دریافت تنظیم GetSetting

تابع دریافت تنظیم(c: کلاینت، uid: رشته، name: رشته، err &: خطا): رشته
یک تنظیم با نام مسیرش، مثل ranking-rules، به شکل JSON خام؛ برای تنظیم‌هایی که از این بسته تازه‌ترند.

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

به‌روزرسانی تنظیم UpdateSetting

تابع به‌روزرسانی تنظیم(c: کلاینت، uid: رشته، name: رشته، value: رشته، err &: خطا): اطلاعات کار
یک تنظیم را با نام مسیرش و با روش HTTP مناسب آن تغییر می‌دهد.

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

بازنشانی تنظیم ResetSetting

تابع بازنشانی تنظیم(c: کلاینت، uid: رشته، name: رشته، err &: خطا): اطلاعات کار
یک تنظیم را به پیش‌فرض برمی‌گرداند.

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

دریافت قواعد رتبه‌بندی GetRankingRules

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

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

به‌روزرسانی قواعد رتبه‌بندی UpdateRankingRules

تابع به‌روزرسانی قواعد رتبه‌بندی(c: کلاینت، uid: رشته، items: وکتور<رشته>، err &: خطا): اطلاعات کار
تعیین قاعده‌های رتبه‌بندی، به ترتیب.

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

بازنشانی قواعد رتبه‌بندی ResetRankingRules

تابع بازنشانی قواعد رتبه‌بندی(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن قاعده‌های رتبه‌بندی، به ترتیب به پیش‌فرض.

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

دریافت ویژگی‌های قابل جستجو GetSearchableAttributes

تابع دریافت ویژگی‌های قابل جستجو(c: کلاینت، uid: رشته، err &: خطا): وکتور<رشته>
فیلدهایی که جستجو می‌شوند، مهم‌ترین اول.

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

به‌روزرسانی ویژگی‌های قابل جستجو UpdateSearchableAttributes

تابع به‌روزرسانی ویژگی‌های قابل جستجو(c: کلاینت، uid: رشته، items: وکتور<رشته>، err &: خطا): اطلاعات کار
تعیین فیلدهایی که جستجو می‌شوند، مهم‌ترین اول.

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

بازنشانی ویژگی‌های قابل جستجو ResetSearchableAttributes

تابع بازنشانی ویژگی‌های قابل جستجو(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن فیلدهایی که جستجو می‌شوند، مهم‌ترین اول به پیش‌فرض.

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

دریافت ویژگی‌های نمایشی GetDisplayedAttributes

تابع دریافت ویژگی‌های نمایشی(c: کلاینت، uid: رشته، err &: خطا): وکتور<رشته>
فیلدهایی که در نتیجه‌ها برگردانده می‌شوند.

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

به‌روزرسانی ویژگی‌های نمایشی UpdateDisplayedAttributes

تابع به‌روزرسانی ویژگی‌های نمایشی(c: کلاینت، uid: رشته، items: وکتور<رشته>، err &: خطا): اطلاعات کار
تعیین فیلدهایی که در نتیجه‌ها برگردانده می‌شوند.

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

بازنشانی ویژگی‌های نمایشی ResetDisplayedAttributes

تابع بازنشانی ویژگی‌های نمایشی(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن فیلدهایی که در نتیجه‌ها برگردانده می‌شوند به پیش‌فرض.

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

دریافت ویژگی‌های قابل فیلتر GetFilterableAttributes

تابع دریافت ویژگی‌های قابل فیلتر(c: کلاینت، uid: رشته، err &: خطا): وکتور<رشته>
فیلدهایی که می‌توان روی آن‌ها فیلتر و وجه گرفت؛ ورودی دارای گزینه به شکل JSON برمی‌گردد.

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

به‌روزرسانی ویژگی‌های قابل فیلتر UpdateFilterableAttributes

تابع به‌روزرسانی ویژگی‌های قابل فیلتر(c: کلاینت، uid: رشته، items: وکتور<رشته>، err &: خطا): اطلاعات کار
تعیین فیلدهایی که می‌توان روی آن‌ها فیلتر و وجه گرفت؛ ورودی دارای گزینه به شکل JSON برمی‌گردد.

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

بازنشانی ویژگی‌های قابل فیلتر ResetFilterableAttributes

تابع بازنشانی ویژگی‌های قابل فیلتر(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن فیلدهایی که می‌توان روی آن‌ها فیلتر و وجه گرفت؛ ورودی دارای گزینه به شکل JSON برمی‌گردد به پیش‌فرض.

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

دریافت ویژگی‌های قابل مرتب‌سازی GetSortableAttributes

تابع دریافت ویژگی‌های قابل مرتب‌سازی(c: کلاینت، uid: رشته، err &: خطا): وکتور<رشته>
فیلدهایی که می‌توان بر پایه‌ی آن‌ها مرتب کرد.

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

به‌روزرسانی ویژگی‌های قابل مرتب‌سازی UpdateSortableAttributes

تابع به‌روزرسانی ویژگی‌های قابل مرتب‌سازی(c: کلاینت، uid: رشته، items: وکتور<رشته>، err &: خطا): اطلاعات کار
تعیین فیلدهایی که می‌توان بر پایه‌ی آن‌ها مرتب کرد.

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

بازنشانی ویژگی‌های قابل مرتب‌سازی ResetSortableAttributes

تابع بازنشانی ویژگی‌های قابل مرتب‌سازی(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن فیلدهایی که می‌توان بر پایه‌ی آن‌ها مرتب کرد به پیش‌فرض.

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

دریافت کلمات توقف GetStopWords

تابع دریافت کلمات توقف(c: کلاینت، uid: رشته، err &: خطا): وکتور<رشته>
واژه‌هایی که در پرسش نادیده گرفته می‌شوند.

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

به‌روزرسانی کلمات توقف UpdateStopWords

تابع به‌روزرسانی کلمات توقف(c: کلاینت، uid: رشته، items: وکتور<رشته>، err &: خطا): اطلاعات کار
تعیین واژه‌هایی که در پرسش نادیده گرفته می‌شوند.

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

بازنشانی کلمات توقف ResetStopWords

تابع بازنشانی کلمات توقف(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن واژه‌هایی که در پرسش نادیده گرفته می‌شوند به پیش‌فرض.

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

دریافت واژه‌نامه GetDictionary

تابع دریافت واژه‌نامه(c: کلاینت، uid: رشته، err &: خطا): وکتور<رشته>
واژه‌هایی که یکپارچه می‌مانند، مثل J. R. R..

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

به‌روزرسانی واژه‌نامه UpdateDictionary

تابع به‌روزرسانی واژه‌نامه(c: کلاینت، uid: رشته، items: وکتور<رشته>، err &: خطا): اطلاعات کار
تعیین واژه‌هایی که یکپارچه می‌مانند، مثل J. R. R..

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

بازنشانی واژه‌نامه ResetDictionary

تابع بازنشانی واژه‌نامه(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن واژه‌هایی که یکپارچه می‌مانند، مثل J. R. R. به پیش‌فرض.

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

دریافت نشانه‌های جداکننده GetSeparatorTokens

تابع دریافت نشانه‌های جداکننده(c: کلاینت، uid: رشته، err &: خطا): وکتور<رشته>
نویسه‌های افزوده‌ای که واژه‌ها را جدا می‌کنند.

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

به‌روزرسانی نشانه‌های جداکننده UpdateSeparatorTokens

تابع به‌روزرسانی نشانه‌های جداکننده(c: کلاینت، uid: رشته، items: وکتور<رشته>، err &: خطا): اطلاعات کار
تعیین نویسه‌های افزوده‌ای که واژه‌ها را جدا می‌کنند.

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

بازنشانی نشانه‌های جداکننده ResetSeparatorTokens

تابع بازنشانی نشانه‌های جداکننده(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن نویسه‌های افزوده‌ای که واژه‌ها را جدا می‌کنند به پیش‌فرض.

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

دریافت نشانه‌های غیر جداکننده GetNonSeparatorTokens

تابع دریافت نشانه‌های غیر جداکننده(c: کلاینت، uid: رشته، err &: خطا): وکتور<رشته>
نویسه‌هایی که دیگر واژه‌ها را جدا نمی‌کنند.

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

به‌روزرسانی نشانه‌های غیر جداکننده UpdateNonSeparatorTokens

تابع به‌روزرسانی نشانه‌های غیر جداکننده(c: کلاینت، uid: رشته، items: وکتور<رشته>، err &: خطا): اطلاعات کار
تعیین نویسه‌هایی که دیگر واژه‌ها را جدا نمی‌کنند.

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

بازنشانی نشانه‌های غیر جداکننده ResetNonSeparatorTokens

تابع بازنشانی نشانه‌های غیر جداکننده(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن نویسه‌هایی که دیگر واژه‌ها را جدا نمی‌کنند به پیش‌فرض.

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

دریافت ویژگی متمایز GetDistinctAttribute

تابع دریافت ویژگی متمایز(c: کلاینت، uid: رشته، err &: خطا): رشته
فیلدی که برای هر مقدار فقط یک سند نگه می‌دارد.

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

به‌روزرسانی ویژگی متمایز UpdateDistinctAttribute

تابع به‌روزرسانی ویژگی متمایز(c: کلاینت، uid: رشته، value: رشته، err &: خطا): اطلاعات کار
تعیین فیلدی که برای هر مقدار فقط یک سند نگه می‌دارد.

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

بازنشانی ویژگی متمایز ResetDistinctAttribute

تابع بازنشانی ویژگی متمایز(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن فیلدی که برای هر مقدار فقط یک سند نگه می‌دارد به پیش‌فرض.

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

دریافت دقت مجاورت GetProximityPrecision

تابع دریافت دقت مجاورت(c: کلاینت، uid: رشته، err &: خطا): رشته
شیوه‌ی سنجش فاصله‌ی واژه‌ها: byWord یا byAttribute.

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

به‌روزرسانی دقت مجاورت UpdateProximityPrecision

تابع به‌روزرسانی دقت مجاورت(c: کلاینت، uid: رشته، value: رشته، err &: خطا): اطلاعات کار
تعیین شیوه‌ی سنجش فاصله‌ی واژه‌ها: byWord یا byAttribute.

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

بازنشانی دقت مجاورت ResetProximityPrecision

تابع بازنشانی دقت مجاورت(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن شیوه‌ی سنجش فاصله‌ی واژه‌ها: byWord یا byAttribute به پیش‌فرض.

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

دریافت جستجوی پیشوندی GetPrefixSearch

تابع دریافت جستجوی پیشوندی(c: کلاینت، uid: رشته، err &: خطا): رشته
زمان کار جستجوی پیشوندی: indexingTime یا disabled.

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

به‌روزرسانی جستجوی پیشوندی UpdatePrefixSearch

تابع به‌روزرسانی جستجوی پیشوندی(c: کلاینت، uid: رشته، value: رشته، err &: خطا): اطلاعات کار
تعیین زمان کار جستجوی پیشوندی: indexingTime یا disabled.

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

بازنشانی جستجوی پیشوندی ResetPrefixSearch

تابع بازنشانی جستجوی پیشوندی(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن زمان کار جستجوی پیشوندی: indexingTime یا disabled به پیش‌فرض.

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

دریافت مهلت جستجو GetSearchCutoffMs

تابع دریافت مهلت جستجو(c: کلاینت، uid: رشته، err &: خطا): صحیح۶۴
بیشترین زمان اجرای یک جستجو، به میلی‌ثانیه؛ اگر تعیین نشده -۱.

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

به‌روزرسانی مهلت جستجو UpdateSearchCutoffMs

تابع به‌روزرسانی مهلت جستجو(c: کلاینت، uid: رشته، value: صحیح۶۴، err &: خطا): اطلاعات کار
تعیین بیشترین زمان اجرای یک جستجو، به میلی‌ثانیه؛ اگر تعیین نشده -۱.

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

بازنشانی مهلت جستجو ResetSearchCutoffMs

تابع بازنشانی مهلت جستجو(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن بیشترین زمان اجرای یک جستجو، به میلی‌ثانیه؛ اگر تعیین نشده -۱ به پیش‌فرض.

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

دریافت جستجوی وجه GetFacetSearch

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

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

به‌روزرسانی جستجوی وجه UpdateFacetSearch

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

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

بازنشانی جستجوی وجه ResetFacetSearch

تابع بازنشانی جستجوی وجه(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن روشن بودن جستجوی وجه به پیش‌فرض.

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

دریافت مترادف‌ها GetSynonyms

تابع دریافت مترادف‌ها(c: کلاینت، uid: رشته، err &: خطا): رشته
مترادف‌ها، به شکل شیء JSON از فهرست واژه‌ها.

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

به‌روزرسانی مترادف‌ها UpdateSynonyms

تابع به‌روزرسانی مترادف‌ها(c: کلاینت، uid: رشته، value: رشته، err &: خطا): اطلاعات کار
تعیین مترادف‌ها، به شکل شیء JSON از فهرست واژه‌ها.

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

بازنشانی مترادف‌ها ResetSynonyms

تابع بازنشانی مترادف‌ها(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن مترادف‌ها، به شکل شیء JSON از فهرست واژه‌ها به پیش‌فرض.

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

دریافت تحمل غلط املایی GetTypoTolerance

تابع دریافت تحمل غلط املایی(c: کلاینت، uid: رشته، err &: خطا): رشته
گزینه‌های تحمل غلط املایی، به شکل JSON.

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

به‌روزرسانی تحمل غلط املایی UpdateTypoTolerance

تابع به‌روزرسانی تحمل غلط املایی(c: کلاینت، uid: رشته، value: رشته، err &: خطا): اطلاعات کار
تعیین گزینه‌های تحمل غلط املایی، به شکل JSON.

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

بازنشانی تحمل غلط املایی ResetTypoTolerance

تابع بازنشانی تحمل غلط املایی(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن گزینه‌های تحمل غلط املایی، به شکل JSON به پیش‌فرض.

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

دریافت صفحه‌بندی GetPagination

تابع دریافت صفحه‌بندی(c: کلاینت، uid: رشته، err &: خطا): رشته
گزینه‌های صفحه‌بندی، مثل maxTotalHits، به شکل JSON.

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

به‌روزرسانی صفحه‌بندی UpdatePagination

تابع به‌روزرسانی صفحه‌بندی(c: کلاینت، uid: رشته، value: رشته، err &: خطا): اطلاعات کار
تعیین گزینه‌های صفحه‌بندی، مثل maxTotalHits، به شکل JSON.

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

بازنشانی صفحه‌بندی ResetPagination

تابع بازنشانی صفحه‌بندی(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن گزینه‌های صفحه‌بندی، مثل maxTotalHits، به شکل JSON به پیش‌فرض.

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

دریافت وجه‌بندی GetFaceting

تابع دریافت وجه‌بندی(c: کلاینت، uid: رشته، err &: خطا): رشته
گزینه‌های وجه‌بندی، مثل maxValuesPerFacet، به شکل JSON.

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

به‌روزرسانی وجه‌بندی UpdateFaceting

تابع به‌روزرسانی وجه‌بندی(c: کلاینت، uid: رشته، value: رشته، err &: خطا): اطلاعات کار
تعیین گزینه‌های وجه‌بندی، مثل maxValuesPerFacet، به شکل JSON.

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

بازنشانی وجه‌بندی ResetFaceting

تابع بازنشانی وجه‌بندی(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن گزینه‌های وجه‌بندی، مثل maxValuesPerFacet، به شکل JSON به پیش‌فرض.

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

دریافت جاسازها GetEmbedders

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

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

به‌روزرسانی جاسازها UpdateEmbedders

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

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

بازنشانی جاسازها ResetEmbedders

تابع بازنشانی جاسازها(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن جاسازها برای جستجوی هوشمند، به شکل JSON به پیش‌فرض.

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

دریافت ویژگی‌های محلی GetLocalizedAttributes

تابع دریافت ویژگی‌های محلی(c: کلاینت، uid: رشته، err &: خطا): رشته
زبان فیلدها، به شکل آرایه‌ی JSON از قاعده‌ها.

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

به‌روزرسانی ویژگی‌های محلی UpdateLocalizedAttributes

تابع به‌روزرسانی ویژگی‌های محلی(c: کلاینت، uid: رشته، value: رشته، err &: خطا): اطلاعات کار
تعیین زبان فیلدها، به شکل آرایه‌ی JSON از قاعده‌ها.

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

بازنشانی ویژگی‌های محلی ResetLocalizedAttributes

تابع بازنشانی ویژگی‌های محلی(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن زبان فیلدها، به شکل آرایه‌ی JSON از قاعده‌ها به پیش‌فرض.

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

دریافت گفتگو GetChat

تابع دریافت گفتگو(c: کلاینت، uid: رشته، err &: خطا): رشته
گزینه‌های جستجوی گفت‌وگویی، به شکل JSON.

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

به‌روزرسانی گفتگو UpdateChat

تابع به‌روزرسانی گفتگو(c: کلاینت، uid: رشته، value: رشته، err &: خطا): اطلاعات کار
تعیین گزینه‌های جستجوی گفت‌وگویی، به شکل JSON.

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

بازنشانی گفتگو ResetChat

تابع بازنشانی گفتگو(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
بازگرداندن گزینه‌های جستجوی گفت‌وگویی، به شکل JSON به پیش‌فرض.

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

تابع جستجو(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

سلامت Health

تابع سلامت(c: کلاینت، err &: خطا): رشته
وضعیت سلامت: اگر سرور بالا باشد available.

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

سالم است IsHealthy

تابع سالم است(c: کلاینت): منطقی
سرور پاسخ می‌دهد و در دسترس است.

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

دریافت نسخه GetVersion

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

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

دریافت آمار GetStats

تابع دریافت آمار(c: کلاینت، err &: خطا): آمار
آمار کل سرور.

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

ایجاد دامپ CreateDump

تابع ایجاد دامپ(c: کلاینت، err &: خطا): اطلاعات کار
یک دامپ، یعنی پشتیبان قابل جابجایی از همه‌ی نمایه‌ها، را شروع می‌کند.

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

ایجاد اسنپ‌شات CreateSnapshot

تابع ایجاد اسنپ‌شات(c: کلاینت، err &: خطا): اطلاعات کار
یک اسنپ‌شات از پایگاه داده را شروع می‌کند.

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

دریافت ویژگی‌های آزمایشی GetExperimentalFeatures

تابع دریافت ویژگی‌های آزمایشی(c: کلاینت، err &: خطا): رشته
ویژگی‌های آزمایشی و روشن بودن هر کدام، به شکل JSON خام.

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

به‌روزرسانی ویژگی‌های آزمایشی UpdateExperimentalFeatures

تابع به‌روزرسانی ویژگی‌های آزمایشی(c: کلاینت، features: رشته، err &: خطا): رشته
ویژگی‌های آزمایشی را روشن یا خاموش می‌کند؛ یک شیء JSON مثل {"metrics": true} بدهید.

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

دریافت شبکه GetNetwork

تابع دریافت شبکه(c: کلاینت، err &: خطا): رشته
تنظیمات شبکه برای جستجوی فدرال میان چند سرور، به شکل JSON خام.

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

به‌روزرسانی شبکه UpdateNetwork

تابع به‌روزرسانی شبکه(c: کلاینت، network: رشته، err &: خطا): رشته
تنظیمات شبکه را تغییر می‌دهد.

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

صدور Export

تابع صدور(c: کلاینت، request: رشته، err &: خطا): اطلاعات کار
فرستادن نمایه‌ها به یک میلی‌سرچ دیگر را شروع می‌کند؛ بدنه‌ی JSON مسیر صدور را بدهید.

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

دریافت معیارها GetMetrics

تابع دریافت معیارها(c: کلاینت، err &: خطا): رشته
معیارهای Prometheus به شکل متن؛ ویژگی metrics باید روشن باشد.

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

جدید New

تابع جدید(host: رشته، api_key: رشته): کلاینت
یک کارخواه می‌سازد. اگر http:// نباشد افزوده و اسلش پایانی حذف می‌شود.

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

با عامل WithAgent

تابع با عامل(c: کلاینت، agent: رشته): کلاینت
رونوشتی از کارخواه که نام برنامه‌ی شما را در سرآیند کارخواه می‌گذارد.

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

موفق Ok

تابع موفق(err: خطا): منطقی
آخرین فراخوانی موفق بود.

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

متن خطا ErrorString

تابع متن خطا(err: خطا): رشته
خطا در یک خط، مثل meilisearch 404 [index_not_found]: Index `movies` not found.؛ اگر خطایی نباشد خالی است.

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

درخواست Request

تابع درخواست(c: کلاینت، method: رشته، path: رشته، body: رشته، err &: خطا): رشته
هر درخواستی را با بدنه‌ی JSON می‌فرستد و بدنه‌ی خام پاسخ را برمی‌گرداند؛ برای مسیرهایی که تابع جداگانه ندارند.

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

درخواست با نوع RequestAs

تابع درخواست با نوع(c: کلاینت، method: رشته، path: رشته، content_type: رشته، body: رشته، err &: خطا): رشته
همان، با نوع محتوایی که خودتان تعیین می‌کنید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: db-meilisearch-Client.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

ایجاد کلید CreateKey

تابع ایجاد کلید(c: کلاینت، r: درخواست کلید، err &: خطا): کلید
یک کلید API می‌سازد؛ کلید اصلی لازم است.

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

دریافت کلید GetKey

تابع دریافت کلید(c: کلاینت، key_or_uid: رشته، err &: خطا): کلید
یک کلید، با شناسه یا مقدارش.

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

دریافت کلیدها GetKeys

تابع دریافت کلیدها(c: کلاینت، offset: صحیح، limit: صحیح، err &: خطا): صفحه کلید
یک صفحه از کلیدها.

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

به‌روزرسانی کلید UpdateKey

تابع به‌روزرسانی کلید(c: کلاینت، key_or_uid: رشته، name: رشته، description: رشته، err &: خطا): کلید
نام و توضیح یک کلید را تغییر می‌دهد؛ چیز دیگری از کلید قابل تغییر نیست.

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

حذف کلید DeleteKey

تابع حذف کلید(c: کلاینت، key_or_uid: رشته، err &: خطا): منطقی
یک کلید را حذف می‌کند؛ بی‌درنگ از کار می‌افتد.

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

توکن مستاجر TenantToken

تابع توکن مستاجر(api_key_uid: رشته، api_key: رشته، search_rules: رشته، expires_at: صحیح۶۴، err &: خطا): رشته
یک توکن مستاجر برای یک کاربر امضا می‌کند: کلید جستجویی که قاعده‌های فیلتر شما را روی هر جستجو اعمال می‌کند و بدون درخواست به سرور ساخته می‌شود. شناسه و مقدار کلیدی را که اجازه‌ی جستجو دارد، قاعده‌های جستجو به شکل JSON (خالی یعنی همه‌ی نمایه‌ها) و زمان انقضای یونیکس (۰ یعنی بدون انقضا) را بدهید.

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

ایجاد نمایه CreateIndex

تابع ایجاد نمایه(c: کلاینت، uid: رشته، primary_key: رشته، err &: خطا): اطلاعات کار
یک نمایه می‌سازد؛ کلید اصلی را خالی بگذارید تا میلی‌سرچ آن را از نخستین سندها حدس بزند.

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

دریافت نمایه GetIndex

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

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

فهرست نمایه‌ها ListIndexes

تابع فهرست نمایه‌ها(c: کلاینت، offset: صحیح، limit: صحیح، err &: خطا): صفحه نمایه
یک صفحه از نمایه‌ها؛ ۰ برای جابجایی و حد یعنی پیش‌فرض سرور.

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

به‌روزرسانی نمایه UpdateIndex

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

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

تغییر نام نمایه RenameIndex

تابع تغییر نام نمایه(c: کلاینت، uid: رشته، new_uid: رشته، err &: خطا): اطلاعات کار
به نمایه نام تازه می‌دهد.

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

حذف نمایه DeleteIndex

تابع حذف نمایه(c: کلاینت، uid: رشته، err &: خطا): اطلاعات کار
نمایه و همه‌ی سندهایش را حذف می‌کند.

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

جابجایی نمایه‌ها SwapIndexes

تابع جابجایی نمایه‌ها(c: کلاینت، swaps: وکتور<جابجایی نمایه>، err &: خطا): اطلاعات کار
محتوای جفت نمایه‌ها را در یک گام یکپارچه جابجا می‌کند؛ راه بازسازی نمایه بدون از کار افتادن.

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

دریافت آمار نمایه GetIndexStats

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

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

افزودن سندها AddDocuments

تابع افزودن سندها(c: کلاینت، uid: رشته، documents: رشته، primary_key: رشته، err &: خطا): اطلاعات کار
سندها را می‌افزاید یا سندهای هم‌شناسه را جایگزین می‌کند؛ یک آرایه یا شیء JSON بدهید.

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

به‌روزرسانی سندها UpdateDocuments

تابع به‌روزرسانی سندها(c: کلاینت، uid: رشته، documents: رشته، primary_key: رشته، err &: خطا): اطلاعات کار
سندها را می‌افزاید یا فیلدهای داده‌شده را با سندهای هم‌شناسه ادغام می‌کند.

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

افزودن سندهای ان‌دی‌جیسون AddDocumentsNdjson

تابع افزودن سندهای ان‌دی‌جیسون(c: کلاینت، uid: رشته، documents: رشته، primary_key: رشته، err &: خطا): اطلاعات کار
سندهایی را که به شکل NDJSON، یعنی هر خط یک شیء JSON، نوشته شده‌اند می‌افزاید.

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

به‌روزرسانی سندهای ان‌دی‌جیسون UpdateDocumentsNdjson

تابع به‌روزرسانی سندهای ان‌دی‌جیسون(c: کلاینت، uid: رشته، documents: رشته، primary_key: رشته، err &: خطا): اطلاعات کار
سندهای NDJSON را ادغام می‌کند.

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

افزودن سندهای سی‌اس‌وی AddDocumentsCsv

تابع افزودن سندهای سی‌اس‌وی(c: کلاینت، uid: رشته، documents: رشته، primary_key: رشته، delimiter: رشته، err &: خطا): اطلاعات کار
سندهایی را که به شکل CSV نوشته شده‌اند می‌افزاید؛ جداکننده‌ی خالی یعنی ویرگول. برای ستون عددی در سرستون year:number بنویسید.

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

به‌روزرسانی سندهای سی‌اس‌وی UpdateDocumentsCsv

تابع به‌روزرسانی سندهای سی‌اس‌وی(c: کلاینت، uid: رشته، documents: رشته، primary_key: رشته، delimiter: رشته، err &: خطا): اطلاعات کار
سندهای CSV را ادغام می‌کند.

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

افزودن سندها در دسته‌ها AddDocumentsInBatches

تابع افزودن سندها در دسته‌ها(c: کلاینت، uid: رشته، documents: وکتور<رشته>، batch_size: صحیح، primary_key: رشته، err &: خطا): وکتور<اطلاعات کار>
سندهای زیاد را، هر کدام یک شیء JSON، در دسته‌هایی به اندازه‌ی داده‌شده می‌افزاید؛ برای هر دسته یک کار برمی‌گرداند.

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

افزودن سندهای نوع AddDocumentsOf

تابع افزودن سندهای نوع<T>(c: کلاینت، uid: رشته، documents: وکتور<T>، primary_key: رشته، err &: خطا): اطلاعات کار
ساختارهای سلام را به عنوان سند می‌افزاید؛ هر کدام به JSON تبدیل می‌شود.

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

دریافت سند GetDocument

تابع دریافت سند(c: کلاینت، uid: رشته، id: رشته، fields: وکتور<رشته>، err &: خطا): رشته
یک سند به شکل JSON خام؛ فهرست خالی فیلدها یعنی همه‌ی فیلدها.

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

دریافت سند به نوع GetDocumentAs

تابع دریافت سند به نوع<T>(c: کلاینت، uid: رشته، id: رشته، out &: T، err &: خطا): منطقی
یک سند که درون یک ساختار سلام خوانده می‌شود؛ فیلدهایی که ساختار ندارد نادیده گرفته می‌شوند.

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

دریافت سندها GetDocuments

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

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

سندها به نوع DocumentsAs

تابع سندها به نوع<T>(p: صفحه، out &: وکتور<T>، err &: خطا): منطقی
همه‌ی سندهای یک صفحه را درون ساختارهای سلام می‌خواند.

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

حذف سند DeleteDocument

تابع حذف سند(c: کلاینت، uid: رشته، id: رشته، err &: خطا): اطلاعات کار
یک سند را حذف می‌کند.

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

حذف سندها DeleteDocuments

تابع حذف سندها(c: کلاینت، uid: رشته، ids: وکتور<رشته>، err &: خطا): اطلاعات کار
سندهای دارای این شناسه‌ها را حذف می‌کند.

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

حذف سندها با فیلتر DeleteDocumentsByFilter

تابع حذف سندها با فیلتر(c: کلاینت، uid: رشته، filter: رشته، err &: خطا): اطلاعات کار
سندهای منطبق با یک فیلتر را حذف می‌کند.

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

حذف همه سندها DeleteAllDocuments

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

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

به‌روزرسانی سندها با اسکریپت UpdateDocumentsByFunction

تابع به‌روزرسانی سندها با اسکریپت(c: کلاینت، uid: رشته، function: رشته، filter: رشته، context: رشته، err &: خطا): اطلاعات کار
سندها را با یک اسکریپت Rhai تغییر می‌دهد، در صورت نیاز فقط سندهای منطبق با یک فیلتر و با یک زمینه‌ی JSON؛ ویژگی editDocumentsByFunction باید روشن باشد.

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