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

اپن سرچ db/opensearch

کارخواه OpenSearch: سند، دسته‌ای، زبان پرسمان، تجمیع، پیمایش و نقطه‌ی زمانی، مدیریت نمایه، SQL و PPL، جستجوی برداری k-NN، سیاست ISM، امنیت و امضای AWS.

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

اپن سرچ یک موتور جستجو و تحلیل متن‌باز است. این بسته مستقیم و بدون هیچ کتابخانه‌ی بیرونی، با net.tcp و tls با API آن کار می‌کند: چند گره با تلاش دوباره و کنار گذاشتن گره از کار افتاده، احراز هویت پایه، توکن حامل و امضای AWS SigV4 (برای Amazon OpenSearch Service و Serverless) و TLS با پرونده‌ی CA خودتان یا، برای سرور آزمایشی، بدون وارسی گواهی. روی این‌ها سند، دسته‌ای، پرسمان‌ها و تجمیع‌های رایج، صفحه‌بندی با پیمایش و نقطه‌ی زمانی، مدیریت نمایه، نام مستعار، الگو و جریان داده، مدیریت خوشه، کار، تصویر لحظه‌ای و خط لوله را پوشش می‌دهد و افزونه‌هایی که اپن سرچ را اپن سرچ می‌کنند: SQL و PPL، جستجوی k-NN و عصبی، خط لوله‌ی جستجوی ترکیبی، سیاست‌های ISM، افزونه‌ی امنیت، پایشگرهای هشدار و ML Commons.

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

الستیک سرچ هم با API پایه‌ی اپن سرچ کار می‌کند. هر جا به چیزی نیاز دارید که فقط اپن سرچ دارد این بسته را به کار ببرید: PPL، جستجوی k-NN، عصبی و ترکیبی، ISM، افزونه‌ی امنیت، هشدار، ML Commons یا امضای AWS SigV4 برای Amazon OpenSearch Service و Serverless.

آموزش: جستجو با اپن سرچ

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

سروری برای گفتگو

هر نمونه‌ای که با خوشه گفتگو می‌کند انتظار دارد سروری روی http://localhost:9200 باشد. ساده‌ترین راه داکر است: docker run -p 9200:9200 -e discovery.type=single-node -e DISABLE_SECURITY_PLUGIN=true opensearchproject/opensearch:2.17.1. پشت این صفحه سروری نیست، پس این نمونه‌ها را مترجم بررسی می‌کند و خروجی‌ای را نشان می‌دهند که هنگام اجرای پشت سر هم روی یک اپن سرچ ۲.۱۷.۱ واقعی چاپ کردند. نمونه‌هایی که فقط درخواست می‌سازند یا پاسخ می‌خوانند در هر ساخت سایت اجرا می‌شوند.

این بسته را با واردسازی دیتابیس.اپن سرچ بیاورید و با نام اپن سرچ صدا بزنید.

اتصال

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

opensearch-connect.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ک := اپن سرچ.اتصال("http://localhost:9200")
    اگر وارونه اپن سرچ.پینگ(ک):
        سرچاپ "پاسخی نیامد:"، اپن سرچ.خطا(ک)
        برگشت 1
    پایان
    آگاهی := اپن سرچ.دریافت اطلاعات(ک)
    سرچاپ آگاهی.توزیع، آگاهی.نسخه، آگاهی.نام خوشه
    ه := اپن سرچ.سلامت خوشه(ک)
    سرچاپ "سلامت:"، ه.وضعیت، ه.گره‌ها، "گره"
    برگشت 0
پایان
خروجیopensearch 2.17.1 docker-cluster سلامت: green 1 گره

یک راه‌اندازی واقعی معمولا بیشتر لازم دارد: چند گره، نام کاربری و گذرواژه، مرجع صدور گواهی خودتان و سقف زمان. آن‌ها را در یک پیکربندی بگذارید و به کارخواه تازه بدهید. کارخواه درخواست‌ها را میان گره‌ها پخش می‌کند، گره‌ای را که اتصال را رد کند یک دقیقه کنار می‌گذارد و درخواستی را که پاسخ 502، 503 یا 504 گرفته روی گره‌ی دیگری دوباره می‌فرستد. اتصال بدون وارسی گواهی برای راه‌اندازی نمایشی با گواهی خودامضاست و اتصال آمازون هر درخواست را با AWS SigV4 برای Amazon OpenSearch Service امضا می‌کند؛ برای یک مجموعه‌ی Serverless به جای سرویس دامنه از سرویس بی‌سرور استفاده کنید.

opensearch-config.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ناپایا تنظیم := اپن سرچ.پیکربندی پیش‌فرض()
    تنظیم.گره‌ها.بیفزا("https://node2.example.com:9200, https://node3.example.com:9200")
    تنظیم.نام کاربری = "app"
    تنظیم.گذرواژه = "s3cret-pass"
    تنظیم.پرونده مراجع گواهی = "/etc/ssl/certs/opensearch-ca.pem"
    تنظیم.مهلت به میلی‌ثانیه = 10000
    تنظیم.حداکثر کوشش مجدد = 2
    ک := اپن سرچ.کارخواه تازه(تنظیم)
    سرچاپ اپن سرچ.معتبر(ک)، اپن سرچ.گره‌ها(ک)

    محلی := اپن سرچ.اتصال بدون وارسی گواهی("https://localhost:9200"، "admin"، "admin-pass")
    سرچاپ اپن سرچ.معتبر(محلی)

    آمازون := اپن سرچ.اتصال آمازون(
        "https://search-books.eu-west-1.es.amazonaws.com"، "eu-west-1"، اپن سرچ.سرویس دامنه،
        "AKIA..."، "secret-key"، ""
    )
    سرچاپ اپن سرچ.معتبر(آمازون)
پایان
خروجیtrue ["http://localhost:9200", "https://node2.example.com:9200", "https://node3.example.com:9200"] true true

نمایه و سندهایش

نمایه جایی است که سندها در آن زندگی می‌کنند و نگاشت آن می‌گوید هر فیلد چیست: text برای جستجوی تمام‌متن به واژه‌ها شکسته می‌شود، keyword دقیق تطبیق می‌خورد و عدد و تاریخ را می‌شود مقایسه و مرتب کرد. اگر نگاشتی ندهید اپن سرچ آن را حدس می‌زند، ولی حدس را بعدا نمی‌شود عوض کرد؛ پس بهتر است نمایه را خودتان بسازید. ویژگی یک فیلد می‌نویسد و ویژگی‌ها آن‌ها را کنار هم می‌گذارد.

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

opensearch-documents.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ک := اپن سرچ.اتصال("http://localhost:9200")
    ناپایا ویژگی‌ها := وکتور {} برگردان وکتور<رشته>
    ویژگی‌ها.بیفزا(اپن سرچ.ویژگی("title"، "text"))
    ویژگی‌ها.بیفزا(اپن سرچ.ویژگی("author"، "keyword"))
    ویژگی‌ها.بیفزا(اپن سرچ.ویژگی("year"، "integer"))
    ویژگی‌ها.بیفزا(اپن سرچ.ویژگی("stock"، "integer"))
    سرچاپ "ساخته شد:"، اپن سرچ.ایجاد نمایه با تنظیمات(ک، "books"، 1، 0، اپن سرچ.ویژگی‌ها(ویژگی‌ها))

    ن := اپن سرچ.نمایه‌سازی با گزینه(ک، "books"، "1"، `{"title":"Shahnameh","author":"Ferdowsi","year":1010,"stock":3}`، اپن سرچ.گزینه‌ها { تازه‌سازی = اپن سرچ.تازه‌سازی با انتظار })
    سرچاپ "نمایه شد:"، ن.موفق، ن.نتیجه، ن.نسخه

    د := اپن سرچ.دریافت(ک، "books"، "1")
    اگر د.یافت شد:
        سرچاپ "عنوان:"، اپن سرچ.مسیر جیسون(د.منبع، "title")
    پایان

    به‌روز := اپن سرچ.به‌روزرسانی(ک، "books"، "1"، `{"stock":2}`)
    سرچاپ "به‌روز شد:"، به‌روز.نتیجه، به‌روز.نسخه

    حذف شده := اپن سرچ.حذف سند(ک، "books"، "1")
    سرچاپ "حذف شد:"، حذف شده.نتیجه
پایان
خروجیساخته شد: true نمایه شد: true created 1 عنوان: Shahnameh به‌روز شد: updated 2 حذف شد: deleted

چند سند با هم

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

opensearch-bulk.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ناپایا ب := اپن سرچ.دسته‌ای تازه()
    اپن سرچ.نمایه‌سازی دسته‌ای(ب، "books"، "1"، `{"title":"Shahnameh","author":"Ferdowsi","year":1010}`)
    اپن سرچ.نمایه‌سازی دسته‌ای(ب، "books"، "2"، `{"title":"Masnavi","author":"Rumi","year":1258}`)
    اپن سرچ.نمایه‌سازی دسته‌ای(ب، "books"، "3"، `{"title":"Golestan","author":"Saadi","year":1258}`)
    اپن سرچ.به‌روزرسانی دسته‌ای(ب، "books"، "2"، `{"stock":4}`)
    اپن سرچ.حذف دسته‌ای(ب، "books"، "99")
    سرچاپ اپن سرچ.اندازه دسته‌ای(ب)، "کنش"
    چاپ اپن سرچ.بدنه دسته‌ای(ب)
    اپن سرچ.آزادسازی دسته‌ای(ب)
پایان
خروجی5 کنش {"index":{"_index":"books","_id":"1"}} {"title":"Shahnameh","author":"Ferdowsi","year":1010} {"index":{"_index":"books","_id":"2"}} {"title":"Masnavi","author":"Rumi","year":1258} {"index":{"_index":"books","_id":"3"}} {"title":"Golestan","author":"Saadi","year":1258} {"update":{"_index":"books","_id":"2"}} {"doc":{"stock":4}} {"delete":{"_index":"books","_id":"99"}}

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

opensearch-bulk-send.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ک := اپن سرچ.اتصال("http://localhost:9200")
    ناپایا ب := اپن سرچ.دسته‌ای تازه()
    اپن سرچ.نمایه‌سازی دسته‌ای(ب، "books"، "1"، `{"title":"Shahnameh, the Book of Kings","author":"Ferdowsi","year":1010}`)
    اپن سرچ.نمایه‌سازی دسته‌ای(ب، "books"، "2"، `{"title":"Masnavi","author":"Rumi","year":1258}`)
    اپن سرچ.نمایه‌سازی دسته‌ای(ب، "books"، "3"، `{"title":"Golestan","author":"Saadi","year":1258}`)
    اپن سرچ.نمایه‌سازی دسته‌ای(ب، "books"، "4"، `{"title":"Kings and Heroes","author":"Anonymous","year":1900}`)
    پاسخ := اپن سرچ.ارسال دسته‌ای با تازه‌سازی(ک، ب، اپن سرچ.تازه‌سازی فوری)
    اپن سرچ.آزادسازی دسته‌ای(ب)
    سرچاپ پاسخ.تعداد موفق، "ذخیره شد،"، پاسخ.تعداد ناموفق، "شکست خورد"
    هر قلم در پاسخ.موارد:
        اگر وارونه قلم.موفق:
            سرچاپ قلم.شناسه، قلم.نوع خطا، قلم.علت خطا
        پایان
    پایان
پایان
خروجی4 ذخیره شد، 0 شکست خورد

ساختن پرسمان

پرسمان هم JSON است و بسته برای هر گونه‌ی رایج یک سازنده دارد. تطبیق واژه‌های یک فیلد متنی را جستجو می‌کند، واژه یک مقدار دقیق می‌خواهد و بازه، بازه صحیح و بازه تاریخ مقایسه می‌کنند. برای ترکیبشان یک پرسمان منطقی را پر کنید: must باید تطبیق بخورد و به امتیاز می‌افزاید، filter باید تطبیق بخورد ولی امتیاز نمی‌دهد، should امتیاز را بالا می‌برد و must_not کنار می‌گذارد. یک درخواست جستجو صفحه‌بندی، مرتب‌سازی و فیلدهای برگشتی را می‌افزاید؛ بدنه جستجو نشان می‌دهد چه فرستاده خواهد شد.

opensearch-query.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    سرچاپ اپن سرچ.تطبیق("title"، "book of kings")
    سرچاپ اپن سرچ.واژه("author"، "Ferdowsi")
    سرچاپ اپن سرچ.بازه صحیح("year"، 1000، 1300)

    ناپایا شرط := اپن سرچ.پرسمان منطقی {}
    شرط.الزامی.بیفزا(اپن سرچ.تطبیق("title"، "kings"))
    شرط.فیلتر.بیفزا(اپن سرچ.بازه صحیح("year"، 1000، 1300))
    شرط.ممنوع.بیفزا(اپن سرچ.واژه("author"، "Anonymous"))
    سرچاپ اپن سرچ.پرسمان منطقی ساخته(شرط)

    ناپایا درخواست := اپن سرچ.درخواست جستجو { پرسمان = اپن سرچ.پرسمان منطقی ساخته(شرط)، اندازه = 5 }
    درخواست.مرتب‌سازی.بیفزا(اپن سرچ.مرتب نزولی("year"))
    درخواست.منبع.بیفزا("title")
    سرچاپ اپن سرچ.بدنه جستجو(درخواست)
پایان
خروجی{"match":{"title":"book of kings"}} {"term":{"author":"Ferdowsi"}} {"range":{"year":{"gte":1000,"lte":1300}}} {"bool":{"must":[{"match":{"title":"kings"}}],"filter":[{"range":{"year":{"gte":1000,"lte":1300}}}],"must_not":[{"term":{"author":"Anonymous"}}]}} {"query":{"bool":{"must":[{"match":{"title":"kings"}}],"filter":[{"range":{"year":{"gte":1000,"lte":1300}}}],"must_not":[{"term":{"author":"Anonymous"}}]}},"size":5,"sort":[{"year":{"order":"desc"}}],"_source":{"includes":["title"]}}

هر چه سازنده‌ها پوشش نمی‌دهند را می‌شود با دست به شکل رشته‌ی بک‌تیک نوشت، چون پرسمان فقط متن است. سازنده‌ها، بدنه‌ی درخواست و پاسخ را می‌شود با JSON خودتان درآمیخت.

خواندن یافته‌ها

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

opensearch-search.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ک := اپن سرچ.اتصال("http://localhost:9200")
    ناپایا فیلدها := وکتور {} برگردان وکتور<رشته>
    فیلدها.بیفزا("title")
    ناپایا درخواست := اپن سرچ.درخواست جستجو { پرسمان = اپن سرچ.تطبیق("title"، "kings")، اندازه = 10 }
    درخواست.برجسته‌سازی = اپن سرچ.برجسته‌سازی(فیلدها)
    ر := اپن سرچ.جستجو با درخواست(ک، "books"، درخواست)
    اگر وارونه ر.موفق:
        سرچاپ ر.خطا
        برگشت 1
    پایان
    سرچاپ ر.کل، "یافته"
    هر ه در ر.نتایج:
        سرچاپ ه.شناسه، ه.امتیاز، ه.منبع
    پایان
    برگشت 0
پایان
خروجی2 یافته 4 0.8547784 {"title":"Kings and Heroes","author":"Anonymous","year":1900} 1 0.63807404 {"title":"Shahnameh, the Book of Kings","author":"Ferdowsi","year":1010}

همین خواننده روی پاسخی که از پیش دارید هم کار می‌کند، با تجزیه جستجو. این نمونه به همین شکل این‌جا بدون سرور اجرا می‌شود:

opensearch-results.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    پاسخ سرور := `{"took":3,"timed_out":false,"hits":{"total":{"value":2,"relation":"eq"},"max_score":2.1,"hits":[{"_index":"books","_id":"1","_score":2.1,"_source":{"title":"Shahnameh","author":"Ferdowsi"},"highlight":{"title":["<em>Shahnameh</em>"]}},{"_index":"books","_id":"7","_score":0.8,"_source":{"title":"Tales from the Shahnameh","author":"Anonymous"}}]}}`
    ر := اپن سرچ.تجزیه جستجو(پاسخ سرور)
    سرچاپ ر.کل، "یافته در"، ر.زمان اجرا، "میلی‌ثانیه"
    هر ه در ر.نتایج:
        سرچاپ ه.شناسه، ه.امتیاز، اپن سرچ.مسیر جیسون(ه.منبع، "title")، "از"، اپن سرچ.مسیر جیسون(ه.منبع، "author")
    پایان
    سرچاپ اپن سرچ.مسیر جیسون(ر.نتایج.بگیر(0).برجسته‌سازی، "title.0")
پایان
خروجی2 یافته در 3 میلی‌ثانیه 1 2.1 Shahnameh از Ferdowsi 7 0.8 Tales from the Shahnameh از Anonymous <em>Shahnameh</em>

شمردن با تجمیع

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

opensearch-aggs.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ناپایا تجمیع‌ها := اپن سرچ.افزودن تجمیع("{}"، "authors"، اپن سرچ.تجمیع واژه‌ها("author"، 3))
    تجمیع‌ها = اپن سرچ.افزودن تجمیع(تجمیع‌ها، "avg_year"، اپن سرچ.تجمیع میانگین("year"))
    سرچاپ اپن سرچ.بدنه جستجو(اپن سرچ.درخواست جستجو { اندازه = 0، تجمیع‌ها = تجمیع‌ها })

    پاسخ سرور := `{"took":2,"hits":{"total":{"value":40,"relation":"eq"},"hits":[]},"aggregations":{"authors":{"buckets":[{"key":"Saadi","doc_count":12},{"key":"Rumi","doc_count":9},{"key":"Hafez","doc_count":7}]},"avg_year":{"value":1265.5}}}`
    ر := اپن سرچ.تجزیه جستجو(پاسخ سرور)
    هر ب در اپن سرچ.سطل‌ها(ر.تجمیع‌ها، "authors"):
        سرچاپ ب.کلید، ب.تعداد سند
    پایان
    سرچاپ "میانگین سال:"، اپن سرچ.مقدار تجمیع(ر.تجمیع‌ها، "avg_year")
پایان
خروجی{"size":0,"aggs":{"authors":{"terms":{"field":"author","size":3}},"avg_year":{"avg":{"field":"year"}}}} Saadi 12 Rumi 9 Hafez 7 میانگین سال: 1265.5

گذر از همه‌چیز

from و size برای صفحه‌های نخستی که آدم‌ها می‌بینند خوب است، ولی نه برای گذشتن از کل یک نمایه. برای آن با ایجاد نقطه زمانی یک نقطه‌ی زمانی باز کنید که نمایی از نمایه را ثابت نگه می‌دارد، با یک فیلد مرتب کنید و هر صفحه‌ی بعد را با search_after برابر مقدارهای مرتب‌سازی آخرین یافته بخواهید. صفحه‌ی خالی یعنی تمام؛ نقطه‌ی زمانی را با حذف نقطه زمانی ببندید.

opensearch-paging.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ک := اپن سرچ.اتصال("http://localhost:9200")
    نقطه := اپن سرچ.ایجاد نقطه زمانی(ک، "books"، "2m")
    ناپایا درخواست := اپن سرچ.درخواست جستجو { پرسمان = اپن سرچ.تطبیق همه()، اندازه = 100، شناسه نقطه زمانی = نقطه، زنده‌ماندن نقطه زمانی = "2m" }
    درخواست.مرتب‌سازی.بیفزا(اپن سرچ.مرتب صعودی("year"))
    ناپایا دیده‌شده := 0
    ناپایا صفحه := اپن سرچ.جستجو با درخواست(ک، ""، درخواست)
    تا صفحه.نتایج.طول() > 0:
        دیده‌شده += صفحه.نتایج.طول()
        درخواست.ادامه پس از = صفحه.نتایج.بگیر(صفحه.نتایج.طول() - 1).مرتب‌سازی
        صفحه = اپن سرچ.جستجو با درخواست(ک، ""، درخواست)
    پایان
    اپن سرچ.حذف نقطه زمانی(ک، نقطه)
    سرچاپ دیده‌شده، "کتاب"
پایان
خروجی4 کتاب

SQL و PPL

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

opensearch-sql.salam
واردسازی دیتابیس
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ک := اپن سرچ.اتصال("http://localhost:9200")
    رابط := اپن سرچ.اتصال عمومی(ک)
    سرچاپ دیتابیس.پرسمان عدد(رابط، "SELECT COUNT(*) FROM books WHERE year > 1200")
    ردیف‌ها := رابط.پرسمان("SELECT author, COUNT(*) AS n FROM books GROUP BY author ORDER BY n DESC")
    تا ردیف‌ها.بعدی():
        سرچاپ ردیف‌ها.متن(0)، ردیف‌ها.عدد صحیح(1)
    پایان
    ردیف‌ها.بستن()

    پ := اپن سرچ.پی پی ال(ک، "source=books | where year > 1200 | stats count() by author")
    تا پ.بعدی():
        سرچاپ پ.متن(1)، پ.عدد صحیح(0)
    پایان
    پ.بستن()
پایان
خروجی3 Anonymous 1 Saadi 1 Rumi 1 Ferdowsi 1 Anonymous 1 Rumi 1 Saadi 1

جستجوی برداری

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

opensearch-vectors.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ک := اپن سرچ.اتصال("http://localhost:9200")
    روش درخواست := اپن سرچ.روش همسایه‌یابی { موتور = "lucene"، نوع فضا = "cosinesimil" }
    ناپایا افزوده := وکتور {} برگردان وکتور<رشته>
    افزوده.بیفزا(اپن سرچ.ویژگی("name"، "text"))
    اپن سرچ.ایجاد نمایه(ک، "places"، اپن سرچ.بدنه نمایه همسایه‌یابی("embedding"، 3، روش درخواست، افزوده))
    اپن سرچ.نمایه‌سازی(ک، "places"، "1"، `{"name":"Naderi Cafe","embedding":[0.1,0.9,0.2]}`)
    اپن سرچ.تازه‌سازی(ک، "places")

    ناپایا ز := وکتور {} برگردان وکتور<اعشار۶۴>
    ز.بیفزا(0.1)
    ز.بیفزا(0.8)
    ز.بیفزا(0.3)
    ر := اپن سرچ.جستجو(ک، "places"، اپن سرچ.نزدیک‌ترین همسایه‌ها("embedding"، ز، 3))
    هر ه در ر.نتایج:
        سرچاپ ه.شناسه، ه.امتیاز، ه.منبع
    پایان
پایان
خروجی1 0.99514455 {"name":"Naderi Cafe","embedding":[0.1,0.9,0.2]}

وقتی چیزی خراب می‌شود

هیچ فراخوانی برنامه‌ی شما را متوقف نمی‌کند. فراخوانی ناموفق نادرست، منفی یک یا نتیجه‌ی خالی برمی‌گرداند و کارخواه آن‌چه رخ داده را به یاد می‌سپارد: وضعیت وضعیت HTTP آخرین درخواست است (وقتی پاسخی نیامد ۰)، خطا پیامی خواناست و نوع خطا و علت خطا همان چیزی‌اند که اپن سرچ گفته، مثل version_conflict_engine_exception. نشانی نادرست هنگام ساختن کارخواه گرفته می‌شود و معتبر آن را می‌گوید. نبودن سند خطا نیست: دریافت با found = false و error خالی برمی‌گردد.

opensearch-errors.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ناپایا تنظیم := اپن سرچ.پیکربندی پیش‌فرض()
    تنظیم.گره‌ها = وکتور {} برگردان وکتور<رشته>
    تنظیم.گره‌ها.بیفزا("http://127.0.0.1:1")
    تنظیم.حداکثر کوشش مجدد = 0
    ک := اپن سرچ.کارخواه تازه(تنظیم)
    سرچاپ "پیکربندی معتبر:"، اپن سرچ.معتبر(ک)

    د := اپن سرچ.دریافت(ک، "books"، "1")
    سرچاپ "پیدا شد:"، د.یافت شد
    سرچاپ "وضعیت:"، اپن سرچ.وضعیت(ک)
    سرچاپ "خطا:"، اپن سرچ.خطا(ک)

    خراب := اپن سرچ.اتصال("ftp://example.com")
    سرچاپ "پیکربندی معتبر:"، اپن سرچ.معتبر(خراب)، "|"، اپن سرچ.خطا(خراب)
