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

Uploaded Source

Built Distribution

summ-0.1.2-py3-none-any.whl (43.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: summ-0.1.2.tar.gz
  • Upload date:
  • Size: 71.9 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.2.tar.gz
Algorithm Hash digest
SHA256 07fa6ca87f47c50982ad45ecdf0041743931aef2f7befae12331681d48920e86
MD5 27a12e476329121f5056b4fc2b456ce2
BLAKE2b-256 12dd9fb4adcdf72d8139a1a23e46f5ea4e35675409032fa6b638d7c451542942

See more details on using hashes here.

File details

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

File metadata

  • Download URL: summ-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 43.5 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a7c6b6d89642c616df65d32b7955b16e66818e3b6baffcac63c0fd268fe20814
MD5 3ce48e74954cd53991e9495f8f667771
BLAKE2b-256 4ebb32f4c2a418234448b4c441c005988ffbca20c311cdd1f0c71f91f2837fa2

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