Office SDK の概要
Office SDK の 3 つの部分 (Web SDK、Server SDK、AI SDK) と、それらが Office アプリケーション内でどのように連携するかについて説明します。
Univer Office SDK は Web SDK、Server SDK、AI SDK で構成され、スプレッドシート、ドキュメント、スライド、リレーショナルテーブル、キャンバス、PDF に対応しています。
Web SDK は、ブラウザ エディタとヘッドレス コンテンツ処理の両方を実行する共有コンテンツ エンジンを提供します。 Server SDK と AI SDK は両方とも、このヘッドレス ランタイムに依存します。 Server SDK ではコラボレーションとファイル処理が追加され、AI SDK ではエージェントのコンテンツ操作と検証が追加されます。
機能を調べる
機能カタログ を、サポート レベル、オープンソースの可用性、統合範囲など、製品およびカテゴリ別に参照します。共有機能には、チャート、ファイル変換、コラボレーション、Worktree、埋め込みが含まれます。
はじめに: 1 つの要件テンプレートと 3 つの実行可能なサンプルから始めて、アプリケーションを接続、構築、デプロイします。
SDK のアーキテクチャと役割
Web SDK: 共有コンテンツ エンジン
アプリケーションで Office コンテンツを表示、編集、または処理する開発者向け。 Facade APIs を使用して、ブラウザ エディターまたはヘッドレス Node.js アプリケーションでコンテンツ、データ、および UI を操作します。
Web SDK はプラグイン アーキテクチャを使用しています。製品機能、エディタ UI、および検索や置換などの個々の機能は、プラグインを通じて構成できます。プリセットから開始するか、アプリケーションに必要な製品および機能プラグインを選択し、それらを依存関係とともに組み立てます。
Univer のコア コードを変更せずに、ビジネス固有の機能用のカスタム プラグインを開発することもできます。異なるプラグインの組み合わせにより、同じコンテンツ エンジンが各環境に適応します。ブラウザ アプリケーションはエディタ UI をロードしますが、ヘッドレス アプリケーションはブラウザ UI プラグインを省略します。 Univer アーキテクチャ: プラグイン設計 を参照してください。
共有キャンバス レンダリング。 Office コンテンツは共有キャンバス ベースのレンダリング アーキテクチャを使用し、コンテンツ タイプがレイアウトおよび描画機能を再利用し、ネストされたコンテンツをサポートできるようにします。たとえば、スプレッドシートのセル テキストは、一貫したコンテンツの表示のためにドキュメントのレイアウトとレンダリングを再利用します。 レンダリング エンジンのアーキテクチャ を参照してください。
ハイブリッド計算 数式エンジンは、フロントエンド計算がサーバー側 Rust エンジンと連携して動作するハイブリッド計算モデルをサポートし、応答性の高い編集と大規模な数式ワークロードのパフォーマンスを組み合わせます。 数式機能 と サーバー側の計算 を調べてください。
スプレッドシートから始める、または ドキュメント、スライド、リレーショナルテーブル、キャンバス、および PDF を選択します。
Server SDK: コラボレーションとファイルを接続する
共有編集、ファイル変換、バックエンド拡張機能を追加する開発者向け。 Web SDK のヘッドレス コンテンツ機能を基盤として構築し、モジュールを独自のバックエンドに統合し、アプリケーションの ID、権限、ストレージを使用します。
リアルタイム コラボレーション。 OT (操作変換) は、行/列の変更やコンテンツの編集などの同時操作を処理します。編集は最初にローカルに適用され、その後、可能な限りユーザーの意図を維持しながらレプリカ全体に収束します。必要に応じて、履歴、コメント、Worktree を追加します。 共同編集デザイン および コラボレーションのクイックスタート を参照してください。
ファイル変換。 Office ファイルと Univer ドキュメント データの間で変換を行い、コラボレーションの有無にかかわらず、インポート、編集、エクスポートを接続します。変換 API については Office ファイルのインポートとエクスポート を、アップロード、タスク、ダウンロードについては ファイル交換の統合 を参照してください。
展開とスケーリング。 独自の Node.js アプリケーションでモジュールをアセンブルします。 1 台のマシンで開始し、負荷が増加するにつれてファイル変換を個別に実行し、複数のコラボレーション ノードに拡張します。 アプリケーションアーキテクチャ および 導入ガイド を参照してください。
AI SDK: エージェントにエントリ ポイントを与える
既存のエージェント、自動化、およびアプリケーション固有の CLI に Office 機能を追加する開発者向け。 Web SDK のヘッドレス ランタイムと Facade APIs を基盤として、コンテンツの操作、計算、検査を行います。
既存のエージェント スタックを接続します。 TypeScript API、または SDK から組み立てられたアプリケーション CLI を通じて Office ツールを公開します。アプリケーションは、モデルの選択、タスク オーケストレーション、およびスキルを所有します。エージェントは実行結果と検査フィードバックを受け取り、ワークフローを続行します。
編集可能なコンテンツを作成します。 エージェントは文書構造を読み取り、範囲または段落を見つけて、Facade APIs を使用してスプレッドシート、文書、スライド、数式計算を含むその他のコンテンツを作成および変更します。結果はコンテンツ構造と編集機能を保持するため、ユーザーは引き続き改良を続けることができます。 コンテンツの操作 を参照してください。
検査して修正します。 値と計算結果を読み返し、実際のページのスクリーンショットを検査します。スライドの場合、レイアウト チェックでは、ページ外、はみ出し、重複するテキストも特定されます。エージェントはフィードバックを使用して修正と再検証を行い、読み取り→編集と計算→検査→修正のループを形成します。 目視検査 を参照してください。
Server SDK に接続し、Worktree を使用して、人間によるレビューと Web アプリケーションでのマージの前に中間エージェントの変更を分離します。 AI SDK を詳しく見る。
アプリケーションの処理フロー
- 埋め込みエディタ: Web SDK を使用して、アプリケーション内のコンテンツを表示および編集します。
- 連携アプリケーション: Web SDK と Server SDK を組み合わせて、ユーザーが共有ドキュメントを一緒に編集できるようにします。
- 人間とエージェントのコラボレーション: エージェントは AI SDK を通じてドラフトを編集および検証し、Server SDK はバージョンとマージを管理し、Web アプリケーションは表示、比較、人間によるレビューの対話を提供します。 3 つすべてが完全なレビュー ワークフローに貢献します。
共有基盤と依存関係
Web SDK は、エディターまたは Headless コンテンツエンジンとして単独で実行できます。Server SDK と AI SDK は、どちらも Web SDK の Headless 機能に依存します。ブラウザー UI を使わない場合も、コンテンツの実行環境は必要です。用途に応じてサービスやモジュールを有効にしてください。人と Agent が協働する一連の処理では、通常、3 つの SDK を組み合わせます。
ユースケースから始める
| 目的 | 参照先 |
|---|---|
| スプレッドシートエディタを埋め込む | Web SDK クイック スタート |
| 別の Office エディターを選択する | 書類, スライド, リレーショナルテーブル, ボード、または PDF |
| 複数のユーザーが同じドキュメントを編集できるようにする | コラボレーションのクイックスタート |
| Office ファイルのインポートまたはエクスポート | Server SDK ファイル変換 |
| エージェントまたは CLI を介してドキュメントを操作する | AI SDK の概要 |
| 共有ドキュメントに対するエージェントの変更を確認する | AI SDK Worktree |
次のステップ
Web SDK のコンテンツ ランタイムから開始し、Server SDK および AI SDK と組み合わせて最初のアプリケーション ワークフローを完了し、モジュールを段階的に追加します。関連する Univer パッケージのバージョンを揃えて、選択したモジュールに必要な環境、認証、ライセンスを準備します。
オープンソース アプリケーション、エージェント統合、デモ、リポジトリについては、サンプル を参照してください。 オンラインショーケース で Office 製品を試すこともできます。
このガイドはいかがですか?