پایان
خروجیپیکربندی معتبر: true پیدا شد: false وضعیت: 0 خطا: http://127.0.0.1:1: could not connect to 127.0.0.1:1 پیکربندی معتبر: false | the node url could not be parsed: ftp://example.com

گام بعد

مرجع پایین همین صفحه همه‌ی تابع‌ها را با نمونه فهرست می‌کند، از جمله الگوهای نمایه، نام‌های مستعار، تصویر لحظه‌ای، خط لوله‌ی ورودی، سیاست‌های ISM، افزونه‌ی امنیت، هشدار و ML Commons. برای هر چه بسته تابعی برایش ندارد، انجام هر درخواستی را که بنویسید می‌فرستد.

بیشتر

کدام تابع برای کدام کار

برای این کاربه کار ببرید
گذر از کل یک نمایهایجاد نقطه زمانی، search_after، حذف نقطه زمانی (یا جستجوی پیمایشی و پیمایش)
چند جستجو در یک درخواستجستجوی چندگانه
تغییر یا حذف آن‌چه یک پرسمان می‌یابدبه‌روزرسانی پرسمانی، حذف پرسمانی
رونوشت از نمایه و جابجایی بدون توقفنمایه‌سازی دوباره، سپس جابجایی نام مستعار
پرسمان با SQL یا PPLاتصال عمومی با رابط دیتابیس، اس کیو ال، اس کیو ال با پارامتر، پی پی ال
جستجوی برداری، عصبی و ترکیبیبدنه نمایه همسایه‌یابی، نزدیک‌ترین همسایه‌ها، عصبی، ترکیبی، خط لوله نرمال‌سازی
حذف زمان‌بندی‌شده‌ی نمایه‌های کهنهسیاست حذف پس از، تنظیم سیاست، افزودن سیاست
کاربران و مجوزهاتنظیم کاربر، بدنه نقش، تنظیم نقش، تنظیم نگاشت نقش، من کیستم
دگرگونی سندها هنگام نمایه‌سازیخط لوله، پردازنده، تنظیم خط لوله، شبیه‌سازی خط لوله
پشتیبان‌گیری و بازیابیتنظیم مخزن، ایجاد تصویر لحظه‌ای، بازیابی تصویر لحظه‌ای
هر کار دیگرانجام، انجام چندخطی

آزمودن بدون سرور

آزمون‌های این بسته روی یک اپن سرچ ساختگی کوچک ساخته‌شده با اچ تی تی پی اجرا می‌شوند: هر درخواست را ثبت می‌کند و با JSON آماده پاسخ می‌دهد، پس آزمون هم آن‌چه کارخواه فرستاده و هم خواندن پاسخ را بررسی می‌کند. مجموعه‌ی tests/en/stdlib/opensearch و همتای فارسی آن در tests/fa/stdlib/opensearch همه‌ی ویژگی‌ها را به همین شکل پوشش می‌دهند و نقطه‌ی آغاز خوبی برای آزمون‌های خودتان هستند.

گونه‌ها

پرسمان منطقی BoolQuery

ساختار پرسمان منطقی
چهار فهرست بند و گزینه‌های یک پرسمان منطقی، برای پرسمان منطقی ساخته.
نامانگلیسیگونهتوضیح
الزامیmustوکتور<رشته>باید تطبیق بخورد و به امتیاز می‌افزاید.
فیلترfilterوکتور<رشته>باید تطبیق بخورد ولی امتیاز نمی‌دهد؛ در حافظه‌ی نهان می‌ماند.
ترجیحیshouldوکتور<رشته>بهتر است تطبیق بخورد؛ امتیاز را بالا می‌برد.
ممنوعmust_notوکتور<رشته>نباید تطبیق بخورد.
کمترین تطابق ترجیحیminimum_should_matchرشته = ""چند بند should باید تطبیق بخورند، مثل 1 یا 75%.
ضریبboostاعشار۶۴ = 0امتیاز را چند برابر می‌کند؛ ۰ آن را کنار می‌گذارد.
db-opensearch-Query.salam
واردسازی دیتابیس.اپن سرچ

تابع فهرست(الف: رشته، ب: رشته): وکتور<رشته>:
    ناپایا ز := وکتور {} برگردان وکتور<رشته>
    ز.بیفزا(الف)
    اگر ب.طول() بزرگتر 0: ز.بیفزا(ب) پایان
    برگشت ز
پایان

تابع ریشه:
    سرچاپ اپن سرچ.تطبیق همه()، اپن سرچ.تطبیق هیچ()
    سرچاپ اپن سرچ.تطبیق("title"، "salam")، اپن سرچ.تطبیق همه واژه‌ها("title"، "salam world")
    سرچاپ اپن سرچ.تطبیق تقریبی("title"، "slam")، اپن سرچ.تطبیق عبارت("title"، "hello world")
    سرچاپ اپن سرچ.تطبیق عبارت با فاصله("title"، "hello world"، 2)، اپن سرچ.تطبیق پیشوند عبارت("title"، "sal")
    سرچاپ اپن سرچ.تطبیق پیشوند منطقی("title"، "quick bro")
    سرچاپ اپن سرچ.تطبیق چندگانه("salam"، فهرست("title^2"، "body"))، اپن سرچ.تطبیق چندگانه نوع‌دار("salam"، فهرست("title"، "body")، "phrase")
    سرچاپ اپن سرچ.واژه("tag"، "news")، اپن سرچ.واژه عددی("year"، 1403)، اپن سرچ.واژه منطقی("published"، درست)
    سرچاپ اپن سرچ.واژه بدون حساسیت حروف("tag"، "News")، اپن سرچ.واژه‌ها("tag"، فهرست("news"، "sport"))
    ناپایا سال‌ها := وکتور {} برگردان وکتور<صحیح۶۴>
    سال‌ها.بیفزا(1402)
    سال‌ها.بیفزا(1403)
    سرچاپ اپن سرچ.واژه‌های عددی("year"، سال‌ها)، اپن سرچ.واژه‌های ارجاعی("tag"، "users"، "7"، "follows")
    سرچاپ اپن سرچ.مجموعه واژه‌ها("skills"، فهرست("go"، "salam")، "required")
    سرچاپ اپن سرچ.بازه("date"، "2026-01-01"، "2026-12-31")، اپن سرچ.بازه باز("price"، "10"، "20")
    سرچاپ اپن سرچ.بازه عددی("price"، 9.5، 20.0)، اپن سرچ.بازه صحیح("stock"، 1، 100)، اپن سرچ.بازه با عملگر("price"، "lt"، "5")
    سرچاپ اپن سرچ.بازه تاریخ("at"، "now-7d/d"، "now"، ""، "+03:30")
    سرچاپ اپن سرچ.وجود فیلد("email")، اپن سرچ.پیشوند("sku"، "AB-")، اپن سرچ.نویسه عام("sku"، "AB-*-9")
    سرچاپ اپن سرچ.عبارت باقاعده("sku"، "AB-[0-9]+")، اپن سرچ.تقریبی("name"، "maryem")، اپن سرچ.شناسه‌ها(فهرست("1"، "2"))
    سرچاپ اپن سرچ.رشته پرسمان("title:salam AND year:1403")
    سرچاپ اپن سرچ.رشته پرسمان در فیلدها("salam world"، فهرست("title"، "body")، "AND")
    سرچاپ اپن سرچ.رشته پرسمان ساده("salam -draft"، فهرست("title"، ""))

    ناپایا ب := اپن سرچ.پرسمان منطقی { کمترین تطابق ترجیحی = "1"، ضریب = 1.5 }
    ب.الزامی.بیفزا(اپن سرچ.تطبیق("title"، "salam"))
    ب.فیلتر.بیفزا(اپن سرچ.واژه("status"، "published"))
    ب.ترجیحی.بیفزا(اپن سرچ.واژه("tag"، "featured"))
    ب.ممنوع.بیفزا(اپن سرچ.واژه("tag"، "spam"))
    سرچاپ اپن سرچ.پرسمان منطقی ساخته(ب)
    سرچاپ اپن سرچ.منطقی(فهرست(اپن سرچ.تطبیق("t"، "x")، "")، فهرست(اپن سرچ.واژه("a"، "1")، "")، وکتور {} برگردان وکتور<رشته>، وکتور {} برگردان وکتور<رشته>)
    سرچاپ اپن سرچ.همه شرط‌ها(فهرست(اپن سرچ.واژه("a"، "1")، اپن سرچ.واژه("b"، "2")))
    سرچاپ اپن سرچ.یکی از شرط‌ها(فهرست(اپن سرچ.واژه("a"، "1")، اپن سرچ.واژه("b"، "2")))، اپن سرچ.نقیض(اپن سرچ.واژه("a"، "1"))
    سرچاپ اپن سرچ.پالایش شده(اپن سرچ.تطبیق("t"، "x")، فهرست(اپن سرچ.واژه("a"، "1")، ""))
    سرچاپ اپن سرچ.امتیاز ثابت(اپن سرچ.واژه("tag"، "news")، 1.2)
    سرچاپ اپن سرچ.بیشینه جداگانه(فهرست(اپن سرچ.تطبیق("title"، "x")، اپن سرچ.تطبیق("body"، "x"))، 0.3)
    سرچاپ اپن سرچ.تقویت(اپن سرچ.تطبیق("t"، "apple")، اپن سرچ.تطبیق("t"، "pie")، 0.5)
    سرچاپ اپن سرچ.تودرتو("comments"، اپن سرچ.تطبیق("comments.text"، "great"))
    سرچاپ اپن سرچ.دارای فرزند("answer"، اپن سرچ.تطبیق همه())، اپن سرچ.دارای والد("question"، اپن سرچ.تطبیق همه())
    سرچاپ اپن سرچ.مشابه(فهرست("title"، "body")، "search engines in Salam")
    سرچاپ اپن سرچ.پرسمان اسکریپت("doc['stock'].value > params.min"، `{"min":5}`)
    سرچاپ اپن سرچ.امتیاز اسکریپتی(اپن سرچ.تطبیق همه()، "_score * doc['rank'].value"، "")
    سرچاپ اپن سرچ.امتیاز تابعی(اپن سرچ.تطبیق("t"، "x")، فهرست(اپن سرچ.ضریب مقدار فیلد("likes"، 1.2، "log1p")، "")، "sum"، "multiply")
    سرچاپ اپن سرچ.فاصله جغرافیایی("location"، 35.69، 51.39، "5km")
    سرچاپ اپن سرچ.کادر جغرافیایی("location"، 36.0، 51.0، 35.5، 51.8)

    ناپایا ز := وکتور {} برگردان وکتور<اعشار۶۴>
    ز.بیفزا(0.12)
    ز.بیفزا(-0.5)
    ز.بیفزا(0.9)
    سرچاپ اپن سرچ.نزدیک‌ترین همسایه‌ها("embedding"، ز، 10)، اپن سرچ.بردار همسایه‌یابی(ز)
    سرچاپ اپن سرچ.نزدیک‌ترین همسایه‌های پالایش شده("embedding"، ز، 10، اپن سرچ.واژه("lang"، "fa"))
    سرچاپ اپن سرچ.همسایه‌های شعاعی("embedding"، ز، 0.5)، اپن سرچ.همسایه‌ها با کمینه امتیاز("embedding"، ز، 0.8)
    سرچاپ اپن سرچ.عصبی("embedding"، "a cosy cafe"، "model-1"، 5)، اپن سرچ.عصبی پراکنده("tokens"، "a cosy cafe"، "model-2")
    سرچاپ اپن سرچ.ترکیبی(فهرست(اپن سرچ.تطبیق("text"، "cafe")، اپن سرچ.عصبی("embedding"، "cafe"، "model-1"، 5)))

    سرچاپ اپن سرچ.مرتب صعودی("price")، اپن سرچ.مرتب نزولی("date")، اپن سرچ.مرتب‌سازی امتیازی()
    سرچاپ اپن سرچ.مرتب‌سازی مکانی("location"، 35.69، 51.39، "km")
    سرچاپ اپن سرچ.برجسته‌سازی(فهرست("title"، "body"))، اپن سرچ.برجسته‌سازی با برچسب(فهرست("title"، "")، "<mark>"، "</mark>")
    سرچاپ اپن سرچ.ادغام فیلدی("author")، اپن سرچ.پیشنهاد واژه("fix"، "salm"، "title")
    سرچاپ اپن سرچ.پیشنهاد تکمیل("auto"، "sal"، "title.suggest"، 5)

    ناپایا تجمیع‌ها := اپن سرچ.افزودن تجمیع("{}"، "tags"، اپن سرچ.تجمیع واژه‌ها("tag"، 10))
    تجمیع‌ها = اپن سرچ.افزودن تجمیع(تجمیع‌ها، "avg_price"، اپن سرچ.تجمیع میانگین("price"))
    تجمیع‌ها = اپن سرچ.افزودن تجمیع(تجمیع‌ها، "total"، اپن سرچ.تجمیع جمع("price"))
    تجمیع‌ها = اپن سرچ.افزودن تجمیع(تجمیع‌ها، "cheapest"، اپن سرچ.تجمیع کمینه("price"))
    تجمیع‌ها = اپن سرچ.افزودن تجمیع(تجمیع‌ها، "dearest"، اپن سرچ.تجمیع بیشینه("price"))
    تجمیع‌ها = اپن سرچ.افزودن تجمیع(تجمیع‌ها، "priced"، اپن سرچ.تجمیع شمار مقدار("price"))
    تجمیع‌ها = اپن سرچ.افزودن تجمیع(تجمیع‌ها، "authors"، اپن سرچ.تجمیع یکتاها("author"))
    سرچاپ تجمیع‌ها
    ناپایا صدک‌ها := وکتور {} برگردان وکتور<اعشار۶۴>
    صدک‌ها.بیفزا(50.0)
    صدک‌ها.بیفزا(99.0)
    سرچاپ اپن سرچ.تجمیع آمار("price")، اپن سرچ.تجمیع آمار گسترده("price")، اپن سرچ.تجمیع صدک‌ها("ms"، صدک‌ها)
    سرچاپ اپن سرچ.تجمیع هیستوگرام("price"، 10.0)، اپن سرچ.تجمیع بازه("price"، صدک‌ها)
    ماهانه := اپن سرچ.زیرتجمیع‌ها(اپن سرچ.تجمیع هیستوگرام تاریخ("date"، "month")، اپن سرچ.افزودن تجمیع("{}"، "sales"، اپن سرچ.تجمیع جمع("price")))
    سرچاپ ماهانه
    سرچاپ اپن سرچ.تجمیع پالایه(اپن سرچ.واژه("tag"، "news"))، اپن سرچ.تجمیع تودرتو("comments")، اپن سرچ.تجمیع گمشده‌ها("price")
    سرچاپ اپن سرچ.تجمیع برترین یافته‌ها(3)، اپن سرچ.تجمیع ترکیبی(فهرست("tag"، "author")، 100)
    سرچاپ اپن سرچ.افزودن عضو(`{"size":0}`، "aggs"، تجمیع‌ها)

    ناپایا درخواست := اپن سرچ.درخواست جستجو { پرسمان = اپن سرچ.پرسمان منطقی ساخته(ب)، جابجایی = 0، اندازه = 20، ردیابی کل نتایج = "true" }
    درخواست.مرتب‌سازی.بیفزا(اپن سرچ.مرتب نزولی("date"))
    درخواست.منبع.بیفزا("title")
    درخواست.منابع مستثنا.بیفزا("body")
    درخواست.فیلدها.بیفزا("date")
    درخواست.فیلدهای مقدار سند.بیفزا("price")
    درخواست.تجمیع‌ها = تجمیع‌ها
    درخواست.برجسته‌سازی = اپن سرچ.برجسته‌سازی(فهرست("title"، ""))
    درخواست.فیلتر پسین = اپن سرچ.واژه("color"، "red")
    درخواست.فشرده‌سازی = اپن سرچ.ادغام فیلدی("author")
    درخواست.پیشنهاد‌ها = اپن سرچ.پیشنهاد واژه("fix"، "salm"، "title")
    درخواست.امتیازدهی مجدد = `{"window_size":50,"query":{"rescore_query":{"match_phrase":{"title":"salam"}}}}`
    درخواست.فیلدهای اسکریپت = `{"double":{"script":{"source":"doc['price'].value * 2"}}}`
    درخواست.ادامه پس از = `[1700000000000]`
    درخواست.ردیابی امتیاز‌ها = درست
    درخواست.کمترین امتیاز = "0.1"
    درخواست.مهلت = "2s"
    درخواست.توضیح = نادرست
    درخواست.نسخه = درست
    درخواست.شماره توالی با دوره اصلی = درست
    درخواست.افزونه‌ها = `{"rag":{"llm_question":"why"}}`
    درخواست.اعضای اضافی.بیفزا(`"profile":false`)
    سرچاپ اپن سرچ.بدنه جستجو(درخواست)
    سرچاپ اپن سرچ.بدنه جستجو(اپن سرچ.درخواست جستجو { پرسمان = اپن سرچ.تطبیق همه()، شناسه نقطه زمانی = "PIT"، زنده‌ماندن نقطه زمانی = "1m"، بدون منبع = درست })
پایان
خروجی{"match_all":{}} {"match_none":{}} {"match":{"title":"salam"}} {"match":{"title":{"query":"salam world","operator":"and"}}} {"match":{"title":{"query":"slam","fuzziness":"AUTO"}}} {"match_phrase":{"title":"hello world"}} {"match_phrase":{"title":{"query":"hello world","slop":2}}} {"match_phrase_prefix":{"title":"sal"}} {"match_bool_prefix":{"title":"quick bro"}} {"multi_match":{"query":"salam","fields":["title^2","body"]}} {"multi_match":{"query":"salam","fields":["title","body"],"type":"phrase"}} {"term":{"tag":"news"}} {"term":{"year":1403}} {"term":{"published":true}} {"term":{"tag":{"value":"News","case_insensitive":true}}} {"terms":{"tag":["news","sport"]}} {"terms":{"year":[1402,1403]}} {"terms":{"tag":{"index":"users","id":"7","path":"follows"}}} {"terms_set":{"skills":{"terms":["go","salam"],"minimum_should_match_field":"required"}}} {"range":{"date":{"gte":"2026-01-01","lte":"2026-12-31"}}} {"range":{"price":{"gt":"10","lt":"20"}}} {"range":{"price":{"gte":9.5,"lte":20}}} {"range":{"stock":{"gte":1,"lte":100}}} {"range":{"price":{"lt":"5"}}} {"range":{"at":{"gte":"now-7d/d","lte":"now","time_zone":"+03:30"}}} {"exists":{"field":"email"}} {"prefix":{"sku":"AB-"}} {"wildcard":{"sku":"AB-*-9"}} {"regexp":{"sku":"AB-[0-9]+"}} {"fuzzy":{"name":"maryem"}} {"ids":{"values":["1","2"]}} {"query_string":{"query":"title:salam AND year:1403"}} {"query_string":{"query":"salam world","fields":["title","body"],"default_operator":"AND"}} {"simple_query_string":{"query":"salam -draft","fields":["title"]}} {"bool":{"must":[{"match":{"title":"salam"}}],"filter":[{"term":{"status":"published"}}],"should":[{"term":{"tag":"featured"}}],"must_not":[{"term":{"tag":"spam"}}],"minimum_should_match":"1","boost":1.5}} {"bool":{"must":[{"match":{"t":"x"}}],"filter":[{"term":{"a":"1"}}]}} {"bool":{"must":[{"term":{"a":"1"}},{"term":{"b":"2"}}]}} {"bool":{"should":[{"term":{"a":"1"}},{"term":{"b":"2"}}],"minimum_should_match":"1"}} {"bool":{"must_not":[{"term":{"a":"1"}}]}} {"bool":{"must":[{"match":{"t":"x"}}],"filter":[{"term":{"a":"1"}}]}} {"constant_score":{"filter":{"term":{"tag":"news"}},"boost":1.2}} {"dis_max":{"queries":[{"match":{"title":"x"}},{"match":{"body":"x"}}],"tie_breaker":0.3}} {"boosting":{"positive":{"match":{"t":"apple"}},"negative":{"match":{"t":"pie"}},"negative_boost":0.5}} {"nested":{"path":"comments","query":{"match":{"comments.text":"great"}}}} {"has_child":{"type":"answer","query":{"match_all":{}}}} {"has_parent":{"parent_type":"question","query":{"match_all":{}}}} {"more_like_this":{"fields":["title","body"],"like":"search engines in Salam","min_term_freq":1,"min_doc_freq":1}} {"script":{"script":{"source":"doc['stock'].value > params.min","lang":"painless","params":{"min":5}}}} {"script_score":{"query":{"match_all":{}},"script":{"source":"_score * doc['rank'].value","lang":"painless"}}} {"function_score":{"query":{"match":{"t":"x"}},"functions":[{"field_value_factor":{"field":"likes","factor":1.2,"modifier":"log1p","missing":1}}],"score_mode":"sum","boost_mode":"multiply"}} {"geo_distance":{"distance":"5km","location":{"lat":35.69,"lon":51.39}}} {"geo_bounding_box":{"location":{"top_left":{"lat":36,"lon":51},"bottom_right":{"lat":35.5,"lon":51.8}}}} {"knn":{"embedding":{"vector":[0.12,-0.5,0.9],"k":10}}} [0.12,-0.5,0.9] {"knn":{"embedding":{"vector":[0.12,-0.5,0.9],"k":10,"filter":{"term":{"lang":"fa"}}}}} {"knn":{"embedding":{"vector":[0.12,-0.5,0.9],"max_distance":0.5}}} {"knn":{"embedding":{"vector":[0.12,-0.5,0.9],"min_score":0.8}}} {"neural":{"embedding":{"query_text":"a cosy cafe","model_id":"model-1","k":5}}} {"neural_sparse":{"tokens":{"query_text":"a cosy cafe","model_id":"model-2"}}} {"hybrid":{"queries":[{"match":{"text":"cafe"}},{"neural":{"embedding":{"query_text":"cafe","model_id":"model-1","k":5}}}]}} {"price":{"order":"asc"}} {"date":{"order":"desc"}} "_score" {"_geo_distance":{"location":{"lat":35.69,"lon":51.39},"order":"asc","unit":"km"}} {"fields":{"title":{},"body":{}}} {"pre_tags":["<mark>"],"post_tags":["</mark>"],"fields":{"title":{}}} {"field":"author"} {"fix":{"text":"salm","term":{"field":"title"}}} {"auto":{"prefix":"sal","completion":{"field":"title.suggest","size":5}}} {"tags":{"terms":{"field":"tag","size":10}},"avg_price":{"avg":{"field":"price"}},"total":{"sum":{"field":"price"}},"cheapest":{"min":{"field":"price"}},"dearest":{"max":{"field":"price"}},"priced":{"value_count":{"field":"price"}},"authors":{"cardinality":{"field":"author"}}} {"stats":{"field":"price"}} {"extended_stats":{"field":"price"}} {"percentiles":{"field":"ms","percents":[50,99]}} {"histogram":{"field":"price","interval":10}} {"range":{"field":"price","ranges":[{"to":50},{"from":50,"to":99},{"from":99}]}} {"date_histogram":{"field":"date","calendar_interval":"month"},"aggs":{"sales":{"sum":{"field":"price"}}}} {"filter":{"term":{"tag":"news"}}} {"nested":{"path":"comments"}} {"missing":{"field":"price"}} {"top_hits":{"size":3}} {"composite":{"size":100,"sources":[{"tag":{"terms":{"field":"tag"}}},{"author":{"terms":{"field":"author"}}}]}} {"size":0,"aggs":{"tags":{"terms":{"field":"tag","size":10}},"avg_price":{"avg":{"field":"price"}},"total":{"sum":{"field":"price"}},"cheapest":{"min":{"field":"price"}},"dearest":{"max":{"field":"price"}},"priced":{"value_count":{"field":"price"}},"authors":{"cardinality":{"field":"author"}}}} {"query":{"bool":{"must":[{"match":{"title":"salam"}}],"filter":[{"term":{"status":"published"}}],"should":[{"term":{"tag":"featured"}}],"must_not":[{"term":{"tag":"spam"}}],"minimum_should_match":"1","boost":1.5}},"from":0,"size":20,"sort":[{"date":{"order":"desc"}}],"_source":{"includes":["title"],"excludes":["body"]},"fields":["date"],"docvalue_fields":["price"],"aggs":{"tags":{"terms":{"field":"tag","size":10}},"avg_price":{"avg":{"field":"price"}},"total":{"sum":{"field":"price"}},"cheapest":{"min":{"field":"price"}},"dearest":{"max":{"field":"price"}},"priced":{"value_count":{"field":"price"}},"authors":{"cardinality":{"field":"author"}}},"highlight":{"fields":{"title":{}}},"post_filter":{"term":{"color":"red"}},"collapse":{"field":"author"},"suggest":{"fix":{"text":"salm","term":{"field":"title"}}},"rescore":{"window_size":50,"query":{"rescore_query":{"match_phrase":{"title":"salam"}}}},"script_fields":{"double":{"script":{"source":"doc['price'].value * 2"}}},"search_after":[1700000000000],"track_total_hits":true,"track_scores":true,"min_score":0.1,"timeout":"2s","version":true,"seq_no_primary_term":true,"ext":{"rag":{"llm_question":"why"}},"profile":false} {"query":{"match_all":{}},"_source":false,"pit":{"id":"PIT","keep_alive":"1m"}}

