PHPackages iqsuite/platform-sdk-laravel - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. iqsuite/platform-sdk-laravel ActiveLibrary[API Development](/categories/api) iqsuite/platform-sdk-laravel ============================ iQ Suite, instant RAG API with native support for Laravel 10+. 1.0.0(1y ago)715Apache-2.0PHP Since Jan 28Pushed 1y ago1 watchersCompare [ Source](https://github.com/iQSuite/platform-sdk-laravel)[ Packagist](https://packagist.org/packages/iqsuite/platform-sdk-laravel)[ RSS](/packages/iqsuite-platform-sdk-laravel/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependencies (1)Versions (3)Used By (0) iQ Suite Laravel SDK ==================== [](#iq-suite-laravel-sdk) Overview -------- [](#overview) Welcome to the **iQ Suite Laravel SDK**! This Software Development Kit (SDK) allows you to seamlessly integrate with the **iQ Suite Platform**, a comprehensive Retrieval Augmented Generation as a Service (RAGaaS). Whether you're a seasoned developer or just starting your coding journey, this guide will help you harness the power of iQ Suite to enhance your applications with advanced search and data processing capabilities. ### What is Retrieval Augmented Generation (RAG)? [](#what-is-retrieval-augmented-generation-rag) **Retrieval Augmented Generation (RAG)** is a powerful approach that combines traditional information retrieval techniques with advanced language models. It enables applications to fetch relevant information from large datasets and generate insightful, contextually accurate responses. In simpler terms, RAG helps your applications understand and process data more intelligently, providing users with precise and meaningful answers based on the content they interact with. ### Key Features [](#key-features) - **Multi-Format Document Support:** Easily handle PDFs, Word documents, PowerPoint presentations, and raw text. - **Hybrid Semantic Search:** Combine keyword searches with semantic understanding for more accurate results. - **Natural Language Interaction:** Engage with your documents through conversational queries. - **Instant RAG:** Perform on-the-fly analysis without the need for persistent indexing. - **Asynchronous Processing:** Manage tasks efficiently using webhooks. - **Real-Time Notifications:** Receive immediate updates on task statuses. - **Secure API Authentication:** Protect your data with robust authentication mechanisms. Table of Contents ----------------- [](#table-of-contents) - [Installation](#installation) - [Features](#features) - [Quick Start](#quick-start) - [Support](#support) Installation ------------ [](#installation) Installing the iQ Suite Laravel SDK is straightforward. Let's get started. ### Prerequisites [](#prerequisites) - **PHP 8.2^:** Ensure you have PHP version 8.2 or higher installed on your system. - **composer:** Composer should be available. ### Steps to Install [](#steps-to-install) 1. **Open Your Terminal or Command Prompt:** - **Windows:** Press `Win + R`, type `cmd`, and hit `Enter`. - **macOS/Linux:** Open the Terminal application. 2. **Initialize Your Project (If Not Already Initialized):** ``` composer create-project laravel/laravel iqsuite-sdk ``` 3. **Install the SDK:** - **Using composer:** ``` composer require iqsuite/platform-sdk-laravel ``` This command downloads and installs the latest version of the iQ Suite Laravel SDK from packagist. Features -------- [](#features) The iQ Suite Laravel SDK offers a wide range of features designed to make data retrieval and processing efficient and effective. Here's a detailed look at what you can do: - 📄 **Multi-Format Document Support:** Easily ingest and process various document types, including PDFs, Word documents, PowerPoint presentations, and raw text files. - 🔍 **Hybrid Semantic Search:** Combines traditional keyword-based search with advanced semantic understanding to deliver more accurate and relevant search results. - 💬 **Natural Language Chat:** Interact with your documents using conversational queries, making data exploration intuitive and user-friendly. - 🚀 **Instant RAG:** Perform immediate analysis on your data without the need to create and maintain persistent indices. - 🔄 **Asynchronous Processing:** Handle long-running tasks efficiently using webhooks, allowing your application to remain responsive. - ⚡ **Real-Time Notifications:** Receive instant updates on the status of your tasks, ensuring you're always informed about ongoing processes. - **Tokenizer**: A free to use endpoint from iQ Suite which allows you to count the number of tokens via an API endpoint. Useful for calculating usage from raw text chunks or data. - **Webhooks**: Manage webhooks to receive async data from iQ Suite platform. - 🔒 **Secure API Authentication:** Protect your data and ensure secure interactions with robust API key management. Quick Start ----------- [](#quick-start) This section will guide you through the initial steps to get your application up and running with the iQ Suite Laravel SDK. Whether you're setting up for the first time or integrating it into an existing project, these instructions will help you get started quickly. ### Step 1: Obtain Your API Key [](#step-1-obtain-your-api-key) Before you can interact with the iQ Suite Platform, you'll need an API key. This key authenticates your requests and ensures secure access to your data. > **⚠️ Important:** *Never expose your API key in version control systems (like GitHub) or unsecured environments. Always use environment variables or secure key management systems to store your API keys.* #### How to Get Your API Key [](#how-to-get-your-api-key) 1. **Visit the iQ Suite Platform:** Open your web browser and navigate to the [iQ Suite Platform](https://iqsuite.ai). 2. **Sign Up or Log In:** - **New Users:** Click on the **Sign Up** button and create an account using your email address or GitHub account. - **Existing Users:** Click on **Log In** and enter your credentials. 3. **Navigate to API Keys:** Once logged in, locate the **API Keys** section in the sidebar menu. This section manages all your API keys. 4. **Create a New API Key:** - Click on the **Create API Key** button. - Provide a **name** for your API key (e.g., "Development Key" or "Production Key") to help you identify its purpose. - Click **Create**. 5. **Store Your API Key Securely:** - After creation, the API key will be displayed **only once**. Make sure to **copy and save** it in a secure location. - **Do not** share your API key publicly or commit it to version control repositories. ### Step 2: Initialize the Client [](#step-2-initialize-the-client) With your API key in hand, you can now initialize the iQ Suite client in your Laravel application. #### Using Environment Variables (Recommended) [](#using-environment-variables-recommended) Storing your API key in an environment variable enhances security by keeping sensitive information out of your codebase. 1. **Set the Environment Variable:** - **.env** ``` IQSUITE_API_KEY=your_api_key_here ``` - **publish vendor file** ``` php artisan vendor:publish --tag=iqsuite-config ``` ### Step 3: List all Indices [](#step-3-list-all-indices) ``` use IQSuite\Platform\Facades\IQSuite; public function listAllIndices() { $response = IQSuite::getAllIndices(); return $response; } ``` Please refer to our SDK guide in our [documentation](https://docs.iqsuite.ai) for all the other available methods. Support ------- [](#support) We're dedicated to helping you make the most of the iQ Suite Platform. Whether you need technical assistance, want to provide feedback, or are looking for resources to learn more, our support channels are here for you. ### Documentation [](#documentation) Comprehensive documentation is available to guide you through every aspect of the iQ Suite Platform and the Laravel SDK. - 📚 [API Documentation](https://docs.iqsuite.ai/) - 🔧 [SDK Reference](https://docs.iqsuite.ai/sdk-reference/document-rag/create-index) - 📖 [Tutorials & Guides](https://docs.iqsuite.ai) \[**Coming soon**\] ### Getting Help [](#getting-help) If you encounter issues or have questions, reach out through the following channels: - 📧 [Email Support](mailto:support@iqsuite.ai): Contact our support team directly via email for personalized assistance. - 💬 [Discord Community](https://discord.gg/JWcdjkuDqR): Join our Discord server to interact with other users and developers, share experiences, and get real-time help. *© 2025 iQ Suite. All rights reserved.* > **💡 Tip:** *Engage with the community and stay updated with the latest developments to maximize the benefits of the iQ Suite Platform.* --- *If you have any suggestions or feedback on this documentation, please feel free to [open an issue](https://github.com/iqsuite/platform-sdk-laravel/issues) on our GitHub repository.* ### Health Score 27 — LowBetter than 49% of packages Maintenance43 Moderate activity, may be stable Popularity11 Limited adoption so far Community7 Small or concentrated contributor base Maturity39 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 469d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/4bb2453d75418350760f0d32fc4539eb98ed9781861c49523793df102c6af4dc?d=identicon)[blue-hex](/maintainers/blue-hex) --- Top Contributors [![rohan-krishna](https://avatars.githubusercontent.com/u/3327713?v=4)](https://github.com/rohan-krishna "rohan-krishna (12 commits)") ### Embed Badge ![Health badge](/badges/iqsuite-platform-sdk-laravel/health.svg) ``` [![Health](https://phpackages.com/badges/iqsuite-platform-sdk-laravel/health.svg)](https://phpackages.com/packages/iqsuite-platform-sdk-laravel) ``` ### Alternatives [stripe/stripe-php Stripe PHP Library 4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk A PHP wrapper for Twilio's API 1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api GitHub API v3 client 2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk PHP SDK for Facebook Business 90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php PHP wrapper for the Meilisearch API 73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax Google API Core for PHP 263103.1M454](/packages/google-gax) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)