Summ
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.
Requirements
You'll need an instance of Redis Stack running.
$ brew install --cask redis-stack/redis-stack/redis-stack-server
$ brew install yasyf/summ/redis-stack
$ brew services start yasyf/summ/redis-stack
You'll also need to set three environment variables: OPENAI_API_KEY, PINECONE_API_KEY, and PINECONE_ENVIRONMENT.
Installation
The easiest installation uses pip:
$ pip install summ
If you prefer to use brew:
$ brew install yasyf/summ/summ
n.b summ requires Python 3.10+.
Demo
You can confirm that summ installed properly by running the built-in example.
$ summ-example
Quickstart
First, create a new project with:
$ summ init /path/to/project
$ cd /path/to/project
An example implementation can now be found at /path/to/project/__init__.py.
As you can see, you don't need to do any configuration to start using summ. We 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:
- The categories of tags (and the tags within each category).
- A prompt directing how to apply the tags of a given category.
You can see an example of this at summ/examples/otter.
Docs
Check out the summ/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.
1 maintainer
Metadata
1 maintainer
Release files for summ 0.1.17
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| summ-0.1.17.tar.gz | 83.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| summ-0.1.17-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 178.8 kB
Release files / summ-0.1.17.tar.gz
| Download URL | summ-0.1.17.tar.gz |
|---|---|
| Size | 83.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4521e4997b4634af62a98e6d67678ad3acea5d65883d0dc7be820170ff69e74b
|
|
BLAKE2b-256 checksum How to use checksums |
1b047b41caa394a969150c542e2144d481b01d69d18927ef262f1fb18841d229
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.2
|
Release files / summ-0.1.17-py3-none-any.whl
| Download URL | summ-0.1.17-py3-none-any.whl |
|---|---|
| Size | 95.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9e4029e9e9afb49b0c2c3fabc767e0ad250e2feabfefcd900f6be7e711cefff2
|
|
BLAKE2b-256 checksum How to use checksums |
c75629d691a0c7290b4cd3f0fea703104866352bdff61a123836ca595fc657bf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.2
|
Security for summ 0.1.17
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
