Custom Properties

Custom properties are any user-supplied values that provide additional context or metrics about samples, and can have numerical or categorical values.

Once they're added to the system, they can be utilized like any other property, including for annotation purposes, root cause analysis, version comparison, and production monitoring, allowing flexibility and customizability.

Typical Types of Custom Properties

Custom properties can be broadly categorized into two types: metadata properties and metric properties.

Metadata Properties

Metadata properties are descriptive attributes that provide contextual information about a sample. These properties help in organizing and categorizing samples based on various descriptive factors.

An example for a metadata property could be the "Region" associated with a sample, such as "North America" "Europe", etc.
In the system, metadata properties are used as part of the Root Cause Analysis. Users can receive insights and reports based on custom properties categorization.

Metric Properties

Metric properties are quantitative values that assess certain aspects of the sample. These properties provide measurable data that can be used for evaluation and comparison.

An example for a metric property could be "Internal Document Quality" representing the vector store retrieval score.
In the system, metric properties are can be integrated into the Auto Annotation flow and effect the estimated scores provided by Deepchecks.

By leveraging both metadata and metric properties, users can tailor the system to better meet their specific needs, improving the overall management and analysis of samples.

Adding Custom Properties

Supplying custom property values for the interactions is possible both via our SDK as well as in the UI via CSV Upload, by adding a value for each interaction.

📘 Note: Defining Custom Properties:
Before supplying custom property values for the interactions via CSV, they should first be added to the Application via the Custom Properties tab in the UI.