ドキュメントの検索
karat

+

K

APIリファレンス ↗
オントロジーオブジェクトおよびリンクタイププロパティメタデータリファレンス
Feedback

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

メタデータリファレンス

オントロジーでは、プロパティは次のメタデータで表されます。

  • ID: アプリケーションを設定する際にプロパティを参照するために使用される、プロパティの一意の識別子。例えば、開始日プロパティのIDは start-date になるかもしれません。
  • 表示名: ユーザーアプリケーションでこのプロパティのプロパティ値にアクセスするすべての人に表示される名前。例えば、start date プロパティの表示名は 開始日 になるでしょう。
  • 説明: ユーザーアプリケーションで誰もが読むことができる、プロパティに関する説明文。例えば、start date プロパティの説明は、従業員が新入社員研修を開始した日 になるかもしれません。
  • RID: Foundry内のすべてのリソースに対して自動的に生成される一意の識別子。プロパティのRIDは、プラットフォーム全体のエラーメッセージで参照されます。
  • ステータス: ユーザーや他のオントロジービルダーに、プロパティが開発プロセスのどの段階にあるかを示す信号。activeexperimental、または deprecated になります。デフォルトでは、start date プロパティのステータスは experimental になります。ステータスについて詳しく読む。
  • API名: コードでプロパティをプログラムで参照する際に使用される名前。例えば、start date プロパティのAPI名は startDate になるでしょう。API名について詳しく読む。
  • キー: そのプロパティがオブジェクトタイプのタイトルキーかプライマリキーであるかどうかの指示。
    • タイトルキー は、このタイプのオブジェクトに表示名として機能するプロパティです。例えば、Employee オブジェクトタイプの full name プロパティをタイトルキーとして設定すると、そのプロパティの値(例:仮想的な従業員「Melissa Chang」や「Diego Rodriguez」など)が、それぞれの Employee オブジェクトの表示名として使用されます。
    • プライマリキー は、オブジェクトタイプの各インスタンスに対して一意の識別子として機能するプロパティであり、バックエンドデータソースの各行でこのプロパティに異なる値を持たなければなりません。例えば、「Melissa Chang」を組織内の一意の従業員として識別するために、employee number プロパティの値が使用されるかもしれません。
  • 基本タイプ: このプロパティの値のタイプを示し、ユーザーアプリケーションで利用可能な操作のセットを決定します。例えば、start date プロパティは基本タイプが date になります。ユーザーアプリケーションでは、このプロパティを使用してタイムラインウィジェットを設定できます。
  • 値の書式設定: プロパティの基本タイプに応じて、数値書式設定、日付と時刻の書式設定、ユーザーIDおよびリソースIDの書式設定がプロパティに適用できます。これにより、ユーザーアプリケーションでの生の値をより読みやすいバージョンに変換します。値の書式設定について詳しく読む。
  • 条件付き書式設定: ユーザー向けアプリケーションでプロパティ値がどのように表示されるかを決定するルールがプロパティに設定されています(例:色付け、整列など)。例えば、full name プロパティに、start date プロパティの値が2週間以内である場合に値を緑色にするルールを設定し、ユーザーアプリケーションで新入社員を示すことができます。条件付き書式設定について詳しく読む。
  • タイプクラス: ユーザーアプリケーションが解釈する追加のメタデータです。タイプクラスについて詳しく読む。
  • レンダリングヒント: プロパティを、同じ基本タイプの他のプロパティとは異なる方法でレンダリングするように、ユーザーアプリケーションに指示する情報です。多くのレンダリングヒントは、プロパティが定義されているオブジェクトタイプのリインデックスのパフォーマンスに影響を与えることができます。例えば、ユーザーアプリケーションで start date プロパティを検索したりソートしたりするユーザーがいないと予想される場合、searchable および sortable のレンダリングヒントを選択解除して、Employee オブジェクトタイプのリインデックスのパフォーマンスを向上させることができます。レンダリングヒントについて詳しく読む。
  • 可視性: プロパティをどの程度目立たせるかをユーザーアプリケーションに示す指示です。「prominent」なプロパティは、アプリケーションがこのプロパティをユーザーに最初に表示します。hidden なプロパティはユーザーアプリケーションに表示されません。デフォルトでは、start date プロパティの可視性は normal になります。

オントロジーでプロパティを作成および設定し、プロパティメタデータの検証要件について詳しく学ぶ

サポートが限定されているプロパティの基本タイプ

いくつかのプロパティの基本タイプにはサポートが限定されています。これらのタイプは、プロパティの基本タイプピッカーで Limited support タグが表示されることで示されます。

  • byte:
    • このタイプのプロパティはアクションタイプ内で使用できません。
  • decimal:
    • このタイプのプロパティは、JSONとJavaの間の変換により、このデータタイプの更新時に精度が保証できないため、アクションタイプ内で使用できません。
    • また、Object Storage V2ではサポートされていません。
  • float:
    • このタイプのプロパティはアクションタイプ内で使用できません。
  • short:
    • このタイプのプロパティはアクションタイプ内で使用できません。
  • vector:
    • このタイプのプロパティはアクションタイプ内で使用できません。
    • このタイプのプロパティを持つオブジェクトタイプはアクションタイプ内で使用できません。
    • ベクターは KNN でのみクエリできます。
    • 最大ベクター次元は2048です。

アクションタイプのプロパティ基本タイプの制限に関する詳細情報は、サポートされているプロパティタイプに関するドキュメントを参照してください。