@narrative.io/data-collaboration-sdk-ts 2.26.0 → 2.28.0

package/build/access-rules/types.d.ts

@@ -4,7 +4,7 @@ export interface AccessRule {
     id: number;
     dataset_id?: AccessRuleDatasetId;
     policy?: AccessRulePolicy;
-    company_constraint?: AccessRuleCompanyConstraint;
+    collaborators?: CollaboratorsConfig;
     constraints?: AccessRuleConstraints;
     created_at: string;
     description?: AccessRuleDescription;
@@ -25,10 +25,6 @@ interface AccessRulePolicy {
     query: string;
     datasets: AccessRulePolicyDataset;
 }
-interface AccessRuleCompanyConstraint {
-    type: "inclusion" | "exclusion";
-    company_ids: number[];
-}
 type AccessRuleConstraints = string[];
 type AccessRuleDescription = string;
 type AccessRulePricing = number;

package/build/index.d.ts

@@ -23,6 +23,7 @@ import { type ExplainInput, type ExplainOutput, type GetJobsParameters, type Job
 import JsonBigNumber from "./json-big-number";
 import { type Mapping, type MappingTestResult, MappingsApi } from "./mappings";
 import type { CreateMapping, ObjectMapping, ValueMapping } from "./mappings/types";
+import { type CreateModelRequest, type Model, ModelTrainingApi, type ModelTrainingCollaborators, type ModelTrainingConfig, type OutputModel, type TrainModelRequest, type TrainModelResponse, type UpdateModelRequest } from "./model-training";
 import { type CompiledNql, type CreateMaterializedView, type Deduplication, type Explain, type Expression, type Nql, NqlApi, type NqlAst, type NqlBooleanExpression, type NqlCompileResult, type NqlExpression, type NqlField, type NqlFilterBinaryExpression, type NqlFilterExpression, type NqlFilterUnaryExpression, type NqlQueryInput, type NqlResult, type NqlWhere, type Raw, type Select, type Statement, type Table, compileStatement, parseStatement } from "./nql";
 import { convertNqlObjectToForecastBody } from "./nql/DataRulesConverter";
 import { buildNql, getNqlObject } from "./nql/NQLParser";
@@ -44,6 +45,6 @@ import { WhoAmIApi } from "./whoami";
 import type { User } from "./whoami/types";
 declare class NarrativeApi extends BaseApi {
 }
-interface NarrativeApi extends BaseApi, HealthCheckApi, AccessTokensApi, DataPlaneApi, DatasetApi, RosettaStoneApi, AttributeApi, AttributeApiV2, PingApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, SubscriptionsApi, JobsApi, QueriesApi, ViewsApi, WhoAmIApi {
+interface NarrativeApi extends BaseApi, HealthCheckApi, AccessTokensApi, DataPlaneApi, DatasetApi, RosettaStoneApi, AttributeApi, AttributeApiV2, PingApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, SubscriptionsApi, JobsApi, QueriesApi, ViewsApi, ModelTrainingApi, WhoAmIApi {
 }
-export { NarrativeApi, AttributeApi, AttributeApiV2, AccessTokensApi, DataPlaneApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, QueriesApi, ViewsApi, WhoAmIApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, resources, type DataPlane, type AccessTokenMetadata, type CreateSystemAccessTokenRequest, type CreateSystemAccessTokenResponse, type UpdateSystemAccessTokenRequest, type App, type Resource, type AccessRuleV2, type GetAccessRulesParameters, type CreateAccessRuleV2Request, type UpdateAccessRuleV2Request, type UploadsResponse, type PingStatus, type Attribute, type ShallowAttribute, type Connection, type RefAttribute, type SubAttribute, type PrimitiveAttribute, type ArrayAttribute, type ObjectAttribute, type Environment, type Config, type ApiRecords, type ApiRecordsV2, type GeneralCollaboratorType, type SpecificCollaboratorType, type NonAuthenticatedCollaborator, type CollaboratorList, type GeneralCollaborator, type QueryCollaborator, type ViewCollaborator, type QueryAccess, type ViewAccess, type CollaboratorsConfig, type Dataset, type HealthCheckResult, type SampleRecords, type Permission, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, type UpdateDatasetRequest, type SchemaFileConfigType, type SchemaPropertiesType, type DatasetStatus, type DatasetWriteMode, type SchemaFileConfig, type SchemaProperties, type SchemaProperty, type SchemaPrimitiveProperty, type SchemaObjectProperty, type SchemaArrayProperty, type SchemaArrayItems, type SchemaArrayItemsPrimitive, type SchemaArrayItemsObject, type SchemaArrayItemsArray, type Schema, type AdvancedStatisticsMetadata, type SnapshotRange, type Configuration, type Columns, type ColumnSummary, type ColumnStatistics, type BasicStatistics, type AdvancedStatistics, type Histogram, type Value, type CreateDatasetRequest, type IngestDatasetFileRequest, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type Profile, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type CompiledNql, type CreateMaterializedView, type GetJobsParameters, type Deduplication, type Explain, type Expression, type Raw, type Select, type Statement, type Table, type Nql, type NqlAst, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, type DataStream, type DataRules, type ColumnSet, type ColumnWithFilterAndExport, type AttributeSet, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type ForecastResult, type CostForecastResult, type ForecastResultFailure, type JobState, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest, type RegistrationStatusResponse, type ForecastBody, type AstNodeType, type AstNodeMetadata, type SharedAccessRule, type OwnedAccessRule, type ConversationAssistantMessage, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageName, type ConversationMessageRole, type AccessRuleSchema, type ConversationMessages, type ConversationSystemMessage, type ConversationUserMessage, type RosettaRequestMessage, type ConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, type RosettaResponseMessage, type ConversationAssistantMessageWithoutFunctionCall, type RetentionPolicy, type AccessRule, type Subscription, type SubscriptionDetails, type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails, type SubscriptionOutput, type SubscriptionType, type SubscriptionStatus, type SubscriptionBudget, type Job, type ExplainInput, type MaterializedViewInput, type ExplainOutput, type MaterializedViewOutput, type User, type Mapping, type MappingTestResult, type ValueMapping, type ObjectMapping, type CreateMapping, type CreateNqlQueryRequest, type UpdateNqlQueryRequest, type NqlQueryResponse, type NqlSharedQueryResponse, type NqlOwnedQueryResponse, type NqlQueryCollaborators, type NqlQueryOwner, type NqlQueryMetadata, type View, type OwnedView, type SharedView, type ViewOwner, type CreateViewRequest, type UpdateViewRequest, compileStatement, parseStatement, JsonBigNumber, };
+export { NarrativeApi, AttributeApi, AttributeApiV2, AccessTokensApi, DataPlaneApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, QueriesApi, ViewsApi, ModelTrainingApi, WhoAmIApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, resources, type DataPlane, type AccessTokenMetadata, type CreateSystemAccessTokenRequest, type CreateSystemAccessTokenResponse, type UpdateSystemAccessTokenRequest, type App, type Resource, type AccessRuleV2, type GetAccessRulesParameters, type CreateAccessRuleV2Request, type UpdateAccessRuleV2Request, type UploadsResponse, type PingStatus, type Attribute, type ShallowAttribute, type Connection, type RefAttribute, type SubAttribute, type PrimitiveAttribute, type ArrayAttribute, type ObjectAttribute, type Environment, type Config, type ApiRecords, type ApiRecordsV2, type GeneralCollaboratorType, type SpecificCollaboratorType, type NonAuthenticatedCollaborator, type CollaboratorList, type GeneralCollaborator, type QueryCollaborator, type ViewCollaborator, type QueryAccess, type ViewAccess, type CollaboratorsConfig, type Dataset, type HealthCheckResult, type SampleRecords, type Permission, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, type UpdateDatasetRequest, type SchemaFileConfigType, type SchemaPropertiesType, type DatasetStatus, type DatasetWriteMode, type SchemaFileConfig, type SchemaProperties, type SchemaProperty, type SchemaPrimitiveProperty, type SchemaObjectProperty, type SchemaArrayProperty, type SchemaArrayItems, type SchemaArrayItemsPrimitive, type SchemaArrayItemsObject, type SchemaArrayItemsArray, type Schema, type AdvancedStatisticsMetadata, type SnapshotRange, type Configuration, type Columns, type ColumnSummary, type ColumnStatistics, type BasicStatistics, type AdvancedStatistics, type Histogram, type Value, type CreateDatasetRequest, type IngestDatasetFileRequest, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type Profile, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type CompiledNql, type CreateMaterializedView, type GetJobsParameters, type Deduplication, type Explain, type Expression, type Raw, type Select, type Statement, type Table, type Nql, type NqlAst, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, type DataStream, type DataRules, type ColumnSet, type ColumnWithFilterAndExport, type AttributeSet, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type ForecastResult, type CostForecastResult, type ForecastResultFailure, type JobState, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest, type RegistrationStatusResponse, type ForecastBody, type AstNodeType, type AstNodeMetadata, type SharedAccessRule, type OwnedAccessRule, type ConversationAssistantMessage, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageName, type ConversationMessageRole, type AccessRuleSchema, type ConversationMessages, type ConversationSystemMessage, type ConversationUserMessage, type RosettaRequestMessage, type ConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, type RosettaResponseMessage, type ConversationAssistantMessageWithoutFunctionCall, type RetentionPolicy, type AccessRule, type Subscription, type SubscriptionDetails, type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails, type SubscriptionOutput, type SubscriptionType, type SubscriptionStatus, type SubscriptionBudget, type Job, type ExplainInput, type MaterializedViewInput, type ExplainOutput, type MaterializedViewOutput, type User, type Mapping, type MappingTestResult, type ValueMapping, type ObjectMapping, type CreateMapping, type CreateNqlQueryRequest, type UpdateNqlQueryRequest, type NqlQueryResponse, type NqlSharedQueryResponse, type NqlOwnedQueryResponse, type NqlQueryCollaborators, type NqlQueryOwner, type NqlQueryMetadata, type View, type OwnedView, type SharedView, type ViewOwner, type CreateViewRequest, type UpdateViewRequest, type ModelTrainingCollaborators, type Model, type OutputModel, type CreateModelRequest, type UpdateModelRequest, type TrainModelRequest, type TrainModelResponse, type ModelTrainingConfig, compileStatement, parseStatement, JsonBigNumber, };

package/build/index.js

@@ -17,6 +17,7 @@ import { InstallationsApi, } from "./installations";
 import { JobsApi, } from "./jobs";
 import JsonBigNumber from "./json-big-number";
 import { MappingsApi } from "./mappings";
+import { ModelTrainingApi, } from "./model-training";
 import { NqlApi, compileStatement, parseStatement, } from "./nql";
 import { convertNqlObjectToForecastBody } from "./nql/DataRulesConverter";
 import { buildNql, getNqlObject } from "./nql/NQLParser";
@@ -60,8 +61,9 @@ applyMixins(NarrativeApi, [
     JobsApi,
     QueriesApi,
     ViewsApi,
+    ModelTrainingApi,
     WhoAmIApi,
 ]);
 export { 
 // biome-ignore lint/style/useExportType: We need to export the class
-NarrativeApi, AttributeApi, AttributeApiV2, AccessTokensApi, DataPlaneApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, QueriesApi, ViewsApi, WhoAmIApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, resources, compileStatement, parseStatement, JsonBigNumber, };
+NarrativeApi, AttributeApi, AttributeApiV2, AccessTokensApi, DataPlaneApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, QueriesApi, ViewsApi, ModelTrainingApi, WhoAmIApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, resources, compileStatement, parseStatement, JsonBigNumber, };

package/build/model-training/index.d.ts

@@ -0,0 +1,31 @@
+import { BaseApi } from "../base-api";
+import type { ApiRecords } from "../types";
+import type { CreateModelRequest, Model, ModelTrainingCollaborators, ModelTrainingConfig, OutputModel, TrainModelRequest, TrainModelResponse, UpdateModelRequest } from "./types";
+/**
+ * A class for accessing the Model Training API.
+ * @extends BaseApi
+ */
+declare class ModelTrainingApi extends BaseApi {
+    /**
+     * Gets a list of accessable models from the API.
+     *
+     * @returns {Promise<ApiRecords<Model>>} A promise that resolves with the list of models.
+     */
+    getModels(): Promise<ApiRecords<Model>>;
+    /**
+     * Updates an existing model on the API.
+     *
+     * @param {string} modelId - The ID of the model to update.
+     * @param {UpdateNqlModelRequest} data - The updated data for the model.
+     * @returns {Promise<Model>} A promise that resolves with the updated model.
+     */
+    updateModel(modelId: string, data: UpdateModelRequest): Promise<Model>;
+    /**
+     * Trains a model.
+     *
+     * @param {CreateNqlQueryRequest} data - The data for the model training.
+     * @returns {Promise<NqlQueryResponse>} A promise that resolves with the model training response.
+     */
+    trainModel(data: TrainModelRequest): Promise<TrainModelResponse>;
+}
+export { ModelTrainingApi, type ModelTrainingCollaborators, type Model, type OutputModel, type CreateModelRequest, type UpdateModelRequest, type TrainModelRequest, type TrainModelResponse, type ModelTrainingConfig, };

package/build/model-training/index.js

@@ -0,0 +1,42 @@
+import { BaseApi } from "../base-api";
+/**
+ * The name of the resource to be used in API requests.
+ * @constant
+ * @private
+ * @type {string}
+ */
+const resourceName = "model-training";
+/**
+ * A class for accessing the Model Training API.
+ * @extends BaseApi
+ */
+class ModelTrainingApi extends BaseApi {
+    /**
+     * Gets a list of accessable models from the API.
+     *
+     * @returns {Promise<ApiRecords<Model>>} A promise that resolves with the list of models.
+     */
+    async getModels() {
+        return await this.get(`${resourceName}/models`);
+    }
+    /**
+     * Updates an existing model on the API.
+     *
+     * @param {string} modelId - The ID of the model to update.
+     * @param {UpdateNqlModelRequest} data - The updated data for the model.
+     * @returns {Promise<Model>} A promise that resolves with the updated model.
+     */
+    async updateModel(modelId, data) {
+        return await this.put(`${resourceName}/${modelId}`, data);
+    }
+    /**
+     * Trains a model.
+     *
+     * @param {CreateNqlQueryRequest} data - The data for the model training.
+     * @returns {Promise<NqlQueryResponse>} A promise that resolves with the model training response.
+     */
+    async trainModel(data) {
+        return await this.post(`${resourceName}/run`, data);
+    }
+}
+export { ModelTrainingApi, };

package/build/model-training/types.d.ts

@@ -0,0 +1,56 @@
+import type { CollaboratorList, GeneralCollaborator } from "src/types";
+export interface ModelTrainingCollaborators {
+    view: CollaboratorList | GeneralCollaborator;
+    train: CollaboratorList | GeneralCollaborator;
+    deploy: CollaboratorList | GeneralCollaborator;
+}
+export interface Model {
+    id: string;
+    company_id: number;
+    name: string;
+    license_id: string;
+    repository: string;
+    collaborators: ModelTrainingCollaborators;
+    description?: string;
+    tags: string[];
+    base_model_id: string;
+    created_at: string;
+    updated_at?: string;
+    archived_at?: string;
+    version: string;
+    status: string;
+}
+export interface OutputModel {
+    name: string;
+    collaborators: ModelTrainingCollaborators;
+    description?: string;
+    tags?: string[];
+    license_id?: string;
+}
+export interface CreateModelRequest {
+    name: string;
+    license_id: string;
+    repository: string;
+    collaborators: ModelTrainingCollaborators;
+    description?: string;
+    tags?: string[];
+    base_model_id?: string;
+}
+export interface UpdateModelRequest {
+    description?: string;
+    tags?: string[];
+    license_id?: string;
+}
+export interface TrainModelRequest {
+    base_model_id: string;
+    dataset_id: number;
+    training_config: ModelTrainingConfig;
+    output_model: OutputModel;
+}
+export interface TrainModelResponse {
+    job_id: string;
+}
+export interface ModelTrainingConfig {
+    instance_type: string;
+    custom_axolotl_config_override?: string;
+}

package/build/model-training/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@narrative.io/data-collaboration-sdk-ts",
-	"version": "2.26.0",
+	"version": "2.28.0",
 	"main": "build/index.js",
 	"repository": "github:narrative-io/data-collaboration-sdk-ts",
 	"source": "src/index.ts",