ChatBees
  • 👋Welcome
  • Concepts
    • 📖Architecture
    • 📖Security
    • 📖Serverless RAG
    • 📖Namespace and Collection
    • 📖Access Control
    • 🚀Ticket AI Agent
  • Ticket AI Agent
    • Installation
  • WEB APP REFERENCES
    • 🔑Sign-in and Sign-out
    • ⛓️Manage Connectors
    • 🌏Manage Collections
      • 💿Data Sources
        • 📖Configure Periodic Import
      • ❓Chat with collection
      • ⏱️View Q/A history
      • 📖Publish a Collection
    • 🏛️Manage Users
    • 💰[Flex] Billing and Payment
    • 💰[Enterprise] Billing and Payment
    • 📈Account Usage
    • 🗝️API Keys
    • 🖥️Generated Code Sample
  • ChatBots
    • 🪄AI Chat for Confluence
    • 🪄ChatBees Slack Bot
    • 🪄ChatBees Website ChatBot
    • 🪄Pnyx Discord Bot
  • Snowflake Native App
  • API References
    • 📖API Key
    • 📖Collection Operations
      • 📖Create Collection
      • 📖Configure Collection
      • 📖List Collections
      • 📖Delete Collection
    • 📖Document Operations
      • 📖Upload Document
      • 📖Summarize Document
      • 📖Get Document Outlines and FAQs
      • 📖Ask
      • 📖Chat
      • 📖Search
      • 📖Personalize Response
      • 📖List Documents
      • 📖Delete Document
    • 📖Crawl Operations
      • 📖Create Crawl
      • 📖Get Crawl
      • 📖Index Crawl
      • 📖Delete Crawl
    • 📖Ingest Data Sources
      • 📖Create Ingestion
      • 📖Get Ingestion
      • 📖Index Ingestion
      • 📖Delete Ingestion
Powered by GitBook
On this page
  1. API References
  2. Collection Operations

Configure Collection

PreviousCreate CollectionNextList Collections

Last updated 10 months ago

Configure Collection

You can easily enable/disable whether a collection is publicly readable, or update the description of a collection.

The public_read flag makes the collection publicly readable. You could send an ask request with no Api-Key. This is useful when you want to expose such as a chatbot on your website to automatically answer questions from customers.

, the simple chatbot, you can customize and add to your website.

POST /collections/configure HTTP/1.1
Api-Key: my_api_key
Content-Type: application/json
Host: my_account_id.us-west-2.aws.chatbees.ai

{
  "namespace_name": "string",
  "collection_name": "string",
  // description is Optional
  "description": "string" or null,
  // Optional, whether the collection is publicly readable
  "public_read": bool or null,
}

Response:
{}
import chatbees as cb

# Configure to use the API key
cb.init(api_key="my_api_key", account_id='my_account_id')

# set public_read to true, if you want the collection to 
# be publicly readable
cb.configure_collection(collection_name='llm_research', public_read=True)
📖
📖
https://github.com/ChatBees/chatbees-chat-widget