🚀 Get Started with CIQ in Minutes
Welcome to NineBit CIQ — your private, developer-friendly platform for building intelligent document workflows using RAG (Retrieval-Augmented Generation), classification, and taxonomy extraction.
This guide will help you:
- 📁 Upload your first document
- 💬 Query it using natural language
- ⚙️ Run everything via Python or Node.js SDK
1️⃣ Install the SDK
- Python
- JavaScript
pip install ninebit-ciq
npm install @ninebit/ciq
2️⃣ Set Up the Client
- Python
- JavaScript
from ninebit_ciq import NineBitCIQClient
client = NineBitCIQClient(
api_key="<your-api-key>"
)
// Use import for ESM
import { CIQClient } from '@ninebit/ciq';
// Or use require() for CommonJS
// const { CIQClient } = require('@ninebit/ciq');
const apiKey = process.env.API_KEY || '';
const client = new CIQClient(apiKey);
🔑 Where to Get Your API Key
⚠️ To use the SDK, you’ll need your unique CIQ API key.
🧭 Go to ciq.ninebit.in, click “Register” (or Login if you already have an account), and your API key will be visible in the bottom-left corner of the dashboard.
3️⃣ Upload a Document
- Python
- JavaScript
def on_done(error, data):
if error:
print(f"Ingest_file failed: {error}")
else:
print(f"Ingest_file succeeded: {str(data)}")
client.ingest_file(file="files/sample.pdf", callback=on_done)
await client.ingestFile('files/sample.pdf');
4️⃣ Ask a Question
- Python
- JavaScript
query = "What are land breeze?"
response = client.rag_query(query=query)
print(f"Query response is {response}")
const query = "What are land breeze?";
const response = await client.ragQuery(query);
console.log("Query response is", response);
## ✅ You're Done!
You’ve just:
- Uploaded a document to CIQ
- Queried it using natural language
- Retrieved AI-generated answers using RAG
Return to Home.