Documentation
ドキュメントの検索
karat

+

K

APIリファレンス ↗
Developer toolchainオントロジー SDKオントロジー SDK

注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

オントロジー SDK の概要ヘッダー画像。

オントロジー SDK（オントロジー SDK）

オントロジーソフトウェア開発キット（オントロジー SDK）を使用すると、開発環境から直接オントロジーの機能を最大限に活用できます。オントロジー SDK は、TypeScript 向けの npm、Python 向けの pip または Conda、Java 向けの Maven、およびその他の言語向けの OpenAPI 仕様をサポートしています。

Foundry をバックエンドとして使用することで、きめ細かなガバナンス制御に加え、大規模なクエリや Foundry へのライトバックを実行するオントロジーの強力な機能を活用し、組織を支えるアプリケーションを安全かつ迅速に開発できます。

オントロジー SDK アプリケーションの作成と管理には、Developer Console を使用します。このセクションでは、SDK 固有のリファレンスドキュメントを紹介します。

デモアプリのセットアップページに表示されるサンプルコードとドキュメント。

オントロジー SDK の利点

オントロジー SDK は、以下の主要な利点を提供するために開発されました。

  • 開発の迅速化： オントロジー SDK を使用すると、Foundry オントロジーを元にしたアプリケーションの開発をすぐにはじめられます。オントロジー API に使いやすい方法でアクセスできるため、オントロジー SDK を使用すると、ごく少量のコードでオントロジーの読み取りとライトバックを実行できます。
  • 強力な型安全性： オントロジー SDK 向けに生成される関数とデータ型は、ユーザーに関連するオントロジーのサブセットのみに基づいています。データ型と関数がオントロジーから生成されるため、エディターで直接オントロジーにクエリを実行し、探索できます。
  • メンテナンスの一元化： オントロジーは Foundry 内で一元的に構築・管理されるため、アプリケーションの構築に専念でき、データ基盤の構築に通常伴うメンテナンスの負担を軽減できます。
  • 設計段階からのセキュリティ： オントロジー SDK は、データに対するユーザー自身の権限に加え、アプリケーションからアクセスさせたいオントロジーのエンティティだけにスコープを限定したトークンを使用します。
読み取り時のみ適用

行と列のアクセス制御（制限付きビュー、オブジェクトセキュリティポリシー、プロパティセキュリティポリシー を含む）は、ユーザーがオントロジー SDK を通じて読み取れるデータを絞り込みます。ユーザーは、閲覧を許可されていないデータを読み取ることはできません。これらの制御は、オントロジー SDK のレスポンスペイロードや、アプリケーションがそのデータを使用して行う処理には適用されません。下流へ流れるデータの保護を維持するには、これらの制御とマーキングまたは機密情報区分に基づくアクセス制御を併用してください。モデル全体については、アクセス制御の伝播を参照してください。

さらに、フロントエンド開発向けの TypeScript バインディングにより、開発者は Foundry 上で React アプリケーションを迅速かつ容易に構築できます。

Developer Console のインターフェースに表示されるアプリケーション SDK の概要パネル。

生成されたコードは、プロパティ名や説明など、オントロジーに関するメタデータを使用します。このメタデータはエディターで直接表示できます。

はじめに

UI ではなくコードでオントロジーを定義する場合は、以下の手順に従う代わりに SuperRepo の作成を検討してください。SuperRepo は、オントロジーとアプリケーションを一緒に進化させ、単一の Artifact としてバージョン管理およびリリースを行いたい場合に適しています。SuperRepo では、関数やフロントエンドと同じリポジトリ内で、Ontology-as-code を使用してオブジェクトタイプ、リンク、アクションを宣言します。オントロジー SDK はローカルで生成され、これらの定義が変更されるたびに再生成されるため、変更のたびに SDK バージョンを再公開しなくても、1 回の編集とプレビューのサイクル内でオントロジーを拡張し、新しいデータ型を使用できます。

オントロジー SDK を使用してアプリケーションを構築するには、以下の手順に従います。

  1. Developer Console で新しいアプリケーションを作成します
  2. 以下の言語別ガイドのいずれかに従って、アプリケーションをセットアップします。
  3. 必要に応じて、Foundry でアプリケーションをホストします

オントロジー SDK を使用せずにセットアップした既存のアプリケーションがある場合は、統合手順についてセットアップ済みのリポジトリにオントロジー SDK を追加を参照してください。

Compute Module 内でオントロジー SDK を使用して、コンテナ化されたアプリケーションから Foundry のオントロジーオブジェクトを操作することもできます。

SDK リファレンス

このセクションには、言語別の API リファレンスドキュメントが含まれています。

関連ドキュメント