📖Get Document Outlines and FAQs

After a document is uploaded, you can get the outlines and FAQs of the document. get_document_outline_faq() method returns the outlines and FAQs of the document in JSON format.

HTTP

POST /docs/get_outline_faq 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",
  "doc_name": "string"
}

Response:
{
  "outlines": ["outline1", "outline2", ...],
  "faqs": [
    {"question1": "answer1"},
    ...
  ]
}

Python

import chatbees as cb

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

resp = cb.collection('llm_research').get_document_outline_faq('file.pdf')
print(resp.outlines)
print(resp.faqs)