Skip to main content

Summ provides intelligent question-answering and search capabilities across user interview transcripts.

Project description

Summ

PyPI - Version PyPI - Python Version


Summ uses ChatGPT to provide intelligent question-answering and search capabilities across user transcripts!

Easily surface insights and summarize facts across various dimensions such as department, industry, and role. With the help of natural language processing, the tool can understand and respond to complex questions and queries, making it easy for users to find the information they need.

A tool by @markiewagner and @yasyf.

asciicast

Installation

pip install summ

You'll need an instance of Redis Stack running. We've found that brew install redis-stack/redis-stack/redis-stack is the fastest way to get up and running.

You'll also need to set two environment variables: OPENAI_API_KEY, and PINECONE_API_KEY

Quickstart

You don't need to do any configuration to start using summ. Simply use summ.Pipeline.default and pass a path to a directory with text files.

However, the tool works much better when users are tagged. In order to do so, you need to specify two things:

  1. The categories of tags (and the tags within each category).
  2. A prompt directing how to apply the tags of a given category.

You can see an example of this at examples/otter.

Docs

Check out the examples directory for some samples, or dive into the full docs at summ.readthedocs.io.

License

summ is distributed under the terms of the AGPL 3.0 license.

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

summ-0.1.1.tar.gz (66.4 kB view details)

Uploaded Source

Built Distribution

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

summ-0.1.1-py3-none-any.whl (35.7 kB view details)

Uploaded Python 3

File details

Details for the file summ-0.1.1.tar.gz.

File metadata

  • Download URL: summ-0.1.1.tar.gz
  • Upload date:
  • Size: 66.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for summ-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c4cea36ec9fdde2625558969693d74d5a54cc56fe2a9fd090a4fd49a5da5e064
MD5 eab11db1ead1bf0f2df95045718e4f36
BLAKE2b-256 ab0ed172dafd84795b937b7a116f6b0b30b040ce48a53a6c0f64195f7640d989

See more details on using hashes here.

File details

Details for the file summ-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: summ-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 35.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for summ-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1260134520d75a433576212c526feb9e091c0db93f49293991af0804f7dcae39
MD5 6a6ec42b1fa1bb09a0b54b42bc6a8d89
BLAKE2b-256 751f04606941595888f0b4a8d4d96a06656ab35d76cff14c88ea13eab6196449

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