# Cobi Documentation

## Docs

- [Introduction](https://docs.hellocobi.com/introduction.md): What is Cobi and how to get started
- [On-Premises Deployment Overview](https://docs.hellocobi.com/deployment/overview.md): Architecture overview for deploying Cobi on Kubernetes or OpenShift using the cobi-dashboard Helm chart
- [Requirements](https://docs.hellocobi.com/deployment/requirements.md): Hardware, software, and access requirements for deploying Cobi on-premises
- [Helm Chart Setup](https://docs.hellocobi.com/deployment/helm-setup.md): Step-by-step guide to installing Cobi on Kubernetes or OpenShift using the cobi-dashboard Helm chart
- [Gateway, Ingress & Routes](https://docs.hellocobi.com/deployment/ingress-routes.md): Configure Gateway API, Kubernetes Ingress, or OpenShift Routes for Cobi
- [Backend Service](https://docs.hellocobi.com/deployment/backend.md): Environment variables, secrets, and Helm values for the Cobi backend service
- [Frontend Service](https://docs.hellocobi.com/deployment/frontend.md): Environment variables and secrets required to run the Cobi frontend service on-premises
- [Connect Service](https://docs.hellocobi.com/deployment/dashboard-connect.md): Environment variables and secrets required to run the connect service for data source ingestion
- [PostgreSQL Setup](https://docs.hellocobi.com/deployment/postgresql-setup.md): Deploy PostgreSQL in-cluster via the Helm subchart, or connect to an existing standalone database instance
- [Qdrant Setup](https://docs.hellocobi.com/deployment/qdrant-setup.md): Configure the Qdrant vector database for semantic search and document embeddings
- [MinIO Setup](https://docs.hellocobi.com/deployment/minio-setup.md): Configure MinIO object storage for document uploads and data ingestion artifacts in on-premises environments
- [vLLM Inference Setup](https://docs.hellocobi.com/deployment/vllm-setup.md): Deploy a self-hosted LLM inference endpoint using the vllm-stack subchart
- [Model Storage](https://docs.hellocobi.com/deployment/model-storage.md): Host model weights in your own Git repository or MinIO instead of pulling from Hugging Face Hub
- [Overview](https://docs.hellocobi.com/platform/data-connectors/overview.md): Connect your database to start exploring your data with Cobi
- [PostgreSQL](https://docs.hellocobi.com/platform/data-connectors/postgresql.md): Connect a PostgreSQL database to Cobi
- [MySQL](https://docs.hellocobi.com/platform/data-connectors/mysql.md): Connect a MySQL database to Cobi
- [MongoDB](https://docs.hellocobi.com/platform/data-connectors/mongodb.md): Connect a MongoDB database to Cobi
- [Troubleshooting](https://docs.hellocobi.com/platform/data-connectors/troubleshooting.md): Diagnose and fix common Data Connector issues
- [Custom Instructions](https://docs.hellocobi.com/platform/custom-instructions.md): Add context and business rules to help Cobi understand your data
- [Chat Widget](https://docs.hellocobi.com/platform/channels/embed-chat-widget.md): Add Cobi's Data Assistant to your website with a simple iframe
- [Data Scopes](https://docs.hellocobi.com/platform/channels/data-scopes.md): Restrict which tables an embed key can query and enforce row-level isolation for multi-tenant deployments
- [Slack](https://docs.hellocobi.com/platform/channels/slack/overview.md): Use Cobi inside Slack to ask questions, create charts, and share answers with your team
- [Install Slack](https://docs.hellocobi.com/platform/channels/slack/install.md): Connect a Slack workspace to a Cobi organization
- [Using Cobi in Slack](https://docs.hellocobi.com/platform/channels/slack/using-cobi.md): Ask Cobi questions in channels, DMs, and threads
- [Slash Commands](https://docs.hellocobi.com/platform/channels/slack/slash-commands.md): Reference for the /cobi command in Slack
- [Account Linking](https://docs.hellocobi.com/platform/channels/slack/account-linking.md): Connect your Slack user to your Cobi account
- [Slack Troubleshooting](https://docs.hellocobi.com/platform/channels/slack/troubleshooting.md): Fix common Cobi Slack setup and usage issues
- [Quickstart](https://docs.hellocobi.com/quickstart.md): Make your first API call to the Cobi Data API
- [Authentication](https://docs.hellocobi.com/authentication.md): Secure your Cobi API requests with Bearer token authentication
- [Overview](https://docs.hellocobi.com/api-reference/data/overview.md): The Cobi Data API provides a consistent interface for uploading different types of structured data into the Cobi system for analytics and segmentation.
- [Customers](https://docs.hellocobi.com/api-reference/data/endpoint/customers.md): Upload customer records to the Cobi Data API.
- [Transactions](https://docs.hellocobi.com/api-reference/data/endpoint/transactions.md): Upload transaction records to the Cobi Data API.
- [Offers](https://docs.hellocobi.com/api-reference/data/endpoint/offers.md): Upload offer records to the Cobi Data API
- [Shops](https://docs.hellocobi.com/api-reference/data/endpoint/shops.md): Upload shop records to the Cobi Data API.
- [Branches](https://docs.hellocobi.com/api-reference/data/endpoint/branches.md): Upload branch records to the Cobi Data API.
- [Categories](https://docs.hellocobi.com/api-reference/data/endpoint/categories.md): Upload category records to the Cobi Data API.
- [Shop Categories](https://docs.hellocobi.com/api-reference/data/endpoint/shop-categories.md): Upload shop category mappings to the Cobi Data API
- [Tags](https://docs.hellocobi.com/api-reference/data/endpoint/tags.md): Upload tag records to the Cobi Data API.
- [Shop Tags](https://docs.hellocobi.com/api-reference/data/endpoint/shop-tags.md): Upload shop tag mappings to the Cobi Data API
- [Keywords](https://docs.hellocobi.com/api-reference/data/endpoint/keywords.md): Upload keyword records to the Cobi Data API.
- [Shop Keywords](https://docs.hellocobi.com/api-reference/data/endpoint/shop-keywords.md): Upload shop keyword mappings to the Cobi Data API
- [Student Favourites](https://docs.hellocobi.com/api-reference/data/endpoint/student-favourites.md): Upload student favourite mappings to the Cobi Data API.
- [Institutes](https://docs.hellocobi.com/api-reference/data/endpoint/institutes.md): Upload institute records to the Cobi Data API.
- [Courses](https://docs.hellocobi.com/api-reference/data/endpoint/courses.md): Upload course records to the Cobi Data API.
- [Interactions](https://docs.hellocobi.com/api-reference/data/endpoint/user-interactions.md): Record and retrieve user interactions with items (TAG, OFFER, SHOP, KEYWORD).
- [Customer Model](https://docs.hellocobi.com/api-reference/data/models/customer.md): The customer data model represents information about your customers in the Cobi system.
- [Transaction Model](https://docs.hellocobi.com/api-reference/data/models/transaction.md): The transaction data model represents purchase records in the Cobi system, including savings and discount information.
- [Offer Model](https://docs.hellocobi.com/api-reference/data/models/offer.md): The offer data model represents discounts and promotions in the Cobi system.
- [Shop Model](https://docs.hellocobi.com/api-reference/data/models/shop.md): The shop data model represents information about shops in the Cobi system.
- [Branch Model](https://docs.hellocobi.com/api-reference/data/models/branch.md): The category data model represents information about shop categories in the Cobi system.
- [Category Model](https://docs.hellocobi.com/api-reference/data/models/category.md): The category data model represents information about shop categories in the Cobi system.
- [Shop Category Model](https://docs.hellocobi.com/api-reference/data/models/shop-category.md): The shop category data model represents the mappings between shops and categories in the Cobi system.
- [Tag Model](https://docs.hellocobi.com/api-reference/data/models/tag.md): The tag data model represents information about tags in the Cobi system.
- [Shop Tag Model](https://docs.hellocobi.com/api-reference/data/models/shop-tag.md): The shop tag data model represents the mappings between shops and tags in the Cobi system.
- [Keyword Model](https://docs.hellocobi.com/api-reference/data/models/keyword.md): The keyword data model represents information about keywords in the Cobi system.
- [Shop Keyword Model](https://docs.hellocobi.com/api-reference/data/models/shop-keyword.md): The shop keyword data model represents the mappings between shops and keywords in the Cobi system.
- [Student Favourite Model](https://docs.hellocobi.com/api-reference/data/models/student-favourite.md): The student favourite data model represents the mappings between students and their favourite shops in the Cobi system.
- [Institute Model](https://docs.hellocobi.com/api-reference/data/models/institute.md): The institute data model represents information about educational institutions in the Cobi system.
- [Course Model](https://docs.hellocobi.com/api-reference/data/models/course.md): The course data model represents information about educational courses in the Cobi system.
- [Interaction Model](https://docs.hellocobi.com/api-reference/data/models/user-interaction.md): The user interaction data model represents a user's interaction with an item (TAG, OFFER, KEYWORD, or SHOP) in the Cobi system.
- [Overview](https://docs.hellocobi.com/api-reference/recommendations/overview.md): The Cobi Recommendations API provides personalized recommendations for customers and segments based on their preferences and behavior.
- [Customer Recommendations](https://docs.hellocobi.com/api-reference/recommendations/endpoint/customers.md): Get personalized recommendations for a specific customer based on their preferences and behavior.
- [Segment Recommendations](https://docs.hellocobi.com/api-reference/recommendations/endpoint/segments.md): Get recommendations for a specific customer segment based on collective preferences.
- [Customer Recommendation Model](https://docs.hellocobi.com/api-reference/recommendations/models/customer-recommendation.md): The customer recommendation model represents personalized recommendations for a specific customer in the Cobi system.
- [Segment Recommendation Model](https://docs.hellocobi.com/api-reference/recommendations/models/segment-recommendation.md): The segment recommendation model represents recommendations for a specific customer segment in the Cobi system.

## OpenAPI Specs

- [openapi](https://docs.hellocobi.com/openapi.yml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.