RAG Server package
Depends on the just-agents package
This package also has some features which are specific for Just-Chat integration.
It allows easier index for markdown files.
- Indexing papers
For indexing what you have to do is run
poetry shell
index_markdown <path_to_markdown_folder> -i <index_name>
this will index all markdown files in the folder and create a Meilisearch index. It will all be indexed in the location where you gave the input files from. NOTE: this is run here, in the just-semantic-search folder but can have targets outside of this folder, for example in other projects.
- Searching indexed papers
First off- searching is mostly done in the project you are working on. Meaning that the primary usecase is for the user to import the libary.
2.1. Just-Agents have you should configure a web_agent in your agent_profiles.yaml.
You can either user meilisearch separately from just-chat or you can extend the just-chat docker-compose.yml file with the following meilisearch service.
meilisearch:
container_name: meilisearch
image: getmeili/meilisearch:v1.13.0
environment:
- http_proxy
- https_proxy
- MEILI_MASTER_KEY=fancy_master_key
- MEILI_NO_ANALYTICS=${MEILI_NO_ANALYTICS:-true}
- MEILI_ENV=${MEILI_ENV:-development}
- MEILI_LOG_LEVEL
- MEILI_DB_PATH=${MEILI_DB_PATH:-/data.ms}
- MEILI_EXPERIMENTAL_ENABLE_METRICS=true
- MEILI_EXPERIMENTAL_ENABLE_VECTORS=true
ports:
- ${MEILI_PORT:-7700}:7700
volumes:
- ./data.ms:/data.ms
restart: unless-stopped
2.2. in requirements.txt you have to add just-semantic-search-meili
2.3. in agent_profiles.yaml you have to add the following tools for the agent you want to use it
- package: "just_semantic_search.meili.tools"
function: "search_documents"
This will allow the agent to use the search_documents function from the just_semantic_search.meili.tools package. Also, given you have indexed the papers in this project, the only part from the libary you will use is the search_documents function.
2.4. run
docker compose up
and querry the agent so that it will have to search your indexed papers
NOTE: to check things before you run the agent you can first check port 0.0.0.0:7700 to see if the meilisearch is running. -key is fancy_master_key
There you should be able to see whether meilisearch is running and if there are indexes created.
Following text explains more in details how this library works and it is structured
1 maintainer
Metadata
1 maintainer
Release files for just-semantic-search-server 0.4.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| just_semantic_search_server-0.4.8.tar.gz | 24.5 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| just_semantic_search_server-0.4.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 52.4 kB
Release files / just_semantic_search_server-0.4.8.tar.gz
| Download URL | just_semantic_search_server-0.4.8.tar.gz |
|---|---|
| Size | 24.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4f0730d25b521020c8e795d6be7ef63cbafb387509929872744f07075b8b32e7
|
|
BLAKE2b-256 checksum How to use checksums |
456b44f1f7de92cae8475558a9c4136fdc411e3b6eb65b02c1eba9be99d8ffc0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.2.1 CPython/3.10.12 Linux/5.15.0-161-generic
|
Release files / just_semantic_search_server-0.4.8-py3-none-any.whl
| Download URL | just_semantic_search_server-0.4.8-py3-none-any.whl |
|---|---|
| Size | 27.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7ac7ad38bbb3ca11d9cb16f7bd3159dbd1c9a109d5ad6d5e239060a38e9fa329
|
|
BLAKE2b-256 checksum How to use checksums |
69760cbfb1221305c6ad95ab76839133325a5d86e1e464ee517f7c490c2cdfb0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.2.1 CPython/3.10.12 Linux/5.15.0-161-generic
|
Security for just-semantic-search-server 0.4.8
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
