Packages and index setup
Get an index ready for site search without opening the Control Panel, then plug it into the framework you already use. The packages do the setup checks for you and call the same endpoints as the rest of this section.
Set up the index
These calls go to https://opensolr.com.
vector_regionsThe regions where site search, search by meaning and the chat bot run, with the one nearest to you marked when you ask.
Referenceget_envThe regions and servers you can create an index on; with web_crawler=true, only the ones with site search.
create_indexCreate an Opensolr Index in the region you choose.
Referencecheck_schemaTell whether an index is ready for pushed data and search by meaning, and exactly why not.
Check and install the schemaapply_schemaInstall the Opensolr site search schema on an index.
Check and install the schemaget_account_summarySigned: your plan, its limits and what you used, AI requests included, in one call.
ReferencePackages
A vector store with the vectors made by Opensolr and hybrid search, nothing to run on your side.
LangChainA vector store and an embedding model for LlamaIndex, on your Opensolr Index.
LlamaIndexA document store and a hybrid retriever for Haystack pipelines.
HaystackSearch, indexing of files, reading of pictures and answers as tools any AI agent can call.
MCPA Scout engine: your Laravel models searched by words and by meaning.
Laravel ScoutEach package checks an index once before using it and says exactly what it cannot do; each one also offers the schema check and install. More in Integrations.