{"id":21655209,"url":"https://github.com/pseitz/veloci","last_synced_at":"2026-02-25T21:04:16.716Z","repository":{"id":54616855,"uuid":"81763295","full_name":"PSeitz/veloci","owner":"PSeitz","description":"High performance fulltext search engine","archived":false,"fork":false,"pushed_at":"2024-10-07T07:31:16.000Z","size":4639,"stargazers_count":10,"open_issues_count":11,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-11T21:14:47.532Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PSeitz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-02-12T22:42:23.000Z","updated_at":"2024-10-07T07:31:20.000Z","dependencies_parsed_at":"2023-11-18T11:22:05.198Z","dependency_job_id":"283b7fe5-7f86-4379-be23-21a791c17d04","html_url":"https://github.com/PSeitz/veloci","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/PSeitz/veloci","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PSeitz%2Fveloci","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PSeitz%2Fveloci/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PSeitz%2Fveloci/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PSeitz%2Fveloci/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PSeitz","download_url":"https://codeload.github.com/PSeitz/veloci/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PSeitz%2Fveloci/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29839964,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-25T20:42:33.054Z","status":"ssl_error","status_checked_at":"2026-02-25T20:42:21.322Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-25T08:30:41.176Z","updated_at":"2026-02-25T21:04:16.699Z","avatar_url":"https://github.com/PSeitz.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Veloci ![Veloci Tests](https://github.com/PSeitz/veloci/workflows/Veloci%20Tests/badge.svg) [![codecov](https://codecov.io/gh/PSeitz/veloci/branch/master/graph/badge.svg)](https://codecov.io/gh/PSeitz/veloci) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\nCARGO_INCREMENTAL=1 RUST_BACKTRACE=full RUST_TEST_THREADS=1 RUST_LOG=veloci=trace,measure_time=info cargo watch -w src -x 'test -- --nocapture'\n\n\n## Features\n\n- Optional Schema\n- Fuzzy Search\n- Query Boosting\n- Term Boosting\n- Phrase Boosting\n- Boost by Indexed Data\n- Boost Parts of Query\n- Boost by Text-Locality (multi-hit in same text)\n- Facets\n- Filters\n- WhyFound\n- Stopwordlists (EN, DE)\n- Queryparser\n- Compressed Docstore\n- Support for In-Memory and Diskbased (MMap) Indices\n- Speed\n- Love💖\n\n\n### Goals\n\n- Super easy indexing and searching on data\n- Ultrahigh performance\n\n### Non-Goals (Currently)\n\n- Delta update in indices\n\n\n## Creating Indices\n\nUse the tool in `veloci_bins/src/bin/create_index.rs` to create indices on your data.\nCurrently the data needs to be stored in the `json` format one json per line:\n```json\n{\"text\": \"my first object\", \"sub_objects\": [{\"description\": \"this works\"}]}\n{\"text\": \"my second object\"}\n```\n\nIf your json is not in this format, there is a tool to convert it in `veloci_bins/src/bin/convert_json_to_line_delimited.rs`\n\n\n## Addressing fields\n```json\n{\n    \"text\": \"my first object\",\n    \"sub_objects\": [\n        {\"description\": \"this works\", \"deeper\": [\"tag1\", \"tag2\"]}\n    ],\n    \"structured\":{\n        \"name\": \"a\"\n    }\n}\n```\nThe fields would be adressed like this:\ntext\nsub_objects[].description\nsub_objects[].deeper[]\nstructured.name\n\n## Boosting \nBoost score based on values in the data. Given two products with the same name, but one is more common and should be ranked higher.\n\n```json\n{ \"commonness\": 10, \"name\": \"product\" }\n{ \"commonness\": 99, \"name\": \"product\" }\n```\n\nCreate a column index for the data. Note the \"boost\" prefix.\n```toml\n    [commonness.boost]\n    boost_type = 'f32'\n```\n\n\nFor search we create a boost query that adjusts the score with the following formula.\n`hit.score *= (boost_value + boost_param).log10();`\n\n```rust\n    let req: search::Request = json!({\n        \"search_req\": { \"search\": {\n            \"terms\":[\"product\"],\n            \"path\": \"name\",\n            \"levenshtein_distance\": 0\n        }},\n        \"boost\" : [{\n            \"path\":\"commonness\",\n            \"boost_fun\": \"Log10\",\n            \"param\": 1\n        }]\n    });\n```\n\n\n\n\n## Webserver\n\nTo install the search enginge bundled with the webserver execute in the `server` folder:\n`cd server;cargo install`\n\nTo start the server and load search indices inside the jmdict folder:\n`ROCKET_ENV=stage RUST_BACKTRACE=1 RUST_LOG=veloci=info ROCKET_PORT=3000 rocket_server jmdict`\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpseitz%2Fveloci","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpseitz%2Fveloci","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpseitz%2Fveloci/lists"}