Skip to main content

A questions and answers tool service for Parlant

Project description

Parlant Logo

Parlant Q&A: A Questions/Answers Tool Service for Parlant

Website | Introduction | Installation | Tutorial | About

PyPI - Version PyPI - Python Version Apache 2 License GitHub last commit Discord

A dynamic question-answering tool service that helps your Parlant agents provide accurate, traceable responses based on your FAQ data.

What is this?

This tool service enables your Parlant agents to answer questions based on a managed set of questions and answers that you provide.

✨ Key Features ✨

The service carefully evaluates each question against your FAQ, providing:

  • 📝 Detailed explanation of how the question was interpreted in light of the FAQ
  • 📚 References to specific source material used (question IDs and relevant quotes)
  • 🔍 Complete traceability for each response through session events in Parlant sessions (via tool events)
  • 🛡️ Protection against hallucination - if the information isn't in your knowledge base, the agent won't make up an answer

🚀 Getting Started

You can run the service in two ways:

# As a standalone server
parlant-qna server

# Or as a hosted module within your Parlant server
parlant --module parlant_qna.module

📚 Adding FAQs

Add question/answer pairs dynamically through the CLI:

$ parlant-qna add \
    -q "What are your business hours?" \
    -a "We're open Monday through Friday, 9 AM to 5 PM Eastern Time."

⚡⚙️ How It Works

When your agent needs to answer a question, it calls the find_answer tool through the qna service. The service then:

  1. Evaluates the question for proper context and intent
  2. Searches your FAQs for relevant information
  3. Constructs an answer using only verified information
  4. Records the entire process as a tool event in the session
  5. Returns both the answer and detailed metadata about sources used

Example response:

{
  "answer": "We're open Monday through Friday, 9 AM to 5 PM Eastern Time.",
  "evaluation": "Question seeks information about operational hours, which is provided in the background information",
  "references": [
    {
      "question_id": "dja8-108fj",
      "quotes": ["Monday through Friday, 9 AM to 5 PM Eastern Time"]
    }
  ]
}

💡 Use Cases

Perfect for:

  • Building customer service agents that need accurate, verifiable answers
  • Creating internal support bots that can explain their reasoning
  • Developing agents that need to provide source references for their responses
  • Ensuring compliance by preventing agents from making up information

🤝🛠️ Contributing

We're actively developing this tool service. If you'd like to contribute, please:

  1. Check our issue tracker for current needs
  2. Join our Discord community for discussion
  3. Submit pull requests with improvements

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

parlant_qna-0.1.0.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

parlant_qna-0.1.0-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

Details for the file parlant_qna-0.1.0.tar.gz.

File metadata

  • Download URL: parlant_qna-0.1.0.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.10.5 Darwin/23.5.0

File hashes

Hashes for parlant_qna-0.1.0.tar.gz
Algorithm Hash digest
SHA256 eec734a1996f15f155fd5443ec443334279ce9da0cd6610e8ec3eaa20229e494
MD5 494005ffc6103be53475ce8ad9668eba
BLAKE2b-256 983440e544e32d4ccc254c53b218f53b47107fe9ad9eea94f901199ea852f41c

See more details on using hashes here.

File details

Details for the file parlant_qna-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: parlant_qna-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.10.5 Darwin/23.5.0

File hashes

Hashes for parlant_qna-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f7905997e3793f24e1c6f1bc5a94d5770d63cb0a3b76628de1b39e7dd1c5bfe3
MD5 fdb263653d748ae136facb757360fbc6
BLAKE2b-256 cbc275345d772d977611de365264481e90c6228aadd114528dd47c200a14ad99

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page