{"_id":"r2r-js","_rev":"174-25392a0626b214b354f88e6bc81d4bb2","name":"r2r-js","dist-tags":{"latest":"0.4.43"},"versions":{"0.3.0":{"name":"r2r-js","version":"0.3.0","keywords":[],"author":"","license":"ISC","_id":"r2r-js@0.3.0","maintainers":[{"name":"emrgnt-cmplxty","email":"owen@sciphi.ai"},{"name":"nolantremelling","email":"nolan@sciphi.ai"}],"dist":{"shasum":"9e953e1a919212e2537274dd3fb07baed833caac","tarball":"https://registry.npmjs.org/r2r-js/-/r2r-js-0.3.0.tgz","fileCount":14,"integrity":"sha512-BfgFwEmh0fzQ8/3WjfEWy8Pt1F/CTKYKEk+YXPzD91j3xcmrzOzAOFk6okV6e0dStfCj6PalPtFFxMGX1skRog==","signatures":[{"sig":"MEUCIQCEIvUsONL/5R+YJ/2PiQnm36N5pFFr9AQ+M4thfqdRPgIgArXat3LWJWS8PPRwD0fP1xXoYXkS5venLkcazWBqAiU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":108313},"main":"dist/index.js","types":"dist/index.d.ts","browser":"dist/index.browser.js","exports":{".":"./dist/index.js"},"gitHead":"7cd3743630052aa18765489b423866cc96150e9a","scripts":{"test":"jest --no-cache","build":"tsc","format":"prettier --write .","test:watch":"jest --watch","test:coverage":"jest --coverage","pretest:integration":"node setup.js"},"_npmUser":{"name":"nolantremelling","email":"nolan@sciphi.ai"},"_npmVersion":"8.19.4","description":"

\"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \"Docs\" \n \"Docs\"\n \"Discord\"\n \"Github\n \"Commits-per-week\"\n \"License:\n \"npm\n

\n\n\"R2R\n

\nThe ultimate open source RAG answer engine - JavaScript Client\n

\n\n# About\n\nThe official JavaScript client for R2R (Retrieval-Augmented Generation to Riches). R2R is designed to bridge the gap between local LLM experimentation and scalable, state of the art Retrieval-Augmented Generation (RAG). This JavaScript client provides a seamless interface to interact with the R2R RESTful API.\n\nFor a more complete view of R2R, check out the [full documentation](https://r2r-docs.sciphi.ai/).\n\n## Key Features\n\n- **📁 Multimodal Support**: Ingest files ranging from `.txt`, `.pdf`, `.json` to `.png`, `.mp3`, and more.\n- **🔍 Hybrid Search**: Combine semantic and keyword search with reciprocal rank fusion for enhanced relevancy.\n- **🔗 Graph RAG**: Automatically extract relationships and build knowledge graphs.\n- **🗂️ App Management**: Efficiently manage documents and users with rich observability and analytics.\n- **🌐 Client-Server**: RESTful API support out of the box.\n- **🧩 Configurable**: Provision your application using intuitive configuration files.\n- **🔌 Extensible**: Develop your application further with easy builder + factory pattern.\n- **🖥️ Dashboard**: Use the [R2R Dashboard](https://github.com/SciPhi-AI/R2R-Dashboard), an open-source React+Next.js app for a user-friendly interaction with R2R.\n\n## Table of Contents\n\n1. [Install](#install)\n2. [R2R JavaScript Client Quickstart](#r2r-javascript-client-quickstart)\n3. [Community and Support](#community-and-support)\n4. [Contributing](#contributing)\n\n# Install\n\n```bash\nnpm install r2r-js\n```\n\n# R2R JavaScript Client Quickstart\n\n## Initialize the R2R client\n\n```javascript\nconst { r2rClient } = require(\"r2r-js\");\n\nconst client = new r2rClient(\"http://localhost:7272\");\n```\n\n## Login\n\n```javascript\nconst EMAIL = \"admin@example.com\";\nconst PASSWORD = \"change_me_immediately\";\nconsole.log(\"Logging in...\");\nawait client.login(EMAIL, PASSWORD);\n```\n\n## Ingest files\n\n```javascript\nconst files = [\n { path: \"examples/data/raskolnikov.txt\", name: \"raskolnikov.txt\" },\n { path: \"examples/data/karamozov.txt\", name: \"karamozov.txt\" },\n];\n\nconst ingestResult = await client.ingestFiles(files, {\n metadatas: [{ title: \"raskolnikov.txt\" }, { title: \"karamozov.txt\" }],\n user_ids: [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"123e4567-e89b-12d3-a456-426614174000\",\n ],\n});\nconsole.log(ingestResult);\n```\n\n## Perform a search\n\n```javascript\nconst searchResult = await client.search(\"Who was Raskolnikov?\");\nconsole.log(searchResult);\n```\n\n## Perform RAG\n\n```javascript\nconst ragResult = await client.rag({\n query: \"Who was Raskolnikov?\",\n use_vector_search: true,\n filters: {},\n search_limit: 10,\n use_hybrid_search: false,\n use_kg_search: false,\n kg_generation_config: {},\n rag_generation_config: {\n model: \"gpt-4.1\",\n temperature: 0.0,\n stream: false,\n },\n});\nconsole.log(ragResult);\n```\n\n## Stream a RAG Response\n\n```javascript\nconst streamingRagResult = await client.rag({\n query: \"Who was Raskolnikov?\",\n rag_generation_config: {\n stream: true,\n },\n});\n\nif (streamingRagResult instanceof ReadableStream) {\n const reader = streamingRagResult.getReader();\n while (true) {\n const { done, value } = await reader.read();\n if (done) break;\n console.log(new TextDecoder().decode(value));\n }\n}\n```\n\n# Community and Support\n\n- [Discord](https://discord.gg/p6KqD2kjtB): Chat live with maintainers and community members\n- [Github Issues](https://github.com/SciPhi-AI/R2R-js/issues): Report bugs and request features\n\n**Explore our [R2R Docs](https://r2r-docs.sciphi.ai/) for tutorials and cookbooks on various R2R features and integrations.**\n\n# Contributing\n\nWe welcome contributions of all sizes! Here's how you can help:\n\n- Open a PR for new features, improvements, or better documentation.\n- Submit a [feature request](https://github.com/SciPhi-AI/R2R-js/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=) or [bug report](https://github.com/SciPhi-AI/R2R-js/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=)\n\n### Our Contributors\n\n\n \n\n","readmeFilename":"README.md"}