{"id":16278133,"url":"https://github.com/helgesverre/mindwave-docs","last_synced_at":"2025-07-03T14:09:18.972Z","repository":{"id":170185226,"uuid":"640795481","full_name":"HelgeSverre/mindwave-docs","owner":"HelgeSverre","description":"📚 Documentation for the Mindwave package","archived":false,"fork":false,"pushed_at":"2023-06-01T00:01:16.000Z","size":13606,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-14T13:50:25.134Z","etag":null,"topics":["docs","laravel-package","mindwave","vitepress"],"latest_commit_sha":null,"homepage":"https://mindwave.no","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HelgeSverre.png","metadata":{"files":{"readme":"docs/readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2023-05-15T06:34:15.000Z","updated_at":"2023-05-28T00:34:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"7c345e58-444c-4662-a411-4cee6057e6ac","html_url":"https://github.com/HelgeSverre/mindwave-docs","commit_stats":null,"previous_names":["helgesverre/mindwave-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HelgeSverre%2Fmindwave-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HelgeSverre%2Fmindwave-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HelgeSverre%2Fmindwave-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HelgeSverre%2Fmindwave-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HelgeSverre","download_url":"https://codeload.github.com/HelgeSverre/mindwave-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247892744,"owners_count":21013774,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["docs","laravel-package","mindwave","vitepress"],"created_at":"2024-10-10T18:57:24.375Z","updated_at":"2025-04-08T17:32:55.730Z","avatar_url":"https://github.com/HelgeSverre.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mindwave: AI Chatbots, Agents \u0026 Document Q\u0026A in Laravel Simplified.\n\n## What is Mindwave?\n\nMindwave is a Laravel package that lets you easily build AI-powered chatbots, agents, and document question and\nanswering (Q\u0026A) functionality into your application.\n\n## Example\n\n![Code Example](/art/code.png)\n\n```php\n\u003c?php\n\nuse Illuminate\\Support\\Facades\\File;\nuse Mindwave\\Mindwave\\Facades\\DocumentLoader;\nuse Mindwave\\Mindwave\\Facades\\Mindwave;\nuse Mindwave\\Mindwave\\Memory\\ConversationBufferMemory;\n\n$agent = Mindwave::agent(\n    memory: ConversationBufferMemory::fromMessages([])\n);\n\nMindwave::brain()\n    -\u003econsume(\n        DocumentLoader::fromPdf(\n            data: File::get(\"uploads/important-document.pdf\"),\n            meta: [\"name\" =\u003e \"Important document\"],\n        )\n    )\n    -\u003econsume(\n        DocumentLoader::fromUrl(\n            data: \"https://mindwave.no/\",\n            meta: [\"name\" =\u003e \"Mindwave Documentation\"],\n        )\n    )\n    -\u003econsume(\n        DocumentLoader::make(\"My name is Helge Sverre\")\n    );\n\n\n$agent-\u003eask(\"List the top 3 most important things in 'important document'\");\n$agent-\u003eask(\"What is mindwave?\");\n$agent-\u003eask(\"What is my name?\");\n```\n\n## Use Cases\n\n-   💬 **Chatbots**: Building AI-powered chatbots to provide support to customers.\n-   🤖 **Agents**: Developing intelligent agents to automate tasks within an application.\n-   ❓ **Document Q\u0026A**: Creating document question and answering (Q\u0026A) systems to extract insights from text.\n\n## Technical\n\n-   Mindwave makes it easy to generate embeddings for many types of documents (text, pdf, html, csv, json, etc), store\n    those embeddings in a Vector database.\n-   Using pre-made prompts you can instruct an Agent to run custom \"tools\" that can perform an action in your codebase,\n    lookup specific information from an external source, search your vector database for semantically similar information\n    and use the result of that action to generate an answer.\n\n## Support\n\nMindwave is \"driver\" oriented, this means you can swap out the parts to suite your needs and use-cases.\n\n### Vector databases\n\n| Name     | Supported?   |\n| -------- | ------------ |\n| Pinecone | Yes          |\n| Weaviate | No (planned) |\n| Qdrant   | No (planned) |\n| Milvus   | No (planned) |\n| pgvector | No (planned) |\n\n### LLMs\n\n| Name               | Supported?        |\n| ------------------ | ----------------- |\n| OpenAI Chat models | Yes (Recommended) |\n| OpenAI Completion  | Yes               |\n| Cohere AI          | No (planned)      |\n| Anthropic Claude   | No (planned)      |\n\n### Embeddings\n\n| Name                | Supported?        |\n| ------------------- | ----------------- |\n| OpenAI text-ada-002 | Yes (Recommended) |\n\n## Known Limitations\n\nWhile Mindwave offers powerful AI capabilities, there are some limitations to keep in mind:\n\n| Limitation      | Description                                                                                                                     |\n| --------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| Hallucination   | Large language models (LLMs) like OpenAI's GPT models can occasionally produce nonsensical responses or \"hallucinate\".          |\n| English-Centric | While you can configure Mindwave to respond in different languages, it may not always be accurate or natural-sounding.          |\n| Context Length  | OpenAI's GPT models have a hard limit on the length of the input context they can process, which varies depending on the model. |\n\nHere are the current context length limits for some of the OpenAI models supported by Mindwave:\n\n| Model ID         | Max Tokens |\n| ---------------- | ---------- |\n| text-davinci-003 | 4,097      |\n| gpt-3.5-turbo    | 4,096      |\n| gpt-4            | 4,096      |\n\nIt's important to keep these limitations in mind when building applications with Mindwave, and to test and evaluate the\nresults carefully to ensure the desired outcomes are being achieved.\n\n## Credits\n\n-   [Helge Sverre](https://twitter.com/helgesverre)\n-   [Probots.io](https://github.com/probots-io) for the [Pinecone PHP Client](https://github.com/probots-io/pinecone-php)\n-   [Tim Kleyersburg](https://github.com/timkley) for the [Weaviate PHP Client](https://github.com/timkley/weaviate-php)\n-   [PGVector team](https://github.com/pgvector/pgvector-php/graphs/contributors) for\n    the [PGVector PHP package](https://github.com/pgvector/pgvector-php)\n-   [Yethee](https://github.com/yethee) for the [Tiktoken PHP Package](https://github.com/yethee/tiktoken-php)\n-   [Yethee](https://github.com/yethee) for the [Tiktoken PHP Package](https://github.com/yethee/tiktoken-php)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelgesverre%2Fmindwave-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhelgesverre%2Fmindwave-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelgesverre%2Fmindwave-docs/lists"}