Skip to main content
EKB SDK (ソフトウェア開発キット) は、EKB の強力な機能をアプリケーションに統合するための包括的な TypeScript/JavaScript ライブラリを提供します。チャット インターフェイスを構築し、構造化データを管理し、音声会話を可能にし、AI エージェントをプログラムで活用します。この記事では、EKB SDK の概要をいくつかの使用例とベスト プラクティスとともに説明します。

EKB SDK とは何ですか?

EKB SDK は、EKB のコア機能へのプログラムによるアクセスを提供する TypeScript ライブラリです。
  • ChatSDK: チャット管理、メッセージ処理、ストリーミング応答を備えた会話型 AI インターフェイスを構築します。
  • SmartTablesSDK: 高度なクエリ、フィルタリング、AI を活用したデータ処理を使用して構造化データ テーブルを管理します。
  • VoiceSDK: 自動チャット統合と React フックを使用して音声会話を可能にします。

インストール

または糸を使って:

クイックスタート

基本セットアップ

認証

SDK は 2 つの認証方法をサポートしています。

1. API キー認証 (サーバー側で推奨)

サーバー間通信と外部統合には API キーを使用します。
API キーの取得:
  1. EKB ダッシュボードで マイ アカウント > API キー に移動します
  2. 新しい API キー ペアを作成します
  3. API キーと API シークレットをコピーします。
  4. 安全に保存します (環境変数を使用し、バージョン管理には決してコミットしないでください)

2. アクセストークン認証 (Web アプリの場合)

既存のユーザー セッションでクライアント側アプリケーションのアクセス トークンを使用します。

SDK コンポーネント

チャット SDK

包括的なチャット管理を備えた会話型 AI インターフェイスを構築します。 主な機能:
  • チャットの作成、リスト、管理
  • ストリーミングサポートによるメッセージの送信
  • ナレッジベースの統合
  • ファイルのアップロード (画像、ドキュメント)
  • ユーザーからのフィードバック (高評価/低評価)
  • カスタムエージェントとモデル
詳細: Chat SDK Documentation

スマート テーブル SDK

高度なクエリと AI を活用した処理で構造化データを管理します。 主な機能:
  • データテーブルの作成と管理
  • 高度なフィルタリングと並べ替え
  • データのインポート/エクスポート(CSV、Excel)
  • AI を活用した列計算
  • カスタムビューと列管理
  • ページネーションと検索
詳細: Smart Tables SDK Documentation

音声 SDK

自動チャット統合により音声会話を可能にします。 主な機能:
  • リアルタイムの音声会話
  • 自動文字起こし
  • 統合を容易にする React フック
  • オーディオの視覚化
  • セッション管理
  • チャットの統合
詳細: Voice SDK Documentation

一般的な使用例

1. カスタマーサポートチャットボット

2. データ管理アプリケーション

3. 音声対応アプリケーション

環境変数

運用アプリケーションの場合は、常に環境変数を使用してください。

エラー処理

すべての SDK メソッドは、捕捉して処理する必要があるエラーをスローします。

TypeScript のサポート

SDK は TypeScript で書かれており、完全な型定義を提供します。

React の統合

SDK には、簡単に統合できるように React フックが含まれています。

ベストプラクティス

1. 環境変数を使用する

コード内に API キーやシークレットをハードコーディングしないでください。常に環境変数を使用してください。

2. エラーを適切に処理する

常に SDK 呼び出しを try-catch ブロックでラップし、意味のあるエラー メッセージをユーザーに提供します。

3. SDK インスタンスの再利用

操作ごとに新しいインスタンスを作成するのではなく、SDK インスタンスを一度作成して再利用します。

4. UX を向上させるためにストリーミングを使用する

チャット アプリケーションの場合は、ストリーミング応答を使用してリアルタイムのフィードバックを取得します。

5. ページネーションを実装する

チャットをリストしたり、テーブルをクエリしたりするときは、常にページネーションを実装してください。

助けを求める

  • ドキュメント: 各 SDK コンポーネントの詳細なドキュメントを参照します。
  • サポート: 技術サポートが必要な場合は、Support まで電子メールを送信してください。
  • : 完全な動作例については、SDK リポジトリを確認してください。