OpenSam


NameOpenSam JSON
Version 0.1b1 PyPI version JSON
download
home_pageNone
SummaryA GPT based slack bot trained to specific personalities and use cases.
upload_time2024-04-22 16:52:28
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseNone
keywords gpt ai slack openai bot
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![screenshot.png](screenshot.png)

# Sam – AI powered co-workers

[![PyPi Version](https://img.shields.io/pypi/v/opensam.svg)](https://pypi.python.org/pypi/opensam/)
[![Test Coverage](https://codecov.io/gh/voiio/sam/branch/main/graph/badge.svg)](https://codecov.io/gh/voiio/sam)
[![GitHub License](https://img.shields.io/github/license/voiio/sam)](https://raw.githubusercontent.com/voiio/sam/master/LICENSE)

Sam is an AI-powered co-worker to empower all your colleagues.
Sam lives in company's Slack workspace and is always ready to help.

## Features

Like any good co-worker Sam can

* 🧑‍💻search the web,
* 🌐browse websites,
* 🔎search your companies products,
* 📈read internal documents,
* 📧send emails,
* <img src="https://github.githubassets.com/images/icons/emoji/octocat.png" style="height:1em"> create GitHub issues,

and soon spend half the day in meetings and the other half in the kitchen.

Needless to say, Sam can do all of those things faster, cheaper and better
than most of your human colleagues 😏

## Installation
1. Create a new Slack app, as described below.
2. You will also need an OpenAI API key, which you can get from [here](https://platform.openai.com/api-keys).
3. You need to create a OpenAI Assistant [here](https://platform.openai.com/assistants) and copy the assistant ID.
4. With those tokens at the ready, just hit the button below and follow the instructions.

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/voiio/Sam)

### Create a Slack App

1. Create a new Slack App [here](https://api.slack.com/apps?new_app=1).
2. Select `From an app manifest` and enter the URL to the [slack-manifest.yml](slack-manifest.yml) file in this repo.
3. Click `Create App` and then `Install to Workspace`.
4. Copy the `Bot User OAuth Access Token` and paste it into the `SLACK_BOT_TOKEN` field in the Heroku app settings.
5. Create a new `App-Level Tokens` under `Basic Infomation` and copy the token into the `SLACK_APP_TOKEN` field in the Heroku app settings.


### How it works

Sam is a Slack bot that uses OpenAI's ChatGPT latest and grates AI model
to provide a work-colleague like experience, right in your Slack workspace.

Everyone in your company has instant access to the most powerful AI companion.

Sam uses OpenAI's assistant API to fine-tune ChatGPT to:

* a specific personality traits,
* provide domain specific knowledge
* and company specific context

to provide a work-colleague like experience.

![meme](https://repository-images.githubusercontent.com/726003479/24d020ac-3ac5-401c-beae-7a6103c4e7ae)


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "OpenSam",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "GPT, AI, Slack, OpenAI, bot",
    "author": null,
    "author_email": "Johannes Maron <johannes@maron.family>",
    "download_url": "https://files.pythonhosted.org/packages/67/f5/c0f75170eb292302f0e52539a38e0832ad0581a1cf525ac9a902e6201545/opensam-0.1b1.tar.gz",
    "platform": null,
    "description": "![screenshot.png](screenshot.png)\n\n# Sam \u2013 AI powered co-workers\n\n[![PyPi Version](https://img.shields.io/pypi/v/opensam.svg)](https://pypi.python.org/pypi/opensam/)\n[![Test Coverage](https://codecov.io/gh/voiio/sam/branch/main/graph/badge.svg)](https://codecov.io/gh/voiio/sam)\n[![GitHub License](https://img.shields.io/github/license/voiio/sam)](https://raw.githubusercontent.com/voiio/sam/master/LICENSE)\n\nSam is an AI-powered co-worker to empower all your colleagues.\nSam lives in company's Slack workspace and is always ready to help.\n\n## Features\n\nLike any good co-worker Sam can\n\n* \ud83e\uddd1\u200d\ud83d\udcbbsearch the web,\n* \ud83c\udf10browse websites,\n* \ud83d\udd0esearch your companies products,\n* \ud83d\udcc8read internal documents,\n* \ud83d\udce7send emails,\n* <img src=\"https://github.githubassets.com/images/icons/emoji/octocat.png\" style=\"height:1em\"> create GitHub issues,\n\nand soon spend half the day in meetings and the other half in the kitchen.\n\nNeedless to say, Sam can do all of those things faster, cheaper and better\nthan most of your human colleagues \ud83d\ude0f\n\n## Installation\n1. Create a new Slack app, as described below.\n2. You will also need an OpenAI API key, which you can get from [here](https://platform.openai.com/api-keys).\n3. You need to create a OpenAI Assistant [here](https://platform.openai.com/assistants) and copy the assistant ID.\n4. With those tokens at the ready, just hit the button below and follow the instructions.\n\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/voiio/Sam)\n\n### Create a Slack App\n\n1. Create a new Slack App [here](https://api.slack.com/apps?new_app=1).\n2. Select `From an app manifest` and enter the URL to the [slack-manifest.yml](slack-manifest.yml) file in this repo.\n3. Click `Create App` and then `Install to Workspace`.\n4. Copy the `Bot User OAuth Access Token` and paste it into the `SLACK_BOT_TOKEN` field in the Heroku app settings.\n5. Create a new `App-Level Tokens` under `Basic Infomation` and copy the token into the `SLACK_APP_TOKEN` field in the Heroku app settings.\n\n\n### How it works\n\nSam is a Slack bot that uses OpenAI's ChatGPT latest and grates AI model\nto provide a work-colleague like experience, right in your Slack workspace.\n\nEveryone in your company has instant access to the most powerful AI companion.\n\nSam uses OpenAI's assistant API to fine-tune ChatGPT to:\n\n* a specific personality traits,\n* provide domain specific knowledge\n* and company specific context\n\nto provide a work-colleague like experience.\n\n![meme](https://repository-images.githubusercontent.com/726003479/24d020ac-3ac5-401c-beae-7a6103c4e7ae)\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A GPT based slack bot trained to specific personalities and use cases.",
    "version": "0.1b1",
    "project_urls": {
        "Changelog": "https://github.com/voiio/Sam/releases",
        "Documentation": "https://code.voiio.de/Sam/",
        "Project-URL": "https://github.com/voiio/Sam/"
    },
    "split_keywords": [
        "gpt",
        " ai",
        " slack",
        " openai",
        " bot"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3b226099ad5722450cf925607ea3097f96d68adeb479cb29581c38ed3fd6e237",
                "md5": "b5fb9d94ad03f1a546c7b8fbfbec8f3f",
                "sha256": "ab4f0afbf3f9c5799645458b6df913aa779e3c0022bb9fc9f672d67bf0ce9f07"
            },
            "downloads": -1,
            "filename": "opensam-0.1b1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b5fb9d94ad03f1a546c7b8fbfbec8f3f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 23142,
            "upload_time": "2024-04-22T16:52:27",
            "upload_time_iso_8601": "2024-04-22T16:52:27.670537Z",
            "url": "https://files.pythonhosted.org/packages/3b/22/6099ad5722450cf925607ea3097f96d68adeb479cb29581c38ed3fd6e237/opensam-0.1b1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "67f5c0f75170eb292302f0e52539a38e0832ad0581a1cf525ac9a902e6201545",
                "md5": "2a98d7ea5fccb694ca25152e28c76e0d",
                "sha256": "403d85576af6674992420be6d35deff1282f135a7b68c9b59fee2a9e7ad2d0e7"
            },
            "downloads": -1,
            "filename": "opensam-0.1b1.tar.gz",
            "has_sig": false,
            "md5_digest": "2a98d7ea5fccb694ca25152e28c76e0d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 19655,
            "upload_time": "2024-04-22T16:52:28",
            "upload_time_iso_8601": "2024-04-22T16:52:28.852626Z",
            "url": "https://files.pythonhosted.org/packages/67/f5/c0f75170eb292302f0e52539a38e0832ad0581a1cf525ac9a902e6201545/opensam-0.1b1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-22 16:52:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "voiio",
    "github_project": "Sam",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "opensam"
}
        
Elapsed time: 0.23513s