پیکربندی Config

ساختار پیکربندی
هر چه کارخواه تازه لازم دارد.
نامانگلیسیگونهتوضیح
گره‌هاnodesوکتور<رشته>نشانی گره‌ها؛ هر عضو می‌تواند چند نشانی جداشده با ویرگول داشته باشد و هر نشانی می‌تواند user:password@ و پیشوند مسیر داشته باشد.
نام کاربریusernameرشته = ""کاربر احراز هویت پایه.
گذرواژهpasswordرشته = ""گذرواژه‌ی احراز هویت پایه.
توکن حاملbearerرشته = ""یک توکن حامل که به جای احراز هویت پایه فرستاده می‌شود.
پرونده مراجع گواهیca_fileرشته = ""پرونده‌ی PEM مراجع صدور گواهی مورد اعتماد برای https.
ناامنinsecureمنطقی = نادرستوارسی گواهی را رد کن؛ فقط برای سرور آزمایشی با گواهی خودامضا.
مهلت به میلی‌ثانیهtimeout_msصحیح = 30000بیشترین زمان یک درخواست، به میلی‌ثانیه؛ ۰ یعنی بی‌حد.
حداکثر کوشش مجددmax_retriesصحیح = 3پس از اتصال ناموفق یا پاسخ 502، 503 یا 504 درخواست چند بار دیگر روی گره‌ی دیگری آزموده شود.
سرآیندهاheadersنگاشت<رشته، رشته>سرآیندهای بیشتری که با هر درخواست فرستاده می‌شوند.
ناحیه ای دبلیو اسaws_regionرشته = ""هر درخواست را با AWS SigV4 برای این ناحیه امضا کن؛ خالی یعنی بدون امضا.
سرویس ای دبلیو اسaws_serviceرشته = ""سرویس AWS برای امضا، سرویس دامنه (پیش‌فرض) یا سرویس بی‌سرور.
کلید دسترسی ای دبلیو اسaws_access_keyرشته = ""شناسه‌ی کلید دسترسی AWS.
کلید محرمانه ای دبلیو اسaws_secret_keyرشته = ""کلید دسترسی محرمانه‌ی AWS.
توکن نشست ای دبلیو اسaws_session_tokenرشته = ""توکن نشست AWS برای اعتبارنامه‌ی موقت؛ اگر نیست خالی.
db-opensearch-Client.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ناپایا تنظیم := اپن سرچ.پیکربندی پیش‌فرض()
    تنظیم.گره‌ها.بیفزا("https://node2.example.com:9200, https://node3.example.com:9200")
    تنظیم.نام کاربری = "admin"
    تنظیم.گذرواژه = "S3cret-pass!"
    تنظیم.پرونده مراجع گواهی = "/etc/ssl/certs/opensearch-ca.pem"
    تنظیم.مهلت به میلی‌ثانیه = 10000
    تنظیم.حداکثر کوشش مجدد = 2
    تنظیم.سرآیندها.درج("X-Opaque-Id"، "shop-api")
    ناپایا ک := اپن سرچ.کارخواه تازه(تنظیم)
    اگر وارونه اپن سرچ.معتبر(ک):
        سرچاپ اپن سرچ.خطا(ک)
        برگشت 1
    پایان
    سرچاپ اپن سرچ.گره‌ها(ک)، اپن سرچ.سرآیند احراز(ک).طول() بزرگتر 0، اپن سرچ.نسخه کارخواه
    سرچاپ اپن سرچ.پینگ(ک)

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

    ر := اپن سرچ.انجام(ک، "GET"، "/_cat/health?format=json"، "")
    سرچاپ ر.موفق، ر.وضعیت، ر.بدنه
    اگر وارونه ر.موفق:
        سرچاپ ر.خطا، ر.نوع خطا، ر.علت خطا
    پایان
    چندخطی := اپن سرچ.انجام چندخطی(ک، "POST"، "/_bulk"، "{\"delete\":{\"_index\":\"shop\",\"_id\":\"1\"}}\n")
    سرچاپ چندخطی.وضعیت، اپن سرچ.وضعیت(ک)، اپن سرچ.نوع خطا(ک)، اپن سرچ.علت خطا(ک)
    متنی := اپن سرچ.انجام متنی(ک، "POST"، "/_plugins/_sql?format=csv"، `{"query":"SELECT 1"}`، "application/json")
    سرچاپ متنی.بدنه
    اپن سرچ.بستن(ک)

    ناپایا محلی := اپن سرچ.اتصال(اپن سرچ.نشانی پیش‌فرض)
    سرچاپ اپن سرچ.معتبر(محلی)، اپن سرچ.درگاه پیش‌فرض، اپن سرچ.مهلت گره از کار افتاده
    اپن سرچ.بستن(محلی)
    ناپایا نمایشی := اپن سرچ.اتصال بدون وارسی گواهی("https://localhost:9200"، "admin"، "S3cret-pass!")
    اپن سرچ.بستن(نمایشی)
    ناپایا احراز := اپن سرچ.اتصال با رمز("https://search.example.com"، "reader"، "pass")
    سرچاپ اپن سرچ.کدگذاری پایه("reader"، "pass")
    اپن سرچ.بستن(احراز)

    ناپایا آمازون := اپن سرچ.اتصال آمازون(
        "https://search-shop.eu-west-1.es.amazonaws.com"، "eu-west-1"، اپن سرچ.سرویس دامنه،
        "AKIAEXAMPLE"، "secret-key"، ""
    )
    اپن سرچ.تنظیم زمان امضا(آمازون، 1700000000 برگردان صحیح۶۴)
    سرچاپ اپن سرچ.سلامت خوشه(آمازون).وضعیت
    اپن سرچ.بستن(آمازون)
    ناپایا بی‌سرور := اپن سرچ.اتصال آمازون(
        "https://abc123.eu-west-1.aoss.amazonaws.com"، "eu-west-1"، اپن سرچ.سرویس بی‌سرور،
        "AKIAEXAMPLE"، "secret-key"، "session-token"
    )
    اپن سرچ.بستن(بی‌سرور)
    برگشت 0
پایان

کارخواه Client

ساختار کارخواه
اتصال به یک خوشه‌ی اپن سرچ؛ با بستن آزادش کنید.
نامانگلیسیگونهتوضیح
دستهhandleتهی*حالت درونی.

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

پاسخ Response

ساختار پاسخ
پاسخ خام یک درخواست.
نامانگلیسیگونهتوضیح
وضعیتstatusصحیح = 0وضعیت HTTP؛ اگر پاسخی نیامد ۰.
موفقokمنطقی = نادرستوضعیت 2xx بود.
بدنهbodyرشته = ""بدنه‌ی پاسخ.
خطاerrorرشته = ""چه چیزی خراب شد، همراه نوع و علت خطای سرور اگر فرستاده باشد.
نوع خطاerror_typeرشته = ""نوع خطای سرور، مثل index_not_found_exception.
علت خطاerror_reasonرشته = ""علت خطای سرور.

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

گزینه‌ها Options

ساختار گزینه‌ها
تنظیمات اختیاری نوشتن. رشته‌های خالی و عددهای منفی کنار گذاشته می‌شوند.
نامانگلیسیگونهتوضیح
تازه‌سازیrefreshرشته = ""یکی از مقدارهای تازه‌سازی.
مسیریابیroutingرشته = ""مقدار مسیریابی، برای گذاشتن سند روی شارد دلخواه.
خط لولهpipelineرشته = ""خط لوله‌ی ورودی‌ای که سند از آن بگذرد.
مهلتtimeoutرشته = ""مدت انتظار برای شاردها، مثل 5s.
منتظر شارد‌های فعالwait_for_active_shardsرشته = ""چند نسخه‌ی شارد باید فعال باشند، یا all.
تعارض‌هاconflictsرشته = ""برای فراخوانی‌های پرسمانی: proceed با وجود ناسازگاری نسخه ادامه می‌دهد.
شرط شماره توالیif_seq_noصحیح۶۴ = -1فقط اگر سند هنوز این شماره‌ی ترتیب را دارد بنویس.
شرط دوره اصلیif_primary_termصحیح۶۴ = -1فقط اگر سند هنوز این دوره‌ی اصلی را دارد بنویس.
کوشش مجدد هنگام تعارضretry_on_conflictصحیح = -1برای به‌روزرسانی: چند بار هنگام ناسازگاری نسخه دوباره تلاش شود.
نسخهversionصحیح۶۴ = -1نسخه‌ی صریح سند.
نوع نسخهversion_typeرشته = ""گونه‌ی نسخه، مثل external.
الزام نام مستعارrequire_aliasمنطقی = نادرستمقصد باید نام مستعار باشد.
db-opensearch-Index.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ک := اپن سرچ.اتصال("http://localhost:9200")
    ن := اپن سرچ.نمایه‌سازی(ک، "books"، "1"، `{"title":"The Book of Kings","year":1010,"stock":3}`)
    سرچاپ ن.موفق، ن.وضعیت، ن.نمایه، ن.شناسه، ن.نتیجه، ن.نسخه، ن.شماره توالی، ن.دوره اصلی
    سرچاپ ن.کل شارد‌ها، ن.شارد‌های موفق، ن.خطا
    خودکار := اپن سرچ.نمایه‌سازی با گزینه(ک، "books"، ""، `{"title":"Masnavi"}`، اپن سرچ.گزینه‌ها { تازه‌سازی = اپن سرچ.تازه‌سازی با انتظار، مسیریابی = "poetry" })
    سرچاپ خودکار.شناسه
    تکراری := اپن سرچ.ایجاد سند(ک، "books"، "1"، `{"title":"again"}`)
    سرچاپ تکراری.موفق، تکراری.وضعیت
    لوله‌شده := اپن سرچ.ایجاد سند با گزینه(ک، "books"، "2"، `{"title":"Golestan"}`، اپن سرچ.گزینه‌ها { خط لوله = "clean"، مهلت = "5s"، منتظر شارد‌های فعال = "1" })
    سرچاپ لوله‌شده.نتیجه

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

    سرچاپ اپن سرچ.به‌روزرسانی(ک، "books"، "1"، `{"stock":2}`).نتیجه
    شرطی := اپن سرچ.به‌روزرسانی با گزینه(ک، "books"، "1"، `{"doc":{"stock":1}}`، اپن سرچ.گزینه‌ها { شرط شماره توالی = د.شماره توالی، شرط دوره اصلی = د.دوره اصلی، کوشش مجدد هنگام تعارض = -1 })
    سرچاپ شرطی.موفق، اپن سرچ.نوع خطا(ک)
    سرچاپ اپن سرچ.به‌روزرسانی درجی(ک، "books"، "9"، `{"title":"Shahnameh","stock":1}`).نتیجه
    سرچاپ اپن سرچ.به‌روزرسانی اسکریپتی(ک، "books"، "1"، اپن سرچ.اسکریپت("ctx._source.stock += params.n"، `{"n":5}`)، `{"stock":5}`).نتیجه
    سرچاپ اپن سرچ.حذف سند با گزینه(ک، "books"، "9"، اپن سرچ.گزینه‌ها { تازه‌سازی = اپن سرچ.تازه‌سازی فوری، نسخه = 3، نوع نسخه = "external" }).نتیجه
    سرچاپ اپن سرچ.حذف سند(ک، "books"، "2").نتیجه

    ناپایا شناسه‌ها := وکتور {} برگردان وکتور<رشته>
    شناسه‌ها.بیفزا("1")
    شناسه‌ها.بیفزا("404")
    هر سند در اپن سرچ.دریافت چندگانه(ک، "books"، شناسه‌ها):
        سرچاپ سند.شناسه، سند.یافت شد
    پایان
    سرچاپ اپن سرچ.شمارش(ک، "books"، "")، اپن سرچ.شمارش(ک، "books"، اپن سرچ.بازه("year"، "1000"، ""))

    ناپایا ب := اپن سرچ.دسته‌ای تازه()
    اپن سرچ.نمایه‌سازی دسته‌ای(ب، "books"، "10"، `{"title":"Divan"}`)
    اپن سرچ.نمایه‌سازی دسته‌ای مسیردار(ب، "books"، "11"، "poetry"، `{"title":"Rubaiyat"}`)
    اپن سرچ.ایجاد دسته‌ای(ب، "books"، ""، `{"title":"Bustan"}`)
    اپن سرچ.به‌روزرسانی دسته‌ای(ب، "books"، "10"، `{"stock":4}`)
    اپن سرچ.به‌روزرسانی درجی دسته‌ای(ب، "books"، "12"، `{"title":"Kalila"}`)
    اپن سرچ.حذف دسته‌ای(ب، "books"، "3")
    سرچاپ اپن سرچ.اندازه دسته‌ای(ب)، ب.شمار، ب.خط‌ها.طول()
    چاپ اپن سرچ.بدنه دسته‌ای(ب)
    نتیجه دسته := اپن سرچ.ارسال دسته‌ای با تازه‌سازی(ک، ب، اپن سرچ.بدون تازه‌سازی)
    سرچاپ نتیجه دسته.موفق، نتیجه دسته.وضعیت، نتیجه دسته.زمان اجرا، نتیجه دسته.خطا دارد، نتیجه دسته.تعداد موفق، نتیجه دسته.تعداد ناموفق، نتیجه دسته.خطا
    هر قلم در نتیجه دسته.موارد:
        سرچاپ قلم.عملیات، قلم.نمایه، قلم.شناسه، قلم.وضعیت، قلم.موفق، قلم.نتیجه، قلم.نسخه، قلم.نوع خطا، قلم.علت خطا
    پایان
    اپن سرچ.بازنشانی دسته‌ای(ب)
    اپن سرچ.نمایه‌سازی دسته‌ای(ب، "books"، "13"، `{"title":"Makhzan"}`)
    سرچاپ اپن سرچ.ارسال دسته‌ای(ک، ب).موفق
    اپن سرچ.آزادسازی دسته‌ای(ب)
    سرچاپ اپن سرچ.تجزیه دسته‌ای(`{"took":1,"errors":false,"items":[]}`).موفق

    به‌روزشده‌ها := اپن سرچ.به‌روزرسانی پرسمانی(ک، "books"، اپن سرچ.واژه("stock"، "0")، اپن سرچ.اسکریپت("ctx._source.out = true"، ""))
    سرچاپ به‌روزشده‌ها.موفق، به‌روزشده‌ها.وضعیت، به‌روزشده‌ها.زمان اجرا، به‌روزشده‌ها.مهلت تمام شد، به‌روزشده‌ها.کل، به‌روزشده‌ها.به‌روز‌شده، به‌روزشده‌ها.دسته‌ها، به‌روزشده‌ها.تعارض‌های نسخه، به‌روزشده‌ها.بدون تغییر، به‌روزشده‌ها.ناموفق‌ها
    به‌روزشده‌ها۲ := اپن سرچ.به‌روزرسانی پرسمانی با گزینه(ک، "books"، ""، ""، اپن سرچ.گزینه‌ها { تعارض‌ها = "proceed"، خط لوله = "clean" })
    سرچاپ به‌روزشده‌ها۲.به‌روز‌شده
    حذف‌شده‌ها := اپن سرچ.حذف پرسمانی(ک، "books"، اپن سرچ.واژه("out"، "true"))
    سرچاپ حذف‌شده‌ها.حذف‌شده، اپن سرچ.حذف پرسمانی با گزینه(ک، "books"، اپن سرچ.تطبیق همه()، اپن سرچ.گزینه‌ها { تازه‌سازی = "true"، تعارض‌ها = "proceed" }).حذف‌شده
    بازنمایه := اپن سرچ.نمایه‌سازی دوباره(ک، "books"، "books_v2")
    سرچاپ بازنمایه.ایجاد‌شده، بازنمایه.خطا
    کار := اپن سرچ.نمایه‌سازی دوباره با بدنه(ک، `{"source":{"index":"books"},"dest":{"index":"books_v3"}}`، نادرست)
    سرچاپ کار.کار
پایان

نتیجه نوشتن WriteResult

ساختار نتیجه نوشتن
نتیجه‌ی نوشتن روی یک سند.
نامانگلیسیگونهتوضیح
موفقokمنطقی = نادرستنوشتن موفق بود.
وضعیتstatusصحیح = 0وضعیت HTTP.
نمایهindexرشته = ""نمایه‌ای که در آن نوشته شد.
شناسهidرشته = ""شناسه‌ی سند؛ اگر چیزی ندادید ساخته می‌شود.
نتیجهresultرشته = ""created، updated، deleted، noop یا not_found.
نسخهversionصحیح۶۴ = 0نسخه‌ی تازه‌ی سند.
شماره توالیseq_noصحیح۶۴ = -1شماره‌ی ترتیب تازه.
دوره اصلیprimary_termصحیح۶۴ = 0دوره‌ی اصلی.
کل شارد‌هاshards_totalصحیح = 0چند نسخه‌ی شارد باید نوشته را داشته باشند.
شارد‌های موفقshards_successfulصحیح = 0چند تا داشتند.
خطاerrorرشته = ""چه چیزی خراب شد.

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

سند Document

ساختار سند
یک سند که با شناسه خوانده شده.
نامانگلیسیگونهتوضیح
یافت شدfoundمنطقی = نادرستسند وجود دارد.
نمایهindexرشته = ""نمایه‌ی آن.
شناسهidرشته = ""شناسه‌ی آن.
نسخهversionصحیح۶۴ = 0نسخه‌ی آن.
شماره توالیseq_noصحیح۶۴ = -1شماره‌ی ترتیب آن، برای نوشتن شرطی بعدی.
دوره اصلیprimary_termصحیح۶۴ = 0دوره‌ی اصلی آن، برای نوشتن شرطی بعدی.
مسیریابیroutingرشته = ""مقدار مسیریابی آن اگر دارد.
منبعsourceرشته = ""سند به شکل JSON خام.
فیلدهاfieldsرشته = ""فیلدهای ذخیره‌شده به شکل JSON خام، اگر خواسته شوند.
خطاerrorرشته = ""چه چیزی خراب شد؛ وقتی سند فقط وجود ندارد خالی است.

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

یافته Hit

