[{"data":1,"prerenderedAt":1832},["ShallowReactive",2],{"navigation":3,"\u002Fsearch\u002Fengines":173,"\u002Fsearch\u002Fengines-surround":1827},[4,27,69,103,113,135],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":26},"Getting Started","i-heroicons-star","\u002Fgetting-started","1.getting-started",[10,14,18,22],{"title":11,"path":12,"stem":13},"Introduction","\u002Fgetting-started\u002Fintroduction","1.getting-started\u002F1.introduction",{"title":15,"path":16,"stem":17},"Installation","\u002Fgetting-started\u002Finstallation","1.getting-started\u002F2.installation",{"title":19,"path":20,"stem":21},"Quick start","\u002Fgetting-started\u002Fquick-start","1.getting-started\u002F3.quick-start",{"title":23,"path":24,"stem":25},"Upgrade guide","\u002Fgetting-started\u002Fupgrade-guide","1.getting-started\u002F5.upgrade-guide",false,{"title":28,"icon":29,"path":30,"stem":31,"children":32,"page":26},"Essentials","i-heroicons-shield-check","\u002Fessentials","2.essentials",[33,37,41,45,49,53,57,61,65],{"title":34,"path":35,"stem":36},"Controls","\u002Fessentials\u002Fcontrols","2.essentials\u002F1.controls",{"title":38,"path":39,"stem":40},"Perimeters","\u002Fessentials\u002Fperimeters","2.essentials\u002F2.perimeters",{"title":42,"path":43,"stem":44},"Perimeter classes","\u002Fessentials\u002Fperimeter-classes","2.essentials\u002F3.perimeter-classes",{"title":46,"path":47,"stem":48},"Levels","\u002Fessentials\u002Flevels","2.essentials\u002F4.levels",{"title":50,"path":51,"stem":52},"Boundaries","\u002Fessentials\u002Fboundaries","2.essentials\u002F5.boundaries",{"title":54,"path":55,"stem":56},"Parents","\u002Fessentials\u002Fparents","2.essentials\u002F6.parents",{"title":58,"path":59,"stem":60},"Policies","\u002Fessentials\u002Fpolicies","2.essentials\u002F7.policies",{"title":62,"path":63,"stem":64},"Queries","\u002Fessentials\u002Fqueries","2.essentials\u002F8.queries",{"title":66,"path":67,"stem":68},"Readers","\u002Fessentials\u002Freaders","2.essentials\u002F9.readers",{"title":70,"icon":71,"path":72,"stem":73,"children":74,"page":26},"Search","i-heroicons-magnifying-glass","\u002Fsearch","3.search",[75,79,83,87,91,95,99],{"title":76,"path":77,"stem":78},"Search overview","\u002Fsearch\u002Foverview","3.search\u002F1.overview",{"title":80,"path":81,"stem":82},"Engines","\u002Fsearch\u002Fengines","3.search\u002F2.engines",{"title":84,"path":85,"stem":86},"Keeping the keys fresh","\u002Fsearch\u002Fkeeping-the-keys-fresh","3.search\u002F3.keeping-the-keys-fresh",{"title":88,"path":89,"stem":90},"Exceptions and dates","\u002Fsearch\u002Fexceptions-and-dates","3.search\u002F4.exceptions-and-dates",{"title":92,"path":93,"stem":94},"Searching through a parent","\u002Fsearch\u002Fthrough-a-parent","3.search\u002F5.through-a-parent",{"title":96,"path":97,"stem":98},"Search from the browser","\u002Fsearch\u002Ffrom-the-browser","3.search\u002F6.from-the-browser",{"title":100,"path":101,"stem":102},"Your own search client","\u002Fsearch\u002Fyour-own-client","3.search\u002F7.your-own-client",{"title":104,"icon":105,"path":106,"stem":107,"children":108,"page":26},"Integrations","i-heroicons-puzzle-piece","\u002Fintegrations","4.integrations",[109],{"title":110,"path":111,"stem":112},"laravel-rest-api","\u002Fintegrations\u002Flaravel-rest-api","4.integrations\u002F1.laravel-rest-api",{"title":114,"icon":115,"path":116,"stem":117,"children":118,"page":26},"Testing and Tooling","i-heroicons-wrench-screwdriver","\u002Ftesting-and-tooling","5.testing-and-tooling",[119,123,127,131],{"title":120,"path":121,"stem":122},"Testing","\u002Ftesting-and-tooling\u002Ftesting","5.testing-and-tooling\u002F1.testing",{"title":124,"path":125,"stem":126},"access:check","\u002Ftesting-and-tooling\u002Faccess-check","5.testing-and-tooling\u002F2.access-check",{"title":128,"path":129,"stem":130},"Cache and about","\u002Ftesting-and-tooling\u002Fcache-and-about","5.testing-and-tooling\u002F3.cache-and-about",{"title":132,"path":133,"stem":134},"Generators","\u002Ftesting-and-tooling\u002Fgenerators","5.testing-and-tooling\u002F4.generators",{"title":136,"icon":137,"path":138,"stem":139,"children":140,"page":26},"Digging Deeper","i-heroicons-list-bullet","\u002Fdigging-deeper","6.digging-deeper",[141,145,149,153,157,161,165,169],{"title":142,"path":143,"stem":144},"Abilities","\u002Fdigging-deeper\u002Fabilities","6.digging-deeper\u002F1.abilities",{"title":146,"path":147,"stem":148},"Kept decisions","\u002Fdigging-deeper\u002Fdecisions","6.digging-deeper\u002F2.decisions",{"title":150,"path":151,"stem":152},"Batched decisions","\u002Fdigging-deeper\u002Fbatched-decisions","6.digging-deeper\u002F3.batched-decisions",{"title":154,"path":155,"stem":156},"Row checks","\u002Fdigging-deeper\u002Frow-checks","6.digging-deeper\u002F4.row-checks",{"title":158,"path":159,"stem":160},"Several brands","\u002Fdigging-deeper\u002Fseveral-brands","6.digging-deeper\u002F5.several-brands",{"title":162,"path":163,"stem":164},"Row context","\u002Fdigging-deeper\u002Frow-context","6.digging-deeper\u002F6.row-context",{"title":166,"path":167,"stem":168},"What is public in 1.x","\u002Fdigging-deeper\u002Fpublic-api","6.digging-deeper\u002F7.public-api",{"title":170,"path":171,"stem":172},"Use with AI","\u002Fdigging-deeper\u002Fuse-with-ai","6.digging-deeper\u002F8.use-with-ai",{"id":174,"title":80,"body":175,"description":1819,"extension":1820,"links":1821,"meta":1822,"navigation":1359,"path":81,"seo":1823,"sitemap":1824,"stem":82,"updatedAt":1825,"__hash__":1826},"docs\u002F3.search\u002F2.engines.md",{"type":176,"value":177,"toc":1806},"minimark",[178,183,204,765,768,803,810,815,841,845,930,937,958,965,984,988,1001,1028,1031,1093,1096,1100,1114,1195,1198,1233,1236,1240,1252,1262,1785,1792,1796,1802],[179,180,182],"h2",{"id":181},"index-settings","Index settings",[184,185,186,187,191,192,195,196,199,200,203],"p",{},"Declare ",[188,189,190],"code",{},"_access"," and ",[188,193,194],{},"_boundary"," as filterable in the settings of each searchable model. ",[188,197,198],{},"Access::searchFilterables()"," returns ",[188,201,202],{},"['_access', '_boundary']",":",[205,206,207,333,518,609],"code-group",{},[208,209,215],"pre",{"className":210,"code":211,"filename":212,"language":213,"meta":214,"style":214},"language-php shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","\u002F\u002F config\u002Fscout.php\n'meilisearch' => [\n    'index-settings' => [\n        Post::class => [\n            'filterableAttributes' => [...Access::searchFilterables(), 'status'],\n        ],\n    ],\n],\n","Meilisearch","php","",[188,216,217,226,245,259,277,316,322,328],{"__ignoreMap":214},[218,219,222],"span",{"class":220,"line":221},"line",1,[218,223,225],{"class":224},"sHwdD","\u002F\u002F config\u002Fscout.php\n",[218,227,229,233,237,239,242],{"class":220,"line":228},2,[218,230,232],{"class":231},"sMK4o","'",[218,234,236],{"class":235},"sfazB","meilisearch",[218,238,232],{"class":231},[218,240,241],{"class":231}," =>",[218,243,244],{"class":231}," [\n",[218,246,248,251,253,255,257],{"class":220,"line":247},3,[218,249,250],{"class":231},"    '",[218,252,181],{"class":235},[218,254,232],{"class":231},[218,256,241],{"class":231},[218,258,244],{"class":231},[218,260,262,266,269,273,275],{"class":220,"line":261},4,[218,263,265],{"class":264},"sBMFI","        Post",[218,267,268],{"class":231},"::",[218,270,272],{"class":271},"sbssI","class",[218,274,241],{"class":231},[218,276,244],{"class":231},[218,278,280,283,286,288,290,293,296,298,302,305,308,311,313],{"class":220,"line":279},5,[218,281,282],{"class":231},"            '",[218,284,285],{"class":235},"filterableAttributes",[218,287,232],{"class":231},[218,289,241],{"class":231},[218,291,292],{"class":231}," [...",[218,294,295],{"class":264},"Access",[218,297,268],{"class":231},[218,299,301],{"class":300},"s2Zo4","searchFilterables",[218,303,304],{"class":231},"(),",[218,306,307],{"class":231}," '",[218,309,310],{"class":235},"status",[218,312,232],{"class":231},[218,314,315],{"class":231},"],\n",[218,317,319],{"class":220,"line":318},6,[218,320,321],{"class":231},"        ],\n",[218,323,325],{"class":220,"line":324},7,[218,326,327],{"class":231},"    ],\n",[218,329,331],{"class":220,"line":330},8,[218,332,315],{"class":231},[208,334,337],{"className":210,"code":335,"filename":336,"language":213,"meta":214,"style":214},"\u002F\u002F config\u002Fscout.php\n'typesense' => [\n    'model-settings' => [\n        Post::class => [\n            'collection-schema' => [\n                'fields' => [\n                    \u002F\u002F your fields\n                    ['name' => '_access', 'type' => 'string[]'],\n                    ['name' => '_boundary', 'type' => 'string[]'],\n                ],\n            ],\n        ],\n    ],\n],\n","Typesense",[188,338,339,343,356,369,381,394,408,413,454,491,497,503,508,513],{"__ignoreMap":214},[218,340,341],{"class":220,"line":221},[218,342,225],{"class":224},[218,344,345,347,350,352,354],{"class":220,"line":228},[218,346,232],{"class":231},[218,348,349],{"class":235},"typesense",[218,351,232],{"class":231},[218,353,241],{"class":231},[218,355,244],{"class":231},[218,357,358,360,363,365,367],{"class":220,"line":247},[218,359,250],{"class":231},[218,361,362],{"class":235},"model-settings",[218,364,232],{"class":231},[218,366,241],{"class":231},[218,368,244],{"class":231},[218,370,371,373,375,377,379],{"class":220,"line":261},[218,372,265],{"class":264},[218,374,268],{"class":231},[218,376,272],{"class":271},[218,378,241],{"class":231},[218,380,244],{"class":231},[218,382,383,385,388,390,392],{"class":220,"line":279},[218,384,282],{"class":231},[218,386,387],{"class":235},"collection-schema",[218,389,232],{"class":231},[218,391,241],{"class":231},[218,393,244],{"class":231},[218,395,396,399,402,404,406],{"class":220,"line":318},[218,397,398],{"class":231},"                '",[218,400,401],{"class":235},"fields",[218,403,232],{"class":231},[218,405,241],{"class":231},[218,407,244],{"class":231},[218,409,410],{"class":220,"line":324},[218,411,412],{"class":224},"                    \u002F\u002F your fields\n",[218,414,415,418,420,423,425,427,429,431,433,436,438,441,443,445,447,450,452],{"class":220,"line":330},[218,416,417],{"class":231},"                    [",[218,419,232],{"class":231},[218,421,422],{"class":235},"name",[218,424,232],{"class":231},[218,426,241],{"class":231},[218,428,307],{"class":231},[218,430,190],{"class":235},[218,432,232],{"class":231},[218,434,435],{"class":231},",",[218,437,307],{"class":231},[218,439,440],{"class":235},"type",[218,442,232],{"class":231},[218,444,241],{"class":231},[218,446,307],{"class":231},[218,448,449],{"class":235},"string[]",[218,451,232],{"class":231},[218,453,315],{"class":231},[218,455,457,459,461,463,465,467,469,471,473,475,477,479,481,483,485,487,489],{"class":220,"line":456},9,[218,458,417],{"class":231},[218,460,232],{"class":231},[218,462,422],{"class":235},[218,464,232],{"class":231},[218,466,241],{"class":231},[218,468,307],{"class":231},[218,470,194],{"class":235},[218,472,232],{"class":231},[218,474,435],{"class":231},[218,476,307],{"class":231},[218,478,440],{"class":235},[218,480,232],{"class":231},[218,482,241],{"class":231},[218,484,307],{"class":231},[218,486,449],{"class":235},[218,488,232],{"class":231},[218,490,315],{"class":231},[218,492,494],{"class":220,"line":493},10,[218,495,496],{"class":231},"                ],\n",[218,498,500],{"class":220,"line":499},11,[218,501,502],{"class":231},"            ],\n",[218,504,506],{"class":220,"line":505},12,[218,507,321],{"class":231},[218,509,511],{"class":220,"line":510},13,[218,512,327],{"class":231},[218,514,516],{"class":220,"line":515},14,[218,517,315],{"class":231},[208,519,522],{"className":210,"code":520,"filename":521,"language":213,"meta":214,"style":214},"\u002F\u002F config\u002Fscout.php\n'algolia' => [\n    'index-settings' => [\n        Post::class => [\n            'attributesForFaceting' => ['filterOnly(_access)', 'filterOnly(_boundary)'],\n        ],\n    ],\n],\n","Algolia",[188,523,524,528,541,553,565,597,601,605],{"__ignoreMap":214},[218,525,526],{"class":220,"line":221},[218,527,225],{"class":224},[218,529,530,532,535,537,539],{"class":220,"line":228},[218,531,232],{"class":231},[218,533,534],{"class":235},"algolia",[218,536,232],{"class":231},[218,538,241],{"class":231},[218,540,244],{"class":231},[218,542,543,545,547,549,551],{"class":220,"line":247},[218,544,250],{"class":231},[218,546,181],{"class":235},[218,548,232],{"class":231},[218,550,241],{"class":231},[218,552,244],{"class":231},[218,554,555,557,559,561,563],{"class":220,"line":261},[218,556,265],{"class":264},[218,558,268],{"class":231},[218,560,272],{"class":271},[218,562,241],{"class":231},[218,564,244],{"class":231},[218,566,567,569,572,574,576,579,581,584,586,588,590,593,595],{"class":220,"line":279},[218,568,282],{"class":231},[218,570,571],{"class":235},"attributesForFaceting",[218,573,232],{"class":231},[218,575,241],{"class":231},[218,577,578],{"class":231}," [",[218,580,232],{"class":231},[218,582,583],{"class":235},"filterOnly(_access)",[218,585,232],{"class":231},[218,587,435],{"class":231},[218,589,307],{"class":231},[218,591,592],{"class":235},"filterOnly(_boundary)",[218,594,232],{"class":231},[218,596,315],{"class":231},[218,598,599],{"class":220,"line":318},[218,600,321],{"class":231},[218,602,603],{"class":220,"line":324},[218,604,327],{"class":231},[218,606,607],{"class":220,"line":330},[218,608,315],{"class":231},[208,610,613],{"className":210,"code":611,"filename":612,"language":213,"meta":214,"style":214},"\u002F\u002F config\u002Fscout.php, the schema that Scout sends with each write\n'turbopuffer' => [\n    'model-settings' => [\n        Post::class => [\n            'schema' => [\n                '_access' => ['type' => '[]string', 'filterable' => true],\n                '_boundary' => ['type' => '[]string', 'filterable' => true],\n            ],\n        ],\n    ],\n],\n","Turbopuffer",[188,614,615,620,633,645,657,670,711,749,753,757,761],{"__ignoreMap":214},[218,616,617],{"class":220,"line":221},[218,618,619],{"class":224},"\u002F\u002F config\u002Fscout.php, the schema that Scout sends with each write\n",[218,621,622,624,627,629,631],{"class":220,"line":228},[218,623,232],{"class":231},[218,625,626],{"class":235},"turbopuffer",[218,628,232],{"class":231},[218,630,241],{"class":231},[218,632,244],{"class":231},[218,634,635,637,639,641,643],{"class":220,"line":247},[218,636,250],{"class":231},[218,638,362],{"class":235},[218,640,232],{"class":231},[218,642,241],{"class":231},[218,644,244],{"class":231},[218,646,647,649,651,653,655],{"class":220,"line":261},[218,648,265],{"class":264},[218,650,268],{"class":231},[218,652,272],{"class":271},[218,654,241],{"class":231},[218,656,244],{"class":231},[218,658,659,661,664,666,668],{"class":220,"line":279},[218,660,282],{"class":231},[218,662,663],{"class":235},"schema",[218,665,232],{"class":231},[218,667,241],{"class":231},[218,669,244],{"class":231},[218,671,672,674,676,678,680,682,684,686,688,690,692,695,697,699,701,704,706,708],{"class":220,"line":318},[218,673,398],{"class":231},[218,675,190],{"class":235},[218,677,232],{"class":231},[218,679,241],{"class":231},[218,681,578],{"class":231},[218,683,232],{"class":231},[218,685,440],{"class":235},[218,687,232],{"class":231},[218,689,241],{"class":231},[218,691,307],{"class":231},[218,693,694],{"class":235},"[]string",[218,696,232],{"class":231},[218,698,435],{"class":231},[218,700,307],{"class":231},[218,702,703],{"class":235},"filterable",[218,705,232],{"class":231},[218,707,241],{"class":231},[218,709,710],{"class":231}," true],\n",[218,712,713,715,717,719,721,723,725,727,729,731,733,735,737,739,741,743,745,747],{"class":220,"line":324},[218,714,398],{"class":231},[218,716,194],{"class":235},[218,718,232],{"class":231},[218,720,241],{"class":231},[218,722,578],{"class":231},[218,724,232],{"class":231},[218,726,440],{"class":235},[218,728,232],{"class":231},[218,730,241],{"class":231},[218,732,307],{"class":231},[218,734,694],{"class":235},[218,736,232],{"class":231},[218,738,435],{"class":231},[218,740,307],{"class":231},[218,742,703],{"class":235},[218,744,232],{"class":231},[218,746,241],{"class":231},[218,748,710],{"class":231},[218,750,751],{"class":220,"line":330},[218,752,502],{"class":231},[218,754,755],{"class":220,"line":456},[218,756,321],{"class":231},[218,758,759],{"class":220,"line":493},[218,760,327],{"class":231},[218,762,763],{"class":220,"line":499},[218,764,315],{"class":231},[184,766,767],{},"Then push the settings and index the documents:",[208,769,773],{"className":770,"code":771,"language":772,"meta":214,"style":214},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","php artisan scout:sync-index-settings\nphp artisan scout:import \"App\\Models\\Post\"\n","bash",[188,774,775,785],{"__ignoreMap":214},[218,776,777,779,782],{"class":220,"line":221},[218,778,213],{"class":264},[218,780,781],{"class":235}," artisan",[218,783,784],{"class":235}," scout:sync-index-settings\n",[218,786,787,789,791,794,797,800],{"class":220,"line":228},[218,788,213],{"class":264},[218,790,781],{"class":235},[218,792,793],{"class":235}," scout:import",[218,795,796],{"class":231}," \"",[218,798,799],{"class":235},"App\\Models\\Post",[218,801,802],{"class":231},"\"\n",[184,804,805,806,809],{},"Turbopuffer sets the type of an attribute on its first write and cannot change it: declare the schema before the first write, or delete the namespace (",[188,807,808],{},"scout:flush",") and import it again.",[811,812,814],"h3",{"id":813},"why-digests","Why digests",[184,816,817,818,191,821,824,825,828,829,832,833,836,837,840],{},"Each key leaves the application as a digest of 32 lowercase hexadecimal characters. Search engines do not compare indexed strings verbatim: Typesense drops symbols such as ",[188,819,820],{},".",[188,822,823],{},"_"," and cuts values at 100 characters, so ",[188,826,827],{},"author.1.23"," would match ",[188,830,831],{},"author.12.3",", and Meilisearch cuts a stored value at 468 bytes. A digest has a fixed length and no symbol, so every engine compares it exactly, and the engines need no setting for it: no ",[188,834,835],{},"symbols_to_index"," or ",[188,838,839],{},"token_separators"," on Typesense.",[179,842,844],{"id":843},"supported-engines","Supported engines",[846,847,848,861],"table",{},[849,850,851],"thead",{},[852,853,854,858],"tr",{},[855,856,857],"th",{},"Engine",[855,859,860],{},"Controlled search",[862,863,864,881,892,902,912,922],"tbody",{},[852,865,866,870],{},[867,868,869],"td",{},"Algolia, Meilisearch, Typesense",[867,871,872,873,876,877,191,879],{},"Filtered with ",[188,874,875],{},"whereIn"," on ",[188,878,190],{},[188,880,194],{},[852,882,883,885],{},[867,884,612],{},[867,886,887,888,891],{},"Filtered with its native ",[188,889,890],{},"ContainsAny"," operator",[852,893,894,899],{},[867,895,896],{},[188,897,898],{},"database",[867,900,901],{},"The control's SQL inside the search query, without keys",[852,903,904,909],{},[867,905,906],{},[188,907,908],{},"null",[867,910,911],{},"Accepted: it finds nothing",[852,913,914,919],{},[867,915,916],{},[188,917,918],{},"collection",[867,920,921],{},"Refused: it paginates before it filters",[852,923,924,927],{},[867,925,926],{},"Any other engine",[867,928,929],{},"Refused, unless you trust it",[184,931,932,933,936],{},"The package checks the engines with ",[188,934,935],{},"instanceof",", so a subclass of a supported engine is trusted as it is.",[938,939,940],"warning",{},[184,941,942,943,948,949,952,953,957],{},"A subclass keeps the duties of a ",[944,945,947],"a",{"href":946},"#trusting-another-engine","trusted engine",": it sends the options it receives, the access filter included, on every read path, as ",[188,950,951],{},"...$options"," does in the ",[944,954,956],{"href":955},"#readers-with-many-keys","multi-search engine"," below. The package does not check what a subclass overrides.",[811,959,961,962,964],{"id":960},"the-database-engine","The ",[188,963,898],{}," engine",[184,966,961,967,969,970,973,974,976,977,979,980,983],{},[188,968,898],{}," engine searches with SQL: a controlled search applies the control's SQL inside the search query, through Scout's ",[188,971,972],{},"query()"," callback, which still runs the callback you pass to ",[188,975,972],{},". No keys are computed for it. It is also the engine for your tests: the ",[188,978,918],{}," engine throws ",[188,981,982],{},"UnsupportedSearchEngineException"," on a controlled search.",[811,985,987],{"id":986},"trusting-another-engine","Trusting another engine",[184,989,990,991,993,994,996,997,1000],{},"Any other engine throws ",[188,992,982],{},": an engine that ignored ",[188,995,875],{}," would return every document. When your engine filters correctly, trust it in the ",[188,998,999],{},"boot()"," method of a service provider:",[208,1002,1004],{"className":210,"code":1003,"language":213,"meta":214,"style":214},"Access::trustSearchEngine(ElasticsearchEngine::class);\n",[188,1005,1006],{"__ignoreMap":214},[218,1007,1008,1010,1012,1015,1018,1021,1023,1025],{"class":220,"line":221},[218,1009,295],{"class":264},[218,1011,268],{"class":231},[218,1013,1014],{"class":300},"trustSearchEngine",[218,1016,1017],{"class":231},"(",[218,1019,1020],{"class":264},"ElasticsearchEngine",[218,1022,268],{"class":231},[218,1024,272],{"class":271},[218,1026,1027],{"class":231},");\n",[184,1029,1030],{},"A trusted engine must:",[1032,1033,1034,1047,1050,1076,1083],"ul",{},[1035,1036,1037,1038,1040,1041,1043,1044,1046],"li",{},"render ",[188,1039,875],{}," on an array attribute as \"at least one element in common\", and AND the fields together, ",[188,1042,194],{}," with ",[188,1045,190],{},";",[1035,1048,1049],{},"compare each value as a whole string;",[1035,1051,1052,1053,1056,1057,1060,1061,1060,1064,1060,1067,1060,1070,191,1073,1046],{},"apply the ",[188,1054,1055],{},"whereIns"," of the search on every read path: ",[188,1058,1059],{},"get()",", ",[188,1062,1063],{},"paginate()",[188,1065,1066],{},"simplePaginate()",[188,1068,1069],{},"keys()",[188,1071,1072],{},"raw()",[188,1074,1075],{},"cursor()",[1035,1077,1078,1079,1082],{},"write ",[188,1080,1081],{},"scoutMetadata()"," with each document, as the Meilisearch and Typesense engines do, or no key is indexed;",[1035,1084,1085,1086,1089,1090,820],{},"for laravel-rest-api, have an engine profile that implements ",[188,1087,1088],{},"MatchesStringLists",", or its searches throw ",[188,1091,1092],{},"UnsupportedRestSearchException",[184,1094,1095],{},"It needs nothing for a reader who reaches nothing: the package never calls the engine for them.",[179,1097,1099],{"id":1098},"your-own-filters","Your own filters",[184,1101,1102,1103,191,1106,1109,1110,1113],{},"Your ",[188,1104,1105],{},"where()",[188,1107,1108],{},"whereIn()"," clauses narrow a controlled search on every engine. Filters passed through ",[188,1111,1112],{},"options()"," behave differently on each engine:",[1032,1115,1116,1140,1176],{},[1035,1117,1118,1122,1123,1126,1127,836,1129,1132,1133,1136,1137,820],{},[1119,1120,1121],"strong",{},"Typesense."," A ",[188,1124,1125],{},"filter_by"," from ",[188,1128,1112],{},[188,1130,1131],{},"typesenseSearchParameters()"," is combined with the access filter as ",[188,1134,1135],{},"(\u003Cyour filter_by>) && (\u003Caccess filter>)",", on every read path and in a search callback, so it can only narrow the results. Your filter must end on its own: a filter that is not a string, or that leaves a backtick-quoted value, a geo filter, a reference or an object filter open, throws ",[188,1138,1139],{},"UncombinableSearchFilterException",[1035,1141,1142,1145,1146,191,1148,1150,1151,1154,1155,1158,1159,1161,1162,191,1164,1166,1167,191,1170,1173,1174,820],{},[1119,1143,1144],{},"Meilisearch and Algolia."," Scout sends its own filter, built from the ",[188,1147,1105],{},[188,1149,1108],{}," clauses and the access filter, in place of the ",[188,1152,1153],{},"filter"," (Meilisearch) or ",[188,1156,1157],{},"filters"," (Algolia) of ",[188,1160,1112],{},". Put your conditions in ",[188,1163,1105],{},[188,1165,1108],{},". Algolia still ANDs the ",[188,1168,1169],{},"facetFilters",[188,1171,1172],{},"numericFilters"," of ",[188,1175,1112],{},[1035,1177,1178,1181,1182,1185,1186,1189,1190,836,1192,1194],{},[1119,1179,1180],{},"Turbopuffer."," The access filter is added to the native filters of ",[188,1183,1184],{},"options['filters']",", joined with ",[188,1187,1188],{},"And",", and applied again when the search runs, so a later ",[188,1191,1112],{},[188,1193,1108],{}," cannot remove it.",[184,1196,1197],{},"Some engine features would show documents that the filter does not keep, so a controlled search turns them off:",[1032,1199,1200,1219],{},[1035,1201,1202,1203,1206,1207,1210,1211,1214,1215,1218],{},"Typesense: ",[188,1204,1205],{},"filter_curated_hits"," is always ",[188,1208,1209],{},"true",", so pinned hits and curated documents go through the filter. Natural-language search (",[188,1212,1213],{},"nl_query",") throws ",[188,1216,1217],{},"NaturalLanguageSearchException","; do not use a preset that turns it on for a controlled model.",[1035,1220,1221,1222,191,1225,1228,1229,1232],{},"Algolia: ",[188,1223,1224],{},"enableRules",[188,1226,1227],{},"enableABTest"," are always ",[188,1230,1231],{},"false",", since a rule can promote records whatever the filters and an A\u002FB test can answer from another index.",[184,1234,1235],{},"An unrestricted reader without a boundary has no access filter: their search is sent as you wrote it, with these features on.",[179,1237,1239],{"id":1238},"readers-with-many-keys","Readers with many keys",[184,1241,1242,1243,191,1245,1247,1248,1251],{},"A reader with many keys sends a long filter. Scout's Typesense engine searches with a GET request, and Typesense refuses a query string longer than 4,000 encoded characters with HTTP 400: the search fails, it never shows a row too many. Each key costs about 36 encoded characters, so a search holds about 100 keys, ",[188,1244,194],{},[188,1246,190],{}," together. The keys through a ",[944,1249,1250],{"href":93},"parent"," multiply.",[184,1253,1254,1255,1258,1259,1261],{},"When your readers hold more, search through Typesense's ",[188,1256,1257],{},"multi_search"," endpoint, which takes the filter in a POST body, with a subclass of Scout's engine registered under the ",[188,1260,349],{}," driver. It needs Scout 11.7 or later:",[208,1263,1265],{"className":210,"code":1264,"language":213,"meta":214,"style":214},"use Laravel\\Scout\\Builder;\nuse Laravel\\Scout\\EngineManager;\nuse Laravel\\Scout\\Engines\\TypesenseEngine;\nuse Typesense\\Client;\nuse Typesense\\Documents;\n\nclass MultiSearchTypesenseEngine extends TypesenseEngine\n{\n    protected function executeSearch(Builder $builder, Documents $documents, array $options): mixed\n    {\n        $results = $this->typesense->getMultiSearch()->perform([\n            'searches' => [[...$options, 'collection' => $builder->index ?? $builder->model->searchableAs()]],\n        ]);\n\n        $result = $results['results'][0] ?? [];\n\n        if (isset($result['error'])) {\n            throw $this->marshalMultiSearchException($result);\n        }\n\n        return $result;\n    }\n}\n\n\u002F\u002F In the boot() method of a service provider\nresolve(EngineManager::class)->extend('typesense', fn () => new MultiSearchTypesenseEngine(\n    new Client(config('scout.typesense.client-settings')),\n    config('scout.typesense.max_total_results', 1000),\n    config('scout.typesense'),\n));\n",[188,1266,1267,1290,1307,1328,1342,1355,1361,1375,1380,1427,1432,1463,1518,1523,1527,1566,1571,1605,1622,1628,1633,1645,1651,1657,1662,1668,1714,1740,1763,1779],{"__ignoreMap":214},[218,1268,1269,1272,1276,1279,1282,1284,1287],{"class":220,"line":221},[218,1270,1271],{"class":271},"use",[218,1273,1275],{"class":1274},"sTEyZ"," Laravel",[218,1277,1278],{"class":231},"\\",[218,1280,1281],{"class":1274},"Scout",[218,1283,1278],{"class":231},[218,1285,1286],{"class":1274},"Builder",[218,1288,1289],{"class":231},";\n",[218,1291,1292,1294,1296,1298,1300,1302,1305],{"class":220,"line":228},[218,1293,1271],{"class":271},[218,1295,1275],{"class":1274},[218,1297,1278],{"class":231},[218,1299,1281],{"class":1274},[218,1301,1278],{"class":231},[218,1303,1304],{"class":1274},"EngineManager",[218,1306,1289],{"class":231},[218,1308,1309,1311,1313,1315,1317,1319,1321,1323,1326],{"class":220,"line":247},[218,1310,1271],{"class":271},[218,1312,1275],{"class":1274},[218,1314,1278],{"class":231},[218,1316,1281],{"class":1274},[218,1318,1278],{"class":231},[218,1320,80],{"class":1274},[218,1322,1278],{"class":231},[218,1324,1325],{"class":1274},"TypesenseEngine",[218,1327,1289],{"class":231},[218,1329,1330,1332,1335,1337,1340],{"class":220,"line":261},[218,1331,1271],{"class":271},[218,1333,1334],{"class":1274}," Typesense",[218,1336,1278],{"class":231},[218,1338,1339],{"class":1274},"Client",[218,1341,1289],{"class":231},[218,1343,1344,1346,1348,1350,1353],{"class":220,"line":279},[218,1345,1271],{"class":271},[218,1347,1334],{"class":1274},[218,1349,1278],{"class":231},[218,1351,1352],{"class":1274},"Documents",[218,1354,1289],{"class":231},[218,1356,1357],{"class":220,"line":318},[218,1358,1360],{"emptyLinePlaceholder":1359},true,"\n",[218,1362,1363,1366,1369,1372],{"class":220,"line":324},[218,1364,272],{"class":1365},"spNyl",[218,1367,1368],{"class":264}," MultiSearchTypesenseEngine",[218,1370,1371],{"class":1365}," extends",[218,1373,1374],{"class":264}," TypesenseEngine\n",[218,1376,1377],{"class":220,"line":330},[218,1378,1379],{"class":231},"{\n",[218,1381,1382,1385,1388,1391,1393,1395,1398,1401,1403,1406,1408,1411,1413,1416,1418,1421,1424],{"class":220,"line":456},[218,1383,1384],{"class":1365},"    protected",[218,1386,1387],{"class":1365}," function",[218,1389,1390],{"class":300}," executeSearch",[218,1392,1017],{"class":231},[218,1394,1286],{"class":264},[218,1396,1397],{"class":231}," $",[218,1399,1400],{"class":1274},"builder",[218,1402,435],{"class":231},[218,1404,1405],{"class":264}," Documents",[218,1407,1397],{"class":231},[218,1409,1410],{"class":1274},"documents",[218,1412,435],{"class":231},[218,1414,1415],{"class":271}," array",[218,1417,1397],{"class":231},[218,1419,1420],{"class":1274},"options",[218,1422,1423],{"class":231},"):",[218,1425,1426],{"class":271}," mixed\n",[218,1428,1429],{"class":220,"line":493},[218,1430,1431],{"class":231},"    {\n",[218,1433,1434,1437,1440,1443,1446,1448,1451,1454,1457,1460],{"class":220,"line":499},[218,1435,1436],{"class":231},"        $",[218,1438,1439],{"class":1274},"results ",[218,1441,1442],{"class":231},"=",[218,1444,1445],{"class":231}," $this->",[218,1447,349],{"class":1274},[218,1449,1450],{"class":231},"->",[218,1452,1453],{"class":300},"getMultiSearch",[218,1455,1456],{"class":231},"()->",[218,1458,1459],{"class":300},"perform",[218,1461,1462],{"class":231},"([\n",[218,1464,1465,1467,1470,1472,1474,1477,1479,1481,1483,1485,1487,1489,1491,1493,1495,1498,1501,1503,1505,1507,1510,1512,1515],{"class":220,"line":505},[218,1466,282],{"class":231},[218,1468,1469],{"class":235},"searches",[218,1471,232],{"class":231},[218,1473,241],{"class":231},[218,1475,1476],{"class":231}," [[...$",[218,1478,1420],{"class":1274},[218,1480,435],{"class":231},[218,1482,307],{"class":231},[218,1484,918],{"class":235},[218,1486,232],{"class":231},[218,1488,241],{"class":231},[218,1490,1397],{"class":231},[218,1492,1400],{"class":1274},[218,1494,1450],{"class":231},[218,1496,1497],{"class":1274},"index ",[218,1499,1500],{"class":231},"??",[218,1502,1397],{"class":231},[218,1504,1400],{"class":1274},[218,1506,1450],{"class":231},[218,1508,1509],{"class":1274},"model",[218,1511,1450],{"class":231},[218,1513,1514],{"class":300},"searchableAs",[218,1516,1517],{"class":231},"()]],\n",[218,1519,1520],{"class":220,"line":510},[218,1521,1522],{"class":231},"        ]);\n",[218,1524,1525],{"class":220,"line":515},[218,1526,1360],{"emptyLinePlaceholder":1359},[218,1528,1530,1532,1535,1537,1539,1542,1545,1547,1549,1551,1554,1557,1560,1563],{"class":220,"line":1529},15,[218,1531,1436],{"class":231},[218,1533,1534],{"class":1274},"result ",[218,1536,1442],{"class":231},[218,1538,1397],{"class":231},[218,1540,1541],{"class":1274},"results",[218,1543,1544],{"class":231},"[",[218,1546,232],{"class":231},[218,1548,1541],{"class":235},[218,1550,232],{"class":231},[218,1552,1553],{"class":231},"][",[218,1555,1556],{"class":271},"0",[218,1558,1559],{"class":231},"]",[218,1561,1562],{"class":231}," ??",[218,1564,1565],{"class":231}," [];\n",[218,1567,1569],{"class":220,"line":1568},16,[218,1570,1360],{"emptyLinePlaceholder":1359},[218,1572,1574,1578,1581,1584,1587,1590,1592,1594,1597,1599,1602],{"class":220,"line":1573},17,[218,1575,1577],{"class":1576},"s7zQu","        if",[218,1579,1580],{"class":231}," (",[218,1582,1583],{"class":300},"isset",[218,1585,1586],{"class":231},"($",[218,1588,1589],{"class":1274},"result",[218,1591,1544],{"class":231},[218,1593,232],{"class":231},[218,1595,1596],{"class":235},"error",[218,1598,232],{"class":231},[218,1600,1601],{"class":231},"]))",[218,1603,1604],{"class":231}," {\n",[218,1606,1608,1611,1613,1616,1618,1620],{"class":220,"line":1607},18,[218,1609,1610],{"class":1576},"            throw",[218,1612,1445],{"class":231},[218,1614,1615],{"class":300},"marshalMultiSearchException",[218,1617,1586],{"class":231},[218,1619,1589],{"class":1274},[218,1621,1027],{"class":231},[218,1623,1625],{"class":220,"line":1624},19,[218,1626,1627],{"class":231},"        }\n",[218,1629,1631],{"class":220,"line":1630},20,[218,1632,1360],{"emptyLinePlaceholder":1359},[218,1634,1636,1639,1641,1643],{"class":220,"line":1635},21,[218,1637,1638],{"class":1576},"        return",[218,1640,1397],{"class":231},[218,1642,1589],{"class":1274},[218,1644,1289],{"class":231},[218,1646,1648],{"class":220,"line":1647},22,[218,1649,1650],{"class":231},"    }\n",[218,1652,1654],{"class":220,"line":1653},23,[218,1655,1656],{"class":231},"}\n",[218,1658,1660],{"class":220,"line":1659},24,[218,1661,1360],{"emptyLinePlaceholder":1359},[218,1663,1665],{"class":220,"line":1664},25,[218,1666,1667],{"class":224},"\u002F\u002F In the boot() method of a service provider\n",[218,1669,1671,1674,1676,1678,1680,1682,1685,1688,1690,1692,1694,1696,1698,1701,1704,1706,1709,1711],{"class":220,"line":1670},26,[218,1672,1673],{"class":300},"resolve",[218,1675,1017],{"class":231},[218,1677,1304],{"class":264},[218,1679,268],{"class":231},[218,1681,272],{"class":271},[218,1683,1684],{"class":231},")->",[218,1686,1687],{"class":300},"extend",[218,1689,1017],{"class":231},[218,1691,232],{"class":231},[218,1693,349],{"class":235},[218,1695,232],{"class":231},[218,1697,435],{"class":231},[218,1699,1700],{"class":1365}," fn",[218,1702,1703],{"class":231}," ()",[218,1705,241],{"class":231},[218,1707,1708],{"class":271}," new",[218,1710,1368],{"class":264},[218,1712,1713],{"class":231},"(\n",[218,1715,1717,1720,1723,1725,1728,1730,1732,1735,1737],{"class":220,"line":1716},27,[218,1718,1719],{"class":271},"    new",[218,1721,1722],{"class":264}," Client",[218,1724,1017],{"class":231},[218,1726,1727],{"class":300},"config",[218,1729,1017],{"class":231},[218,1731,232],{"class":231},[218,1733,1734],{"class":235},"scout.typesense.client-settings",[218,1736,232],{"class":231},[218,1738,1739],{"class":231},")),\n",[218,1741,1743,1746,1748,1750,1753,1755,1757,1760],{"class":220,"line":1742},28,[218,1744,1745],{"class":300},"    config",[218,1747,1017],{"class":231},[218,1749,232],{"class":231},[218,1751,1752],{"class":235},"scout.typesense.max_total_results",[218,1754,232],{"class":231},[218,1756,435],{"class":231},[218,1758,1759],{"class":271}," 1000",[218,1761,1762],{"class":231},"),\n",[218,1764,1766,1768,1770,1772,1775,1777],{"class":220,"line":1765},29,[218,1767,1745],{"class":300},[218,1769,1017],{"class":231},[218,1771,232],{"class":231},[218,1773,1774],{"class":235},"scout.typesense",[218,1776,232],{"class":231},[218,1778,1762],{"class":231},[218,1780,1782],{"class":220,"line":1781},30,[218,1783,1784],{"class":231},"));\n",[184,1786,1787,1788,1791],{},"The subclass is trusted without ",[188,1789,1790],{},"Access::trustSearchEngine()",", since it passes the options it receives, the access filter included, to the engine. Its browser tokens keep working, and it covers the searches of laravel-rest-api too. Algolia accepts at most 1,000 filters in a query, so a reader with more keys than that cannot search an Algolia index.",[179,1793,1795],{"id":1794},"the-engine-is-the-only-barrier","The engine is the only barrier",[184,1797,1798,1799,1801],{},"A controlled search shows what the index says. An index that lags behind can show a row that just left the reader's perimeters until the row is indexed again, and documents keep the keys of a former rule until they are reindexed. ",[944,1800,84],{"href":85}," covers what reindexes them.",[1803,1804,1805],"style",{},"html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}",{"title":214,"searchDepth":221,"depth":228,"links":1807},[1808,1811,1816,1817,1818],{"id":181,"depth":228,"text":182,"children":1809},[1810],{"id":813,"depth":247,"text":814},{"id":843,"depth":228,"text":844,"children":1812},[1813,1815],{"id":960,"depth":247,"text":1814},"The database engine",{"id":986,"depth":247,"text":987},{"id":1098,"depth":228,"text":1099},{"id":1238,"depth":228,"text":1239},{"id":1794,"depth":228,"text":1795},"Declare the access attributes in Meilisearch, Typesense, Algolia or Turbopuffer, use the database engine, and combine your own filters with the access filter.","md",null,{},{"title":80,"description":1819},{"loc":81,"lastmod":1825},"2026-11-21T16:10:34+01:00","ydJC8H225DWgzHLkcaziREFqie4QatB1jP1g7XHcXL8",[1828,1830],{"title":76,"path":77,"stem":78,"description":1829,"children":-1},"A controlled Laravel Scout search keeps, in one engine query, the documents the reader may view: each document carries the keys that open it.",{"title":84,"path":85,"stem":86,"description":1831,"children":-1},"Search keys are computed at indexing time. Declare with reindexWhen() and ReindexesSearch what reindexes the documents when the data behind them changes.",1795277181301]