Tools Reference Manual ====================== ツールリファレンスマニュアル ============================ ツールは、パッシブAIアシスタントを、外部サービスとの対話、計算、カスタムビジネスロジックの実行ができるアクティブシステムに変換する拡張可能なアクション機能を提供します。これらは、会話型AIインターフェイスと組織インフラストラクチャ内のオペレーションシステム間のブリッジとして機能します。 アーキテクチャの目的 -------------------- ツールは、外部システム統合のための構造化インターフェイスを提供することにより、テキスト生成を超えて言語モデル機能を拡張します。これらにより、アシスタントは、セキュリティ境界と運用ガバナンスを維持しながら、データの取得、システム操作、ワークフローの自動化を含む具体的なアクションを実行できます。 システムインテグレーションフレームワーク ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ **Gen AI Builderコンポーネント** - **アシスタント** 言語モデルの意思決定プロセスを介してツールを呼び出します - **構造** パイプライン操作内のワークフローコンポーネントとしてツールを組み込みます - **ルールセット** ツール使用ポリシーと操作上の制約を定義します - **メモリシステム** マルチステップツール実行シーケンスのコンテキストを維持します **外部システムの接続** - **API** データ交換のためのRESTfulおよびGraphQLサービスの統合 - **データベース** 運用データにアクセスするための直接データベース接続 - **サービス** 認証接続を介した内部システム統合 - **ワークフロー** マルチツールオーケストレーションを介したビジネスプロセスの自動化 テクニカルアーキテクチャ ------------------------ ツール実装フレームワーク ^^^^^^^^^^^^^^^^^^^^^^^^ ツールは、さまざまなアシスタントタイプと操作コンテキストにわたって一貫した統合を可能にする標準化されたインターフェイスを実装します。このフレームワークは、単純な単一目的ツールと複雑なマルチステップのワークフローの自動化の両方をサポートしています。 **実装リファレンス** ツールは、 `EnterpriseDB/pgai-ai-builder `_ で入手可能なpgai-ai-builder SDKフレームワークを使用して開発されています。このSDKは、ツール開発のための基本的なクラスとユーティリティを提供します。 実行アーキテクチャ ^^^^^^^^^^^^^^^^^^ **ツール呼び出しフロー** 1. **決定フェーズ** 言語モデルは、会話のコンテキストに基づいてツールの必要性を判断します 2. **パラメーター抽出** ユーザー入力と会話履歴からの関連情報の抽出 3. **セキュリティ検証** 権限検証とレート制限の適用 4. **実行フェーズ** エラー処理とタイムアウト管理を使用したツール固有のロジック実行 5. **結果の統合** 出力フォーマットと会話フローへの組み込み 6. **コンテキストの更新** ツールの実行結果を反映するメモリシステムの更新 ツールカテゴリ -------------- システム統合ツール ^^^^^^^^^^^^^^^^^^ **APIコネクタ** REST、GraphQL、サービス固有のプロトコルを含むさまざまなAPIタイプの標準化されたインターフェイスを提供する外部サービス統合ツール。 **一般的な実装** - **CRM統合** 顧客関係管理システムの接続 - **ERPシステム** エンタープライズリソースプランニングのデータアクセス - **Payment Processor** 金融トランザクション処理機能 - **Communication Services** 電子メール、SMS、および通知システムの統合 **データベースアクセスツール** セキュリティ境界とパフォーマンスの最適化を維持しながら、構造化データのクエリを有効にする直接データベース接続ツール。 **サポートされているデータベースタイプ** - **PostgreSQL** Vector Engine機能とのネイティブ統合 - **クラウドデータベース** AWS RDS、Google Cloud SQL、Azure Database - **データウェアハウス** Snowflake、BigQuery、Redshift - **NoSQLシステム** MongoDB、Redis、Elasticsearch コンピューティングツール ^^^^^^^^^^^^^^^^^^^^^^^^ **数学的操作** 統計分析、財務モデリング、科学計算など、言語モデルの機能を超えた計算を実行する専用の計算ツール。 **ビジネスロジックプロセッサ** 価格計算、資格判断、コンプライアンス検証を含む組織ロジックをエンコードするカスタムビジネスルール実装ツール。 **データ変換ツール** データ形式の操作、集計、および業務に必要な複雑な変換を実行するコンテンツ処理ツール。 ワークフロー自動化ツール ^^^^^^^^^^^^^^^^^^^^^^^^ **プロセスオーケストレーション** 承認ワークフロー、データ同期、システム統合シーケンスを含む複雑なビジネスプロセスを管理するマルチステップのワークフロー調整ツール。 **通知システム** 複数のチャネルとシステムにわたってアラートの配信、ステータスの更新、および関係者コミュニケーションを管理する通信調整ツール。 実装パターン ------------ エンタープライズシステムインテグレーション ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 組織は、セキュリティ境界とパフォーマンス要件を維持しながら、AIアシスタントを既存の業務システムに接続する包括的なツールスイートを実装しています。 **セキュリティフレームワーク** - **認証統合** 組織IDシステムの接続 - **権限境界** ツール操作のロールベースのアクセス制御 - **監査ログ** コンプライアンス要件の包括的な操作追跡 - **レート制限** 構成可能な使用制限を介したリソース保護 カスタマーサービスオートメーション ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 顧客対応アプリケーションは、顧客情報、注文ステータス、サポートシステム統合へのリアルタイムアクセスを提供する専用ツールを活用します。 **一般的なツールスイート** - **Account Lookup** CRMシステムからの顧客情報の取得 - **注文管理** 注文ステータスの照会と変更機能 - **支払い処理** 安全な金融取引の処理 - **チケット管理** サポートケースの作成とステータスの更新 社内の生産性の向上 ^^^^^^^^^^^^^^^^^^ ナレッジワーカーアプリケーションは、ドキュメント管理、プロジェクト追跡、通信プラットフォームを含む生産性システムと統合するツールを利用します。 **生産性統合ツール** - **ドキュメント取得** エンタープライズコンテンツ管理システムへのアクセス - **カレンダーの統合** スケジュール管理と会議の調整 - **プロジェクト管理** プロジェクトシステム全体のタスク作成とステータス追跡 - **Analytics Access** ビジネスインテリジェンスとレポートシステムの統合 構成管理 -------- ツール構成スキーマ ^^^^^^^^^^^^^^^^^^ ツールには、操作パラメーター、セキュリティ境界、および統合要件を定義する体系的な構成が必要です。 環境マネジメント ^^^^^^^^^^^^^^^^ ツールの展開には、運用の柔軟性とセキュリティ要件のバランスをとった体系的な構成管理が必要です。 品質保証 -------- パフォーマンスモニタリング ^^^^^^^^^^^^^^^^^^^^^^^^^^ **オペレーションメトリック** - **実行レイテンシー** ツールオペレーションの完了時間の測定 - **成功率** さまざまなツールタイプの操作の成功率 - **エラーパターン** 故障モードとエラー条件の系統的な分析 - **リソース使用率** CPU、メモリ、およびネットワークリソースの消費追跡 セキュリティ検証 ^^^^^^^^^^^^^^^^ **セキュリティ評価フレームワーク** - **アクセス制御検証** 権限境界のテストと検証 - **認証テスト** セキュリティ資格情報の検証とローテーション手順 - **データ保護** 機密情報の取り扱いの検証と監査手順 - **Compliance Validation** 規制要件の遵守検証 開発フレームワーク ------------------ SDK統合 ^^^^^^^ ツール開発では、以下を提供するpgai-ai-builder SDKを利用します。 - **基本クラス** 標準化されたツールインターフェイスと結果構造 - **ユーティリティファンクション** API統合とデータ処理の一般的な操作 - **構成管理** 環境変数の処理とセキュリティ検証 - **テストフレームワーク** ツール検証のための単体テストユーティリティ **SDKドキュメント** 完全な実装ガイダンスは `pgai-ai-builder repository `_ で入手できます。 導入プロセス ^^^^^^^^^^^^ **ツールパッケージ** 展開可能なコンポーネントとしてのツールパッケージ。以下を含みます。 - pgai-ai-builder SDKを使用した実装コード - パラメーターと要件を定義する構成スキーマ - 使用例やセキュリティ上の考慮事項を含むドキュメント - 機能とエラー処理を検証するテストケース 運用上の考慮事項 ---------------- 展開管理 ^^^^^^^^ **ツールのライフサイクル** - **バージョン管理** 下位互換性管理を使用した体系的なツールのバージョン管理 - **展開の自動化** 環境全体で一貫したツール展開手順 - **ロールバックプロシージャ** 問題のある展開の自動ロールバック機能 - **ドキュメントメンテナンス** ツールの進化に合わせた包括的なドキュメントの更新 メンテナンス手順 ^^^^^^^^^^^^^^^^ **進行中のオペレーション** - **Dependency Management** 外部システムの接続性の監視とメンテナンス - **パフォーマンスの最適化** 使用パターンに基づいた継続的なパフォーマンスチューニング - **セキュリティの更新** 定期的なセキュリティ評価と脆弱性の修正 - **キャパシティプランニング** 使用量の増加に基づいたリソース割り当ての最適化 実装リソース ------------ 開発ガイド ^^^^^^^^^^ 特定の実装手順は、専用のハウツーガイドでカバーされています。 - :ref:`Create a Tool in Gen AI Builder ` pgai-ai-builder SDKを使用したステップバイステップツール開発 - :ref:`Tool Configuration File ` 構成スキーマと展開プロシージャー - :ref:`Run Tool ` 実行テストと検証プロシージャ 参考資料 ^^^^^^^^ **SDKドキュメント** - `pgai-ai-builder SDK `_ 完全なSDKドキュメントと例 - :ref:`Tool API Reference ` ツールインターフェイスの技術仕様 **統合ドキュメント** - :ref:`Assistants Reference Manual ` 会話インターフェイス内のツールの使用率 - :ref:`Structures Reference Manual ` 自動プロセスへのツールの組み込み -------------- ツールは、Gen AI Builderエコシステム内での外部システム統合とカスタムロジック実行のための安全でスケーラブルなインターフェイスを提供することにより、パッシブAIシステムを組織ワークフローのアクティブな参加者に変えます。