Skip to main content

This is LLM interface library.

Project description

augllm

English README is here

augllm は、Ollama を用いた拡張型(Augmented)大規模言語モデル(LLM)操作のためのラッパーです。
Function Calling による外部ツール利用のためのインターフェースを提供します。
ただし、ツール本体の実装は含まず、利用者が必要に応じて外部実装を組み込む形を想定しています。

PyPIに登録されているため、pip install でインストールできます。 https://pypi.org/project/augllm/

目次

  1. 特長 / 概要
  2. 前提条件
  3. インストール方法
  4. 使い方
    • サンプルプログラム
    • Function Calling との連携
  5. ライセンス

1. 特長 / 概要

  • Ollama を通じて LLM(ローカルまたはクラウド上)とやり取り
  • Function Calling(関数呼び出し)形式でのツール連携をサポート
  • ツールは抽象インターフェースとして定義されており、具体的な実装(API 呼び出し、ローカルスクリプト実行など)はユーザーが自由に実装可能
  • 拡張性重視:カスタムツール、チェーン処理、プロンプト設計などへの組み込み容易

2. 前提条件

  • Python 3.11 以上
  • Ollama コマンドラインや API クライアントが動作可能な環境

3. インストール方法

  1. 仮想環境の作成と起動

以下を実行し、仮想環境を作成します。

python -m venv env

仮想環境を起動します。Macの場合は以下を実行します。

source env/bin/activate
  1. ライブラリのインストール

通常のライブラリとして使う場合は以下を実行します。

pip install augllm

このライブラリ自体の改良を行いたい場合は以下を実行します。

pip install -e .

4. 使い方

サンプルプログラム

リポジトリ内に test/ ディレクトリがあります。中の2つのファイルを参考にしてください。

Function Calling との連携

  1. プロンプト内で、ツール呼び出しを期待する関数署名を与える
  2. モデルから返ってきた関数呼び出し要求(ツール名 + 引数)を受け取り
  3. 対応ツールインターフェースの run(...) を呼び出し、結果を受け取り
  4. 結果をモデルに返して最終応答を得る

5. ライセンス

このプロジェクトは Apache‑2.0 ライセンス のもとで公開されています。 詳細は、LICENSEファイルを確認してください。

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

augllm-2.3.5.tar.gz (32.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

augllm-2.3.5-py3-none-any.whl (42.5 kB view details)

Uploaded Python 3

File details

Details for the file augllm-2.3.5.tar.gz.

File metadata

  • Download URL: augllm-2.3.5.tar.gz
  • Upload date:
  • Size: 32.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for augllm-2.3.5.tar.gz
Algorithm Hash digest
SHA256 8df70f52c259dc49518dd9fbcd03144c314fe483e4238c4dc71d1d03818763a3
MD5 1766f44c0601a35c4dfcaa8b942a1c36
BLAKE2b-256 440d5bfcb0042516a911c6cb28ed63d90d673f3c70856105c7ceee99e217c064

See more details on using hashes here.

File details

Details for the file augllm-2.3.5-py3-none-any.whl.

File metadata

  • Download URL: augllm-2.3.5-py3-none-any.whl
  • Upload date:
  • Size: 42.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for augllm-2.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 509be4dd2be3c1b99dffb97fe6170dfad5689ae106abd5b138f1d49098826816
MD5 d9f389bc81b8812afbad4517cda6ea12
BLAKE2b-256 8006b2c2e84c75c46d197c8f22b1425627a1f80d0f8f2ea287b6ba4a8553c18d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page