ساختار یافته
یک یافته‌ی جستجو.
نامانگلیسیگونهتوضیح
نمایهindexرشته = ""نمایه‌ای که از آن آمده.
شناسهidرشته = ""شناسه‌ی سند.
امتیازscoreاعشار۶۴ = 0امتیاز ارتباط آن.
منبعsourceرشته = ""سند به شکل JSON خام.
مرتب‌سازیsortرشته = ""مقدارهای مرتب‌سازی آن به شکل JSON خام؛ مقدار آخرین یافته را به search_after بدهید تا صفحه‌ی بعد بیاید.
برجسته‌سازیhighlightرشته = ""تکه‌های برجسته‌شده به شکل JSON خام.
فیلدهاfieldsرشته = ""فیلدهای خواسته‌شده به شکل JSON خام.
نتایج درونیinner_hitsرشته = ""یافته‌های درونی پرسمان تودرتو یا ادغام‌شده، به شکل JSON خام.
پرسمان‌های منطبقmatched_queriesرشته = ""پرسمان‌های نام‌داری که تطبیق خوردند، به شکل JSON خام.
خامrawرشته = ""کل یافته به شکل JSON خام.
db-opensearch-Search.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ک := اپن سرچ.اتصال("http://localhost:9200")
    ناپایا درخواست := اپن سرچ.درخواست جستجو { پرسمان = اپن سرچ.تطبیق("title"، "kings")، اندازه = 10 }
    درخواست.مرتب‌سازی.بیفزا(اپن سرچ.مرتب نزولی("year"))
    درخواست.تجمیع‌ها = اپن سرچ.افزودن تجمیع(اپن سرچ.افزودن تجمیع("{}"، "by_tag"، اپن سرچ.تجمیع واژه‌ها("tag"، 5))، "avg_year"، اپن سرچ.تجمیع میانگین("year"))
    درخواست.تجمیع‌ها = اپن سرچ.افزودن تجمیع(درخواست.تجمیع‌ها، "stats"، اپن سرچ.تجمیع آمار("year"))
    ناپایا صدک‌ها := وکتور {} برگردان وکتور<اعشار۶۴>
    صدک‌ها.بیفزا(50.0)
    صدک‌ها.بیفزا(99.0)
    درخواست.تجمیع‌ها = اپن سرچ.افزودن تجمیع(درخواست.تجمیع‌ها، "pages"، اپن سرچ.تجمیع صدک‌ها("pages"، صدک‌ها))
    درخواست.پیشنهاد‌ها = اپن سرچ.پیشنهاد واژه("fix"، "kngs"، "title")
    ر := اپن سرچ.جستجو با درخواست(ک، "books"، درخواست)
    سرچاپ ر.موفق، ر.وضعیت، ر.زمان اجرا، ر.مهلت تمام شد، ر.کل، ر.نسبت کل، ر.بیشترین امتیاز، ر.خطا
    هر ه در ر.نتایج:
        سرچاپ ه.نمایه، ه.شناسه، ه.امتیاز، ه.منبع، ه.مرتب‌سازی، ه.برجسته‌سازی، ه.فیلدها، ه.نتایج درونی، ه.پرسمان‌های منطبق، ه.خام.طول()
    پایان
    هر سطل در اپن سرچ.سطل‌ها(ر.تجمیع‌ها، "by_tag"):
        سرچاپ سطل.کلید، سطل.کلید متنی، سطل.تعداد سند، سطل.خام.طول()
    پایان
    سرچاپ اپن سرچ.مقدار تجمیع(ر.تجمیع‌ها، "avg_year")، اپن سرچ.فیلد تجمیع(ر.تجمیع‌ها، "stats"، "max")
    سرچاپ اپن سرچ.تجمیع خام(ر.تجمیع‌ها، "stats")، اپن سرچ.پیشنهادها(ر.پیشنهاد‌ها، "fix")
    سرچاپ اپن سرچ.صدک تجمیع(ر.تجمیع‌ها، "pages"، 50.0)، اپن سرچ.صدک تجمیع(ر.تجمیع‌ها، "pages"، 99.0)
    سرچاپ اپن سرچ.جستجو(ک، "books,articles"، اپن سرچ.تطبیق همه()).کل
    سرچاپ اپن سرچ.جستجوی خام(ک، "books"، `{"query":{"match_all":{}},"size":1}`).نتایج.طول()
    پ := اپن سرچ.پارامترهای جستجو {
        مسیریابی = "poetry"، ترجیح = "_local"، خط لوله جستجو = "rerank"، نوع جستجو = "dfs_query_then_fetch"،
        حافظه نهان درخواست = "true"، اجازه نتیجه ناقص = "false"، نادیده گرفتن ناموجود = درست
    }
    سرچاپ اپن سرچ.جستجو با پارامتر(ک، "books"، `{"size":0}`، پ).کل، پ.پیمایش.طول()
    تجزیه‌شده := اپن سرچ.تجزیه جستجو(ر.خام)
    سرچاپ تجزیه‌شده.نتایج.طول()، تجزیه‌شده.شناسه پیمایش، تجزیه‌شده.شناسه نقطه زمانی

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

    نقطه := اپن سرچ.ایجاد نقطه زمانی(ک، "books"، "2m")
    ناپایا درخواست نقطه := اپن سرچ.درخواست جستجو { پرسمان = اپن سرچ.تطبیق همه()، اندازه = 100، شناسه نقطه زمانی = نقطه، زنده‌ماندن نقطه زمانی = "2m" }
    درخواست نقطه.مرتب‌سازی.بیفزا(اپن سرچ.مرتب صعودی("year"))
    ناپایا صفحه نقطه := اپن سرچ.جستجو با درخواست(ک، ""، درخواست نقطه)
    تا صفحه نقطه.نتایج.طول() بزرگتر 0:
        درخواست نقطه.ادامه پس از = صفحه نقطه.نتایج.بگیر(صفحه نقطه.نتایج.طول() - 1).مرتب‌سازی
        صفحه نقطه = اپن سرچ.جستجو با درخواست(ک، ""، درخواست نقطه)
    پایان
    سرچاپ اپن سرچ.فهرست نقطه‌های زمانی(ک)، اپن سرچ.حذف نقطه زمانی(ک، نقطه)، اپن سرچ.حذف همه نقطه‌های زمانی(ک)

    ناپایا بدنه‌ها := وکتور {} برگردان وکتور<رشته>
    بدنه‌ها.بیفزا(`{"query":{"term":{"tag":"poetry"}},"size":0}`)
    بدنه‌ها.بیفزا(`{"query":{"match_all":{}},"size":0}`)
    هر یکی در اپن سرچ.جستجوی چندگانه(ک، "books"، بدنه‌ها):
        سرچاپ یکی.موفق، یکی.کل
    پایان
    سرچاپ اپن سرچ.جستجوی الگو(ک، "books"، "by_tag"، `{"tag":"poetry"}`).کل
    سرچاپ اپن سرچ.جستجوی الگوی درون‌خطی(ک، "books"، `{"query":{"term":{"tag":"{{t}}"}}}`، `{"t":"poetry"}`).کل
    سرچاپ اپن سرچ.نمایش الگو(ک، `{"query":{"term":{"tag":"{{t}}"}}}`، `{"t":"poetry"}`)
    سرچاپ اپن سرچ.توضیح امتیاز(ک، "books"، "1"، اپن سرچ.تطبیق("title"، "kings"))
    سرچاپ اپن سرچ.اعتبارسنجی پرسمان(ک، "books"، اپن سرچ.تطبیق("title"، "kings"))
    ناپایا فیلدها := وکتور {} برگردان وکتور<رشته>
    فیلدها.بیفزا("title")
    سرچاپ اپن سرچ.توانایی فیلدها(ک، "books"، فیلدها)
    سرچاپ اپن سرچ.مسیر جیسون(ر.خام، "hits.hits.0._source.title")، اپن سرچ.مسیر خام جیسون(ر.خام، "hits.total")
    سرچاپ اپن سرچ.اقلام جیسون(`[1,"two",{"three":3}]`).طول()
پایان

نتیجه جستجو SearchResult

ساختار نتیجه جستجو
نتیجه‌ی یک جستجو.
نامانگلیسیگونهتوضیح
موفقokمنطقی = نادرستجستجو موفق بود.
وضعیتstatusصحیح = 0وضعیت HTTP.
زمان اجراtookصحیح۶۴ = 0زمان آن روی سرور، به میلی‌ثانیه.
مهلت تمام شدtimed_outمنطقی = نادرستسرور به خاطر سررسید مهلت زود ایستاد.
کلtotalصحیح۶۴ = 0چند سند تطبیق خورد.
نسبت کلtotal_relationرشته = ""eq وقتی total دقیق است و gte وقتی کران پایین است.
بیشترین امتیازmax_scoreاعشار۶۴ = 0بهترین امتیاز.
نتایجhitsوکتور<یافته>یافته‌های این صفحه.
تجمیع‌هاaggregationsرشته = ""تجمیع‌ها به شکل JSON خام؛ با سطل‌ها و مقدار تجمیع بخوانیدشان.
پیشنهاد‌هاsuggestرشته = ""پیشنهادها به شکل JSON خام؛ با پیشنهادها بخوانیدشان.
شناسه پیمایشscroll_idرشته = ""شناسه برای فراخوانی بعدی پیمایش.
شناسه نقطه زمانیpit_idرشته = ""شناسه‌ی نقطه‌ی زمانی که سرور برگرداند.
خامrawرشته = ""کل پاسخ.
خطاerrorرشته = ""چه چیزی خراب شد.

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

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

ساختار درخواست جستجو
یک جستجو. رشته‌ها و فهرست‌های خالی و عددهای منفی از بدنه‌ی درخواست کنار گذاشته می‌شوند.
نامانگلیسیگونهتوضیح
پرسمانqueryرشته = ""پرسمان، ساخته‌شده با سازنده‌ها یا نوشته‌شده به شکل JSON.
جابجاییfromصحیح = -1چند یافته رد شود.
اندازهsizeصحیح = -1چند یافته برگردد.
مرتب‌سازیsortوکتور<رشته>بندهای مرتب‌سازی، مثل مرتب نزولی("date").
منبعsourceوکتور<رشته>فقط این فیلدهای منبع برگردند.
منابع مستثناsource_excludesوکتور<رشته>این فیلدهای منبع کنار گذاشته شوند.
بدون منبعno_sourceمنطقی = نادرستهیچ منبعی برنگردد.
فیلدهاfieldsوکتور<رشته>فیلدهایی که در فیلدهای یافته برگردند.
فیلدهای مقدار سندdocvalue_fieldsوکتور<رشته>فیلدهای مقدار سند که برگردند.
تجمیع‌هاaggsرشته = ""تجمیع‌ها، ساخته‌شده با افزودن تجمیع.
برجسته‌سازیhighlightرشته = ""تنظیمات برجسته‌سازی، از برجسته‌سازی.
فیلتر پسینpost_filterرشته = ""پالایه‌ای که پس از شمردن تجمیع‌ها اعمال می‌شود.
فشرده‌سازیcollapseرشته = ""ادغام یافته‌ها روی یک فیلد، از ادغام فیلدی.
پیشنهاد‌هاsuggestرشته = ""پیشنهاددهنده‌ها، از پیشنهاد واژه یا پیشنهاد تکمیل.
امتیازدهی مجددrescoreرشته = ""یک بند امتیازدهی دوباره به شکل JSON.
فیلدهای اسکریپتscript_fieldsرشته = ""فیلدهای اسکریپتی به شکل JSON.
ادامه پس ازsearch_afterرشته = ""مقدارهای مرتب‌سازی آخرین یافته به شکل آرایه‌ی JSON، برای گرفتن صفحه‌ی بعد.
شناسه نقطه زمانیpit_idرشته = ""شناسه‌ی نقطه‌ی زمانی از ایجاد نقطه زمانی؛ آن‌گاه جستجو به /_search می‌رود و نمایه نام برده نمی‌شود.
زنده‌ماندن نقطه زمانیpit_keep_aliveرشته = ""نقطه‌ی زمانی چقدر دیگر نگه داشته شود، مثل 1m.
ردیابی کل نتایجtrack_total_hitsرشته = ""true، false یا یک عدد: تا کجا تطبیق‌ها دقیق شمرده شوند.
ردیابی امتیاز‌هاtrack_scoresمنطقی = نادرستحتی هنگام مرتب‌سازی با فیلد هم امتیاز حساب شود.
کمترین امتیازmin_scoreرشته = ""یافته‌های کمتر از این امتیاز کنار گذاشته شوند.
مهلتtimeoutرشته = ""پس از این مدت جستجو بایستد، مثل 2s.
توضیحexplainمنطقی = نادرستتوضیح بده هر امتیاز چگونه حساب شد.
نسخهversionمنطقی = نادرستنسخه‌ی هر یافته را برگردان.
شماره توالی با دوره اصلیseq_no_primary_termمنطقی = نادرستشماره‌ی ترتیب و دوره‌ی اصلی هر یافته را برگردان.
افزونه‌هاextرشته = ""افزونه‌های جستجو به شکل JSON، مثل تنظیمات تولید پاسخ با بازیابی.
اعضای اضافیextraوکتور<رشته>عضوهای بیشتر به شکل "key":value که همان‌طور افزوده می‌شوند.

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

سطل Bucket

ساختار سطل
یک سطل از یک تجمیع سطلی.
نامانگلیسیگونهتوضیح
کلیدkeyرشته = ""کلید آن به شکل متن.
کلید متنیkey_as_stringرشته = ""کلید قالب‌بندی‌شده، برای تاریخ‌ها و عددهای دارای قالب.
تعداد سندdoc_countصحیح۶۴ = 0چند سند در آن افتاد.
خامrawرشته = ""سطل به شکل JSON خام، با زیرتجمیع‌هایش.

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

دسته‌ای Bulk

ساختار دسته‌ای
دسته‌ای از کنش‌های نمایه‌سازی، ایجاد، به‌روزرسانی و حذف که در یک درخواست فرستاده می‌شوند.
نامانگلیسیگونهتوضیح
خط‌هاlinesوکتور<رشته>خط‌های NDJSON تا این‌جا.
شمارcountصحیح = 0چند کنش در آن است.

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

قلم دسته‌ای BulkItem

ساختار قلم دسته‌ای
نتیجه‌ی یک کنش دسته‌ای.
نامانگلیسیگونهتوضیح
عملیاتactionرشته = ""index، create، update یا delete.
نمایهindexرشته = ""نمایه.
شناسهidرشته = ""شناسه‌ی سند.
وضعیتstatusصحیح = 0وضعیت HTTP این کنش.
موفقokمنطقی = نادرستموفق بود؛ حذف سندی که وجود ندارد هم مانند خود اپن سرچ موفق شمرده می‌شود.
نتیجهresultرشته = ""نتیجه، مثل created.
نسخهversionصحیح۶۴ = 0نسخه‌ی تازه‌ی سند.
نوع خطاerror_typeرشته = ""نوع خطا وقتی شکست خورد.
علت خطاerror_reasonرشته = ""علت خطا وقتی شکست خورد.

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

نتیجه دسته‌ای BulkResult

ساختار نتیجه دسته‌ای
نتیجه‌ی یک درخواست دسته‌ای.
نامانگلیسیگونهتوضیح
موفقokمنطقی = نادرستهمه‌ی کنش‌ها موفق بودند.
وضعیتstatusصحیح = 0وضعیت HTTP درخواست.
زمان اجراtookصحیح۶۴ = 0زمان آن، به میلی‌ثانیه.
خطا داردerrorsمنطقی = نادرستسرور دست‌کم یک کنش ناموفق گزارش کرد.
تعداد موفقsucceededصحیح = 0چند کنش موفق بودند.
تعداد ناموفقfailedصحیح = 0چند کنش شکست خوردند.
مواردitemsوکتور<قلم دسته‌ای>یک نتیجه برای هر کنش، به همان ترتیب.
خطاerrorرشته = ""خلاصه‌ی آن‌چه خراب شد.

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

اطلاعات Info

ساختار اطلاعات
آن‌چه خوشه درباره‌ی خودش می‌گوید.
نامانگلیسیگونهتوضیح
موفقokمنطقی = نادرستدرخواست موفق بود.
نامnameرشته = ""نام گره.
نام خوشهcluster_nameرشته = ""نام خوشه.
شناسه خوشهcluster_uuidرشته = ""شناسه‌ی خوشه.
نسخهversionرشته = ""نسخه‌ی اپن سرچ، مثل 2.17.1.
توزیعdistributionرشته = ""opensearch.
نوع ساختbuild_typeرشته = ""شکل بسته‌بندی، مثل tar یا rpm.
نسخه لوسینlucene_versionرشته = ""نسخه‌ی لوسین.
کمترین نسخه سازگارminimum_wire_compatibility_versionرشته = ""قدیمی‌ترین نسخه‌ای که می‌تواند با آن گفتگو کند.
شعارtaglineرشته = ""شعار.

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

سلامت Health

ساختار سلامت
سلامت یک خوشه یا یک نمایه.
نامانگلیسیگونهتوضیح
موفقokمنطقی = نادرستدرخواست موفق بود.
نام خوشهcluster_nameرشته = ""نام خوشه.
وضعیتstatusرشته = ""green، yellow یا red.
مهلت تمام شدtimed_outمنطقی = نادرستانتظار برای وضعیت با سررسید مهلت پایان یافت.
گره‌هاnodesصحیح = 0شمار گره‌ها.
گره‌های دادهdata_nodesصحیح = 0شمار گره‌های داده.
شارد‌های اصلی فعالactive_primary_shardsصحیح = 0شاردهای اصلی فعال.
شارد‌های فعالactive_shardsصحیح = 0همه‌ی شاردهای فعال.
شارد‌های منتقل‌شوندهrelocating_shardsصحیح = 0شاردهایی که میان گره‌ها جابه‌جا می‌شوند.
شارد‌های راه‌اندازی‌شوندهinitializing_shardsصحیح = 0شاردهایی که در حال راه‌اندازی‌اند.
شارد‌های بی‌گرهunassigned_shardsصحیح = 0شاردهای بی‌گره.
کارهای منتظرpending_tasksصحیح = 0کارهای خوشه در صف.
درصد شارد‌های فعالactive_shards_percentاعشار۶۴ = 0سهم شاردهای فعال، از ۰ تا ۱۰۰.
db-opensearch-ClusterHealth.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ک := اپن سرچ.اتصال("http://localhost:9200")
    ه := اپن سرچ.سلامت خوشه(ک)
    سرچاپ ه.موفق، ه.نام خوشه، ه.وضعیت، ه.مهلت تمام شد، ه.گره‌ها، ه.گره‌های داده، ه.شارد‌های اصلی فعال
    سرچاپ ه.شارد‌های فعال، ه.شارد‌های منتقل‌شونده، ه.شارد‌های راه‌اندازی‌شونده، ه.شارد‌های بی‌گره، ه.کارهای منتظر، ه.درصد شارد‌های فعال
    سرچاپ اپن سرچ.انتظار وضعیت(ک، "books"، "yellow"، "30s").وضعیت
    سرچاپ اپن سرچ.آمار خوشه(ک).طول() بزرگتر 0، اپن سرچ.حالت خوشه(ک، "metadata").طول() بزرگتر 0
    سرچاپ اپن سرچ.تنظیم تنظیمات خوشه(ک، `{"cluster.routing.allocation.enable":"all"}`، "")
    سرچاپ اپن سرچ.دریافت تنظیمات خوشه(ک)
    سرچاپ اپن سرچ.توضیح تخصیص(ک، `{"index":"books","shard":0,"primary":true}`).طول()
    سرچاپ اپن سرچ.اطلاعات گره‌ها(ک، "os").طول() بزرگتر 0، اپن سرچ.آمار گره‌ها(ک، "jvm").طول() بزرگتر 0، اپن سرچ.نخ‌های پرکار(ک).طول() بزرگتر 0
    هر ردیف در اپن سرچ.فهرست(ک، "shards?h=index,shard,state"):
        سرچاپ ردیف
    پایان
    سرچاپ اپن سرچ.فهرست متنی(ک، "nodes")، اپن سرچ.افزونه‌ها(ک)، اپن سرچ.دارای افزونه(ک، "opensearch-knn")

    بازنمایه := اپن سرچ.نمایه‌سازی دوباره با بدنه(ک، `{"source":{"index":"books"},"dest":{"index":"books_v4"}}`، نادرست)
    ت := اپن سرچ.دریافت کار(ک، بازنمایه.کار)
    سرچاپ ت.موفق، ت.شناسه، ت.تمام‌شده، ت.عملیات، ت.توضیح، ت.وضعیت، ت.پاسخ، ت.خطا
    سرچاپ اپن سرچ.انتظار کار(ک، بازنمایه.کار، "60s").تمام‌شده، اپن سرچ.لغو کار(ک، بازنمایه.کار)
    سرچاپ اپن سرچ.فهرست کارها(ک، "*reindex").طول() بزرگتر 0

    سرچاپ اپن سرچ.تنظیم مخزن(ک، "backups"، "fs"، `{"location":"/mnt/backups"}`)، اپن سرچ.وارسی مخزن(ک، "backups")
    سرچاپ اپن سرچ.دریافت مخزن(ک، "backups")، اپن سرچ.ایجاد تصویر لحظه‌ای(ک، "backups"، "nightly-1"، "books"، درست)
    سرچاپ اپن سرچ.تصویرهای لحظه‌ای(ک، "backups")، اپن سرچ.دریافت تصویر لحظه‌ای(ک، "backups"، "nightly-1").طول() بزرگتر 0
    سرچاپ اپن سرچ.وضعیت تصویر لحظه‌ای(ک، "backups"، "nightly-1").طول() بزرگتر 0
    سرچاپ اپن سرچ.بازیابی تصویر لحظه‌ای(ک، "backups"، "nightly-1"، `{"indices":"books","rename_pattern":"(.+)","rename_replacement":"restored_$1"}`، درست)
    سرچاپ اپن سرچ.حذف تصویر لحظه‌ای(ک، "backups"، "nightly-1")، اپن سرچ.حذف مخزن(ک، "backups")

    ناپایا پردازنده‌ها := وکتور {} برگردان وکتور<رشته>
    پردازنده‌ها.بیفزا(اپن سرچ.پردازنده("lowercase"، `{"field":"tag"}`))
    پردازنده‌ها.بیفزا(اپن سرچ.پردازنده("set"، `{"field":"seen","value":true}`))
    سرچاپ اپن سرچ.تنظیم خط لوله(ک، "clean"، اپن سرچ.خط لوله("tidy incoming books"، پردازنده‌ها))
    ناپایا سندها := وکتور {} برگردان وکتور<رشته>
    سندها.بیفزا(`{"tag":"POETRY"}`)
    سرچاپ اپن سرچ.شبیه‌سازی خط لوله(ک، "clean"، سندها)، اپن سرچ.دریافت خط لوله(ک، "clean").طول() بزرگتر 0
    سرچاپ اپن سرچ.حذف خط لوله(ک، "clean")

    سرچاپ اپن سرچ.تنظیم اسکریپت(ک، "double"، "doc['stock'].value * 2")، اپن سرچ.دریافت اسکریپت(ک، "double")
    سرچاپ اپن سرچ.تنظیم الگوی جستجو(ک، "by_tag"، `{"query":{"term":{"tag":"{{tag}}"}}}`)، اپن سرچ.حذف اسکریپت(ک، "by_tag")، اپن سرچ.حذف اسکریپت(ک، "double")
پایان

اطلاعات نمایه IndexInfo

ساختار اطلاعات نمایه
یک ردیف از فهرست نمایه‌ها.
نامانگلیسیگونهتوضیح
سلامتhealthرشته = ""green، yellow یا red.
وضعیتstatusرشته = ""open یا close.
نمایهindexرشته = ""نام نمایه.
شناسهuuidرشته = ""شناسه‌ی نمایه.
شارد‌های اصلیprimariesصحیح = 0شمار شاردهای اصلی.
نسخه‌های پشتیبانreplicasصحیح = 0شمار نسخه‌های تکراری.
تعداد سندهاdocs_countصحیح۶۴ = 0شمار سندها.
سندهای حذف‌شدهdocs_deletedصحیح۶۴ = 0سندهای حذف‌شده‌ای که هنوز ادغام نشده‌اند.
اندازه ذخیرهstore_sizeرشته = ""اندازه روی دیسک، به بایت.
db-opensearch-CreateIndex.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ک := اپن سرچ.اتصال("http://localhost:9200")
    ناپایا ویژگی‌ها := وکتور {} برگردان وکتور<رشته>
    ویژگی‌ها.بیفزا(اپن سرچ.ویژگی("title"، "text"))
    ویژگی‌ها.بیفزا(اپن سرچ.ویژگی با گزینه("title_fa"، "text"، `{"analyzer":"persian"}`))
    ویژگی‌ها.بیفزا(اپن سرچ.ویژگی("tag"، "keyword"))
    ویژگی‌ها.بیفزا(اپن سرچ.ویژگی("year"، "integer"))
    سرچاپ اپن سرچ.ایجاد نمایه با تنظیمات(ک، "books"، 1، 0، اپن سرچ.ویژگی‌ها(ویژگی‌ها))
    سرچاپ اپن سرچ.ایجاد نمایه(ک، "logs-000001"، `{"aliases":{"logs":{"is_write_index":true}}}`)
    سرچاپ اپن سرچ.وجود نمایه(ک، "books")، اپن سرچ.دریافت نمایه(ک، "books").طول() بزرگتر 0
    سرچاپ اپن سرچ.تنظیم نگاشت(ک، "books"، "{" + اپن سرچ.ویژگی("isbn"، "keyword") + "}")
    سرچاپ اپن سرچ.تنظیم نگاشت با بدنه(ک، "books"، `{"dynamic":"strict"}`)، اپن سرچ.دریافت نگاشت(ک، "books")
    سرچاپ اپن سرچ.تنظیم تنظیمات(ک، "books"، `{"index":{"refresh_interval":"5s"}}`)
    سرچاپ اپن سرچ.دریافت تنظیمات(ک، "books").طول() بزرگتر 0، اپن سرچ.دریافت یک تنظیم(ک، "books"، "index.refresh_interval")
    سرچاپ اپن سرچ.تازه‌سازی(ک، "books")، اپن سرچ.تخلیه(ک، "books")، اپن سرچ.ادغام اجباری(ک، "books"، 1)، اپن سرچ.پاک‌سازی حافظه نهان(ک، "books")
    سرچاپ اپن سرچ.بستن نمایه(ک، "books")، اپن سرچ.گشودن نمایه(ک، "books")
    سرچاپ اپن سرچ.تنظیم تنظیمات(ک، "books"، `{"index.blocks.write":true}`)
    سرچاپ اپن سرچ.همسان‌سازی نمایه(ک، "books"، "books_clone"، "")، اپن سرچ.کوچک‌سازی نمایه(ک، "books"، "books_small"، "")، اپن سرچ.شکافتن نمایه(ک، "books"، "books_big"، `{"settings":{"index.number_of_shards":2}}`)
    سرچاپ اپن سرچ.آمار نمایه(ک، "books").طول() بزرگتر 0

    سرچاپ اپن سرچ.افزودن نام مستعار(ک، "books"، "library")، اپن سرچ.وجود نام مستعار(ک، "library")، اپن سرچ.نمایه‌های نام مستعار(ک، "library")
    سرچاپ اپن سرچ.افزودن نام مستعار پالایش شده(ک، "books"، "poetry"، اپن سرچ.واژه("tag"، "poetry")، نادرست)
    سرچاپ اپن سرچ.دریافت نام‌های مستعار(ک، "books")، اپن سرچ.حذف نام مستعار(ک، "books"، "poetry")
    ناپایا کنش‌های نام := وکتور {} برگردان وکتور<رشته>
    کنش‌های نام.بیفزا(اپن سرچ.کنش نام مستعار("add"، "books_clone"، "library"))
    کنش‌های نام.بیفزا(اپن سرچ.کنش نام مستعار("remove"، "books"، "library"))
    سرچاپ اپن سرچ.به‌روزرسانی نام‌های مستعار(ک، کنش‌های نام)، اپن سرچ.جابجایی نام مستعار(ک، "library"، "books_clone"، "books")

    ناپایا الگوها := وکتور {} برگردان وکتور<رشته>
    الگوها.بیفزا("logs-*")
    الگو := اپن سرچ.الگوی نمایه(الگوها، `{"number_of_replicas":0}`، "{" + اپن سرچ.ویژگی("msg"، "text") + "}"، 10)
    سرچاپ اپن سرچ.تنظیم الگوی نمایه(ک، "logs"، الگو)، اپن سرچ.وجود الگوی نمایه(ک، "logs")، اپن سرچ.دریافت الگوی نمایه(ک، "logs").طول() بزرگتر 0
    سرچاپ اپن سرچ.تنظیم الگوی جزء(ک، "base"، `{"template":{"settings":{"number_of_shards":1}}}`)، اپن سرچ.دریافت الگوی جزء(ک، "base").طول() بزرگتر 0
    سرچاپ اپن سرچ.چرخش نمایه(ک، "logs"، `{"max_docs":1000000,"max_age":"7d"}`)
    سرچاپ اپن سرچ.تنظیم الگوی نمایه(ک، "events"، `{"index_patterns":["events-*"],"data_stream":{}}`)
    سرچاپ اپن سرچ.ایجاد جریان داده(ک، "events-web")، اپن سرچ.جریان‌های داده(ک)، اپن سرچ.حذف جریان داده(ک، "events-web")
    سرچاپ اپن سرچ.تحلیل متن(ک، ""، "standard"، "Salam to OpenSearch")
    هر نمایه در اپن سرچ.فهرست نمایه‌ها(ک، "books*"):
        سرچاپ نمایه.سلامت، نمایه.وضعیت، نمایه.نمایه، نمایه.شناسه، نمایه.شارد‌های اصلی، نمایه.نسخه‌های پشتیبان، نمایه.تعداد سندها، نمایه.سندهای حذف‌شده، نمایه.اندازه ذخیره
    پایان
    سرچاپ اپن سرچ.حذف الگوی نمایه(ک، "logs")، اپن سرچ.حذف الگوی نمایه(ک، "events")، اپن سرچ.حذف الگوی جزء(ک، "base")
    سرچاپ اپن سرچ.حذف نمایه(ک، "books_clone,books_small,books_big")، اپن سرچ.حذف نمایه موجود(ک، "never-made")
