llm-search

pyLLMSearchは、ローカルドキュメントのコレクションと対話するための高度な質問応答システムを提供します。YAMLベースの設定を使用し、文書解析やハイブリッド検索、カスタマイズ可能な埋め込みなどの機能を強化しています。OpenAIやローカルにインストールしたLLMと連携可能です。

GitHubスター

624

ユーザー評価

未評価

お気に入り

0

閲覧数

7

フォーク

67

イシュー

6

インストール方法
難易度
中級
推定所要時間
10-20
必要な環境
Python 3.7 or higher
pip latest version

インストール方法

インストール方法

前提条件

必要なソフトウェアとバージョンを明記してください。
Python: 3.7以上
pip: 最新版

インストール手順

1. リポジトリのクローン

bash
git clone https://github.com/snexus/llm-search.git
cd llm-search

2. 依存関係のインストール

bash
pip install -r requirements.txt

3. サーバーの起動

bash
python -m llm_search.server

トラブルシューティング

よくある問題

問題: サーバーが起動しない 解決策: Pythonのバージョンを確認し、依存関係を再インストールしてください。 問題: ドキュメントが正しく解析されない 解決策: ドキュメント形式がサポートされているか確認してください。

設定方法

設定方法

基本設定

YAML設定ファイルの作成

config.yamlを作成し、以下のように設定します:
yaml
llm:
  model: "openai"
  api_key: "your-api-key"
documents:
  folder: "path/to/documents"

環境変数

必要に応じて以下の環境変数を設定:
bash
export API_KEY="your-api-key"

詳細設定

セキュリティ設定

APIキーは環境変数または安全な設定ファイルに保存
ファイルアクセス権限の適切な設定

パフォーマンス調整

タイムアウト値の設定
同時実行数の制限

設定例

yaml
llm:
  model: "huggingface"
  api_key: "your-api-key"
documents:
  folder: "./data"

使用例

使用例

基本的な使用方法

Jupyter Notebookでの使用

python
from llm_search import LLMSearch

search = LLMSearch(api_key="your-api-key")
results = search.query("特定の質問")
print(results)

応用例

自動化スクリプト

bash
#!/bin/bash

バッチ処理の例

for file in *.txt; do llm-search process "$file" done

使用ケース

企業のナレッジベースを検索し、関連情報を迅速に取得する
学術論文を解析し、特定のトピックに関する質問に答える
カスタムチャットボットを構築し、ユーザーの質問に対して文脈に基づいた回答を提供する
PDFマニュアルから特定の手順を抽出し、ユーザーに提示する

追加リソース