跳转至

Metadata reference（元数据参考）

A property is represented in the Ontology by the following metadata:

  • ID: A unique identifier of the property, primarily used to reference the property when configuring an application. For example, start-date may be the ID of the start date property.
  • Display name: The name shown to anyone accessing property values for this property in user applications. For example, the display name for the start date property may be Start date.
  • Description: Explanatory text about the property that anyone can read in user applications. For example, the description of the start date property may be The day the employee began new hire training.
  • RID: An automatically generated unique identifier for every resource in Foundry. A property’s RID will be referenced in error messages across the platform.
  • Status: A signal to users and other Ontology builders about where in the development process the property stands. It can be active, experimental, or deprecated. By default, the start date property will have status experimental. Read more about statuses.
  • API name: The name used when referring to the property programmatically in code. For example, the API name of the start date property may be startDate. Read more about API names.
  • Keys: An indication of whether the property is the object type’s title key or primary key.
  • The title key is the property that acts as a display name for objects of this type. For example, setting the full name property as the title key of the Employee object type will use the values of that property, such as the notional employees “Melissa Chang” and “Diego Rodriguez” as the display names for each respective Employee object.
  • The primary key is the property that acts as a unique identifier for each instance of an object type, meaning that each row in the backing datasources must have a different value for this property. For example, the value of the employee number property may be used to identify “Melissa Chang” as a unique employee within the organization.
  • Base type: Indicates the type of values for this property and determines the set of operations available in user applications. For example, the start date property will have base type date. User applications will allow you to configure a timeline widget with this property.
  • Value formatting: Depending on the base type of the property, numeric formatting, date and time formatting, user ID and resource ID formatting are available to apply to the property, transforming its raw values into more readable versions in user applications. Read more about value formatting.
  • Conditional formatting: Rules set on a property that dictate how that property value will render (e.g coloring, alignment, etc.) in user facing applications. For example, you may set a rule on the full name property that colors its values green if the value of the start date property was less than 2 weeks ago, in order to indicate a new hire in user applications. Read more about conditional formatting.
  • Type classes: Additional metadata that are interpreted by user applications. Read more about type classes.
  • Render hints: Indications to user applications about how to render the property that may be different than most properties of the same base type. Many render hints can be used to impact the performance of reindexes of the object type the property is defined on. For example, if you don’t expect any users to search or sort on the start date property in user applications, you can deselect the searchable and sortable render hints and improve the reindex performance of the Employee object type. Read more about render hints.
  • Visibility: An indication to user applications for how prominently to display the property. A prominent property will lead applications to show this property first to users. A hidden property will not appear in user applications. By default, the start date property will have visibility normal.

Learn more about creating and configuring properties in the Ontology and about validation requirements for property metadata.

Property base types with limited support

Some property base types have limited support. These types are indicated with the Limited support tag which is visible in the property base type picker.

  • byte:
  • Properties of this type cannot be used within action types.
  • decimal:
  • Properties of this type cannot be used within action types as the precision cannot be guaranteed when updating this data type due to the conversion between JSON and Java.
  • This type is also not supported in Object Storage V2.
  • float:
  • Properties of this type cannot be used within action types.
  • short:
  • Properties of this type cannot be used within action types.
  • vector:
  • Vectors can only be queried by KNN.
  • The max vector dimension is 2048.

For more information on the limitations of property base types in action types, see the documentation on supported property types.

中文翻译

元数据参考

在本体论(Ontology)中，属性由以下元数据表示：

  • ID： 属性的唯一标识符，主要用于在配置应用程序时引用该属性。例如，start-date 可能是开始日期属性的 ID。
  • 显示名称(Display name)： 在用户应用程序中访问该属性值时向所有人显示的名称。例如，start date 属性的显示名称可能是 Start date。
  • 描述(Description)： 关于该属性的解释性文本，任何人都可以在用户应用程序中阅读。例如，start date 属性的描述可能是 The day the employee began new hire training。
  • RID： Foundry 中每个资源自动生成的唯一标识符。属性的 RID 将在平台上的错误消息中被引用。
  • 状态(Status)： 向用户和其他本体论构建者表明该属性在开发过程中所处阶段的信号。可以是 active、experimental 或 deprecated。默认情况下，start date 属性的状态为 experimental。了解更多关于状态的信息。
  • API 名称(API name)： 在代码中以编程方式引用该属性时使用的名称。例如，start date 属性的 API 名称可能是 startDate。了解更多关于API 名称的信息。
  • 键(Keys)： 指示该属性是对象类型(Object Type)的标题键(Title Key)还是主键(Primary Key)。
  • 标题键(Title key) 是作为该类型对象显示名称的属性。例如，将 full name 属性设置为 Employee 对象类型的标题键，将使用该属性的值（例如名义员工 "Melissa Chang" 和 "Diego Rodriguez"）作为每个 Employee 对象的显示名称。
  • 主键(Primary key) 是作为对象类型每个实例唯一标识符的属性，这意味着底层数据源中的每一行对于该属性必须具有不同的值。例如，employee number 属性的值可用于将 "Melissa Chang" 标识为组织内的唯一员工。
  • 基础类型(Base type)： 指示该属性值的类型，并确定用户应用程序中可用的操作集。例如，start date 属性的基础类型为 date。用户应用程序将允许您使用此属性配置时间线小部件。
  • 值格式化(Value formatting)： 根据属性的基础类型，可以对属性应用数字格式化、日期和时间格式化、用户 ID 和资源 ID 格式化，将其原始值转换为用户应用程序中更易读的版本。了解更多关于值格式化的信息。
  • 条件格式化(Conditional formatting)： 在属性上设置的规则，规定该属性值在面向用户的应用程序中的渲染方式（例如颜色、对齐等）。例如，您可以在 full name 属性上设置一条规则：如果 start date 属性的值距今不到 2 周，则将其值着色为绿色，以便在用户应用程序中指示新员工。了解更多关于条件格式化的信息。
  • 类型类(Type classes)： 由用户应用程序解释的附加元数据。了解更多关于类型类的信息。
  • 渲染提示(Render hints)： 向用户应用程序提供的关于如何渲染该属性的提示，可能与大多数相同基础类型的属性不同。许多渲染提示可用于影响定义该属性的对象类型的重新索引性能。例如，如果您不希望任何用户在用户应用程序中搜索或排序 start date 属性，您可以取消选择 searchable 和 sortable 渲染提示，从而提高 Employee 对象类型的重新索引性能。了解更多关于渲染提示的信息。
  • 可见性(Visibility)： 向用户应用程序指示该属性的显示突出程度。prominent 属性将引导应用程序首先向用户显示此属性。hidden 属性将不会出现在用户应用程序中。默认情况下，start date 属性的可见性为 normal。

了解更多关于在本体论中创建和配置属性以及属性元数据验证要求的信息。

支持受限的属性基础类型

某些属性基础类型的支持受限。这些类型在属性基础类型选择器中以 Limited support 标签标示。

  • byte：
  • 此类型的属性不能在操作类型(Action Types)中使用。
  • decimal：
  • 此类型的属性不能在操作类型中使用，因为由于 JSON 和 Java 之间的转换，更新此数据类型时无法保证精度。
  • 此类型在对象存储 V2(Object Storage V2) 中也不受支持。
  • float：
  • 此类型的属性不能在操作类型中使用。
  • short：
  • 此类型的属性不能在操作类型中使用。
  • vector：
  • 向量只能通过 KNN 进行查询。
  • 最大向量维度为 2048。

有关操作类型中属性基础类型限制的更多信息，请参阅关于支持属性类型的文档。