پایان

اطلاعات کار TaskInfo

ساختار اطلاعات کار
یک کار پس‌زمینه.
نامانگلیسیگونهتوضیح
موفقokمنطقی = نادرستدرخواست موفق بود و کار شکست نخورد.
شناسهidرشته = ""شناسه‌ی کار، node:number.
تمام‌شدهcompletedمنطقی = نادرستپایان یافته است.
عملیاتactionرشته = ""چه کاری می‌کند، مثل indices:data/write/reindex.
توضیحdescriptionرشته = ""یک توضیح.
وضعیتstatusرشته = ""پیشرفت آن به شکل JSON خام.
پاسخresponseرشته = ""نتیجه‌ی آن به شکل JSON خام، پس از پایان.
خطاerrorرشته = ""چه چیزی خراب شد.

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

نتیجه پرسمانی ByQueryResult

ساختار نتیجه پرسمانی
نتیجه‌ی حذف پرسمانی، به‌روزرسانی پرسمانی یا نمایه‌سازی دوباره.
نامانگلیسیگونهتوضیح
موفقokمنطقی = نادرستبدون شکست پایان یافت.
وضعیتstatusصحیح = 0وضعیت HTTP.
زمان اجراtookصحیح۶۴ = 0زمان آن، به میلی‌ثانیه.
مهلت تمام شدtimed_outمنطقی = نادرستمهلت آن سر رسید.
کلtotalصحیح۶۴ = 0چند سند را بررسی کرد.
ایجاد‌شدهcreatedصحیح۶۴ = 0چند سند ساخت.
به‌روز‌شدهupdatedصحیح۶۴ = 0چند سند را به‌روز کرد.
حذف‌شدهdeletedصحیح۶۴ = 0چند سند را حذف کرد.
دسته‌هاbatchesصحیح۶۴ = 0چند دسته‌ی پیمایش طول کشید.
تعارض‌های نسخهversion_conflictsصحیح۶۴ = 0چند سند به ناسازگاری نسخه خوردند.
بدون تغییرnoopsصحیح۶۴ = 0اسکریپت چند سند را دست‌نخورده گذاشت.
ناموفق‌هاfailuresرشته = ""شکست‌ها به شکل JSON خام؛ اگر نبودند خالی است.
کارtaskرشته = ""شناسه‌ی کار، وقتی در پس‌زمینه اجرا می‌شود.
خطاerrorرشته = ""چه چیزی خراب شد.

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

ردیف‌های اس کیو ال SqlRows

ساختار ردیف‌های اس کیو ال
ردیف‌های یک پرسمان SQL یا PPL؛ هر چه پیش بروید صفحه‌های بیشتری می‌گیرد و ردیف‌های دیتابیس را پیاده می‌کند.
نامانگلیسیگونهتوضیح
دستهhandleتهی*حالت درونی.
db-opensearch-Sql.salam
واردسازی دیتابیس
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ک := اپن سرچ.اتصال("http://localhost:9200")
    رابط := اپن سرچ.اتصال عمومی(ک)
    سرچاپ رابط.نوع()، رابط.معتبر()، رابط.پینگ()، دیتابیس.پرسمان عدد(رابط، "SELECT COUNT(*) FROM books")
    ردیف‌ها := رابط.پرسمان("SELECT title, year, price FROM books WHERE year > 1000 ORDER BY year")
    سرچاپ ردیف‌ها.معتبر()، ردیف‌ها.تعداد ستون()، ردیف‌ها.نام ستون(0)، ردیف‌ها.نوع ستون(1)
    تا ردیف‌ها.بعدی():
        سرچاپ ردیف‌ها.متن(0)، ردیف‌ها.عدد صحیح(1)، ردیف‌ها.عدد صحیح۶۴(1)، ردیف‌ها.عدد اعشار(2)، ردیف‌ها.خالی است(2)
    پایان
    ردیف‌ها.بستن()
    سرچاپ رابط.اجرا("DELETE FROM books WHERE year < 0")، رابط.تعداد تغییرات()، رابط.شناسه آخرین درج()، رابط.خطا()، رابط.نقل قول("it's")
    تراکنش := رابط.شروع تراکنش()
    سرچاپ تراکنش.معتبر()، تراکنش.اجرا("SELECT 1")، تراکنش.پرسمان("SELECT 1").معتبر()، تراکنش.ثبت تراکنش()، تراکنش.بازگردانی()

    ناپایا پارامترها := وکتور {} برگردان وکتور<رشته>
    پارامترها.بیفزا(اپن سرچ.پارامتر اس کیو ال("integer"، "1000"))
    ناپایا صفحه‌بندی‌شده := اپن سرچ.اس کیو ال با پارامتر(ک، "SELECT title FROM books WHERE year > ?"، پارامترها، 100)
    سرچاپ صفحه‌بندی‌شده.مجموع()، صفحه‌بندی‌شده.نام نوع ستون(0)، صفحه‌بندی‌شده.خطا()
    تا صفحه‌بندی‌شده.بعدی():
        سرچاپ صفحه‌بندی‌شده.خام(0)
    پایان
    صفحه‌بندی‌شده.بستن()
    نتیجه جدول := اپن سرچ.اس کیو ال(ک، "SHOW TABLES LIKE books%")
    نتیجه جدول.بستن()
    سرچاپ اپن سرچ.اس کیو ال با قالب(ک، "SELECT title FROM books"، "csv")
    سرچاپ اپن سرچ.توضیح اس کیو ال(ک، "SELECT title FROM books").طول() بزرگتر 0

    پ := اپن سرچ.پی پی ال(ک، "source=books | where year > 1000 | stats count() by tag")
    تا پ.بعدی():
        سرچاپ پ.عدد صحیح(0)، پ.متن(1)
    پایان
    پ.بستن()
    سرچاپ اپن سرچ.پی پی ال با قالب(ک، "source=books | fields title"، "raw")، اپن سرچ.توضیح پی پی ال(ک، "source=books").طول() بزرگتر 0
    د := اپن سرچ.پایگاه داده { دسته = ک.دسته }
    ت := اپن سرچ.تراکنش {}
    سرچاپ د.نوع()، ت.معتبر()، رابط.بستن()
پایان

معتبر Ok

تابع معتبر(): منطقی
پرسمان موفق بود.

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

خطا Error

تابع خطا(): رشته
چه چیزی خراب شد.

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

مجموع Total

تابع مجموع(): صحیح۶۴
شمار ردیفی که سرور با آخرین صفحه گزارش کرد.

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

بعدی Next

تابع بعدی(): منطقی
به ردیف بعد می‌رود و در صورت نیاز صفحه‌ی بعد را می‌گیرد؛ در پایان نادرست.

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

تعداد ستون ColumnCount

تابع تعداد ستون(): صحیح
شمار ستون‌ها.

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

نام ستون ColumnName

تابع نام ستون(col: صحیح): رشته
نام یک ستون، یا نام مستعارش.

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

نام نوع ستون ColumnTypeName

تابع نام نوع ستون(col: صحیح): رشته
گونه‌ی اپن سرچ یک ستون، مثل keyword یا long.

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

نوع ستون ColumnType

تابع نوع ستون(col: صحیح): صحیح
گونه‌ی یک ستون در ردیف جاری، یکی از ثابت‌های گونه‌ی دیتابیس.

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

خالی است IsNull

تابع خالی است(col: صحیح): منطقی
مقدار تهی است.

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

متن Text

تابع متن(col: صحیح): رشته
مقدار به شکل متن.

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

خام Raw

تابع خام(col: صحیح): رشته
مقدار به شکل JSON خام.

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

عدد صحیح Int

تابع عدد صحیح(col: صحیح): صحیح
مقدار به شکل عدد صحیح.

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

عدد صحیح۶۴ Int64

تابع عدد صحیح۶۴(col: صحیح): صحیح۶۴
مقدار به شکل عدد صحیح ۶۴ بیتی.

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

عدد اعشار Float

تابع عدد اعشار(col: صحیح): اعشار۶۴
مقدار به شکل عدد اعشاری.

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

بستن Close

تابع بستن(): صحیح
ردیف‌ها را آزاد می‌کند و اگر صفحه‌ای مانده مکان‌نمای سرور را می‌بندد.

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

پایگاه داده Database

ساختار پایگاه داده
یک کارخواه به شکل اتصال دیتابیس، از اتصال عمومی.
نامانگلیسیگونهتوضیح
دستهhandleتهی*حالت کارخواه.

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

نوع Kind

تابع نوع(): رشته
دیتابیس.اپن سرچ.

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

معتبر Ok

تابع معتبر(): منطقی
کارخواه معتبر است.

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

پینگ Ping

تابع پینگ(): منطقی
خوشه پاسخ می‌دهد.

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

اجرا Exec

تابع اجرا(sql: رشته): صحیح
یک DELETE در SQL اجرا می‌کند و اگر خوشه حذف با SQL را اجازه دهد شمار سندهای حذف‌شده را برمی‌گرداند؛ هر چیز دیگر ۱- است، چون SQL اپن سرچ جز این فقط‌خواندنی است.

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

پرسمان Query

تابع پرسمان(sql: رشته): dyn db.Rows
یک پرسمان SQL اجرا می‌کند.

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

شروع تراکنش Begin

تابع شروع تراکنش(): dyn db.Tx
اپن سرچ تراکنش ندارد؛ نتیجه هرگز معتبر نیست.

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

شناسه آخرین درج LastInsertId

تابع شناسه آخرین درج(): صحیح۶۴
همیشه ۰؛ شناسه را از نمایه‌سازی بگیرید.

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

تعداد تغییرات Changes

تابع تعداد تغییرات(): صحیح۶۴
آخرین اجرا چند سند حذف کرد.

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

خطا Error

تابع خطا(): رشته
آخرین خطا.

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

نقل قول Quote

تابع نقل قول(s: رشته): رشته
یک مقدار متنی نقل‌قول‌شده برای SQL.

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

بستن Close

تابع بستن(): صحیح
کارخواه را آزاد می‌کند.

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

تراکنش Txn

ساختار تراکنش
تراکنشی که شروع تراکنش برمی‌گرداند؛ هر فراخوانی شکست می‌خورد.
نامانگلیسیگونهتوضیح
دستهhandleتهی*به کار نمی‌رود.

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

معتبر Ok

تابع معتبر(): منطقی
همیشه نادرست.

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

اجرا Exec

تابع اجرا(_sql: رشته): صحیح
همیشه ۱-.

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

پرسمان Query

تابع پرسمان(_sql: رشته): dyn db.Rows
ردیف‌هایی که هرگز معتبر نیستند.

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

ثبت تراکنش Commit

تابع ثبت تراکنش(): صحیح
همیشه ۱-.

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

بازگردانی Rollback

تابع بازگردانی(): صحیح
همیشه ۱-.

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

پارامترهای جستجو SearchParams

ساختار پارامترهای جستجو
تنظیماتی که در نشانی یک جستجو فرستاده می‌شوند. رشته‌های خالی کنار گذاشته می‌شوند.
نامانگلیسیگونهتوضیح
مسیریابیroutingرشته = ""فقط شاردهای این مقدار مسیریابی جستجو شوند.
ترجیحpreferenceرشته = ""کدام نسخه‌های شارد ترجیح داده شوند، مثل _local.
خط لوله جستجوsearch_pipelineرشته = ""یک خط لوله‌ی جستجو برای اجرا، مثل خط لوله‌ی جستجوی ترکیبی.
نوع جستجوsearch_typeرشته = ""query_then_fetch یا dfs_query_then_fetch.
پیمایشscrollرشته = ""پیمایش این مدت باز بماند.
حافظه نهان درخواستrequest_cacheرشته = ""true یا false: حافظه‌ی نهان درخواست به کار رود.
اجازه نتیجه ناقصallow_partial_search_resultsرشته = ""false وقتی شاردی شکست بخورد جستجو را ناموفق می‌کند.
نادیده گرفتن ناموجودignore_unavailableمنطقی = نادرستنمایه‌های نبوده یا بسته را رد کن.

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

اطلاعات احراز AuthInfo

ساختار اطلاعات احراز
افزونه‌ی امنیت می‌گوید شما کیستید.
نامانگلیسیگونهتوضیح
موفقokمنطقی = نادرستدرخواست موفق بود.
کاربرuserرشته = ""نام کاربر.
نقش‌هاrolesوکتور<رشته>نقش‌های امنیتی.
نقش‌های بک‌اندbackend_rolesوکتور<رشته>نقش‌های پشتیبان.
مستأجر‌هاtenantsوکتور<رشته>مستاجرهایی که کاربر می‌تواند به کار ببرد.
خطاerrorرشته = ""چه چیزی خراب شد.
db-opensearch-PutPolicy.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ک := اپن سرچ.اتصال بدون وارسی گواهی("https://localhost:9200"، "admin"، "S3cret-pass!")
    ناپایا الگوها := وکتور {} برگردان وکتور<رشته>
    الگوها.بیفزا("logs-*")
    سرچاپ اپن سرچ.تنظیم سیاست(ک، "logs-30d"، اپن سرچ.سیاست حذف پس از("drop old logs"، "30d"، الگوها))
    سرچاپ اپن سرچ.دریافت سیاست(ک، "logs-30d").طول() بزرگتر 0
    سرچاپ اپن سرچ.به‌روزرسانی سیاست(ک، "logs-30d"، اپن سرچ.سیاست حذف پس از("drop old logs"، "60d"، الگوها)، 0 برگردان صحیح۶۴، 1 برگردان صحیح۶۴)
    سرچاپ اپن سرچ.افزودن سیاست(ک، "logs-000001"، "logs-30d")، اپن سرچ.شناسه سیاست نمایه(ک، "logs-000001")
    سرچاپ اپن سرچ.تغییر سیاست(ک، "logs-000001"، "logs-30d"، "hot")، اپن سرچ.کوشش دوباره سیاست(ک، "logs-000001")
    سرچاپ اپن سرچ.توضیح سیاست(ک، "logs-000001")، اپن سرچ.برداشتن سیاست(ک، "logs-000001")، اپن سرچ.حذف سیاست(ک، "logs-30d")

    من := اپن سرچ.من کیستم(ک)
    سرچاپ من.موفق، من.کاربر، من.نقش‌ها، من.نقش‌های بک‌اند، من.مستأجر‌ها، من.خطا
    سرچاپ اپن سرچ.سلامت امنیت(ک)
    ناپایا مجوزها := وکتور {} برگردان وکتور<رشته>
    مجوزها.بیفزا("cluster_monitor")
    ناپایا کنش‌ها := وکتور {} برگردان وکتور<رشته>
    کنش‌ها.بیفزا("read")
    سرچاپ اپن سرچ.تنظیم نقش(ک، "logs_reader"، اپن سرچ.بدنه نقش(مجوزها، الگوها، کنش‌ها))، اپن سرچ.دریافت نقش(ک، "logs_reader")
    سرچاپ اپن سرچ.تنظیم کاربر(ک، "maryam"، "Strong-Pass-1!"، وکتور {} برگردان وکتور<رشته>، `{"team":"ops"}`)، اپن سرچ.دریافت کاربر(ک، "maryam")
    ناپایا کاربران := وکتور {} برگردان وکتور<رشته>
    کاربران.بیفزا("maryam")
    سرچاپ اپن سرچ.تنظیم نگاشت نقش(ک، "logs_reader"، کاربران، وکتور {} برگردان وکتور<رشته>)، اپن سرچ.دریافت نگاشت نقش(ک، "logs_reader")
    سرچاپ اپن سرچ.کاربران(ک)، اپن سرچ.تغییر گذرواژه(ک، "S3cret-pass!"، "N3w-secret-pass!")
    سرچاپ اپن سرچ.حذف نگاشت نقش(ک، "logs_reader")، اپن سرچ.حذف کاربر(ک، "maryam")، اپن سرچ.حذف نقش(ک، "logs_reader")

    پایشگر := `{"type":"monitor","name":"errors","enabled":true,"schedule":{"period":{"interval":5,"unit":"MINUTES"}},"inputs":[{"search":{"indices":["logs-*"],"query":{"size":0,"query":{"match":{"level":"error"}}}}}],"triggers":[]}`
    شناسه := اپن سرچ.ایجاد پایشگر(ک، پایشگر)
    سرچاپ شناسه، اپن سرچ.دریافت پایشگر(ک، شناسه).طول() بزرگتر 0، اپن سرچ.به‌روزرسانی پایشگر(ک، شناسه، پایشگر)
    سرچاپ اپن سرچ.اجرای پایشگر(ک، شناسه، درست).طول() بزرگتر 0، اپن سرچ.جستجوی پایشگرها(ک، اپن سرچ.تطبیق همه()).کل
    سرچاپ اپن سرچ.حذف پایشگر(ک، شناسه)
پایان

روش همسایه‌یابی KnnMethod

ساختار روش همسایه‌یابی
یک فیلد knn_vector چگونه نمایه می‌شود.
نامانگلیسیگونهتوضیح
نامnameرشته = "hnsw"الگوریتم، hnsw یا ivf.
موتورengineرشته = "lucene"lucene، faiss یا nmslib.
نوع فضاspace_typeرشته = "l2"فاصله: l2، cosinesimil، innerproduct و بقیه، بسته به موتور.
تعداد پیوندmصحیح = 0شمار پیوندهای HNSW؛ ۰ برای پیش‌فرض.
کیفیت ساختef_constructionصحیح = 0کیفیت ساخت HNSW؛ ۰ برای پیش‌فرض.
db-opensearch-Knn.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    ک := اپن سرچ.اتصال("http://localhost:9200")
    روش درخواست := اپن سرچ.روش همسایه‌یابی { نام = "hnsw"، موتور = "lucene"، نوع فضا = "cosinesimil"، تعداد پیوند = 16، کیفیت ساخت = 128 }
    ناپایا افزوده := وکتور {} برگردان وکتور<رشته>
    افزوده.بیفزا(اپن سرچ.ویژگی("text"، "text"))
    سرچاپ اپن سرچ.تنظیمات نمایه همسایه‌یابی(1، 0)، اپن سرچ.فیلد بردار همسایه‌یابی(3، روش درخواست)
    سرچاپ اپن سرچ.ایجاد نمایه(ک، "places"، اپن سرچ.بدنه نمایه همسایه‌یابی("embedding"، 3، روش درخواست، افزوده))
    اپن سرچ.نمایه‌سازی(ک، "places"، "1"، `{"text":"a cafe","embedding":[0.1,0.9,0.2]}`)
    اپن سرچ.تازه‌سازی(ک، "places")
    ناپایا ز := وکتور {} برگردان وکتور<اعشار۶۴>
    ز.بیفزا(0.1)
    ز.بیفزا(0.8)
    ز.بیفزا(0.3)
    ر := اپن سرچ.جستجو(ک، "places"، اپن سرچ.نزدیک‌ترین همسایه‌ها("embedding"، ز، 5))
    سرچاپ ر.کل
    سرچاپ اپن سرچ.گرم‌کردن همسایه‌یابی(ک، "places")، اپن سرچ.پاک‌سازی حافظه همسایه‌یابی(ک، "places")، اپن سرچ.آمار همسایه‌یابی(ک).طول() بزرگتر 0
    سرچاپ اپن سرچ.آموزش مدل همسایه‌یابی(ک، "pq-model"، `{"training_index":"train","training_field":"v","dimension":3,"method":{"name":"ivf","engine":"faiss"}}`)
    سرچاپ اپن سرچ.دریافت مدل همسایه‌یابی(ک، "pq-model")، اپن سرچ.حذف مدل همسایه‌یابی(ک، "pq-model")

    ناپایا ن := وکتور {} برگردان وکتور<اعشار۶۴>
    ن.بیفزا(0.3)
    ن.بیفزا(0.7)
    سرچاپ اپن سرچ.تنظیم خط لوله جستجو(ک، "hybrid"، اپن سرچ.خط لوله نرمال‌سازی("min_max"، "arithmetic_mean"، ن))
    سرچاپ اپن سرچ.دریافت خط لوله جستجو(ک، "hybrid")، اپن سرچ.حذف خط لوله جستجو(ک، "hybrid")

    کار := اپن سرچ.ثبت مدل یادگیری(ک، `{"name":"huggingface/sentence-transformers/all-MiniLM-L6-v2","version":"1.0.1","model_format":"TORCH_SCRIPT"}`)
    سرچاپ اپن سرچ.دریافت کار یادگیری(ک، کار)
    سرچاپ اپن سرچ.استقرار مدل یادگیری(ک، "model-1")، اپن سرچ.دریافت مدل یادگیری(ک، "model-1").طول() بزرگتر 0
    سرچاپ اپن سرچ.پیش‌بینی مدل(ک، "text_embedding"، "model-1"، `{"text_docs":["salam"]}`)
    سرچاپ اپن سرچ.برچیدن مدل یادگیری(ک، "model-1")، اپن سرچ.حذف مدل یادگیری(ک، "model-1")
پایان

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

نسخه کارخواه VERSION

پایا نسخه کارخواه: رشته = "1.0.0"
نسخه‌ی این کارخواه.

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

