semantic ai

시맨틱 ai lib

RAG (Resprieval-Augmented System)를위한 오픈 소스 프레임 워크 (RAG)는 시맨틱 검색을 사용하여 예상 결과를 검색하고 LLM (대형 언어 모델)의 도움으로 인간이 읽을 수있는 대화 반응을 생성합니다.

시맨틱 AI 라이브러리 문서 문서 문서

요구 사항

Python 3.10+ Asyncio

설치

 # Using pip
$ python -m pip install semantic-ai

# Manual install
$ python -m pip install .

환경 변수를 설정하십시오

.env 파일에서 자격 증명을 설정하십시오. 하나의 커넥터, 하나의 인덱서 및 하나의 LLM 모델 구성에 대한 자격 증명 만 제공하십시오. 다른 필드는 비어 있습니다

 # Default
FILE_DOWNLOAD_DIR_PATH= # default directory name 'download_file_dir'
EXTRACTED_DIR_PATH= # default directory name 'extracted_dir'

# Connector (SharePoint, S3, GCP Bucket, GDrive, Confluence etc.,)
CONNECTOR_TYPE= " connector_name " # sharepoint
SHAREPOINT_CLIENT_ID= " client_id "
SHAREPOINT_CLIENT_SECRET= " client_secret "
SHAREPOINT_TENANT_ID= " tenant_id "
SHAREPOINT_HOST_NAME= ' <tenant_name>.sharepoint.com '
SHAREPOINT_SCOPE= ' https://graph.microsoft.com/.default '
SHAREPOINT_SITE_ID= " site_id "
SHAREPOINT_DRIVE_ID= " drive_id "
SHAREPOINT_FOLDER_URL= " folder_url " # /My_folder/child_folder/

# Indexer
INDEXER_TYPE= " <vector_db_name> " # elasticsearch, qdrant, opensearch
ELASTICSEARCH_URL= " <elasticsearch_url> " # give valid url
ELASTICSEARCH_USER= " <elasticsearch_user> " # give valid user
ELASTICSEARCH_PASSWORD= " <elasticsearch_password> " # give valid password
ELASTICSEARCH_INDEX_NAME= " <index_name> "
ELASTICSEARCH_SSL_VERIFY= " <ssl_verify> " # True or False

# Qdrant
QDRANT_URL= " <qdrant_url> "
QDRANT_INDEX_NAME= " <index_name> "
QDRANT_API_KEY= " <apikey> "

# Opensearch
OPENSEARCH_URL= " <opensearch_url> "
OPENSEARCH_USER= " <opensearch_user> "
OPENSEARCH_PASSWORD= " <opensearch_password> "
OPENSEARCH_INDEX_NAME= " <index_name> "

# LLM
LLM_MODEL= " <llm_model> " # llama, openai
LLM_MODEL_NAME_OR_PATH= " " # model name
OPENAI_API_KEY= " <openai_api_key> " # if using openai

# SQL
SQLITE_SQL_PATH= " <database_path> " # sqlit db path

# MYSQL
MYSQL_HOST= " <host_name> " # localhost or Ip Address
MYSQL_USER= " <user_name> "
MYSQL_PASSWORD= " <password> "
MYSQL_DATABASE= " <database_name> "
MYSQL_PORT= " <port> " # default port is 3306

방법 1 : .env 파일을로드합니다. ENV 파일에는 자격 증명이 있어야합니다

%load_ext dotenv
%dotenv
%dotenv relative/or/absolute/path/to/.env

(or)

dotenv -f .env run -- python

방법 2 : 방법 2.

 from semantic_ai . config import Settings
settings = Settings ()

비 구조

1. 모듈을 가져옵니다

 import asyncio
import semantic_ai

2. 주어진 소스에서 파일을 다운로드하려면 다운로드 된 파일에서 컨텐츠를 추출하고 주어진 벡터 DB에서 추출 된 데이터를 색인하십시오.

 await semantic_ai . download ()
await semantic_ai . extract ()
await semantic_ai . index ()

다운로드, 추출 및 색인이 완료된 후 인덱스 벡터 DB로부터 답을 생성 할 수 있습니다. 아래에 주어진 코드.

3. 검색 LLM 모델을 사용하여 인덱스 벡터 DB로부터 답을 생성합니다.

 search_obj = await semantic_ai . search ()
query = ""
search = await search_obj . generate ( query )

작업이 오랫동안 실행되고 있다고 가정하고, 처리 된 파일 수, 파일 수에 실패했으며, 'extracted_dir_path/meta'디렉토리에서 처리되고 실패한 텍스트 파일에 저장된 파일 이름을 볼 수 있습니다.

예

소스를 연결하고 연결 객체를 가져옵니다. 예제 폴더에서 볼 수 있습니다. 예 : SharePoint 커넥터

 from semantic_ai . connectors import Sharepoint

CLIENT_ID = '<client_id>'  # sharepoint client id
CLIENT_SECRET = '<client_secret>'  # sharepoint client seceret
TENANT_ID = '<tenant_id>'  # sharepoint tenant id
SCOPE = 'https://graph.microsoft.com/.default'  # scope
HOST_NAME = "<tenant_name>.sharepoint.com"  # for example 'contoso.sharepoint.com'

# Sharepoint object creation
connection = Sharepoint (
    client_id = CLIENT_ID ,
    client_secret = CLIENT_SECRET ,
    tenant_id = TENANT_ID ,
    host_name = HOST_NAME ,
    scope = SCOPE
)

구조

1. 모듈을 가져옵니다

 import asyncio
import semantic_ai

2. 데이터베이스 연결

sqlite :

 from semantic_ai . connectors import Sqlite

file_path = < database_file_path >

sql = Sqlite ( sql_path = file_path )

mysql :

 from semantic_ai . connectors import Mysql

sql = Mysql (
    host = < host_name > ,
    user = < user_name > ,
    password = < password > ,
    database = < database > ,
    port = < port_number >  # 3306 is default port
)

3. 검색 LLM 모델을 사용하여 DB로부터 답을 생성합니다.

 query = ""
search_obj = await semantic_ai . db_search ( query = query )

서버에서 실행하십시오

$ semantic_ai serve -f .env

INFO:     Loading environment from ' .env '
INFO:     Started server process [43973]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

http://127.0.0.1:8000/semantic-ai에서 브라우저를 엽니 다

대화식 API 문서

이제 http://127.0.0.1:8000/docs로 이동하십시오. 자동 대화 형 API 문서 (Swagger UI에서 제공)를 볼 수 있습니다.