Skip to main content

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.

  1. 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.

  1. 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


Metadata

Release files for just-semantic-search-server-cuda 0.4.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for just-semantic-search-server-cuda 0.4.8
File Size Uploaded
just_semantic_search_server_cuda-0.4.8.tar.gz 24.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for just-semantic-search-server-cuda 0.4.8
File Interpreter ABI Platform
just_semantic_search_server_cuda-0.4.8-py3-none-any.whl Python 3 none any Details

Total release size: 52.5 kB

Release files / just_semantic_search_server_cuda-0.4.8.tar.gz

Download URL just_semantic_search_server_cuda-0.4.8.tar.gz
Size 24.5 kB
Tags Source
SHA-256 checksum
How to use checksums
4a9ffd1c8739f02a923b760b87c0b49f868d6bf9b03eeed865e9adc21c308763
BLAKE2b-256 checksum
How to use checksums
55af1903f245164d5113966973360f8088fd73fbd0283ecb0fffcc276fca03a4
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_cuda-0.4.8-py3-none-any.whl

Download URL just_semantic_search_server_cuda-0.4.8-py3-none-any.whl
Size 28.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fddc16a70c66d4b7032c42e6bbe1259087acea207ccfc310552155a6ac72733d
BLAKE2b-256 checksum
How to use checksums
f6f5ef65971c5f06cc6f963853059563a5bbc4b8330dcd3aea0b342a30123805
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 history Release notifications | RSS feed

2.5.0

2 release files

This release

0.4.8 This release

2 release files

0.4.7

2 release files

0.4.6

2 release files

0.4.5

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.9

2 release files

0.3.8

2 release files

0.3.7

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.9

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page