نشانی پیش‌فرض DEFAULT_URL

پایا نشانی پیش‌فرض: رشته = "http://localhost:9200"
نشانی‌ای که وقتی گره‌ای داده نشده به کار می‌رود: http://localhost:9200.

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

درگاه پیش‌فرض DEFAULT_PORT

پایا درگاه پیش‌فرض: صحیح۳۲ = 9200
درگاهی که وقتی نشانی گره درگاه ندارد به کار می‌رود: 9200.

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

مهلت گره از کار افتاده DEAD_NODE_MS

پایا مهلت گره از کار افتاده: صحیح۳۲ = 60000
مدتی که گره‌ای که اتصال را رد کرده کنار گذاشته می‌شود، به میلی‌ثانیه.

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

تازه‌سازی فوری REFRESH_TRUE

پایا تازه‌سازی فوری: رشته = "درست"
بی‌درنگ تازه‌سازی کن تا تغییر هنگام برگشت فراخوانی قابل جستجو باشد.

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

تازه‌سازی با انتظار REFRESH_WAIT_FOR

پایا تازه‌سازی با انتظار: رشته = "wait_for"
پیش از برگشت منتظر تازه‌سازی زمان‌بندی‌شده‌ی بعدی بمان.

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

بدون تازه‌سازی REFRESH_FALSE

پایا بدون تازه‌سازی: رشته = "نادرست"
تازه‌سازی نکن؛ حالت پیش‌فرض.

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

سرویس دامنه SERVICE_ES

پایا سرویس دامنه: رشته = "es"
نام سرویس امضای AWS برای یک دامنه‌ی Amazon OpenSearch Service.

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

سرویس بی‌سرور SERVICE_AOSS

پایا سرویس بی‌سرور: رشته = "aoss"
نام سرویس امضای AWS برای یک مجموعه‌ی OpenSearch Serverless.

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

تابع‌ها

تطبیق همه MatchAll

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

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

تطبیق هیچ MatchNone

تابع تطبیق هیچ(): رشته
با هیچ سندی تطبیق نمی‌خورد.

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

تطبیق Match

تابع تطبیق(field: رشته، text: رشته): رشته
تطبیق تمام‌متن روی یک فیلد.

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

تطبیق همه واژه‌ها MatchAnd

تابع تطبیق همه واژه‌ها(field: رشته، text: رشته): رشته
تطبیق تمام‌متن که همه‌ی واژه‌ها باید باشند.

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

تطبیق تقریبی MatchFuzzy

تابع تطبیق تقریبی(field: رشته، text: رشته): رشته
تطبیق تمام‌متن که از اشتباه تایپی می‌گذرد.

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

تطبیق عبارت MatchPhrase

تابع تطبیق عبارت(field: رشته، text: رشته): رشته
واژه‌ها به همین ترتیب.

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

تطبیق عبارت با فاصله MatchPhraseSlop

تابع تطبیق عبارت با فاصله(field: رشته، text: رشته، slop: صحیح): رشته
واژه‌ها به همین ترتیب، با حداکثر slop واژه در میان.

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

تطبیق پیشوند عبارت MatchPhrasePrefix

تابع تطبیق پیشوند عبارت(field: رشته، text: رشته): رشته
عبارتی که واژه‌ی آخرش می‌تواند پیشوند باشد؛ برای جستجو هنگام تایپ.

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

تطبیق پیشوند منطقی MatchBoolPrefix

تابع تطبیق پیشوند منطقی(field: رشته، text: رشته): رشته
همه‌ی واژه‌ها، آخری به شکل پیشوند، به هر ترتیبی.

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

تطبیق چندگانه MultiMatch

تابع تطبیق چندگانه(text: رشته، fields: وکتور<رشته>): رشته
تطبیق تمام‌متن روی چند فیلد؛ title^2 به یک فیلد وزن می‌دهد.

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

تطبیق چندگانه نوع‌دار MultiMatchType

تابع تطبیق چندگانه نوع‌دار(text: رشته، fields: وکتور<رشته>، kind: رشته): رشته
تطبیق چندگانه از گونه‌ای مثل best_fields، most_fields، phrase یا cross_fields.

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

واژه Term

تابع واژه(field: رشته، value: رشته): رشته
یک مقدار دقیق، برای فیلدهای keyword.

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

واژه عددی TermInt

تابع واژه عددی(field: رشته، value: صحیح۶۴): رشته
یک عدد دقیق.

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

واژه منطقی TermBool

تابع واژه منطقی(field: رشته، value: منطقی): رشته
یک مقدار منطقی دقیق.

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

واژه بدون حساسیت حروف TermCaseInsensitive

تابع واژه بدون حساسیت حروف(field: رشته، value: رشته): رشته
یک مقدار دقیق بدون توجه به بزرگی و کوچکی حروف.

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

واژه‌ها Terms

تابع واژه‌ها(field: رشته، values: وکتور<رشته>): رشته
هر یک از این مقدارهای دقیق.

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

واژه‌های عددی TermsInt

تابع واژه‌های عددی(field: رشته، values: وکتور<صحیح۶۴>): رشته
هر یک از این عددها.

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

واژه‌های ارجاعی TermsLookup

تابع واژه‌های ارجاعی(field: رشته، index: رشته، id: رشته، path: رشته): رشته
هر یک از مقدارهای ذخیره‌شده در مسیری از سندی دیگر.

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

مجموعه واژه‌ها TermsSet

تابع مجموعه واژه‌ها(field: رشته، values: وکتور<رشته>، minimum_field: رشته): رشته
دست‌کم به همان شماری از این مقدارها که فیلدی دیگر می‌گوید.

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

بازه Range

تابع بازه(field: رشته، low: رشته، high: رشته): رشته
بازه‌ای که به شکل متن داده شده، شامل دو سر؛ برای بازه‌ی باز یک سر را خالی بگذارید.

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

بازه باز RangeExclusive

تابع بازه باز(field: رشته، low: رشته، high: رشته): رشته
بازه‌ای که به شکل متن داده شده، بدون دو سر.

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

بازه عددی RangeNum

تابع بازه عددی(field: رشته، low: اعشار۶۴، high: اعشار۶۴): رشته
بازه‌ای از عددهای اعشاری، شامل دو سر.

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

بازه صحیح RangeInt

تابع بازه صحیح(field: رشته، low: صحیح۶۴، high: صحیح۶۴): رشته
بازه‌ای از عددهای صحیح، شامل دو سر.

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

بازه با عملگر RangeOp

تابع بازه با عملگر(field: رشته، op: رشته، value: رشته): رشته
یک کران با عملگر: gt، gte، lt یا lte.

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

بازه تاریخ DateRange

تابع بازه تاریخ(field: رشته، low: رشته، high: رشته، format: رشته، time_zone: رشته): رشته
بازه‌ی تاریخ با قالب و منطقه‌ی زمانی اختیاری؛ ریاضی تاریخ مثل now-7d/d کار می‌کند.

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

وجود فیلد FieldExists

تابع وجود فیلد(field: رشته): رشته
فیلد مقدار دارد.

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

پیشوند Prefix

تابع پیشوند(field: رشته، value: رشته): رشته
مقدار با این آغاز می‌شود.

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

نویسه عام Wildcard

تابع نویسه عام(field: رشته، pattern: رشته): رشته
الگویی با * و ?.

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

عبارت باقاعده Regexp

تابع عبارت باقاعده(field: رشته، pattern: رشته): رشته
یک عبارت باقاعده روی کل مقدار.

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

تقریبی Fuzzy

تابع تقریبی(field: رشته، value: رشته): رشته
مقداری نزدیک به این.

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

شناسه‌ها Ids

تابع شناسه‌ها(ids: وکتور<رشته>): رشته
سندهایی با این شناسه‌ها.

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

رشته پرسمان QueryString

تابع رشته پرسمان(query: رشته): رشته
یک رشته‌ی پرسمان لوسین، مثل title:salam AND year:1403.

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

رشته پرسمان در فیلدها QueryStringFields

تابع رشته پرسمان در فیلدها(query: رشته، fields: وکتور<رشته>، default_operator: رشته): رشته
رشته‌ی پرسمانی روی فیلدهای داده‌شده با یک عملگر پیش‌فرض.

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

رشته پرسمان ساده SimpleQueryString

تابع رشته پرسمان ساده(query: رشته، fields: وکتور<رشته>): رشته
رشته‌ی پرسمان باگذشتی که هرگز در تجزیه شکست نمی‌خورد.

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

پرسمان منطقی ساخته BoolOf

تابع پرسمان منطقی ساخته(q: پرسمان منطقی): رشته
پرسمان منطقی از یک پرسمان منطقی.

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

منطقی Bool

تابع منطقی(must: وکتور<رشته>، filter: وکتور<رشته>، should: وکتور<رشته>، must_not: وکتور<رشته>): رشته
پرسمان منطقی از چهار فهرست بند.

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

همه شرط‌ها And

تابع همه شرط‌ها(clauses: وکتور<رشته>): رشته
همه‌ی بندها باید تطبیق بخورند.

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

یکی از شرط‌ها Or

تابع یکی از شرط‌ها(clauses: وکتور<رشته>): رشته
دست‌کم یک بند باید تطبیق بخورد.

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

نقیض Not

تابع نقیض(clause: رشته): رشته
بند نباید تطبیق بخورد.

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

پالایش شده Filtered

تابع پالایش شده(query: رشته، filters: وکتور<رشته>): رشته
یک پرسمان به همراه پالایه‌هایی که امتیاز نمی‌دهند.

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

امتیاز ثابت ConstantScore

تابع امتیاز ثابت(filter: رشته، boost: اعشار۶۴): رشته
پالایه‌ای که در آن هر تطبیق امتیاز یکسان می‌گیرد.

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

بیشینه جداگانه DisMax

تابع بیشینه جداگانه(queries: وکتور<رشته>، tie_breaker: اعشار۶۴): رشته
بهترین امتیاز از چند پرسمان، به همراه سهمی از بقیه.

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

تقویت Boosting

تابع تقویت(positive: رشته، negative: رشته، negative_boost: اعشار۶۴): رشته
امتیاز تطبیق‌های یک پرسمان منفی را به جای کنار گذاشتن پایین می‌آورد.

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

تودرتو Nested

تابع تودرتو(path: رشته، query: رشته): رشته
پرسمانی روی شیءهای تودرتو.

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

دارای فرزند HasChild

تابع دارای فرزند(child_type: رشته، query: رشته): رشته
والدهایی با فرزند منطبق، برای فیلدهای پیوند.

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

دارای والد HasParent

تابع دارای والد(parent_type: رشته، query: رشته): رشته
فرزندانی با والد منطبق، برای فیلدهای پیوند.

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

مشابه MoreLikeThis

تابع مشابه(fields: وکتور<رشته>، like: رشته): رشته
سندهایی مانند متن داده‌شده.

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

پرسمان اسکریپت ScriptQuery

تابع پرسمان اسکریپت(source: رشته، params: رشته): رشته
سندهایی که اسکریپتی برایشان درست است.

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

اسکریپت Script

تابع اسکریپت(source: رشته، params: رشته): رشته
یک اسکریپت painless با پارامترهای اختیاری به شکل JSON.

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

امتیاز اسکریپتی ScriptScore

تابع امتیاز اسکریپتی(query: رشته، source: رشته، params: رشته): رشته
تطبیق‌های یک پرسمان را با اسکریپت امتیاز می‌دهد.

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

امتیاز تابعی FunctionScore

تابع امتیاز تابعی(query: رشته، functions: وکتور<رشته>، score_mode: رشته، boost_mode: رشته): رشته
امتیازهای یک پرسمان را با تابع‌هایی مثل ضریب مقدار فیلد تغییر می‌دهد.

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

ضریب مقدار فیلد FieldValueFactor

تابع ضریب مقدار فیلد(field: رشته، factor: اعشار۶۴، modifier: رشته): رشته
یک تابع امتیاز از یک فیلد عددی.

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

فاصله جغرافیایی GeoDistance

تابع فاصله جغرافیایی(field: رشته، lat: اعشار۶۴، lon: اعشار۶۴، distance: رشته): رشته
نقطه‌هایی در فاصله‌ای، مثل 5km، از یک مکان.

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

کادر جغرافیایی GeoBoundingBox

تابع کادر جغرافیایی(field: رشته، top: اعشار۶۴، left: اعشار۶۴، bottom: اعشار۶۴، right: اعشار۶۴): رشته
نقطه‌هایی درون کادری که با بالا، چپ، پایین و راست داده شده.

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

نزدیک‌ترین همسایه‌ها Knn

تابع نزدیک‌ترین همسایه‌ها(field: رشته، vector: وکتور<اعشار۶۴>، k: صحیح): رشته
k نزدیک‌ترین همسایه‌ی یک بردار، برای یک فیلد knn_vector.

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

نزدیک‌ترین همسایه‌های پالایش شده KnnFiltered

تابع نزدیک‌ترین همسایه‌های پالایش شده(field: رشته، vector: وکتور<اعشار۶۴>، k: صحیح، filter: رشته): رشته
k نزدیک‌ترین همسایه در میان سندهایی که با پالایه‌ای تطبیق می‌خورند.

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

همسایه‌های شعاعی KnnRadial

تابع همسایه‌های شعاعی(field: رشته، vector: وکتور<اعشار۶۴>، max_distance: اعشار۶۴): رشته
همه‌ی همسایه‌ها در یک فاصله.

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

همسایه‌ها با کمینه امتیاز KnnMinScore

تابع همسایه‌ها با کمینه امتیاز(field: رشته، vector: وکتور<اعشار۶۴>، min_score: اعشار۶۴): رشته
همه‌ی همسایه‌ها با دست‌کم این امتیاز.

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

عصبی Neural

تابع عصبی(field: رشته، query_text: رشته، model_id: رشته، k: صحیح): رشته
جستجوی معنایی: سرور متن را با یک مدل به بردار تبدیل می‌کند؛ به افزونه‌ی جستجوی عصبی نیاز دارد.

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

عصبی پراکنده NeuralSparse

تابع عصبی پراکنده(field: رشته، query_text: رشته، model_id: رشته): رشته
جستجوی عصبی پراکنده با یک مدل.

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

ترکیبی Hybrid

تابع ترکیبی(queries: وکتور<رشته>): رشته
چند پرسمان، معمولا یک تطبیق متنی و یک عصبی، را ترکیب می‌کند؛ با یک خط لوله‌ی جستجوی نرمال‌سازی اجرایش کنید.

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

مرتب صعودی SortAsc

تابع مرتب صعودی(field: رشته): رشته
مرتب‌سازی صعودی با یک فیلد.

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

مرتب نزولی SortDesc

تابع مرتب نزولی(field: رشته): رشته
مرتب‌سازی نزولی با یک فیلد.

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

مرتب‌سازی امتیازی SortScore

تابع مرتب‌سازی امتیازی(): رشته
مرتب‌سازی با امتیاز.

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

مرتب‌سازی مکانی SortGeo

تابع مرتب‌سازی مکانی(field: رشته، lat: اعشار۶۴، lon: اعشار۶۴، unit: رشته): رشته
مرتب‌سازی با فاصله از یک مکان.

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

برجسته‌سازی Highlight

تابع برجسته‌سازی(fields: وکتور<رشته>): رشته
تطبیق‌ها را در این فیلدها برجسته کن.

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

برجسته‌سازی با برچسب HighlightTags

تابع برجسته‌سازی با برچسب(fields: وکتور<رشته>، pre: رشته، post: رشته): رشته
با برچسب‌های خودتان دور هر تطبیق برجسته کن.

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

ادغام فیلدی Collapse

تابع ادغام فیلدی(field: رشته): رشته
برای هر مقدار یک فیلد فقط بهترین یافته را برگردان.

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

پیشنهاد واژه TermSuggest

تابع پیشنهاد واژه(name: رشته، text: رشته، field: رشته): رشته
پیشنهاددهنده‌ای که واژه‌های یک متن را درست می‌کند.

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

پیشنهاد تکمیل CompletionSuggest

تابع پیشنهاد تکمیل(name: رشته، prefix: رشته، field: رشته، size: صحیح): رشته
پیشنهاددهنده‌ای که پیشوندی را از یک فیلد completion کامل می‌کند.

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

تجمیع واژه‌ها TermsAgg

تابع تجمیع واژه‌ها(field: رشته، size: صحیح): رشته
سطل‌هایی برای رایج‌ترین مقدارهای یک فیلد.

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

تجمیع میانگین AvgAgg

تابع تجمیع میانگین(field: رشته): رشته
میانگین یک فیلد.

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

تجمیع جمع SumAgg

تابع تجمیع جمع(field: رشته): رشته
جمع یک فیلد.

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

تجمیع کمینه MinAgg

تابع تجمیع کمینه(field: رشته): رشته
کوچک‌ترین مقدار یک فیلد.

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

تجمیع بیشینه MaxAgg

تابع تجمیع بیشینه(field: رشته): رشته
بزرگ‌ترین مقدار یک فیلد.

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

تجمیع شمار مقدار ValueCountAgg

تابع تجمیع شمار مقدار(field: رشته): رشته
یک فیلد چند مقدار دارد.

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

تجمیع یکتاها CardinalityAgg

تابع تجمیع یکتاها(field: رشته): رشته
یک فیلد تقریبا چند مقدار یکتا دارد.

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

تجمیع آمار StatsAgg

تابع تجمیع آمار(field: رشته): رشته
شمار، کمینه، بیشینه، میانگین و جمع یک فیلد.

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

تجمیع آمار گسترده ExtendedStatsAgg

تابع تجمیع آمار گسترده(field: رشته): رشته
تجمیع آمار به همراه واریانس و انحراف معیار.

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

تجمیع صدک‌ها PercentilesAgg

تابع تجمیع صدک‌ها(field: رشته، percents: وکتور<اعشار۶۴>): رشته
صدک‌های داده‌شده‌ی یک فیلد.

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

تجمیع هیستوگرام HistogramAgg

تابع تجمیع هیستوگرام(field: رشته، interval: اعشار۶۴): رشته
سطل‌هایی با پهنای عددی ثابت.

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

تجمیع هیستوگرام تاریخ DateHistogramAgg

تابع تجمیع هیستوگرام تاریخ(field: رشته، calendar_interval: رشته): رشته
سطل‌هایی با بازه‌ی تقویمی، مثل day یا month.

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

تجمیع بازه RangeAgg

تابع تجمیع بازه(field: رشته، bounds: وکتور<اعشار۶۴>): رشته
سطل‌هایی میان کران‌های داده‌شده، به همراه یکی زیر نخستین و یکی بالای آخرین.

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

تجمیع پالایه FilterAgg

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

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

تجمیع تودرتو NestedAgg

تابع تجمیع تودرتو(path: رشته): رشته
شیءهای تودرتو در یک مسیر را تجمیع می‌کند.

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

تجمیع گمشده‌ها MissingAgg

تابع تجمیع گمشده‌ها(field: رشته): رشته
یک سطل از سندهایی که برای فیلدی مقدار ندارند.

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

تجمیع برترین یافته‌ها TopHitsAgg

تابع تجمیع برترین یافته‌ها(size: صحیح): رشته
بهترین یافته‌ها در هر سطل.

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

تجمیع ترکیبی CompositeAgg

تابع تجمیع ترکیبی(fields: وکتور<رشته>، size: صحیح): رشته
صفحه به صفحه از همه‌ی ترکیب‌های مقدارهای چند فیلد می‌گذرد.

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

افزودن تجمیع AddAgg

تابع افزودن تجمیع(aggs: رشته، name: رشته، agg: رشته): رشته
یک تجمیع نام‌دار به شیء تجمیع‌ها می‌افزاید؛ از {} آغاز کنید.

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

زیرتجمیع‌ها SubAggs

تابع زیرتجمیع‌ها(agg: رشته، aggs: رشته): رشته
تجمیع‌هایی را درون یک تجمیع سطلی می‌گذارد.

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

افزودن عضو AddMember

تابع افزودن عضو(obj: رشته، key: رشته، raw: رشته): رشته
عضوی به یک شیء JSON می‌افزاید.

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

بدنه جستجو SearchBody

تابع بدنه جستجو(req: درخواست جستجو): رشته
بدنه‌ی JSON یک درخواست جستجو.

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

پیکربندی پیش‌فرض DefaultConfig

تابع پیکربندی پیش‌فرض(): پیکربندی
پیکربندی‌ای با گره‌ی پیش‌فرض، آماده‌ی تغییر.

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

کارخواه تازه NewClient

تابع کارخواه تازه(cfg: پیکربندی): کارخواه
از یک پیکربندی کارخواه می‌سازد؛ با معتبر بررسی‌اش کنید.

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

اتصال Connect

تابع اتصال(url: رشته): کارخواه
کارخواهی برای نشانی یک گره؛ نشانی می‌تواند user:password@ داشته باشد.

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

اتصال با رمز ConnectAuth

تابع اتصال با رمز(url: رشته، username: رشته، password: رشته): کارخواه
کارخواهی برای یک گره با احراز هویت پایه.

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

اتصال بدون وارسی گواهی ConnectInsecure

تابع اتصال بدون وارسی گواهی(url: رشته، username: رشته، password: رشته): کارخواه
کارخواهی که گواهی سرور را وارسی نمی‌کند؛ فقط برای راه‌اندازی نمایشی و سرورهای آزمایشی.

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

اتصال آمازون ConnectAWS

تابع اتصال آمازون(url: رشته، region: رشته، service: رشته، access_key: رشته، secret_key: رشته، session_token: رشته): کارخواه
کارخواهی که هر درخواست را با AWS SigV4 امضا می‌کند، برای Amazon OpenSearch Service یا Serverless.

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

معتبر Ok

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

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

خطا Error

تابع خطا(c: کارخواه): رشته
خطای آخرین درخواست، یا خطای پیکربندی.

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

نوع خطا ErrorType

تابع نوع خطا(c: کارخواه): رشته
نوع خطای سرور در آخرین درخواست.

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

علت خطا ErrorReason

تابع علت خطا(c: کارخواه): رشته
علت خطای سرور در آخرین درخواست.

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

وضعیت Status

تابع وضعیت(c: کارخواه): صحیح
وضعیت HTTP آخرین درخواست.

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

گره‌ها Nodes

تابع گره‌ها(c: کارخواه): وکتور<رشته>
نشانی گره‌ها، همان‌طور که کارخواه به کارشان می‌برد.

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

سرآیند احراز AuthHeader

تابع سرآیند احراز(c: کارخواه): رشته
مقدار سرآیند Authorization که با هر درخواست فرستاده می‌شود؛ با امضای AWS خالی است چون هر درخواست جداگانه امضا می‌شود.

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

تنظیم زمان امضا SetSigningTime

تابع تنظیم زمان امضا(c: کارخواه، epoch: صحیح۶۴)
ساعت مورد استفاده‌ی امضای AWS را ثابت می‌کند، به ثانیه‌ی یونیکس؛ برای آزمون. ۰ به ساعت واقعی برمی‌گردد.

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

بستن Close

تابع بستن(c &: کارخواه)
کارخواه را آزاد می‌کند.

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

انجام Perform

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

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

انجام چندخطی PerformNdjson

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

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

انجام متنی PerformText

تابع انجام متنی(c: کارخواه، method: رشته، path: رشته، body: رشته، content_type: رشته): پاسخ
درخواستی با بدنه‌ای از گونه‌ی محتوای داده‌شده می‌فرستد.

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

کدگذاری پایه EncodeBasic

تابع کدگذاری پایه(username: رشته، password: رشته): رشته
پایه۶۴ عبارت user:password، همان‌طور که احراز هویت پایه می‌فرستد.

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

دریافت اطلاعات GetInfo

تابع دریافت اطلاعات(c: کارخواه): اطلاعات
آن‌چه خوشه درباره‌ی خودش می‌گوید.

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

پینگ Ping

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

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

سلامت خوشه ClusterHealth

