@osdk/internal.foundry.ontologies 2.16.0 → 2.18.0

package/build/esm/_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
  */
@@ -44,6 +52,8 @@ export type ActionParameterType = ({
 } & _Core.DoubleType) | ({
     type: "integer";
 } & _Core.IntegerType) | ({
+    type: "geoshape";
+} & _Core.GeoShapeType) | ({
     type: "long";
 } & _Core.LongType) | ({
     type: "objectType";
@@ -60,6 +70,10 @@ export type ActionParameterType = ({
 } & ActionParameterArrayType) | ({
     type: "objectSet";
 } & OntologyObjectSetType) | ({
+    type: "geohash";
+} & _Core.GeohashType) | ({
+    type: "vector";
+} & _Core.VectorType) | ({
     type: "object";
 } & OntologyObjectType) | ({
     type: "timestamp";
@@ -70,6 +84,7 @@ export type ActionParameterType = ({
  * Log Safety: UNSAFE
  */
 export interface ActionParameterV2 {
+    displayName: _Core.DisplayName;
     description?: string;
     dataType: ActionParameterType;
     required: boolean;
@@ -153,6 +168,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 +232,13 @@ export interface AggregateObjectsResponseV2 {
     accuracy: AggregationAccuracy;
     data: Array<AggregateObjectsResponseItemV2>;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface AggregateTimeSeries {
+    method: TimeSeriesAggregationMethod;
+    strategy: TimeSeriesAggregationStrategy;
+}
 /**
  * Specifies an aggregation function.
  *
@@ -759,6 +789,10 @@ export interface CenterPoint {
 export type CenterPointTypes = {
     type: "Point";
 } & _Geo.GeoPoint;
+/**
+ * Log Safety: UNSAFE
+ */
+export type CipherTextProperty = LooselyBrandedString<"CipherTextProperty">;
 /**
    * Returns objects where the specified field contains all of the terms in the order provided,
 but they do have to be adjacent to each other.
@@ -925,6 +959,14 @@ export type CustomTypeId = LooselyBrandedString<"CustomTypeId">;
    * Log Safety: UNSAFE
    */
 export type DataValue = any;
+/**
+ * The result of a CipherText decryption. If successful, the plaintext decrypted value will be returned. Otherwise, an error will be thrown.
+ *
+ * Log Safety: DO_NOT_LOG
+ */
+export interface DecryptionResult {
+    plaintext?: Plaintext;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -984,9 +1026,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 +1058,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 +1181,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 +1272,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 +1490,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 +1885,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 +1912,14 @@ export type NearestNeighborsQuery = ({
 export interface NearestNeighborsQueryText {
     value: string;
 }
+/**
+ * Negates a numeric value.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface NegatePropertyExpression {
+    property: DerivedPropertyDefinition;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -2535,12 +2651,31 @@ export interface PhraseQuery {
     field: FieldNameV1;
     value: string;
 }
+/**
+ * Log Safety: DO_NOT_LOG
+ */
+export type Plaintext = LooselyBrandedString<"Plaintext">;
 /**
  * Log Safety: UNSAFE
  */
 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.
  *
@@ -2663,28 +2798,29 @@ export interface PropertyV2 {
 }
 /**
    * Represents the value of a property in the following format.
-| Type            | JSON encoding                                               | Example                                                                                            |
-|---------------- |-------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
-| Array           | array                                                       | ["alpha", "bravo", "charlie"]                                                                    |
-| Attachment      | JSON encoded AttachmentProperty object                    | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}                       |
-| Boolean         | boolean                                                     | true                                                                                             |
-| Byte            | number                                                      | 31                                                                                               |
-| CipherText      | string                                                      | "CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER"                                                                                                                                                                                        |
+| Type                                                                                                                      | JSON encoding                                               | Example                                                                                            |
+|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
+| Array                                                                                                                     | array                                                       | ["alpha", "bravo", "charlie"]                                                                    |
+| Attachment              | JSON encoded AttachmentProperty object                    | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}                       |
+| Boolean                                                                                                                   | boolean                                                     | true                                                                                             |
+| Byte                                                                                                                      | number                                                      | 31                                                                                               |
+| CipherText                                                                                                                | string                                                      | "CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER"                                                                                                                                                                                        |
 
-| Date            | ISO 8601 extended local date string                         | "2021-05-01"                                                                                     |
-| Decimal         | string                                                      | "2.718281828"                                                                                    |
-| Double          | number                                                      | 3.14159265                                                                                       |
-| Float           | number                                                      | 3.14159265                                                                                       |
-| GeoPoint        | geojson                                                     | {"type":"Point","coordinates":[102.0,0.5]}                                                       |
-| GeoShape        | geojson                                                     | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}            |
-| Integer         | number                                                      | 238940                                                                                           |
-| Long            | string                                                      | "58319870951433"                                                                                 |
-| MediaReference  | JSON encoded MediaReference object                        | {"mimeType":"application/pdf","reference":{"type":"mediaSetViewItem","mediaSetViewItem":{"mediaSetRid":"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642","mediaSetViewRid":"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b","mediaItemRid":"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225"}}}                       |
-| Short           | number                                                      | 8739                                                                                             |
-| String          | string                                                      | "Call me Ishmael"                                                                                |
-| Struct          | JSON object of struct field API name -> value               | {"firstName": "Alex", "lastName": "Karp"}                                                          |
-| Timestamp       | ISO 8601 extended offset date-time string in UTC zone       | "2021-01-04T05:00:00Z"                                                                           |
-| Timeseries      | JSON encoded TimeseriesProperty object or seriesId string | {"seriesId": "wellPressureSeriesId", "syncRid": ri.time-series-catalog.main.sync.04f5ac1f-91bf-44f9-a51f-4f34e06e42df"} or {"templateRid": "ri.codex-emu.main.template.367cac64-e53b-4653-b111-f61856a63df9", "templateVersion": "0.0.0"} or "wellPressureSeriesId"|                                                                           |
+| Date                                                                                                                      | ISO 8601 extended local date string                         | "2021-05-01"                                                                                     |
+| Decimal                                                                                                                   | string                                                      | "2.718281828"                                                                                    |
+| Double                                                                                                                    | number                                                      | 3.14159265                                                                                       |
+| Float                                                                                                                     | number                                                      | 3.14159265                                                                                       |
+| GeoPoint                                                                                                                  | geojson                                                     | {"type":"Point","coordinates":[102.0,0.5]}                                                       |
+| GeoShape                                                                                                                  | geojson                                                     | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}            |
+| Integer                                                                                                                   | number                                                      | 238940                                                                                           |
+| Long                                                                                                                      | string                                                      | "58319870951433"                                                                                 |
+| MediaReference| JSON encoded MediaReference object                        | {"mimeType":"application/pdf","reference":{"type":"mediaSetViewItem","mediaSetViewItem":{"mediaSetRid":"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642","mediaSetViewRid":"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b","mediaItemRid":"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225"}}}                       |
+| Short                                                                                                                     | number                                                      | 8739                                                                                             |
+| String                                                                                                                    | string                                                      | "Call me Ishmael"                                                                                |
+| Struct                                                                                                                    | JSON object of struct field API name -> value               | {"firstName": "Alex", "lastName": "Karp"}                                                          |
+| Timestamp                                                                                                                 | ISO 8601 extended offset date-time string in UTC zone       | "2021-01-04T05:00:00Z"                                                                           |
+| Timeseries            | JSON encoded TimeseriesProperty object or seriesId string | {"seriesId": "wellPressureSeriesId", "syncRid": ri.time-series-catalog.main.sync.04f5ac1f-91bf-44f9-a51f-4f34e06e42df"} or {"templateRid": "ri.codex-emu.main.template.367cac64-e53b-4653-b111-f61856a63df9", "templateVersion": "0.0.0"} or "wellPressureSeriesId"|                                                                           |
+| Vector                                                                                                                    | array                                                       | [0.1, 0.3, 0.02, 0.05 , 0.8, 0.4]                                                                |
 Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
    *
    * Log Safety: UNSAFE
@@ -3019,6 +3155,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
  */
@@ -3192,8 +3336,13 @@ export interface SearchOrderingV2 {
     direction?: string;
 }
 /**
-   * By default, anytime an object is requested, every property belonging to that object is returned.
-The response can be filtered to only include certain properties using the properties query parameter.
+   * By default, whenever an object is requested, all of its properties are returned, except for properties of the
+following types:
+
+Vector
+
+The response can be filtered to only include certain properties using the properties query parameter. Note
+that ontology object set endpoints refer to this parameter as select.
 Properties to include can be specified in one of two ways.
 
 A comma delimited list as the value for the properties query parameter
@@ -3267,21 +3416,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.
@@ -3401,6 +3550,7 @@ export type StreamMessage = ({
  */
 export interface StreamTimeSeriesPointsRequest {
     range?: TimeRange;
+    aggregate?: AggregateTimeSeries;
 }
 /**
  * Log Safety: UNSAFE
@@ -3448,9 +3598,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
    */
@@ -3517,6 +3668,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.
  *
@@ -3560,6 +3720,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.
  *
@@ -3569,6 +3758,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.
  *
@@ -3582,6 +3787,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.
  *
@@ -3604,6 +3829,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
  */