@narrative.io/data-collaboration-sdk-ts 2.57.0 → 2.58.0

package/build/datasets/index.d.ts

@@ -161,11 +161,13 @@ export declare class DatasetApi extends BaseApi {
      * Requests a sample of records from a specified dataset by its ID.
      *
      * @param {number} datasetId - The ID of the dataset to request a sample from.
-     * @returns {Promise<void>} A Promise that resolves when the operation is complete.
+     * @returns {Promise<{ job_id: string }>} A Promise that resolves with the job_id for tracking the sample request.
      * @throws {Error} If there is an issue with the request or the response.
      * @memberof DatasetApi
      */
-    requestDatasetSample(datasetId: number): Promise<void>;
+    requestDatasetSample(datasetId: number): Promise<{
+        job_id: string;
+    }>;
     /**
      * Deletes a sample of a specified dataset by its ID.
      *

package/build/datasets/index.js

@@ -198,12 +198,12 @@ export class DatasetApi extends BaseApi {
      * Requests a sample of records from a specified dataset by its ID.
      *
      * @param {number} datasetId - The ID of the dataset to request a sample from.
-     * @returns {Promise<void>} A Promise that resolves when the operation is complete.
+     * @returns {Promise<{ job_id: string }>} A Promise that resolves with the job_id for tracking the sample request.
      * @throws {Error} If there is an issue with the request or the response.
      * @memberof DatasetApi
      */
     async requestDatasetSample(datasetId) {
-        await this.post(`${resourceName}/${datasetId}/request-sample`);
+        return await this.post(`${resourceName}/${datasetId}/request-sample`);
     }
     /**
      * Deletes a sample of a specified dataset by its ID.

package/build/index.d.ts

@@ -1,4 +1,4 @@
-import { type AccessRule, type AccessRuleV2, AccessRulesApi, type CreateAccessRuleV2Request, type GetAccessRulesParameters, type OwnedAccessRule, type SharedAccessRule, type UpdateAccessRuleV2Request } from "./access-rules/";
+import { type AccessRule, AccessRulesApi, type AccessRuleV2, type CreateAccessRuleV2Request, type GetAccessRulesParameters, type OwnedAccessRule, type SharedAccessRule, type UpdateAccessRuleV2Request } from "./access-rules/";
 import type { AccessRuleSchema } from "./access-rules/types";
 import { type AccessTokenMetadata, AccessTokensApi, type CreateSystemAccessTokenRequest, type CreateSystemAccessTokenResponse, type UpdateSystemAccessTokenRequest } from "./access-tokens";
 import { type Permission, resources } from "./access-tokens/types";
@@ -21,13 +21,13 @@ import { type CostForecastRequest, type CostForecastResponse, type CostForecastR
 import { HealthCheckApi } from "./health";
 import type { HealthCheckResult } from "./health/types";
 import { type Installation, InstallationsApi, type Profile } from "./installations";
-import { type ColumnDetails, type DatasetsCalculateColumnStatsJob, type DatasetsDeleteTableJob, type DatasetsDeliverDataJob, type DatasetsSampleJob, type DeleteInput, type DeliverInput, type ExplainInput, type ExplainJob, type ExplainOutput, type ForecastInput, type ForecastJob, type GetJobsParameters, type Job, type JobRequestSource, type JobRequestSourceApiUser, type JobRequestSourceProcess, JobsApi, type MaterializedViewInput, type MaterializedViewJob, type MaterializedViewOutput, type ModelTrainingRunInput, type ModelTrainingRunJob, type ModelsDeliverModelInput, type ModelsDeliverModelJob, type SampleInput, type StatsInput } from "./jobs";
+import { type ColumnDetails, type DatasetsCalculateColumnStatsJob, type DatasetsDeleteTableJob, type DatasetsDeliverDataJob, type DatasetsSampleJob, type DeleteInput, type DeliverInput, type ExplainInput, type ExplainJob, type ExplainOutput, type ForecastInput, type ForecastJob, type GetJobsParameters, type Job, type JobRequestSource, type JobRequestSourceApiUser, type JobRequestSourceProcess, JobsApi, type MaterializedViewInput, type MaterializedViewJob, type MaterializedViewOutput, type ModelsDeliverModelInput, type ModelsDeliverModelJob, type ModelTrainingRunInput, type ModelTrainingRunJob, type SampleInput, type StatsInput } from "./jobs";
 import JsonBigNumber from "./json-big-number";
-import { type Mapping, type MappingTestResult, MappingsApi } from "./mappings";
+import { type Mapping, MappingsApi, type MappingTestResult } from "./mappings";
 import type { CreateMapping, ObjectMapping, ValueMapping } from "./mappings/types";
 import { ModelTrainingApi, type ModelTrainingConfig, type OutputModel, type TrainModelRequest, type TrainModelResponse } from "./model-training";
 import { type CreateModelRequest, type Model, type ModelCollaborators, ModelsApi, type UpdateModelRequest } from "./models";
-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 { type CompiledNql, type CreateMaterializedView, compileStatement, 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, parseStatement, type Raw, type Select, type Statement, type Table } from "./nql";
 import { convertNqlObjectToForecastBody } from "./nql/DataRulesConverter";
 import { buildNql, getNqlObject } from "./nql/NQLParser";
 import type { AstNodeMetadata, AstNodeType, ForecastBody } from "./nql/types";
@@ -36,10 +36,10 @@ import type { PingStatus } from "./ping/types";
 import { type Product, ProductsApi } from "./products";
 import { type CreateNqlQueryRequest, type NqlOwnedQueryResponse, type NqlQueryAst, type NqlQueryCollaborators, type NqlQueryMetadata, type NqlQueryOwner, type NqlQueryResponse, type NqlSharedQueryResponse, QueriesApi, type UpdateNqlQueryRequest } from "./queries";
 import { type BucketCreationRequest, type Resource, ResourceApi, type UpdateAccessTypeRequest } from "./resources";
+import { type ConversationAssistantMessage, type ConversationAssistantMessageWithFunctionCall, type ConversationAssistantMessageWithoutFunctionCall, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageFunctionCall, type ConversationMessageName, type ConversationMessageRole, type ConversationMessages, type ConversationSystemMessage, type ConversationUserMessage, isConversationAssistantMessage, isConversationAssistantMessageWithFunctionCall, isConversationAssistantMessageWithoutFunctionCall, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageFunctionCall, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isRosettaRequestMessage, isType, type RosettaRequestMessage, type RosettaResponseMessage } from "./rosetta/types";
 import { RosettaStoneApi } from "./rosetta-stone";
 import type { SampleRecords } from "./rosetta-stone/types";
-import { type ConversationAssistantMessage, type ConversationAssistantMessageWithFunctionCall, type ConversationAssistantMessageWithoutFunctionCall, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageFunctionCall, type ConversationMessageName, type ConversationMessageRole, type ConversationMessages, type ConversationSystemMessage, type ConversationUserMessage, type RosettaRequestMessage, type RosettaResponseMessage, isConversationAssistantMessage, isConversationAssistantMessageWithFunctionCall, isConversationAssistantMessageWithoutFunctionCall, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageFunctionCall, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isRosettaRequestMessage, isType } from "./rosetta/types";
-import { type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails, type Subscription, type SubscriptionBudget, type SubscriptionDetails, type SubscriptionOutput, type SubscriptionStatus, type SubscriptionType, SubscriptionsApi } from "./subscriptions";
+import { type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails, type Subscription, type SubscriptionBudget, type SubscriptionDetails, type SubscriptionOutput, type SubscriptionStatus, SubscriptionsApi, type SubscriptionType } from "./subscriptions";
 import type { ApiRecords, ApiRecordsV2, CollaboratorList, CollaboratorsConfig, Config, Environment, GeneralCollaborator, GeneralCollaboratorType, MonetaryAmount, NonAuthenticatedCollaborator, QueryAccess, QueryCollaborator, SpecificCollaboratorType, ViewAccess, ViewCollaborator } from "./types";
 import { UploadsApi } from "./uploads";
 import type { UploadsResponse } from "./uploads/types";

package/build/index.js

@@ -20,15 +20,15 @@ import JsonBigNumber from "./json-big-number";
 import { MappingsApi } from "./mappings";
 import { ModelTrainingApi, } from "./model-training";
 import { ModelsApi, } from "./models";
-import { NqlApi, compileStatement, parseStatement, } from "./nql";
+import { compileStatement, NqlApi, parseStatement, } from "./nql";
 import { convertNqlObjectToForecastBody } from "./nql/DataRulesConverter";
 import { buildNql, getNqlObject } from "./nql/NQLParser";
 import { PingApi } from "./ping";
 import { ProductsApi } from "./products";
 import { QueriesApi, } from "./queries";
 import { ResourceApi, } from "./resources";
-import { RosettaStoneApi } from "./rosetta-stone";
 import { isConversationAssistantMessage, isConversationAssistantMessageWithFunctionCall, isConversationAssistantMessageWithoutFunctionCall, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageFunctionCall, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isRosettaRequestMessage, isType, } from "./rosetta/types";
+import { RosettaStoneApi } from "./rosetta-stone";
 import { SubscriptionsApi, } from "./subscriptions";
 import { UploadsApi } from "./uploads";
 import { applyMixins } from "./utils";
@@ -68,6 +68,4 @@ applyMixins(NarrativeApi, [
     EncryptionMaterialApi,
     WhoAmIApi,
 ]);
-export { 
-// biome-ignore lint/style/useExportType: We need to export the class
-NarrativeApi, AttributeApi, AttributeApiV2, AccessTokensApi, DataPlaneApi, HealthCheckApi, DatasetApi, EncryptionMaterialApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, QueriesApi, ViewsApi, ModelsApi, ModelTrainingApi, WhoAmIApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, resources, compileStatement, parseStatement, JsonBigNumber, };
+export { NarrativeApi, AttributeApi, AttributeApiV2, AccessTokensApi, DataPlaneApi, HealthCheckApi, DatasetApi, EncryptionMaterialApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, QueriesApi, ViewsApi, ModelsApi, 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/jobs/index.d.ts

@@ -1,6 +1,6 @@
 import { BaseApi } from "../base-api";
 import type { ApiRecords } from "../types";
-import type { ColumnDetails, DatasetsCalculateColumnStatsJob, DatasetsDeleteTableJob, DatasetsDeliverDataJob, DatasetsSampleJob, DeleteInput, DeliverInput, ExplainInput, ExplainJob, ExplainOutput, ForecastInput, ForecastJob, Job, JobRequestSource, JobRequestSourceApiUser, JobRequestSourceProcess, MaterializedViewInput, MaterializedViewJob, MaterializedViewOutput, ModelTrainingRunInput, ModelTrainingRunJob, ModelsDeliverModelInput, ModelsDeliverModelJob, SampleInput, StatsInput } from "./types";
+import type { ColumnDetails, DatasetsCalculateColumnStatsJob, DatasetsDeleteTableJob, DatasetsDeliverDataJob, DatasetsSampleJob, DeleteInput, DeliverInput, ExplainInput, ExplainJob, ExplainOutput, ForecastInput, ForecastJob, Job, JobRequestSource, JobRequestSourceApiUser, JobRequestSourceProcess, MaterializedViewInput, MaterializedViewJob, MaterializedViewOutput, ModelsDeliverModelInput, ModelsDeliverModelJob, ModelTrainingRunInput, ModelTrainingRunJob, SampleInput, StatsInput } from "./types";
 interface GetJobsParameters extends Record<string, string | number | boolean | undefined> {
     dataset_id?: number;
     per_page?: number;

package/build/jobs/types.d.ts

@@ -1,7 +1,7 @@
 import type { ForecastResult, JobState } from "src/forecast";
 import type { DataStreamPurchaseDetails, ForecastDimensions, MarketplaceForecastDetails } from "src/forecast/types";
 import type { NqlBudget } from "src/nql/types";
-export type JobType = "forecast" | "nql-forecast" | "materialize-view" | "datasets_calculate_column_stats" | "datasets_delete_table" | "datasets_deliver_data" | "datasets_sample" | "models_deliver_model" | "model_training_run";
+export type JobType = "forecast" | "nql-forecast" | "materialize-view" | "datasets_calculate_column_stats" | "datasets_delete_table" | "datasets_deliver_data" | "datasets_sample" | "models_deliver_model" | "models_train_classifier" | "model_training_run";
 export interface JobRequestSource {
     type: string;
     company_id: number;
@@ -157,5 +157,179 @@ export interface UnknownJob extends BaseJob {
     input: unknown;
     result?: unknown;
 }
-export type Job = ForecastJob | ExplainJob | MaterializedViewJob | DatasetsDeleteTableJob | DatasetsDeliverDataJob | DatasetsSampleJob | DatasetsCalculateColumnStatsJob | ModelTrainingRunJob | ModelsDeliverModelJob | UnknownJob;
+export interface ModelsTrainClassifierJob extends BaseJob {
+    type: "models_train_classifier";
+    result: ModelsTrainClassifierResults;
+}
+export type Job = ForecastJob | ExplainJob | MaterializedViewJob | DatasetsDeleteTableJob | DatasetsDeliverDataJob | DatasetsSampleJob | DatasetsCalculateColumnStatsJob | ModelTrainingRunJob | ModelsDeliverModelJob | ModelsTrainClassifierJob | UnknownJob;
+interface ModelsTrainClassifierTrainingSummary {
+    total_features: number;
+    feature_types: Record<"text" | "categorical" | "embedding" | "numeric", number>;
+    test_accuracy: number;
+    num_classes: number;
+    class_names: Record<string, string>;
+    error?: unknown;
+}
+interface ModelsTrainClassifierRegistryInfo {
+    model_stored: boolean;
+    model_name: string;
+    model_version: string;
+    registry_database: string;
+    registry_schema: string;
+    model_task: string;
+}
+interface ModelsTrainClassifierMinimalMetrics {
+    num_classes: number;
+    class_names: Record<string, string>;
+    accuracy: number;
+    f1_macro: number;
+    precision_macro: number;
+    recall_macro: number;
+}
+interface ModelsTrainClassifierConfig {
+    name: string;
+    version: string;
+    [key: string]: unknown;
+}
+type ModelsTrainClassifierResults = {
+    status: "success" | "error";
+    registry_info?: ModelsTrainClassifierRegistryInfo;
+    num_categories: number;
+    rows_processed: number;
+    rows_dropped: number;
+    metrics: {
+        minimal: ModelsTrainClassifierMinimalMetrics;
+        detailed: DetailedAnalytics;
+    };
+    debug_info?: unknown;
+    config: ModelsTrainClassifierConfig;
+    training_summary: ModelsTrainClassifierTrainingSummary;
+};
+type Metric<V = unknown, M extends Record<string, unknown> = Record<string, unknown>> = {
+    value: V;
+    metadata: M;
+};
+interface AveragePredictionEntropy {
+    correct_predictions: number;
+    incorrect_predictions: number;
+    entropy_difference: number;
+}
+interface PerClassMetricsLabeledPost {
+    class: string;
+    f1_score: number;
+    precision: number;
+    recall: number;
+    support: number;
+    avg_confidence_when_correct: number;
+    total_instances: number;
+    correct_predictions: number;
+}
+interface EntropyStats {
+    min: number;
+    max: number;
+    mean: number;
+    std: number;
+    median: number;
+    perplexity_mean: number;
+    perplexity_median: number;
+    normalized_perplexity_mean: number;
+    normalized_perplexity_median: number;
+}
+interface EntropyPrioritizationHistogram {
+    min: number;
+    max: number;
+    count: number;
+    inclusive_left: number;
+    inclusive_right: number;
+}
+interface TopEntropyRecord {
+    entropy: number;
+    top5_predicted_classes: [string, number][];
+    ID_COLUMN: string;
+    LABEL_COLUMN: string;
+    [key: string]: unknown;
+}
+interface GlobalMetrics {
+    num_documents_corpus_pre: Metric<number, never>;
+    num_documents_labeled_pre: Metric<number, never>;
+    percent_labeled_corpus_pre: Metric<number, never>;
+    label_distribution_labeled_pre: Metric<Record<string, number>, never>;
+    class_imbalance_labeled_pre: Metric<number, never>;
+    missing_values_corpus_pre: Metric<number, never>;
+    duplicate_count_corpus_pre: Metric<number, never>;
+    accuracy_labeled_post: Metric<number, never>;
+    precision_macro_labeled_post: Metric<number, never>;
+    recall_macro_labeled_post: Metric<number, never>;
+    f1_macro_labeled_post: Metric<number, never>;
+    confusion_matrix_labeled_post: Metric<number[][], never>;
+    top_n_accuracy_labeled_post: Metric<Record<string, number>, never>;
+    auc_roc_labeled_post: Metric<number, never>;
+    avg_prediction_entropy_labeled_post: Metric<AveragePredictionEntropy, never>;
+    per_class_metrics_labeled_post: Metric<PerClassMetricsLabeledPost[], never>;
+    entropy_stats: Metric<EntropyStats, never>;
+    entropy_prioritization_histogram: Metric<EntropyPrioritizationHistogram[], never>;
+    top_entropy_records: Metric<TopEntropyRecord[], never>;
+}
+type TopTermsValue = Record<string, number>;
+interface FeatureError {
+    feature: string;
+    prevalence_diff: number;
+    incorrect_prevalence: number;
+    correct_prevalence: number;
+    ratio: number;
+}
+interface ErrorConcentration {
+    feature: string;
+    records_with_feature: number;
+    errors_with_feature: number;
+    error_rate: number;
+    overall_error_rate: number;
+    error_lift: number;
+}
+interface ErrorPredictionImportance {
+    feature: string;
+    correlation: number;
+    p_value: number;
+    abs_correlation: number;
+}
+interface DynamicTextFeatureMetrics {
+    [key: `${string}_avg_doc_length_corpus_pre`]: Metric<number>;
+    [key: `${string}_avg_doc_length_labeled_pre`]: Metric<number>;
+    [key: `${string}_ngram_vocab_size_corpus_pre`]: Metric<number>;
+    [key: `${string}_ngram_vocab_size_labeled_pre`]: Metric<number>;
+    [key: `${string}_ngram_top_terms_corpus_pre`]: Metric<TopTermsValue>;
+    [key: `${string}_ngram_top_terms_labeled_pre`]: Metric<TopTermsValue>;
+    [key: `${string}_ngram_diversity_corpus_pre`]: Metric<number>;
+    [key: `${string}_ngram_stopword_percentage_corpus_pre`]: Metric<number>;
+    [key: `${string}_ngram_entropy_corpus_pre`]: Metric<number>;
+    [key: `${string}_ngram_oov_rate_corpus_pre`]: Metric<number>;
+    [key: `${string}_ngram_sparsity_labeled_pre`]: Metric<number>;
+    [key: `${string}_ngram_diversity_labeled_pre`]: Metric<number>;
+    [key: `${string}_ngram_stopword_percentage_labeled_pre`]: Metric<number>;
+    [key: `${string}_ngram_entropy_labeled_pre`]: Metric<number>;
+    [key: `${string}_ngram_sparsity_labeled_post`]: Metric<number>;
+    [key: `${string}_ngram_top_oov_tokens`]: Metric<string>;
+    [key: `${string}_features_prevalent_in_errors`]: Metric<FeatureError[], {
+        description: string;
+        total_correct: number;
+        total_incorrect: number;
+        analysis_type: string;
+    }>;
+    [key: `${string}_feature_error_concentration`]: Metric<ErrorConcentration[], {
+        description: string;
+        metric_type: string;
+    }>;
+    [key: `${string}_error_prediction_importance`]: Metric<ErrorPredictionImportance[], {
+        description: string;
+        metric_type: string;
+    }>;
+    [key: `${string}_ttr_corpus_pre`]: Metric<number>;
+    [key: `${string}_ttr_labeled_pre`]: Metric<number>;
+    [key: `${string}_ttr_per_class_labeled_pre`]: Metric<Record<string, number>>;
+}
+export type DetailedAnalytics = {
+    global: GlobalMetrics;
+} & {
+    [dynamicKey: string]: DynamicTextFeatureMetrics;
+};
 export {};

package/build/nql/Ast.d.ts

@@ -8,7 +8,7 @@ export declare const NqlAstTypes: {
     binary_op: NqlBinaryOp;
     case: NqlCase;
     function: NqlFunction;
-    literal: NqlLit<NqlSimpleType>;
+    literal: NqlLit;
     string_literal: NqlLit<NqlStringType>;
     long_literal: NqlLit<NqlLongType>;
     double_literal: NqlLit<NqlDoubleType>;

package/build/nql/NqlBuilder.js

@@ -355,9 +355,6 @@ function compilePostfixUnaryOperator(op, operand, as, dsMap) {
 function compileRawRef(nql, as) {
     return aliased(nql, as);
 }
-function compileUnaryMinus(operand, as, dsMap) {
-    return aliased(`-(${compileExpression(operand, dsMap)})`, as);
-}
 export function compilePlaceholder(n) {
     switch (n.expectedType) {
         case "literal":
@@ -394,6 +391,6 @@ function isArray(ns) {
     return Array.isArray(ns);
 }
 // typescript trick to help with checking exhaustivity of swith statements
-function unreachable(x) {
+function unreachable(_x) {
     throw new Error("unreachable");
 }