تابع سلامت خوشه(c: کارخواه): سلامت
سلامت خوشه.

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

انتظار وضعیت WaitForStatus

تابع انتظار وضعیت(c: کارخواه، index: رشته، status: رشته، timeout: رشته): سلامت
صبر می‌کند تا خوشه، یا یک نمایه، به وضعیتی مثل yellow برسد یا مهلت سر برسد.

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

آمار خوشه ClusterStats

تابع آمار خوشه(c: کارخواه): رشته
آمار خوشه به شکل JSON خام.

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

حالت خوشه ClusterState

تابع حالت خوشه(c: کارخواه، metrics: رشته): رشته
حالت خوشه به شکل JSON خام، اگر بخواهید فقط برخی سنجه‌ها مثل metadata.

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

دریافت تنظیمات خوشه GetClusterSettings

تابع دریافت تنظیمات خوشه(c: کارخواه): رشته
تنظیمات خوشه به شکل JSON خام، با نام‌های تخت.

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

تنظیم تنظیمات خوشه PutClusterSettings

تابع تنظیم تنظیمات خوشه(c: کارخواه، persistent: رشته، transient: رشته): منطقی
تنظیمات ماندگار و گذرای خوشه را تغییر می‌دهد؛ برای دست نزدن به یکی رشته‌ی خالی بدهید.

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

توضیح تخصیص AllocationExplain

تابع توضیح تخصیص(c: کارخواه، body: رشته): رشته
چرا یک شارد تخصیص یافته یا نیافته، به شکل JSON خام.

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

اطلاعات گره‌ها NodesInfo

تابع اطلاعات گره‌ها(c: کارخواه، metrics: رشته): رشته
اطلاعات گره‌ها، اگر بخواهید فقط برخی سنجه‌ها.

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

آمار گره‌ها NodesStats

تابع آمار گره‌ها(c: کارخواه، metrics: رشته): رشته
آمار گره‌ها، اگر بخواهید فقط برخی سنجه‌ها.

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

نخ‌های پرکار HotThreads

تابع نخ‌های پرکار(c: کارخواه): رشته
پرکارترین نخ‌ها چه می‌کنند، به شکل متن.

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

فهرست Cat

تابع فهرست(c: کارخواه، what: رشته): وکتور<رشته>
یک API فهرستی، مثل shards یا nodes، به شکل یک شیء JSON برای هر ردیف.

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

فهرست متنی CatText

تابع فهرست متنی(c: کارخواه، what: رشته): رشته
یک API فهرستی به شکل جدول متنی هم‌ترازی که آدم‌ها می‌خوانند.

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

افزونه‌ها Plugins

تابع افزونه‌ها(c: کارخواه): وکتور<رشته>
افزونه‌های نصب‌شده روی خوشه، هر کدام یک بار.

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

دارای افزونه HasPlugin

تابع دارای افزونه(c: کارخواه، name: رشته): منطقی
افزونه‌ای، مثل opensearch-knn، نصب است.

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

دریافت کار GetTask

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

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

انتظار کار WaitTask

تابع انتظار کار(c: کارخواه، task_id: رشته، timeout: رشته): اطلاعات کار
تا مهلتی صبر می‌کند تا کار پایان یابد.

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

لغو کار CancelTask

تابع لغو کار(c: کارخواه، task_id: رشته): منطقی
کاری را لغو می‌کند.

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

فهرست کارها ListTasks

تابع فهرست کارها(c: کارخواه، actions: رشته): رشته
کارهای در حال اجرا به شکل JSON خام، اگر بخواهید فقط کنش‌های منطبق با یک الگو.

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

تنظیم مخزن PutRepository

تابع تنظیم مخزن(c: کارخواه، name: رشته، kind: رشته، settings: رشته): منطقی
یک مخزن تصویر لحظه‌ای از گونه‌ای مثل fs یا s3 ثبت می‌کند.

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

دریافت مخزن GetRepository

تابع دریافت مخزن(c: کارخواه، name: رشته): رشته
یک مخزن تصویر لحظه‌ای به شکل JSON خام.

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

وارسی مخزن VerifyRepository

تابع وارسی مخزن(c: کارخواه، name: رشته): منطقی
بررسی می‌کند که همه‌ی گره‌ها بتوانند مخزنی را به کار ببرند.

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

حذف مخزن DeleteRepository

تابع حذف مخزن(c: کارخواه، name: رشته): منطقی
مخزن تصویر لحظه‌ای را برمی‌دارد؛ تصویرها سر جای خود می‌مانند.

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

ایجاد تصویر لحظه‌ای CreateSnapshot

تابع ایجاد تصویر لحظه‌ای(c: کارخواه، repo: رشته، snapshot: رشته، indices: رشته، wait: منطقی): منطقی
از برخی نمایه‌ها، یا اگر خالی باشد همه، تصویر لحظه‌ای می‌گیرد؛ با wait درست فقط وقتی تصویر موفق بود درست است.

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

دریافت تصویر لحظه‌ای GetSnapshot

تابع دریافت تصویر لحظه‌ای(c: کارخواه، repo: رشته، snapshot: رشته): رشته
یک تصویر لحظه‌ای به شکل JSON خام؛ الگو یا _all هم کار می‌کند.

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

تصویرهای لحظه‌ای Snapshots

تابع تصویرهای لحظه‌ای(c: کارخواه، repo: رشته): وکتور<رشته>
نام همه‌ی تصویرهای لحظه‌ای یک مخزن.

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

وضعیت تصویر لحظه‌ای SnapshotStatus

تابع وضعیت تصویر لحظه‌ای(c: کارخواه، repo: رشته، snapshot: رشته): رشته
پیشرفت یک تصویر لحظه‌ای به شکل JSON خام.

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

حذف تصویر لحظه‌ای DeleteSnapshot

تابع حذف تصویر لحظه‌ای(c: کارخواه، repo: رشته، snapshot: رشته): منطقی
یک تصویر لحظه‌ای را حذف می‌کند.

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

بازیابی تصویر لحظه‌ای RestoreSnapshot

تابع بازیابی تصویر لحظه‌ای(c: کارخواه، repo: رشته، snapshot: رشته، body: رشته، wait: منطقی): منطقی
یک تصویر لحظه‌ای را با بدنه‌ی بازیابی، مثل کدام نمایه‌ها و چگونه تغییر نام بدهند، بازیابی می‌کند.

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

تنظیم خط لوله PutPipeline

تابع تنظیم خط لوله(c: کارخواه، id: رشته، body: رشته): منطقی
یک خط لوله‌ی ورودی می‌سازد یا جایگزین می‌کند.

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

خط لوله Pipeline

تابع خط لوله(description: رشته، processors: وکتور<رشته>): رشته
بدنه‌ی خط لوله‌ی ورودی از یک توضیح و چند پردازنده.

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

پردازنده Processor

تابع پردازنده(kind: رشته، config: رشته): رشته
یک پردازنده‌ی ورودی، مثل پردازنده("lowercase"، `{"field":"tag"}`).

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

دریافت خط لوله GetPipeline

تابع دریافت خط لوله(c: کارخواه، id: رشته): رشته
یک خط لوله‌ی ورودی به شکل JSON خام.

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

حذف خط لوله DeletePipeline

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

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

شبیه‌سازی خط لوله SimulatePipeline

تابع شبیه‌سازی خط لوله(c: کارخواه، id: رشته، docs: وکتور<رشته>): وکتور<رشته>
سندها را بدون ذخیره از خط لوله می‌گذراند؛ منبع هر نتیجه را برمی‌گرداند.

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

تنظیم اسکریپت PutScript

تابع تنظیم اسکریپت(c: کارخواه، id: رشته، source: رشته): منطقی
یک اسکریپت painless را زیر یک شناسه ذخیره می‌کند.

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

تنظیم الگوی جستجو PutSearchTemplate

تابع تنظیم الگوی جستجو(c: کارخواه، id: رشته، source: رشته): منطقی
یک الگوی جستجوی mustache را زیر یک شناسه ذخیره می‌کند، برای جستجوی الگو.

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

دریافت اسکریپت GetScript

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

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

حذف اسکریپت DeleteScript

تابع حذف اسکریپت(c: کارخواه، id: رشته): منطقی
یک اسکریپت یا الگوی ذخیره‌شده را حذف می‌کند.

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

ایجاد نمایه CreateIndex

تابع ایجاد نمایه(c: کارخواه، name: رشته، body: رشته): منطقی
نمایه‌ای با بدنه‌ی تنظیمات و نگاشت می‌سازد؛ بدنه‌ی خالی پیش‌فرض‌ها را به کار می‌برد.

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

ایجاد نمایه با تنظیمات CreateIndexWith

تابع ایجاد نمایه با تنظیمات(c: کارخواه، name: رشته، shards: صحیح، replicas: صحیح، properties: رشته): منطقی
نمایه‌ای از شمار شارد و نسخه‌ی تکراری و ویژگی‌های نگاشت می‌سازد؛ ۰ شارد یا ۱- نسخه آن تنظیم را کنار می‌گذارد.

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

حذف نمایه DeleteIndex

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

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

حذف نمایه موجود DeleteIndexIfExists

تابع حذف نمایه موجود(c: کارخواه، name: رشته): منطقی
نمایه‌ای را حذف می‌کند و وقتی وجود نداشت هم درست است.

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

وجود نمایه IndexExists

تابع وجود نمایه(c: کارخواه، name: رشته): منطقی
نمایه وجود دارد.

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

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

تابع دریافت نمایه(c: کارخواه، name: رشته): رشته
تنظیمات، نگاشت و نام‌های مستعار یک نمایه به شکل JSON خام.

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

دریافت نگاشت GetMapping

تابع دریافت نگاشت(c: کارخواه، index: رشته): رشته
نگاشت به شکل JSON خام؛ نمایه‌ی خالی یعنی همه.

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

تنظیم نگاشت PutMapping

تابع تنظیم نگاشت(c: کارخواه، index: رشته، properties: رشته): منطقی
فیلدهایی را که به شکل عضوهای properties داده شده‌اند به نگاشت می‌افزاید.

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

تنظیم نگاشت با بدنه PutMappingBody

تابع تنظیم نگاشت با بدنه(c: کارخواه، index: رشته، body: رشته): منطقی
نگاشت را با یک بدنه‌ی کامل تغییر می‌دهد.

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

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

تابع دریافت تنظیمات(c: کارخواه، index: رشته): رشته
تنظیمات به شکل JSON خام.

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

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

تابع دریافت یک تنظیم(c: کارخواه، index: رشته، name: رشته): رشته
یک تنظیم یک نمایه، مثل index.refresh_interval.

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

تنظیم تنظیمات PutSettings

تابع تنظیم تنظیمات(c: کارخواه، index: رشته، settings: رشته): منطقی
تنظیمات نمایه را تغییر می‌دهد.

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

تازه‌سازی Refresh

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

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

تخلیه Flush

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

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

ادغام اجباری ForceMerge

تابع ادغام اجباری(c: کارخواه، index: رشته، max_segments: صحیح): منطقی
بخش‌ها را ادغام می‌کند، اگر عدد بیشتر از ۰ باشد تا همان شمار.

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

پاک‌سازی حافظه نهان ClearCache

تابع پاک‌سازی حافظه نهان(c: کارخواه، index: رشته): منطقی
حافظه‌های نهان یک نمایه را پاک می‌کند.

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

گشودن نمایه OpenIndex

تابع گشودن نمایه(c: کارخواه، index: رشته): منطقی
نمایه‌ی بسته‌ای را باز می‌کند.

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

بستن نمایه CloseIndex

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

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

همسان‌سازی نمایه CloneIndex

تابع همسان‌سازی نمایه(c: کارخواه، source: رشته، target: رشته، body: رشته): منطقی
نمایه‌ای را که نوشتنش بسته شده در نمایه‌ای تازه رونوشت می‌کند.

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

کوچک‌سازی نمایه ShrinkIndex

تابع کوچک‌سازی نمایه(c: کارخواه، source: رشته، target: رشته، body: رشته): منطقی
نمایه‌ای را در نمایه‌ای با شاردهای کمتر رونوشت می‌کند.

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

شکافتن نمایه SplitIndex

تابع شکافتن نمایه(c: کارخواه، source: رشته، target: رشته، body: رشته): منطقی
نمایه‌ای را در نمایه‌ای با شاردهای بیشتر رونوشت می‌کند.

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

آمار نمایه IndexStats

تابع آمار نمایه(c: کارخواه، index: رشته): رشته
آمار یک نمایه به شکل JSON خام.

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

افزودن نام مستعار PutAlias

تابع افزودن نام مستعار(c: کارخواه، index: رشته، alias: رشته): منطقی
نام مستعاری را به نمایه‌ای نشانه می‌رود.

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

افزودن نام مستعار پالایش شده PutAliasFiltered

تابع افزودن نام مستعار پالایش شده(c: کارخواه، index: رشته، alias: رشته، filter: رشته، is_write_index: منطقی): منطقی
نام مستعاری با پالایه به نمایه‌ای نشانه می‌رود و اگر بخواهید آن را نمایه‌ی نوشتن می‌کند.

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

حذف نام مستعار DeleteAlias

تابع حذف نام مستعار(c: کارخواه، index: رشته، alias: رشته): منطقی
نام مستعاری را از نمایه‌ای برمی‌دارد.

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

وجود نام مستعار AliasExists

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

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

دریافت نام‌های مستعار GetAliases

تابع دریافت نام‌های مستعار(c: کارخواه، index: رشته): رشته
نام‌های مستعار یک نمایه، یا همه، به شکل JSON خام.

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

نمایه‌های نام مستعار AliasIndices

تابع نمایه‌های نام مستعار(c: کارخواه، alias: رشته): وکتور<رشته>
نمایه‌هایی که نام مستعار به آن‌ها نشانه می‌رود.

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

کنش نام مستعار AliasAction

تابع کنش نام مستعار(action: رشته، index: رشته، alias: رشته): رشته
یک کنش add یا remove برای به‌روزرسانی نام‌های مستعار.

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

به‌روزرسانی نام‌های مستعار UpdateAliases

تابع به‌روزرسانی نام‌های مستعار(c: کارخواه، actions: وکتور<رشته>): منطقی
چند کنش نام مستعار را در یک گام یکپارچه اعمال می‌کند.

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

جابجایی نام مستعار SwapAlias

تابع جابجایی نام مستعار(c: کارخواه، alias: رشته، old_index: رشته، new_index: رشته): منطقی
نام مستعاری را در یک گام یکپارچه از نمایه‌ای به نمایه‌ی دیگر می‌برد؛ راه بازسازی نمایه بدون توقف.

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

تنظیم الگوی نمایه PutIndexTemplate

تابع تنظیم الگوی نمایه(c: کارخواه، name: رشته، body: رشته): منطقی
یک الگوی نمایه می‌سازد یا جایگزین می‌کند.

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

الگوی نمایه IndexTemplate

تابع الگوی نمایه(patterns: وکتور<رشته>، settings: رشته، properties: رشته، priority: صحیح): رشته
بدنه‌ی الگوی نمایه از الگوها، تنظیمات، ویژگی‌های نگاشت و اولویت.

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

دریافت الگوی نمایه GetIndexTemplate

تابع دریافت الگوی نمایه(c: کارخواه، name: رشته): رشته
یک الگوی نمایه به شکل JSON خام.

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

وجود الگوی نمایه IndexTemplateExists

تابع وجود الگوی نمایه(c: کارخواه، name: رشته): منطقی
الگوی نمایه وجود دارد.

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

حذف الگوی نمایه DeleteIndexTemplate

تابع حذف الگوی نمایه(c: کارخواه، name: رشته): منطقی
یک الگوی نمایه را حذف می‌کند.

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

تنظیم الگوی جزء PutComponentTemplate

تابع تنظیم الگوی جزء(c: کارخواه، name: رشته، body: رشته): منطقی
یک الگوی جزء می‌سازد یا جایگزین می‌کند.

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

دریافت الگوی جزء GetComponentTemplate

تابع دریافت الگوی جزء(c: کارخواه، name: رشته): رشته
یک الگوی جزء به شکل JSON خام.

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

حذف الگوی جزء DeleteComponentTemplate

تابع حذف الگوی جزء(c: کارخواه، name: رشته): منطقی
یک الگوی جزء را حذف می‌کند.

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

ایجاد جریان داده CreateDataStream

تابع ایجاد جریان داده(c: کارخواه، name: رشته): منطقی
یک جریان داده می‌سازد؛ باید یک الگوی نمایه‌ی منطبق با data_stream وجود داشته باشد.

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

حذف جریان داده DeleteDataStream

تابع حذف جریان داده(c: کارخواه، name: رشته): منطقی
یک جریان داده و نمایه‌های پشتیبانش را حذف می‌کند.

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

جریان‌های داده DataStreams

تابع جریان‌های داده(c: کارخواه): وکتور<رشته>
نام همه‌ی جریان‌های داده.

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

چرخش نمایه Rollover

تابع چرخش نمایه(c: کارخواه، alias: رشته، conditions: رشته): رشته
نام مستعار یا جریان داده را به نمایه‌ای تازه می‌چرخاند، اگر بخواهید فقط وقتی شرط‌ها برقرارند؛ نام نمایه‌ی تازه را برمی‌گرداند.

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

تحلیل متن Analyze

تابع تحلیل متن(c: کارخواه، index: رشته، analyzer: رشته، text: رشته): وکتور<رشته>
واژه‌هایی که یک تحلیلگر از یک متن می‌سازد؛ تحلیلگر خالی یعنی standard.

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

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

تابع فهرست نمایه‌ها(c: کارخواه، pattern: رشته): وکتور<اطلاعات نمایه>
یک ردیف برای هر نمایه، مرتب با نام؛ الگوی خالی یعنی همه.

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

ویژگی Property

تابع ویژگی(name: رشته، kind: رشته): رشته
یک فیلد نگاشت، "name":{"type":kind}، برای ویژگی‌ها.

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

ویژگی با گزینه PropertyWith

تابع ویژگی با گزینه(name: رشته، kind: رشته، extra: رشته): رشته
یک فیلد نگاشت با تنظیمات بیشتر، مثل یک تحلیلگر.

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

ویژگی‌ها Properties

تابع ویژگی‌ها(props: وکتور<رشته>): رشته
شیء ویژگی‌های نگاشت از چند فیلد.

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

نمایه‌سازی Index

تابع نمایه‌سازی(c: کارخواه، index: رشته، id: رشته، doc: رشته): نتیجه نوشتن
سندی را می‌افزاید یا جایگزین می‌کند؛ شناسه‌ی خالی یعنی سرور یکی بسازد.

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

نمایه‌سازی با گزینه IndexWith

تابع نمایه‌سازی با گزینه(c: کارخواه، index: رشته، id: رشته، doc: رشته، o: گزینه‌ها): نتیجه نوشتن
نمایه‌سازی با گزینه.

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

ایجاد سند Create

تابع ایجاد سند(c: کارخواه، index: رشته، id: رشته، doc: رشته): نتیجه نوشتن
سندی را فقط اگر سندی با آن شناسه نباشد می‌افزاید؛ در غیر این صورت 409.

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

ایجاد سند با گزینه CreateWith

تابع ایجاد سند با گزینه(c: کارخواه، index: رشته، id: رشته، doc: رشته، o: گزینه‌ها): نتیجه نوشتن
ایجاد سند با گزینه.

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

دریافت Get

تابع دریافت(c: کارخواه، index: رشته، id: رشته): سند
سندی را با شناسه می‌خواند.

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

دریافت فیلدها GetFields

تابع دریافت فیلدها(c: کارخواه، index: رشته، id: رشته، includes: وکتور<رشته>، routing: رشته): سند
فقط برخی فیلدهای منبع یک سند را می‌خواند، اگر بخواهید با مقدار مسیریابی.

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

دریافت منبع GetSource

تابع دریافت منبع(c: کارخواه، index: رشته، id: رشته): رشته
فقط منبع یک سند؛ اگر نباشد خالی.

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

وجود سند Exists

تابع وجود سند(c: کارخواه، index: رشته، id: رشته): منطقی
سند وجود دارد.

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

به‌روزرسانی Update

تابع به‌روزرسانی(c: کارخواه، index: رشته، id: رشته، partial: رشته): نتیجه نوشتن
فیلدهای داده‌شده را در یک سند ادغام می‌کند.

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

به‌روزرسانی با گزینه UpdateWith

تابع به‌روزرسانی با گزینه(c: کارخواه، index: رشته، id: رشته، body: رشته، o: گزینه‌ها): نتیجه نوشتن
یک بدنه‌ی کامل به‌روزرسانی، مثل {"doc":...} یا {"script":...}، را با گزینه می‌فرستد.

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

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

تابع به‌روزرسانی درجی(c: کارخواه، index: رشته، id: رشته، doc: رشته): نتیجه نوشتن
فیلدها را در یک سند ادغام می‌کند و اگر سند نباشد آن را می‌سازد.

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

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

تابع به‌روزرسانی اسکریپتی(c: کارخواه، index: رشته، id: رشته، script: رشته، upsert: رشته): نتیجه نوشتن
سندی را با اسکریپتی از اسکریپت تغییر می‌دهد؛ سند درجی، اگر داده شود، وقتی سند نیست به کار می‌رود.

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

حذف سند Delete

تابع حذف سند(c: کارخواه، index: رشته، id: رشته): نتیجه نوشتن
سندی را حذف می‌کند.

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

حذف سند با گزینه DeleteWith

تابع حذف سند با گزینه(c: کارخواه، index: رشته، id: رشته، o: گزینه‌ها): نتیجه نوشتن
حذف سند با گزینه.

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

دریافت چندگانه MGet

تابع دریافت چندگانه(c: کارخواه، index: رشته، ids: وکتور<رشته>): وکتور<سند>
چند سند از یک نمایه را یک‌جا و به همان ترتیب خواسته‌شده می‌خواند.

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

شمارش Count

تابع شمارش(c: کارخواه، index: رشته، query: رشته): صحیح۶۴
چند سند با پرسمانی تطبیق می‌خورند؛ پرسمان خالی همه را می‌شمارد و هنگام خطا ۱- است.

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

حذف پرسمانی DeleteByQuery

تابع حذف پرسمانی(c: کارخواه، index: رشته، query: رشته): نتیجه پرسمانی
هر سندی را که با پرسمانی تطبیق بخورد حذف می‌کند.

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

حذف پرسمانی با گزینه DeleteByQueryWith

تابع حذف پرسمانی با گزینه(c: کارخواه، index: رشته، query: رشته، o: گزینه‌ها): نتیجه پرسمانی
حذف پرسمانی با گزینه.

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

به‌روزرسانی پرسمانی UpdateByQuery

تابع به‌روزرسانی پرسمانی(c: کارخواه، index: رشته، query: رشته، script: رشته): نتیجه پرسمانی
اسکریپتی را روی هر سندی که با پرسمانی تطبیق بخورد اجرا می‌کند؛ پرسمان خالی یعنی همه.

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

به‌روزرسانی پرسمانی با گزینه UpdateByQueryWith

تابع به‌روزرسانی پرسمانی با گزینه(c: کارخواه، index: رشته، query: رشته، script: رشته، o: گزینه‌ها): نتیجه پرسمانی
به‌روزرسانی پرسمانی با گزینه.

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

نمایه‌سازی دوباره Reindex

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

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

نمایه‌سازی دوباره با بدنه ReindexBody

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

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

پارامتر اس کیو ال SqlParam

تابع پارامتر اس کیو ال(kind: رشته، value: رشته): رشته
یک پارامتر پرسمان برای اس کیو ال با پارامتر، مثل پارامتر اس کیو ال("integer"، "5").

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

اس کیو ال Sql

تابع اس کیو ال(c: کارخواه، query: رشته): ردیف‌های اس کیو ال
یک پرسمان SQL اجرا می‌کند.

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

