メタデータリファレンス

プロパティは、オントロジーにおいて以下のメタデータで表されます:

• ID: プロパティの一意の識別子で、主にアプリケーションを設定するときにプロパティを参照するために使用されます。たとえば、start-date が開始日プロパティの ID である場合があります。
• 表示名: ユーザーアプリケーションでこのプロパティの値にアクセスする際に表示される名前です。たとえば、start date プロパティの表示名は Start date である場合があります。
• 説明: ユーザーアプリケーションで誰でも読むことができるプロパティに関する説明文です。たとえば、start date プロパティの説明は The day the employee began new hire training である場合があります。
• RID: Foundry 内のすべてのリソースに対して自動的に生成される一意の識別子です。プロパティの RID は、プラットフォーム全体のエラーメッセージで参照されます。
• ステータス: プロパティが開発プロセスのどこにあるかをユーザーや他のオントロジービルダーに示す信号です。active、experimental、または deprecated のいずれかです。デフォルトでは、start date プロパティのステータスは experimental になります。 ステータスについてさらに読む。
• API 名: コード内でプログラム的にプロパティを参照する際に使用される名前です。たとえば、start date プロパティの API 名は startDate である場合があります。 API 名についてさらに読む。
• キー: プロパティがオブジェクトタイプのタイトルキーまたはプライマリキーであるかどうかの指標です。
  • タイトルキー は、このタイプのオブジェクトの表示名として機能するプロパティです。たとえば、Employee オブジェクトタイプのタイトルキーとして full name プロパティを設定すると、そのプロパティの値（たとえば、架空の従業員 “Melissa Chang” や “Diego Rodriguez”）が各 Employee オブジェクトの表示名として使用されます。
  • プライマリキー は、オブジェクトタイプの各インスタンスに対して一意の識別子として機能するプロパティで、バックデータソースの各行がこのプロパティに対して異なる値を持つ必要があることを意味します。たとえば、employee number プロパティの値は、組織内の “Melissa Chang” を一意の従業員として識別するために使用される場合があります。
• 基本タイプ: このプロパティの値のタイプを示し、ユーザーアプリケーションで利用可能な操作のセットを決定します。たとえば、start date プロパティは基本タイプ date を持ち、ユーザーアプリケーションではこのプロパティを使用してタイムラインウィジェットを設定できます。
• 値のフォーマット: プロパティの基本タイプに応じて、数値フォーマット、日付と時刻のフォーマット、ユーザー ID およびリソース ID のフォーマットが適用され、ユーザーアプリケーションでその生の値をより読みやすいバージョンに変換します。 値のフォーマットについてさらに読む。
• 条件付きフォーマット: プロパティに設定されたルールで、そのプロパティの値がユーザー向けアプリケーションでどのようにレンダリングされるかを決定します（例：色付け、配置など）。たとえば、start date プロパティの値が 2 週間未満の場合に full name プロパティの値を緑色にするルールを設定して、新入社員を示すことができます。 条件付きフォーマットについてさらに読む。
• タイプクラス: ユーザーアプリケーションによって解釈される追加のメタデータです。 タイプクラスについてさらに読む。
• レンダリングヒント: プロパティをどのようにレンダリングするかについてユーザーアプリケーションに示す指標で、多くの場合、同じ基本タイプの他のプロパティとは異なる場合があります。多くのレンダリングヒントは、プロパティが定義されているオブジェクトタイプの再インデックスのパフォーマンスに影響を与える可能性があります。たとえば、ユーザーが start date プロパティをユーザーアプリケーションで検索または並べ替えを行うことを期待しない場合、検索可能 および 並べ替え可能 のレンダリングヒントを選択解除して、Employee オブジェクトタイプの再インデックスパフォーマンスを向上させることができます。 レンダリングヒントについてさらに読む。
• 可視性: プロパティをどの程度重要に表示するかについてユーザーアプリケーションに示す指標です。重要 なプロパティはアプリケーションが最初にこのプロパティをユーザーに表示するように促します。隠された プロパティはユーザーアプリケーションに表示されません。デフォルトでは、start date プロパティの可視性は normal です。

オントロジーでのプロパティの作成と設定、およびプロパティメタデータの検証要件についてさらに読む。

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

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

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

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