open source slack ai

오픈 소스 슬랙 AI 앱

이 저장소는 즉시 호스팅하고 OpenAI를 사용하여 주문형 스레드 및 채널을 요약 할 수있는 능력을 잠금 해제 할 수있는 기본적인 기본 슬랙 AI 솔루션입니다 (수요가있는 경우 대체 및 오픈 소스 LLM에 대한 지원이 추가됩니다). 공식 Slack AI 제품은 훌륭해 보이지만 액세스 및 애드온 가격이 제한되어있어 2023 년 9 월에 제작 한 버전을 오픈 소스로 결정했습니다. 오픈 소스 슬랙 AI를 구축 한 방법과 이유에 대해 자세히 알아보십시오.

일단 가동되고 실행되면 (전체 프로세스에 대한 지침은 아래에 제공됨) 모든 Slack 사용자는 공개 및 개인 모두에게 생성 할 수 있습니다.

1. 스레드 요약 -모든 슬랙 스레드에 대한 자세한 요약 (GPT-3.5-Turbo로 전원)을 생성합니다.
2. 채널 개요 - 확장 메시지 기록을 기반으로 채널 목적의 개요를 생성합니다 (NLP 모델의 앙상블과 자연 언어로의 분석을 설명하기 위해 작은 GPT -4로 구동).
3. 채널 요약 이후 -주어진 시점 (GPT-3.5-Turbo로 구동) 이후 채널 메시지에 대한 자세한 요약을 생성합니다. 이제 커스텀 프롬프트를 지원합니다! 예 : /tldr_since anonymize the summary . 참고 : 여기에는 아직 스레드가 포함되지 않습니다.
4. 전체 채널 요약 (실험)-채널의 확장 기록 (GPT-3.5-Turbo로 구동)에 대한 자세한 요약을 생성합니다. 이제 커스텀 프롬프트를 지원합니다! 예 /tldr_extended anonymize the summary . 참고 : 이것은 매우 길어질 수 있습니다!

목차

• 시작하기
  • 전제 조건
  • 설치
  • 용법
  • 사용자 정의
• 테스트
• 향후 향상
• 기여

시작하기

이 지침을 따르면 개발 및 테스트 목적으로 프로젝트 사본을 현지 기계에서 실행하고 실행하십시오.

전제 조건

지역 개발 기계에 다음과 같은 미리 구성되거나 설치되어 있는지 확인하십시오.

• 파이썬 3.9.x -3.11.x
• Openai API 키
• 슬랙 앱 및 관련 API 토큰
• 시 패키지 관리자
• ngrok (권장)

설치

1. 저장소를 로컬 컴퓨터로 복제하십시오.
2. 프로젝트 디렉토리로 이동하십시오.
3. 시를 사용하여 필요한 파이썬 패키지를 설치하십시오.

poetry install

4. 사전 모델을 설치하십시오

poetry run python -m spacy download en_core_web_md

5. 프로젝트의 루트 디렉토리에 .env 파일을 만들고 API 키 및 토큰으로 채우십시오. example.env 파일을 템플릿으로 사용하십시오.

cp example.env .env && open .env

슬랙 앱 구성

manifest.json 의 사본을 작성하고 요청 URL을 NGROK 또는 서버 URL로 변경하십시오.

여기에 새 슬랙 앱을 만들고 manifest.yaml 파일을 사용하여 구성하십시오.

다른 변경을 할 필요는 없지만 이름, 설명 및 기타 사본 관련 설정을 변경할 수 있습니다.

슬래시 명령의 이름을 조정하려면 slack_server.py 수정해야합니다.

구성되면 "앱 설치"페이지에서 "Bot User Oauth Token"을 검색하고 SLACK_BOT_TOKEN 으로 .env 파일에 추가하십시오.

그런 다음 앱 레벨 토큰 제목 아래의 기본 정보 페이지에서 스코프 connections:write 과 SLACK_APP_TOKEN 토큰 .env 만듭니다.

용법

응용 프로그램을 실행하려면 FastApi 서버를 실행하십시오.

poetry run uvicorn ossai.slack_server:app --reload

그런 다음 Ngrok을 사용하여 서버를 인터넷에 노출시켜야합니다.

다음 명령으로 ngrok을 실행하십시오 : ngrok http 8000

그런 다음 Slack 앱의 설정에 Ngrok URL을 추가하십시오.

사용자 정의

주요 사용자 정의 옵션은 다음과 같습니다.

• 채널 요약 : topic_analysis.py 에서 chatgpt 프롬프트를 사용자 정의합니다
• 스레드 요약 : summarizer.py 에서 chatgpt 프롬프트를 사용자 정의합니다

테스트

이 프로젝트는 pytest 및 pytest-cov 사용하여 테스트를 실행하고 테스트 범위를 측정합니다.

다음 단계에 따라 적용 범위로 테스트를 실행하십시오.

1. 프로젝트 루트 디렉토리로 이동하십시오.

2. 다음 명령을 실행하여 적용 범위로 테스트를 실행하십시오.

   pytest --cov=ossai tests/

   이 명령은 tests/ 디렉토리에서 모든 테스트를 실행하고 ossai 모듈에 대한 커버리지 보고서를 생성합니다.

3. 테스트를 실행 한 후 터미널에서 테스트로 덮인 코드의 백분율을 보여주는 보고서가 표시되고 덮여 있지 않은 라인을 강조 표시합니다.

가상 환경을 사용하는 경우이 명령을 실행하기 전에 활성화되어 있는지 확인하십시오.

향후 향상

• 확장, 추적 및 제어를 위해 Langchain & Langsmith로 이동
• Langsmith의 피드백 기능을 활용하여 사용자 피드백에서 캡처 및 학습
• 주어진 날짜 이후 채널의 메시지를 요약하려면 a /tldr_since 명령을 추가하십시오.
• readme에 슬랙 앱 설정 세부 정보 및 샘플 앱 매니페스트 추가
• 채널 수준 요약에 나사회 대화를 통합하십시오
• 단위 테스트를 보완하기 위해 EVALS Suite를 구현하십시오
• 대체 및 오픈 소스 LLM에 대한 지원을 추가하십시오
• 비용 절감을위한 데이터 및 미세 조정 모델 수집을위한 워크 플로 탐색
• 익명 메시지 요약에 대한 지원을 추가하십시오
• 데스티니 체인과 같은 프롬프트 도구를 활용하십시오
• 회사 지식 기반과 같은 외부 소스에서 지원 컨텍스트를 끌어 당기기위한 지원 추가
• 캐싱 및 기타 성능 최적화를 탐색하십시오
• 감정 분석을 탐색하십시오

기여

나는 환영 기부 이상의 기여 이상! 피드백, 버그, 기능 요청, 개선 사항 또는 자신의 풀 요청을 제출하는 방법에 대한 자세한 내용은 CONTRIBUTING.md 읽으십시오.

특허

이 프로젝트는 GPL -3.0 라이센스에 따라 라이센스가 부여됩니다. 자세한 내용은 LICENSE.md 파일을 참조하십시오.