اس کیو ال با پارامتر SqlWith

تابع اس کیو ال با پارامتر(c: کارخواه، query: رشته، params: وکتور<رشته>، fetch_size: صحیح): ردیف‌های اس کیو ال
یک پرسمان SQL با پارامترهای ? و اندازه‌ی صفحه اجرا می‌کند.

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

اس کیو ال با قالب SqlFormat

تابع اس کیو ال با قالب(c: کارخواه، query: رشته، format: رشته): رشته
نتیجه‌ی SQL در قالبی دیگر: csv، raw، json یا jdbc.

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

توضیح اس کیو ال SqlExplain

تابع توضیح اس کیو ال(c: کارخواه، query: رشته): رشته
یک پرسمان SQL چگونه اجرا می‌شود، به شکل JSON خام.

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

پی پی ال Ppl

تابع پی پی ال(c: کارخواه، query: رشته): ردیف‌های اس کیو ال
یک پرسمان PPL اجرا می‌کند، مثل source=logs | where code > 499 | stats count() by host.

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

پی پی ال با قالب PplFormat

تابع پی پی ال با قالب(c: کارخواه، query: رشته، format: رشته): رشته
نتیجه‌ی PPL در قالبی دیگر.

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

توضیح پی پی ال PplExplain

تابع توضیح پی پی ال(c: کارخواه، query: رشته): رشته
یک پرسمان PPL چگونه اجرا می‌شود، به شکل JSON خام.

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

اتصال عمومی Conn

تابع اتصال عمومی(c: کارخواه): dyn db.Connection
کارخواه به شکل اتصال، برای کدی که با دیتابیس نوشته شده.

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

تابع جستجو(c: کارخواه، index: رشته، query: رشته): نتیجه جستجو
پرسمانی را روی یک نمایه اجرا می‌کند؛ فهرست یا الگو هم کار می‌کند و نمایه‌ی خالی یعنی همه.

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

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

تابع جستجو با درخواست(c: کارخواه، index: رشته، req: درخواست جستجو): نتیجه جستجو
یک درخواست کامل جستجو را اجرا می‌کند.

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

جستجوی خام SearchRaw

تابع جستجوی خام(c: کارخواه، index: رشته، body: رشته): نتیجه جستجو
جستجویی با بدنه‌ای که خودتان نوشته‌اید اجرا می‌کند.

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

جستجو با پارامتر SearchParamsWith

تابع جستجو با پارامتر(c: کارخواه، index: رشته، body: رشته، p: پارامترهای جستجو): نتیجه جستجو
یک بدنه‌ی جستجو را با تنظیمات نشانی، مثل یک خط لوله‌ی جستجو، اجرا می‌کند.

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

تجزیه جستجو ParseSearch

تابع تجزیه جستجو(body: رشته): نتیجه جستجو
پاسخ جستجویی را که در دست دارید می‌خواند.

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

جستجوی پیمایشی SearchScroll

تابع جستجوی پیمایشی(c: کارخواه، index: رشته، req: درخواست جستجو، keep_alive: رشته): نتیجه جستجو
پیمایشی را آغاز می‌کند: صفحه‌ی نخست و یک شناسه‌ی پیمایش.

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

پیمایش Scroll

تابع پیمایش(c: کارخواه، scroll_id: رشته، keep_alive: رشته): نتیجه جستجو
صفحه‌ی بعدی یک پیمایش؛ صفحه‌ی خالی یعنی پایان.

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

پاک‌سازی پیمایش ClearScroll

تابع پاک‌سازی پیمایش(c: کارخواه، scroll_id: رشته): منطقی
پیمایشی را روی سرور آزاد می‌کند.

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

ایجاد نقطه زمانی CreatePit

تابع ایجاد نقطه زمانی(c: کارخواه، index: رشته، keep_alive: رشته): رشته
یک نقطه‌ی زمانی روی نمایه‌ای باز می‌کند، برای صفحه‌بندی پایدار با search_after؛ شناسه‌اش را برمی‌گرداند.

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

حذف نقطه زمانی DeletePit

تابع حذف نقطه زمانی(c: کارخواه، pit_id: رشته): منطقی
یک نقطه‌ی زمانی را می‌بندد.

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

حذف همه نقطه‌های زمانی DeleteAllPits

تابع حذف همه نقطه‌های زمانی(c: کارخواه): منطقی
همه‌ی نقطه‌های زمانی را می‌بندد.

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

فهرست نقطه‌های زمانی ListPits

تابع فهرست نقطه‌های زمانی(c: کارخواه): وکتور<رشته>
شناسه‌ی همه‌ی نقطه‌های زمانی باز.

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

جستجوی چندگانه MSearch

تابع جستجوی چندگانه(c: کارخواه، index: رشته، bodies: وکتور<رشته>): وکتور<نتیجه جستجو>
چند بدنه‌ی جستجو را در یک درخواست روی یک نمایه اجرا می‌کند؛ یک نتیجه برای هر بدنه، به همان ترتیب.

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

جستجوی الگو SearchTemplate

تابع جستجوی الگو(c: کارخواه، index: رشته، template_id: رشته، params: رشته): نتیجه جستجو
یک الگوی جستجوی ذخیره‌شده را با پارامترها اجرا می‌کند.

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

جستجوی الگوی درون‌خطی SearchInlineTemplate

تابع جستجوی الگوی درون‌خطی(c: کارخواه، index: رشته، source: رشته، params: رشته): نتیجه جستجو
یک الگوی mustache داده‌شده به شکل JSON را با پارامترها اجرا می‌کند.

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

نمایش الگو RenderTemplate

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

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

توضیح امتیاز Explain

تابع توضیح امتیاز(c: کارخواه، index: رشته، id: رشته، query: رشته): رشته
امتیاز یک سند برای یک پرسمان چگونه حساب شد، به شکل JSON خام.

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

اعتبارسنجی پرسمان Validate

تابع اعتبارسنجی پرسمان(c: کارخواه، index: رشته، query: رشته): منطقی
پرسمان برای نمایه معتبر است.

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

توانایی فیلدها FieldCaps

تابع توانایی فیلدها(c: کارخواه، index: رشته، fields: وکتور<رشته>): رشته
هر فیلد در یک نمایه چه می‌تواند بکند، به شکل JSON خام.

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

سطل‌ها Buckets

تابع سطل‌ها(aggregations: رشته، name: رشته): وکتور<سطل>
سطل‌های یک تجمیع سطلی، فهرستی یا کلیددار.

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

مقدار تجمیع AggValue

تابع مقدار تجمیع(aggregations: رشته، name: رشته): اعشار۶۴
مقدار یک تجمیع تک‌مقداری مثل avg.

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

فیلد تجمیع AggField

تابع فیلد تجمیع(aggregations: رشته، name: رشته، field: رشته): اعشار۶۴
یک عدد نام‌دار از یک تجمیع، مثل max از stats.

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

صدک تجمیع AggPercentile

تابع صدک تجمیع(aggregations: رشته، name: رشته، percent: اعشار۶۴): اعشار۶۴
یک صدک از یک تجمیع percentiles، مثل صدک تجمیع(تجمیع‌ها، "latency"، 99.0)؛ کلید "99.0" را که مسیر نقطه‌دار به آن نمی‌رسد می‌خواند.

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

تجمیع خام AggRaw

تابع تجمیع خام(aggregations: رشته، name: رشته): رشته
یک تجمیع به شکل JSON خام.

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

پیشنهادها Suggestions

تابع پیشنهادها(suggest: رشته، name: رشته): وکتور<رشته>
متن‌هایی که یک پیشنهاددهنده پیشنهاد کرد.

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

مسیر جیسون JsonPath

تابع مسیر جیسون(text: رشته، path: رشته): رشته
مقداری در یک مسیر نقطه‌دار، با عدد برای اقلام آرایه، مثل hits.hits.0._id؛ رشته‌ها بی‌نقل‌قول برمی‌گردند.

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

مسیر خام جیسون JsonPathRaw

تابع مسیر خام جیسون(text: رشته، path: رشته): رشته
مقداری در یک مسیر نقطه‌دار به شکل JSON خام.

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

اقلام جیسون JsonItems

تابع اقلام جیسون(raw: رشته): وکتور<رشته>
اقلام یک آرایه‌ی JSON به شکل JSON خام.

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

امضای درخواست آمازون SignRequest

تابع امضای درخواست آمازون(method: رشته، host: رشته، path: رشته، body: رشته، region: رشته، service: رشته، access_key: رشته، secret_key: رشته، token: رشته، epoch: صحیح۶۴): رشته
سرآیندهای AWS SigV4 برای یک درخواست: روش، میزبان، مسیر با پرس‌وجو، بدنه، ناحیه، سرویس، کلیدها، توکن نشست و زمان یونیکس.
db-opensearch-SignRequest.salam
واردسازی دیتابیس.اپن سرچ

تابع ریشه:
    سرآیندهای امضا := اپن سرچ.امضای درخواست آمازون(
        "GET"، "example.amazonaws.com"، "/"، ""، "us-east-1"، "service"، "AKIDEXAMPLE"،
        "wJalrXUtnFEMI/K7MDENG+bPxRfiCYEXAMPLEKEY"، ""، 1440938160 برگردان صحیح۶۴
    )
    هر خط در سرآیندهای امضا.بشکاف("\r\n"):
        اگر خط.طول() بزرگتر 0: سرچاپ خط پایان
    پایان
پایان
خروجیX-Amz-Date: 20150830T123600Z X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20150830/us-east-1/service/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=726c5c4879a6b4ccbbd3b24edbd6b8826d34f87450fbbf4e85546fc7ba9c1642

دسته‌ای تازه NewBulk

تابع دسته‌ای تازه(): دسته‌ای
یک دسته‌ی خالی.

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

نمایه‌سازی دسته‌ای BulkIndex

تابع نمایه‌سازی دسته‌ای(b &: دسته‌ای، index: رشته، id: رشته، doc: رشته)
یک کنش نمایه‌سازی می‌افزاید؛ شناسه‌ی خالی یعنی سرور یکی بسازد.

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

نمایه‌سازی دسته‌ای مسیردار BulkIndexRouted

تابع نمایه‌سازی دسته‌ای مسیردار(b &: دسته‌ای، index: رشته، id: رشته، routing: رشته، doc: رشته)
یک کنش نمایه‌سازی با مقدار مسیریابی می‌افزاید.

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

ایجاد دسته‌ای BulkCreate

تابع ایجاد دسته‌ای(b &: دسته‌ای، index: رشته، id: رشته، doc: رشته)
یک کنش ایجاد می‌افزاید که اگر شناسه باشد شکست می‌خورد.

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

به‌روزرسانی دسته‌ای BulkUpdate

تابع به‌روزرسانی دسته‌ای(b &: دسته‌ای، index: رشته، id: رشته، partial: رشته)
یک به‌روزرسانی می‌افزاید که فیلدهای داده‌شده را ادغام می‌کند.

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

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

تابع به‌روزرسانی درجی دسته‌ای(b &: دسته‌ای، index: رشته، id: رشته، doc: رشته)
یک به‌روزرسانی می‌افزاید که اگر سند نباشد آن را می‌سازد.

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

حذف دسته‌ای BulkDelete

تابع حذف دسته‌ای(b &: دسته‌ای، index: رشته، id: رشته)
یک کنش حذف می‌افزاید.

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

اندازه دسته‌ای BulkLen

تابع اندازه دسته‌ای(b: دسته‌ای): صحیح
چند کنش در دسته است.

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

بدنه دسته‌ای BulkBody

تابع بدنه دسته‌ای(b: دسته‌ای): رشته
بدنه‌ی NDJSON که دسته می‌فرستد.

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

بازنشانی دسته‌ای BulkReset

تابع بازنشانی دسته‌ای(b &: دسته‌ای)
دسته را خالی می‌کند تا دوباره پر شود.

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

آزادسازی دسته‌ای BulkFree

تابع آزادسازی دسته‌ای(b &: دسته‌ای)
دسته را آزاد می‌کند.

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

تجزیه دسته‌ای ParseBulk

تابع تجزیه دسته‌ای(body: رشته): نتیجه دسته‌ای
یک پاسخ دسته‌ای را می‌خواند.

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

ارسال دسته‌ای BulkSend

تابع ارسال دسته‌ای(c: کارخواه، b: دسته‌ای): نتیجه دسته‌ای
دسته را می‌فرستد.

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

ارسال دسته‌ای با تازه‌سازی BulkSendWith

تابع ارسال دسته‌ای با تازه‌سازی(c: کارخواه، b: دسته‌ای، refresh: رشته): نتیجه دسته‌ای
دسته را با یک تنظیم تازه‌سازی می‌فرستد.

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

تنظیمات نمایه همسایه‌یابی KnnIndexSettings

تابع تنظیمات نمایه همسایه‌یابی(shards: صحیح، replicas: صحیح): رشته
تنظیمات نمایه با k-NN روشن؛ ۰ شارد یا ۱- نسخه آن تنظیم را کنار می‌گذارد.

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

فیلد بردار همسایه‌یابی KnnVectorField

تابع فیلد بردار همسایه‌یابی(dimension: صحیح، method: روش همسایه‌یابی): رشته
نگاشت یک فیلد knn_vector.

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

بدنه نمایه همسایه‌یابی KnnIndexBody

تابع بدنه نمایه همسایه‌یابی(field: رشته، dimension: صحیح، method: روش همسایه‌یابی، extra_properties: وکتور<رشته>): رشته
یک بدنه‌ی کامل نمایه با k-NN روشن، یک فیلد بردار و ویژگی‌های بیشتر.

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

بردار همسایه‌یابی KnnVector

تابع بردار همسایه‌یابی(values: وکتور<اعشار۶۴>): رشته
یک بردار به شکل آرایه‌ی JSON.

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

آمار همسایه‌یابی KnnStats

تابع آمار همسایه‌یابی(c: کارخواه): رشته
آمار افزونه‌ی k-NN به شکل JSON خام.

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

گرم‌کردن همسایه‌یابی KnnWarmup

تابع گرم‌کردن همسایه‌یابی(c: کارخواه، index: رشته): منطقی
نمایه‌های برداری یک نمایه را پیش از نخستین جستجو در حافظه بار می‌کند.

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

پاک‌سازی حافظه همسایه‌یابی KnnClearCache

تابع پاک‌سازی حافظه همسایه‌یابی(c: کارخواه، index: رشته): منطقی
نمایه‌های برداری یک نمایه را از حافظه بیرون می‌اندازد.

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

آموزش مدل همسایه‌یابی KnnTrainModel

تابع آموزش مدل همسایه‌یابی(c: کارخواه، model_id: رشته، body: رشته): منطقی
یک مدل k-NN، مثلا برای IVF یا PQ، آموزش می‌دهد.

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

دریافت مدل همسایه‌یابی KnnGetModel

تابع دریافت مدل همسایه‌یابی(c: کارخواه، model_id: رشته): رشته
یک مدل آموزش‌دیده‌ی k-NN به شکل JSON خام.

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

حذف مدل همسایه‌یابی KnnDeleteModel

تابع حذف مدل همسایه‌یابی(c: کارخواه، model_id: رشته): منطقی
یک مدل k-NN را حذف می‌کند.

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

تنظیم سیاست PutPolicy

تابع تنظیم سیاست(c: کارخواه، id: رشته، policy: رشته): منطقی
یک سیاست ISM می‌سازد.

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

به‌روزرسانی سیاست UpdatePolicy

تابع به‌روزرسانی سیاست(c: کارخواه، id: رشته، policy: رشته، seq_no: صحیح۶۴، primary_term: صحیح۶۴): منطقی
یک سیاست ISM را با شماره‌ی ترتیب و دوره‌ی اصلی سیاست جاری جایگزین می‌کند.

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

دریافت سیاست GetPolicy

تابع دریافت سیاست(c: کارخواه، id: رشته): رشته
یک سیاست ISM به شکل JSON خام.

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

حذف سیاست DeletePolicy

تابع حذف سیاست(c: کارخواه، id: رشته): منطقی
یک سیاست ISM را حذف می‌کند.

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

افزودن سیاست AddPolicy

تابع افزودن سیاست(c: کارخواه، index: رشته، policy_id: رشته): صحیح
نمایه‌هایی را زیر یک سیاست می‌برد؛ شمارشان را برمی‌گرداند و هنگام شکست ۱-.

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

برداشتن سیاست RemovePolicy

تابع برداشتن سیاست(c: کارخواه، index: رشته): صحیح
نمایه‌ها را از سیاستشان بیرون می‌آورد.

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

تغییر سیاست ChangePolicy

تابع تغییر سیاست(c: کارخواه، index: رشته، policy_id: رشته، state: رشته): صحیح
نمایه‌ها را به سیاستی دیگر می‌برد، اگر بخواهید با آغاز از حالتی معین.

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

کوشش دوباره سیاست RetryPolicy

تابع کوشش دوباره سیاست(c: کارخواه، index: رشته): صحیح
گام ناموفق یک سیاست را دوباره می‌آزماید.

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

توضیح سیاست ExplainPolicy

تابع توضیح سیاست(c: کارخواه، index: رشته): رشته
نمایه‌ها کجای سیاستشان هستند، به شکل JSON خام.

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

شناسه سیاست نمایه PolicyIdOf

تابع شناسه سیاست نمایه(c: کارخواه، index: رشته): رشته
شناسه‌ی سیاستی که یک نمایه زیر آن است.

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

سیاست حذف پس از DeleteAfterPolicy

تابع سیاست حذف پس از(description: رشته، min_index_age: رشته، patterns: وکتور<رشته>): رشته
سیاستی که نمایه را وقتی از سنی مثل 30d پیرتر شد حذف می‌کند؛ با الگوها خودش روی نمایه‌های تازه‌ی منطبق هم اعمال می‌شود.

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

من کیستم WhoAmI

تابع من کیستم(c: کارخواه): اطلاعات احراز
افزونه‌ی امنیت می‌گوید شما کیستید.

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

سلامت امنیت SecurityHealth

تابع سلامت امنیت(c: کارخواه): رشته
وضعیت افزونه‌ی امنیت، مثل UP.

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

تنظیم کاربر PutUser

تابع تنظیم کاربر(c: کارخواه، name: رشته، password: رشته، backend_roles: وکتور<رشته>، attributes: رشته): منطقی
یک کاربر درونی با نقش‌های پشتیبان و ویژگی‌هایی به شکل JSON می‌سازد یا جایگزین می‌کند.

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

دریافت کاربر GetUser

تابع دریافت کاربر(c: کارخواه، name: رشته): رشته
یک کاربر درونی به شکل JSON خام.

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

کاربران Users

تابع کاربران(c: کارخواه): وکتور<رشته>
نام همه‌ی کاربران درونی.

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

حذف کاربر DeleteUser

تابع حذف کاربر(c: کارخواه، name: رشته): منطقی
یک کاربر درونی را حذف می‌کند.

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

تغییر گذرواژه ChangePassword

تابع تغییر گذرواژه(c: کارخواه، current: رشته، password: رشته): منطقی
گذرواژه‌ی کاربری را که کارخواه با آن وارد شده تغییر می‌دهد.

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

بدنه نقش RoleBody

تابع بدنه نقش(cluster_permissions: وکتور<رشته>، index_patterns: وکتور<رشته>، allowed_actions: وکتور<رشته>): رشته
بدنه‌ی یک نقش از مجوزهای خوشه، الگوهای نمایه و کنش‌های مجاز روی آن‌ها.

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

تنظیم نقش PutRole

تابع تنظیم نقش(c: کارخواه، name: رشته، body: رشته): منطقی
یک نقش می‌سازد یا جایگزین می‌کند.

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

دریافت نقش GetRole

تابع دریافت نقش(c: کارخواه، name: رشته): رشته
یک نقش به شکل JSON خام.

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

حذف نقش DeleteRole

تابع حذف نقش(c: کارخواه، name: رشته): منطقی
یک نقش را حذف می‌کند.

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

تنظیم نگاشت نقش PutRoleMapping

تابع تنظیم نگاشت نقش(c: کارخواه، role: رشته، users: وکتور<رشته>، backend_roles: وکتور<رشته>): منطقی
نقشی را به کاربران و نقش‌های پشتیبان می‌دهد.

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

دریافت نگاشت نقش GetRoleMapping

تابع دریافت نگاشت نقش(c: کارخواه، role: رشته): رشته
یک نگاشت نقش به شکل JSON خام.

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

حذف نگاشت نقش DeleteRoleMapping

تابع حذف نگاشت نقش(c: کارخواه، role: رشته): منطقی
یک نگاشت نقش را حذف می‌کند.

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

تنظیم خط لوله جستجو PutSearchPipeline

تابع تنظیم خط لوله جستجو(c: کارخواه، id: رشته، body: رشته): منطقی
یک خط لوله‌ی جستجو می‌سازد یا جایگزین می‌کند.

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

دریافت خط لوله جستجو GetSearchPipeline

تابع دریافت خط لوله جستجو(c: کارخواه، id: رشته): رشته
یک خط لوله‌ی جستجو به شکل JSON خام.

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

حذف خط لوله جستجو DeleteSearchPipeline

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

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

خط لوله نرمال‌سازی NormalizationPipeline

تابع خط لوله نرمال‌سازی(normalization: رشته، combination: رشته، weights: وکتور<اعشار۶۴>): رشته
بدنه‌ی خط لوله‌ی جستجو برای جستجوی ترکیبی: یک روش نرمال‌سازی مثل min_max، یک روش ترکیب مثل arithmetic_mean و وزن‌های اختیاری.

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

ایجاد پایشگر CreateMonitor

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

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

دریافت پایشگر GetMonitor

تابع دریافت پایشگر(c: کارخواه، id: رشته): رشته
یک پایشگر به شکل JSON خام.

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

به‌روزرسانی پایشگر UpdateMonitor

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

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

حذف پایشگر DeleteMonitor

تابع حذف پایشگر(c: کارخواه، id: رشته): منطقی
یک پایشگر را حذف می‌کند.

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

اجرای پایشگر ExecuteMonitor

تابع اجرای پایشگر(c: کارخواه، id: رشته، dry_run: منطقی): رشته
پایشگری را همین حالا، اگر بخواهید به شکل آزمایشی، اجرا می‌کند؛ نتیجه را به شکل JSON خام برمی‌گرداند.

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

جستجوی پایشگرها SearchMonitors

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

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

ثبت مدل یادگیری MlRegisterModel

تابع ثبت مدل یادگیری(c: کارخواه، body: رشته): رشته
یک مدل ML Commons را ثبت می‌کند؛ شناسه‌ی کار را برمی‌گرداند.

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

استقرار مدل یادگیری MlDeployModel

تابع استقرار مدل یادگیری(c: کارخواه، model_id: رشته): رشته
یک مدل را مستقر می‌کند؛ شناسه‌ی کار را برمی‌گرداند.

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

برچیدن مدل یادگیری MlUndeployModel

تابع برچیدن مدل یادگیری(c: کارخواه، model_id: رشته): منطقی
استقرار یک مدل را برمی‌چیند.

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

دریافت مدل یادگیری MlGetModel

تابع دریافت مدل یادگیری(c: کارخواه، model_id: رشته): رشته
یک مدل به شکل JSON خام.

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

حذف مدل یادگیری MlDeleteModel

تابع حذف مدل یادگیری(c: کارخواه، model_id: رشته): منطقی
یک مدل را حذف می‌کند.

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

دریافت کار یادگیری MlGetTask

تابع دریافت کار یادگیری(c: کارخواه، task_id: رشته): رشته
یک کار یادگیری ماشین به شکل JSON خام.

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

پیش‌بینی مدل MlPredict

تابع پیش‌بینی مدل(c: کارخواه، algorithm: رشته، model_id: رشته، body: رشته): رشته
مدلی، مثل text_embedding، را روی ورودی‌ای به شکل JSON اجرا می‌کند.

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