@osdk/foundry.ontologies 2.15.0 → 2.17.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @osdk/foundry.ontologies
 
+## 2.17.0
+
+### Minor Changes
+
+- db7ee48: Update Platform SDKs
+
+### Patch Changes
+
+- Updated dependencies [db7ee48]
+  - @osdk/foundry.core@2.17.0
+  - @osdk/foundry.geo@2.17.0
+
+## 2.16.0
+
+### Minor Changes
+
+- 45b549f: Bumping to include new flag on interface object sets.
+
+### Patch Changes
+
+- Updated dependencies [45b549f]
+  - @osdk/foundry.core@2.16.0
+  - @osdk/foundry.geo@2.16.0
+
 ## 2.15.0
 
 ### Minor Changes

package/build/browser/_components.d.ts

@@ -12,6 +12,14 @@ export interface AbsoluteTimeRange {
     startTime?: string;
     endTime?: string;
 }
+/**
+ * Calculates absolute value of a numeric value.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface AbsoluteValuePropertyExpression {
+    property: DerivedPropertyDefinition;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -70,6 +78,7 @@ export type ActionParameterType = ({
  * Log Safety: UNSAFE
  */
 export interface ActionParameterV2 {
+    displayName: _Core.DisplayName;
     description?: string;
     dataType: ActionParameterType;
     required: boolean;
@@ -153,6 +162,14 @@ export interface AddObject {
     primaryKey: PropertyValue;
     objectType: ObjectTypeApiName;
 }
+/**
+ * Adds two or more numeric values.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface AddPropertyExpression {
+    properties: Array<DerivedPropertyDefinition>;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -209,6 +226,13 @@ export interface AggregateObjectsResponseV2 {
     accuracy: AggregationAccuracy;
     data: Array<AggregateObjectsResponseItemV2>;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface AggregateTimeSeries {
+    method: TimeSeriesAggregationMethod;
+    strategy: TimeSeriesAggregationStrategy;
+}
 /**
  * Specifies an aggregation function.
  *
@@ -984,9 +1008,29 @@ export type DerivedPropertyApiName = LooselyBrandedString<"DerivedPropertyApiNam
  *
  * Log Safety: UNSAFE
  */
-export type DerivedPropertyDefinition = {
+export type DerivedPropertyDefinition = ({
+    type: "add";
+} & AddPropertyExpression) | ({
+    type: "absoluteValue";
+} & AbsoluteValuePropertyExpression) | ({
+    type: "extract";
+} & ExtractPropertyExpression) | ({
     type: "selection";
-} & SelectedPropertyDefinition;
+} & SelectedPropertyExpression) | ({
+    type: "negate";
+} & NegatePropertyExpression) | ({
+    type: "subtract";
+} & SubtractPropertyExpression) | ({
+    type: "property";
+} & PropertyApiNameSelector) | ({
+    type: "least";
+} & LeastPropertyExpression) | ({
+    type: "divide";
+} & DividePropertyExpression) | ({
+    type: "multiply";
+} & MultiplyPropertyExpression) | ({
+    type: "greatest";
+} & GreatestPropertyExpression);
 /**
  * The representation of a time series property backed by a derived time series calculated with a formula.
  *
@@ -996,6 +1040,15 @@ export interface DerivedTimeSeriesProperty {
     templateRid: TimeseriesTemplateRid;
     templateVersion?: TimeseriesTemplateVersion;
 }
+/**
+ * Divides the left numeric value by the right numeric value.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface DividePropertyExpression {
+    left: DerivedPropertyDefinition;
+    right: DerivedPropertyDefinition;
+}
 /**
    * Returns objects where the specified field does not intersect the bounding box provided. Allows you to specify a
 property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not
@@ -1110,6 +1163,19 @@ export interface ExecuteQueryResponse {
  */
 export interface ExperimentalPropertyTypeStatus {
 }
+/**
+ * Log Safety: SAFE
+ */
+export type ExtractDatePart = "DAYS" | "MONTHS" | "QUARTERS" | "YEARS";
+/**
+ * Extracts the specified date part from a date or timestamp.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface ExtractPropertyExpression {
+    property: DerivedPropertyDefinition;
+    part: ExtractDatePart;
+}
 /**
  * A reference to an Ontology object property with the form properties.{propertyApiName}.
  *
@@ -1188,6 +1254,14 @@ Use collectList or collectSet which will return a list of values in that case.
 export interface GetSelectedPropertyOperation {
     selectedPropertyApiName: PropertyApiName;
 }
+/**
+ * Finds greatest of two or more numeric, date or timestamp values.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface GreatestPropertyExpression {
+    properties: Array<DerivedPropertyDefinition>;
+}
 /**
  * The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint.
  *
@@ -1398,6 +1472,14 @@ export interface IsNullQueryV2 {
     propertyIdentifier?: PropertyIdentifier;
     value: boolean;
 }
+/**
+ * Finds least of two or more numeric, date or timestamp values.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface LeastPropertyExpression {
+    properties: Array<DerivedPropertyDefinition>;
+}
 /**
  * A reference to the linked interface type.
  *
@@ -1785,6 +1867,14 @@ export interface ModifyObject {
 export interface ModifyObjectRule {
     objectTypeApiName: ObjectTypeApiName;
 }
+/**
+ * Multiplies two or more numeric values.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface MultiplyPropertyExpression {
+    properties: Array<DerivedPropertyDefinition>;
+}
 /**
    * Queries support either a vector matching the embedding model defined on the property, or text that is
 automatically embedded.
@@ -1804,6 +1894,14 @@ export type NearestNeighborsQuery = ({
 export interface NearestNeighborsQueryText {
     value: string;
 }
+/**
+ * Negates a numeric value.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface NegatePropertyExpression {
+    property: DerivedPropertyDefinition;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -1999,6 +2097,7 @@ export interface ObjectSetFilterType {
  */
 export interface ObjectSetInterfaceBaseType {
     interfaceType: string;
+    includeAllBaseObjectProperties?: boolean;
 }
 /**
  * Log Safety: UNSAFE
@@ -2546,6 +2645,21 @@ export interface PhraseQuery {
 export type PolygonValue = {
     type: "Polygon";
 } & _Geo.Polygon;
+/**
+ * A measurement of duration.
+ *
+ * Log Safety: SAFE
+ */
+export interface PreciseDuration {
+    value: number;
+    unit: PreciseTimeUnit;
+}
+/**
+ * The unit of a fixed-width duration. Each day is 24 hours and each week is 7 days.
+ *
+ * Log Safety: SAFE
+ */
+export type PreciseTimeUnit = "NANOSECONDS" | "SECONDS" | "MINUTES" | "HOURS" | "DAYS" | "WEEKS";
 /**
  * Returns objects where the specified field starts with the provided value.
  *
@@ -3024,6 +3138,14 @@ export type RequestId = string;
  * Log Safety: SAFE
  */
 export type ReturnEditsMode = "ALL" | "ALL_V2_WITH_DELETIONS" | "NONE";
+/**
+ * Number of points in each window.
+ *
+ * Log Safety: SAFE
+ */
+export interface RollingAggregateWindowPoints {
+    count: number;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -3272,21 +3394,21 @@ export interface SelectedPropertyCollectSetAggregation {
 export interface SelectedPropertyCountAggregation {
 }
 /**
- * Definition for a selected property over a MethodObjectSet.
+ * Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.
  *
  * Log Safety: UNSAFE
  */
-export interface SelectedPropertyDefinition {
-    objectSet: MethodObjectSet;
-    operation: SelectedPropertyOperation;
+export interface SelectedPropertyExactDistinctAggregation {
+    selectedPropertyApiName: PropertyApiName;
 }
 /**
- * Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.
+ * Definition for a selected property over a MethodObjectSet.
  *
  * Log Safety: UNSAFE
  */
-export interface SelectedPropertyExactDistinctAggregation {
-    selectedPropertyApiName: PropertyApiName;
+export interface SelectedPropertyExpression {
+    objectSet: MethodObjectSet;
+    operation: SelectedPropertyOperation;
 }
 /**
  * Computes the maximum value for the provided field.
@@ -3406,6 +3528,7 @@ export type StreamMessage = ({
  */
 export interface StreamTimeSeriesPointsRequest {
     range?: TimeRange;
+    aggregate?: AggregateTimeSeries;
 }
 /**
  * Log Safety: UNSAFE
@@ -3453,9 +3576,10 @@ export interface StringRegexMatchConstraint {
  */
 export type StructFieldApiName = LooselyBrandedString<"StructFieldApiName">;
 /**
-   * A combination of a struct property api name and a struct field api name. This is used to select struct fields
-to query on. Note that you can still select struct properties with only a 'PropertyApiNameSelector'; the queries
-will then become 'OR' queries across the fields of the struct property.
+   * A combination of a property API name and a struct field API name used to select struct fields. Note that you can
+still select struct properties with only a 'PropertyApiNameSelector'; the queries will then become 'OR' queries
+across the fields of the struct property, and derived property expressions will operate on the whole struct
+where applicable.
    *
    * Log Safety: UNSAFE
    */
@@ -3522,6 +3646,15 @@ export type SubscriptionId = string;
 export interface SubscriptionSuccess {
     id: SubscriptionId;
 }
+/**
+ * Subtracts the right numeric value from the left numeric value.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface SubtractPropertyExpression {
+    left: DerivedPropertyDefinition;
+    right: DerivedPropertyDefinition;
+}
 /**
  * Computes the sum of values for the provided field.
  *
@@ -3565,6 +3698,35 @@ export type TimeRange = ({
 } & AbsoluteTimeRange) | ({
     type: "relative";
 } & RelativeTimeRange);
+/**
+ * The aggregation function to use for aggregating time series data.
+ *
+ * Log Safety: SAFE
+ */
+export type TimeSeriesAggregationMethod = "SUM" | "MEAN" | "STANDARD_DEVIATION" | "MAX" | "MIN" | "PERCENT_CHANGE" | "DIFFERENCE" | "PRODUCT" | "COUNT" | "FIRST" | "LAST";
+/**
+   * CUMULATIVE aggregates all points up to the current point.
+ROLLING aggregates all points in a rolling window whose size is either the specified number of points or
+time duration.
+PERIODIC aggregates all points in specified time windows.
+   *
+   * Log Safety: UNSAFE
+   */
+export type TimeSeriesAggregationStrategy = ({
+    type: "rolling";
+} & TimeSeriesRollingAggregate) | ({
+    type: "periodic";
+} & TimeSeriesPeriodicAggregate) | ({
+    type: "cumulative";
+} & TimeSeriesCumulativeAggregate);
+/**
+   * The cumulative aggregate is calculated progressively for each point in the input time series,
+considering all preceding points up to and including the current point.
+   *
+   * Log Safety: SAFE
+   */
+export interface TimeSeriesCumulativeAggregate {
+}
 /**
  * A time and value pair.
  *
@@ -3574,6 +3736,22 @@ export interface TimeseriesEntry {
     time: string;
     value: any;
 }
+/**
+   * Aggregates values over discrete, periodic windows for a given time series.
+A periodic window divides the time series into windows of fixed durations.
+For each window, an aggregate function is applied to the points within that window. The result is a time series
+with values representing the aggregate for each window. Windows with no data points are not included
+in the output.
+Periodic aggregation is useful for downsampling a continuous stream of data to larger granularities such as
+hourly, daily, monthly.
+   *
+   * Log Safety: SAFE
+   */
+export interface TimeSeriesPeriodicAggregate {
+    windowSize: PreciseDuration;
+    alignmentTimestamp?: string;
+    windowType: TimeSeriesWindowType;
+}
 /**
  * A time and value pair.
  *
@@ -3587,6 +3765,26 @@ export interface TimeSeriesPoint {
  * Log Safety: UNSAFE
  */
 export type TimeSeriesPropertyV2 = LooselyBrandedString<"TimeSeriesPropertyV2">;
+/**
+ * Log Safety: UNSAFE
+ */
+export interface TimeSeriesRollingAggregate {
+    windowSize: TimeSeriesRollingAggregateWindow;
+}
+/**
+   * A rolling window is a moving subset of data points that ends at the current timestamp (inclusive)
+and spans a specified duration (window size). As new data points are added, old points fall out of the
+window if they are outside the specified duration.
+Rolling windows are commonly used for smoothing data, detecting trends, and reducing noise
+in time series analysis.
+   *
+   * Log Safety: UNSAFE
+   */
+export type TimeSeriesRollingAggregateWindow = ({
+    type: "duration";
+} & PreciseDuration) | ({
+    type: "pointsCount";
+} & RollingAggregateWindowPoints);
 /**
  * The RID identifying a time series sync.
  *
@@ -3609,6 +3807,10 @@ export type TimeseriesTemplateVersion = LooselyBrandedString<"TimeseriesTemplate
  * Log Safety: UNSAFE
  */
 export type TimeSeriesValueBankProperty = LooselyBrandedString<"TimeSeriesValueBankProperty">;
+/**
+ * Log Safety: SAFE
+ */
+export type TimeSeriesWindowType = "START" | "END";
 /**
  * Log Safety: SAFE
  */