はじめに
SmartReadは、技術文書向けに設計されたAIベースのオープンソースツールです。PDFファイルを自動的に分析し、重要な用語や見出し、核となる考え方など、重要なコンテンツに注釈を付け、ユーザーが複雑な文書を素早く理解できるようにします。同時に、文書の主題に関連する記事やビデオのリンクも提供できるので、学習がより包括的になる。smartReadは技術者、学生、研究者に適しており、特に技術的なPDFを効率的に読む必要がある人に便利です。
機能一覧
- 技術PDFに注釈を自動的に追加し、用語、見出し、強調箇所などの重要なコンテンツを強調表示します。
- 文書の内容に基づいて関連記事やビデオを推薦し、理解を深める。
- 幅広い技術的なPDFファイルの処理をサポートし、複雑な文書を読みやすくします。
- すべてのハイライトと注釈を保持したまま、注釈付きPDFファイルをダウンロードできます。
- オープンソースの設計により、ユーザーはコードを閲覧したり、機能を修正したり、改善のための提案を提出したりすることができる。
ヘルプの使用
SmartReadは、GitHubでホストされているオープンソースプロジェクトで、使用するにはインストールと設定が必要です。以下は、ダウンロードから稼働までの詳細な手順です。
設置プロセス
SmartReadは、フロントエンドとバックエンドの2つの部分で動作し、開発環境を準備する必要があります。以下に具体的なインストール手順を示す：
環境を整える
- 基本工具の取り付け
- Gitのダウンロード
git-scm。)でクローンコードを作成する。 - Node.jsをインストールする（バージョン18以上。
nodejs.org)をフロントエンドに使用する。 - Pythonをインストールする（バージョン3.12.
python.org)をバックエンドのローカル開発に使用する。 - Dockerをインストールする
ドッカードットコム)をバックエンドのコンテナで実行する。
- Gitのダウンロード
- ダウンロードコード
- ターミナルを開いて実行する：
git clone https://github.com/Dev-Khant/smartread.git cd smartread
- ターミナルを開いて実行する：
- 環境変数の設定
- 例のファイルをコピーする：
cp backend/.env.example backend/.env cp web/.env.example web/.env.local - コンパイラ
バックエンド/.env鍵は各自でご用意ください）：PORT=8000 HOST=0.0.0.0 ENVIRONMENT=開発環境 MONGODB_URL=mongodb:// あなたの MongoDB アドレス MISTRAL_API_KEY=あなたの Mistral キー GROQ_API_KEY=あなたの Groq キー。 CLOUDINARY_CLOUD_NAME=あなたの Cloudinary 名。 CLOUDINARY_API_KEY=あなたの Cloudinary キー CLOUDINARY_API_SECRET=あなたのCloudinary秘密鍵 - コンパイラ
web/.env.local::next_public_backend_api_url=http://localhost:8000
- 例のファイルをコピーする：
フロントエンドのインストールと実行
- フロントエンド・ディレクトリに移動する：
CDウェブ
- 依存関係をインストールします：
npmインストール
- フロントエンドを開始する：
npm run dev
- ブラウザを開き、次のサイトにアクセスする。
http://localhost:3000フロントエンドのインターフェイスを見ることができる。
バックエンドのインストールと実行
- Dockerの使用（推奨）
- バックエンドのディレクトリに移動する：
cd バックエンド
- 鏡像を作る：
docker build -t smartread-backend .
- コンテナを実行する：
docker run -p 8000:8000 --env-file .env smartread-backend
- ローカル開発（Dockerなし）
- バックエンドのディレクトリに移動する：
cd バックエンド
- 仮想環境を作成し、起動する：
python -m venv .venv
source .venv/bin/activate # Windows with .venvScriptsactivate
- 依存関係をインストールします：
pip install -r requirements.txt
- バックエンドを開始する：
uvicorn main:app --reload --host 0.0.0.0 --port 8000
主な機能の使い方
インストールすると、SmartReadの中核機能は、PDF処理とリソースの推奨を中心に展開する。
機能1：自動注釈技術PDF
- 手続き
- 技術的なPDFファイル（論文やマニュアルなど）を用意する。
- フロントエンド・インターフェースへのファイルのアップロード (
http://localhost:3000)、またはバックエンド/入力フォルダー - フロントエンドで "Upload and Label "をクリックするか、バックエンドで実行する：
python main.py --file input/your filename.pdf
- 処理が完了すると、注釈付きPDFが
バックエンド/アウトプットフォルダー
- 機能説明
SmartReadの使い方 ミストラルAI 歌で応える グロック このモデルは文書を分析し、重要なコンテンツを特定し、ハイライトや注釈を追加します。注釈の結果はPDF上に表示され、素早く簡単に読むことができます。
機能2：関連リソースへのアクセス
- 手続き
- フロントエンドのインターフェイスでPDFをアップロードした後、「関連リソースを取得」ボックスにチェックを入れます。
- あるいはバックエンドで走る：
python main.py --file input/your filename.pdf --resources
- 処理が完了すると、インターフェイスや端末に記事やビデオへのリンクが表示される。
- 機能説明
システムはPDFの内容に基づいてウェブを検索し、関連する技術記事やビデオを推薦します。リンクはMongoDBに保存され、Cloudinaryによって管理されます。
機能3：注釈付きPDFのダウンロード
- 手続き
- フロントエンドのインターフェイスで "Download "をクリックするか、次のサイトにアクセスする。
バックエンド/アウトプットフォルダー - 見つける
ファイル名_annotated.pdf直接保存してください。
- 機能説明
注釈付きPDFは、元のテキストに新しいハイライトと注釈を加えたもので、共有やアーカイブが簡単にできます。
注目の機能操作
オープンソース貢献
- 手続き
- コードを修正し、GitHubにコミットする：
git add .
git commit -m "あなたの変更メモ"
git push origin main
- GitHubでPull Requestを作成する。
- 機能説明
SmartReadはMITライセンスを使用し、AIモデルやインターフェースを改良するための開発への参加をユーザーに奨励している。
ほら
- MongoDB、Mistral AI、Groq、Cloudinaryのキーが正しく設定されていることを確認してください。
- 現在のバージョンは英語の技術文書に適していますが、中国語のサポートは最適化する必要があるかもしれません。
- Dockerの方が安定しているので、最初に使うことをお勧めする。
この手順で、SmartRead Processing Technology PDFをそのまま使うことができます。使いやすく、直感的な結果が得られるので、深い読みが必要な方に最適です。
アプリケーションシナリオ
- 学術研究
SmartReadは、生徒が論文に取り組む際に、重要なポイントを強調表示し、関連リソースを提案することで、検索時間を節約します。 - 技術開発
プログラマーは、APIドキュメントを読みながら重要なパラメーターを強調表示したり、チュートリアル・ビデオにアクセスしたりするのに使う。 - チームワーク
プロジェクト・チームは技術マニュアルを整理し、統一ラベルを貼って共有することで、コミュニケーションの効率を高めている。
品質保証
- SmartReadは中国語PDFに対応していますか？
現在、より英語の技術文書に適していますが、中国語のサポートは最適化されています。 - ネットワークは必要か？
はい、関連リソースにアクセスしてAIモデルを実行するには、ネットワーク接続が必要です。 - オフラインで使用できますか？
ラベリング機能はオフラインで機能するが、リソースの推薦はオンラインである必要がある。
日本語 
简体中文 
English 
Deutsch (Sie) 
Português do Brasil