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.3.tar.gz (78.4 kB view details)

Uploaded Source

Built Distribution

summ-0.1.3-py3-none-any.whl (53.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: summ-0.1.3.tar.gz
  • Upload date:
  • Size: 78.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.3.tar.gz
Algorithm Hash digest
SHA256 69835ca03d731e15aff465320622fc5cd49913f253879c5846e3098bb61f3a83
MD5 34f6a6c49c4874cc135a3b330121bdb4
BLAKE2b-256 b9655dbfc9167d260fdbf927b4ccd283be16b53634176b79057e303584caab1b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: summ-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 53.3 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8cbc56c1feab5f003832342cd256a62fc79ac7329273255f073d38fd310d8ae5
MD5 14d6f6acb25db54943d27b3d114c0cbe
BLAKE2b-256 ae2667878dfc78b05dd2c97535eeacdd6b2c2e7cd67008b545f08296bcd48b85

See more details on using hashes here.

Supported by

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