@athenaintel/sdk 4.3.2303 → 4.3.2305

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
43
43
  const headers = (0, headers_js_1.mergeHeaders)({
44
44
  "X-Fern-Language": "JavaScript",
45
45
  "X-Fern-SDK-Name": "@athenaintel/sdk",
46
- "X-Fern-SDK-Version": "4.3.2303",
47
- "User-Agent": "@athenaintel/sdk/4.3.2303",
46
+ "X-Fern-SDK-Version": "4.3.2305",
47
+ "User-Agent": "@athenaintel/sdk/4.3.2305",
48
48
  "X-Fern-Runtime": core.RUNTIME.type,
49
49
  "X-Fern-Runtime-Version": core.RUNTIME.version,
50
50
  "X-Athena-Session-Credential": options === null || options === void 0 ? void 0 : options.sessionCredential,
@@ -126,11 +126,14 @@ export declare class ToolsClient {
126
126
  * Returns `columns`, an optional `index`, and `data` rows (pandas "split"
127
127
  * orientation) for an asset the caller can read: an Athena spreadsheet, a
128
128
  * file-backed live spreadsheet (SharePoint, OneDrive, Drive, iManage), or an
129
- * uploaded CSV, Excel or Parquet file. `row_limit` caps the rows returned,
130
- * `columns` selects columns by name or position, `sheet_name` picks the sheet
131
- * of an Excel file (the first by default), and `separator` sets the delimiter
132
- * of a CSV file. Any other asset type is a 415; a file the parser cannot read
133
- * is a 500 carrying the parser's message.
129
+ * uploaded CSV, TSV, Excel or Parquet file. `row_limit` caps the rows
130
+ * returned, `columns` selects columns by name or position, `sheet_name` picks
131
+ * the sheet of an Excel file (the first by default), and `separator` sets the
132
+ * delimiter of a CSV file (a TSV file is always read tab-separated). A CSV or
133
+ * TSV whose rows have different numbers of fields, such as a multi-section
134
+ * export, is read whole: every row is padded with empty cells to the widest
135
+ * row, and the first row is the header. Any other asset type is a 415; a file
136
+ * the parser cannot read is a 500 carrying the parser's message.
134
137
  *
135
138
  * @param {AthenaIntelligence.DataFrameToolsRequest} request
136
139
  * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -574,11 +574,14 @@ class ToolsClient {
574
574
  * Returns `columns`, an optional `index`, and `data` rows (pandas "split"
575
575
  * orientation) for an asset the caller can read: an Athena spreadsheet, a
576
576
  * file-backed live spreadsheet (SharePoint, OneDrive, Drive, iManage), or an
577
- * uploaded CSV, Excel or Parquet file. `row_limit` caps the rows returned,
578
- * `columns` selects columns by name or position, `sheet_name` picks the sheet
579
- * of an Excel file (the first by default), and `separator` sets the delimiter
580
- * of a CSV file. Any other asset type is a 415; a file the parser cannot read
581
- * is a 500 carrying the parser's message.
577
+ * uploaded CSV, TSV, Excel or Parquet file. `row_limit` caps the rows
578
+ * returned, `columns` selects columns by name or position, `sheet_name` picks
579
+ * the sheet of an Excel file (the first by default), and `separator` sets the
580
+ * delimiter of a CSV file (a TSV file is always read tab-separated). A CSV or
581
+ * TSV whose rows have different numbers of fields, such as a multi-section
582
+ * export, is read whole: every row is padded with empty cells to the widest
583
+ * row, and the first row is the header. Any other asset type is a 415; a file
584
+ * the parser cannot read is a 500 carrying the parser's message.
582
585
  *
583
586
  * @param {AthenaIntelligence.DataFrameToolsRequest} request
584
587
  * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -48,7 +48,7 @@ export interface SessionOut {
48
48
  thread_id: string;
49
49
  /** Display title of the session */
50
50
  title?: string | null;
51
- /** Total LLM cost of the session in USD, when tracked. Null unless the caller is Athena staff or an owner or manager of the session's workspace */
51
+ /** Total LLM cost of the session in USD, when tracked. Null unless the caller is Athena staff or an owner or manager of the session's workspace. Already includes the workspace's LLM cost multiplier, applied once to the provider's rate; never apply it again. Sessions priced before the in-house token ledger carry their legacy figure, without it. See docs/SESSION_TOKEN_USAGE_AND_TOKEN_COST_GUIDE.md#which-cost-field-do-i-sum. */
52
52
  total_cost_usd?: number | null;
53
53
  /** Trigger that started an AOP/workflow run, such as schedule or api */
54
54
  trigger_type?: string | null;
@@ -17,6 +17,6 @@ export interface WorkspaceUsageComputerOut {
17
17
  title?: string | null;
18
18
  /** Token counters behind this Computer's usage */
19
19
  tokens: AthenaIntelligence.WorkspaceUsageTokensOut;
20
- /** Total LLM cost in USD */
20
+ /** Total LLM cost in USD. Already includes the workspace's LLM cost multiplier, applied once to the provider's rate; never apply it again. Sessions priced before the in-house token ledger carry their legacy figure, without it. See docs/SESSION_TOKEN_USAGE_AND_TOKEN_COST_GUIDE.md#which-cost-field-do-i-sum. */
21
21
  total_cost_usd: number;
22
22
  }
@@ -9,6 +9,6 @@ export interface WorkspaceUsageDayOut {
9
9
  session_count: number;
10
10
  /** Token counters for the day */
11
11
  tokens: AthenaIntelligence.WorkspaceUsageTokensOut;
12
- /** Total LLM cost in USD for the day */
12
+ /** Total LLM cost in USD for the day. Already includes the workspace's LLM cost multiplier, applied once to the provider's rate; never apply it again. Sessions priced before the in-house token ledger carry their legacy figure, without it. See docs/SESSION_TOKEN_USAGE_AND_TOKEN_COST_GUIDE.md#which-cost-field-do-i-sum. */
13
13
  total_cost_usd: number;
14
14
  }
@@ -5,7 +5,7 @@ import type * as AthenaIntelligence from "../index.js";
5
5
  export interface WorkspaceUsageResponseOut {
6
6
  /** Users with at least one session */
7
7
  active_users: number;
8
- /** Portion of total_cost_usd produced by Computers */
8
+ /** Portion of total_cost_usd produced by Computers. Already includes the workspace's LLM cost multiplier, applied once to the provider's rate; never apply it again. Sessions priced before the in-house token ledger carry their legacy figure, without it. See docs/SESSION_TOKEN_USAGE_AND_TOKEN_COST_GUIDE.md#which-cost-field-do-i-sum. */
9
9
  computer_cost_usd: number;
10
10
  /** Number of Computer usage sessions */
11
11
  computer_sessions: number;
@@ -15,7 +15,7 @@ export interface WorkspaceUsageResponseOut {
15
15
  daily: AthenaIntelligence.WorkspaceUsageDayOut[];
16
16
  /** Length of the reporting window in days */
17
17
  days: number;
18
- /** Cost of dry-run (test) sessions */
18
+ /** Cost in USD of dry-run (test) sessions. Already includes the workspace's LLM cost multiplier, applied once to the provider's rate; never apply it again. Sessions priced before the in-house token ledger carry their legacy figure, without it. See docs/SESSION_TOKEN_USAGE_AND_TOKEN_COST_GUIDE.md#which-cost-field-do-i-sum. */
19
19
  dry_run_cost_usd: number;
20
20
  /** Number of dry-run (test) sessions */
21
21
  dry_run_sessions: number;
@@ -27,7 +27,7 @@ export interface WorkspaceUsageResponseOut {
27
27
  per_user: AthenaIntelligence.WorkspaceUsageUserOut[];
28
28
  /** Token counters across the workspace's sessions in the window, excluding dry-run (test) sessions */
29
29
  tokens: AthenaIntelligence.WorkspaceUsageTokensOut;
30
- /** Total LLM cost in USD */
30
+ /** Total LLM cost in USD. Already includes the workspace's LLM cost multiplier, applied once to the provider's rate; never apply it again. Sessions priced before the in-house token ledger carry their legacy figure, without it. See docs/SESSION_TOKEN_USAGE_AND_TOKEN_COST_GUIDE.md#which-cost-field-do-i-sum. */
31
31
  total_cost_usd: number;
32
32
  /** Number of sessions in the window */
33
33
  total_sessions: number;
@@ -36,7 +36,7 @@ export interface WorkspaceUsageSessionRowOut {
36
36
  requested_model: string | null;
37
37
  /** Model that actually served the calls */
38
38
  resolved_model: string;
39
- /** Billed cost of this row in USD; safe to sum across rows */
39
+ /** Billed cost of this row in USD; safe to sum across rows. Already includes the workspace's LLM cost multiplier, applied once to the provider's rate; never apply it again. See docs/SESSION_TOKEN_USAGE_AND_TOKEN_COST_GUIDE.md#which-cost-field-do-i-sum. */
40
40
  row_total_cost_usd: number;
41
41
  /** Model calls aggregated into this row */
42
42
  run_count: number;
@@ -44,7 +44,7 @@ export interface WorkspaceUsageSessionRowOut {
44
44
  session_created_at: string;
45
45
  /** Session (conversation) asset id */
46
46
  session_id: string;
47
- /** Billed cost of the whole session in USD, carried by the session's first row only and null on its other rows, so summing the column never double-counts (same convention as the CSV export) */
47
+ /** Billed cost of the whole session in USD, carried by the session's first row only and null on its other rows, so summing the column never double-counts (same convention as the CSV export). Already includes the workspace's LLM cost multiplier, applied once to the provider's rate; never apply it again. Sessions priced before the in-house token ledger carry their legacy figure, without it. See docs/SESSION_TOKEN_USAGE_AND_TOKEN_COST_GUIDE.md#which-cost-field-do-i-sum. */
48
48
  session_total_cost_usd: number | null;
49
49
  /** Outcome of the aggregated calls; `untracked` marks a session metered before token tracking existed, whose token counters are null */
50
50
  status: string;
@@ -15,7 +15,7 @@ export interface WorkspaceUsageUserOut {
15
15
  session_count: number;
16
16
  /** Token counters across the user's sessions */
17
17
  tokens: AthenaIntelligence.WorkspaceUsageTokensOut;
18
- /** Total LLM cost in USD */
18
+ /** Total LLM cost in USD. Already includes the workspace's LLM cost multiplier, applied once to the provider's rate; never apply it again. Sessions priced before the in-house token ledger carry their legacy figure, without it. See docs/SESSION_TOKEN_USAGE_AND_TOKEN_COST_GUIDE.md#which-cost-field-do-i-sum. */
19
19
  total_cost_usd: number;
20
20
  /** The user ID */
21
21
  user_id: string;
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "4.3.2303";
1
+ export declare const SDK_VERSION = "4.3.2305";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "4.3.2303";
4
+ exports.SDK_VERSION = "4.3.2305";
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
6
6
  const headers = mergeHeaders({
7
7
  "X-Fern-Language": "JavaScript",
8
8
  "X-Fern-SDK-Name": "@athenaintel/sdk",
9
- "X-Fern-SDK-Version": "4.3.2303",
10
- "User-Agent": "@athenaintel/sdk/4.3.2303",
9
+ "X-Fern-SDK-Version": "4.3.2305",
10
+ "User-Agent": "@athenaintel/sdk/4.3.2305",
11
11
  "X-Fern-Runtime": core.RUNTIME.type,
12
12
  "X-Fern-Runtime-Version": core.RUNTIME.version,
13
13
  "X-Athena-Session-Credential": options === null || options === void 0 ? void 0 : options.sessionCredential,
@@ -126,11 +126,14 @@ export declare class ToolsClient {
126
126
  * Returns `columns`, an optional `index`, and `data` rows (pandas "split"
127
127
  * orientation) for an asset the caller can read: an Athena spreadsheet, a
128
128
  * file-backed live spreadsheet (SharePoint, OneDrive, Drive, iManage), or an
129
- * uploaded CSV, Excel or Parquet file. `row_limit` caps the rows returned,
130
- * `columns` selects columns by name or position, `sheet_name` picks the sheet
131
- * of an Excel file (the first by default), and `separator` sets the delimiter
132
- * of a CSV file. Any other asset type is a 415; a file the parser cannot read
133
- * is a 500 carrying the parser's message.
129
+ * uploaded CSV, TSV, Excel or Parquet file. `row_limit` caps the rows
130
+ * returned, `columns` selects columns by name or position, `sheet_name` picks
131
+ * the sheet of an Excel file (the first by default), and `separator` sets the
132
+ * delimiter of a CSV file (a TSV file is always read tab-separated). A CSV or
133
+ * TSV whose rows have different numbers of fields, such as a multi-section
134
+ * export, is read whole: every row is padded with empty cells to the widest
135
+ * row, and the first row is the header. Any other asset type is a 415; a file
136
+ * the parser cannot read is a 500 carrying the parser's message.
134
137
  *
135
138
  * @param {AthenaIntelligence.DataFrameToolsRequest} request
136
139
  * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -538,11 +538,14 @@ export class ToolsClient {
538
538
  * Returns `columns`, an optional `index`, and `data` rows (pandas "split"
539
539
  * orientation) for an asset the caller can read: an Athena spreadsheet, a
540
540
  * file-backed live spreadsheet (SharePoint, OneDrive, Drive, iManage), or an
541
- * uploaded CSV, Excel or Parquet file. `row_limit` caps the rows returned,
542
- * `columns` selects columns by name or position, `sheet_name` picks the sheet
543
- * of an Excel file (the first by default), and `separator` sets the delimiter
544
- * of a CSV file. Any other asset type is a 415; a file the parser cannot read
545
- * is a 500 carrying the parser's message.
541
+ * uploaded CSV, TSV, Excel or Parquet file. `row_limit` caps the rows
542
+ * returned, `columns` selects columns by name or position, `sheet_name` picks
543
+ * the sheet of an Excel file (the first by default), and `separator` sets the
544
+ * delimiter of a CSV file (a TSV file is always read tab-separated). A CSV or
545
+ * TSV whose rows have different numbers of fields, such as a multi-section
546
+ * export, is read whole: every row is padded with empty cells to the widest
547
+ * row, and the first row is the header. Any other asset type is a 415; a file
548
+ * the parser cannot read is a 500 carrying the parser's message.
546
549
  *
547
550
  * @param {AthenaIntelligence.DataFrameToolsRequest} request
548
551
  * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -48,7 +48,7 @@ export interface SessionOut {
48
48
  thread_id: string;
49
49
  /** Display title of the session */
50
50
  title?: string | null;
51
- /** Total LLM cost of the session in USD, when tracked. Null unless the caller is Athena staff or an owner or manager of the session's workspace */
51
+ /** Total LLM cost of the session in USD, when tracked. Null unless the caller is Athena staff or an owner or manager of the session's workspace. Already includes the workspace's LLM cost multiplier, applied once to the provider's rate; never apply it again. Sessions priced before the in-house token ledger carry their legacy figure, without it. See docs/SESSION_TOKEN_USAGE_AND_TOKEN_COST_GUIDE.md#which-cost-field-do-i-sum. */
52
52
  total_cost_usd?: number | null;
53
53
  /** Trigger that started an AOP/workflow run, such as schedule or api */
54
54
  trigger_type?: string | null;
@@ -17,6 +17,6 @@ export interface WorkspaceUsageComputerOut {
17
17
  title?: string | null;
18
18
  /** Token counters behind this Computer's usage */
19
19
  tokens: AthenaIntelligence.WorkspaceUsageTokensOut;
20
- /** Total LLM cost in USD */
20
+ /** Total LLM cost in USD. Already includes the workspace's LLM cost multiplier, applied once to the provider's rate; never apply it again. Sessions priced before the in-house token ledger carry their legacy figure, without it. See docs/SESSION_TOKEN_USAGE_AND_TOKEN_COST_GUIDE.md#which-cost-field-do-i-sum. */
21
21
  total_cost_usd: number;
22
22
  }
@@ -9,6 +9,6 @@ export interface WorkspaceUsageDayOut {
9
9
  session_count: number;
10
10
  /** Token counters for the day */
11
11
  tokens: AthenaIntelligence.WorkspaceUsageTokensOut;
12
- /** Total LLM cost in USD for the day */
12
+ /** Total LLM cost in USD for the day. Already includes the workspace's LLM cost multiplier, applied once to the provider's rate; never apply it again. Sessions priced before the in-house token ledger carry their legacy figure, without it. See docs/SESSION_TOKEN_USAGE_AND_TOKEN_COST_GUIDE.md#which-cost-field-do-i-sum. */
13
13
  total_cost_usd: number;
14
14
  }
@@ -5,7 +5,7 @@ import type * as AthenaIntelligence from "../index.mjs";
5
5
  export interface WorkspaceUsageResponseOut {
6
6
  /** Users with at least one session */
7
7
  active_users: number;
8
- /** Portion of total_cost_usd produced by Computers */
8
+ /** Portion of total_cost_usd produced by Computers. Already includes the workspace's LLM cost multiplier, applied once to the provider's rate; never apply it again. Sessions priced before the in-house token ledger carry their legacy figure, without it. See docs/SESSION_TOKEN_USAGE_AND_TOKEN_COST_GUIDE.md#which-cost-field-do-i-sum. */
9
9
  computer_cost_usd: number;
10
10
  /** Number of Computer usage sessions */
11
11
  computer_sessions: number;
@@ -15,7 +15,7 @@ export interface WorkspaceUsageResponseOut {
15
15
  daily: AthenaIntelligence.WorkspaceUsageDayOut[];
16
16
  /** Length of the reporting window in days */
17
17
  days: number;
18
- /** Cost of dry-run (test) sessions */
18
+ /** Cost in USD of dry-run (test) sessions. Already includes the workspace's LLM cost multiplier, applied once to the provider's rate; never apply it again. Sessions priced before the in-house token ledger carry their legacy figure, without it. See docs/SESSION_TOKEN_USAGE_AND_TOKEN_COST_GUIDE.md#which-cost-field-do-i-sum. */
19
19
  dry_run_cost_usd: number;
20
20
  /** Number of dry-run (test) sessions */
21
21
  dry_run_sessions: number;
@@ -27,7 +27,7 @@ export interface WorkspaceUsageResponseOut {
27
27
  per_user: AthenaIntelligence.WorkspaceUsageUserOut[];
28
28
  /** Token counters across the workspace's sessions in the window, excluding dry-run (test) sessions */
29
29
  tokens: AthenaIntelligence.WorkspaceUsageTokensOut;
30
- /** Total LLM cost in USD */
30
+ /** Total LLM cost in USD. Already includes the workspace's LLM cost multiplier, applied once to the provider's rate; never apply it again. Sessions priced before the in-house token ledger carry their legacy figure, without it. See docs/SESSION_TOKEN_USAGE_AND_TOKEN_COST_GUIDE.md#which-cost-field-do-i-sum. */
31
31
  total_cost_usd: number;
32
32
  /** Number of sessions in the window */
33
33
  total_sessions: number;
@@ -36,7 +36,7 @@ export interface WorkspaceUsageSessionRowOut {
36
36
  requested_model: string | null;
37
37
  /** Model that actually served the calls */
38
38
  resolved_model: string;
39
- /** Billed cost of this row in USD; safe to sum across rows */
39
+ /** Billed cost of this row in USD; safe to sum across rows. Already includes the workspace's LLM cost multiplier, applied once to the provider's rate; never apply it again. See docs/SESSION_TOKEN_USAGE_AND_TOKEN_COST_GUIDE.md#which-cost-field-do-i-sum. */
40
40
  row_total_cost_usd: number;
41
41
  /** Model calls aggregated into this row */
42
42
  run_count: number;
@@ -44,7 +44,7 @@ export interface WorkspaceUsageSessionRowOut {
44
44
  session_created_at: string;
45
45
  /** Session (conversation) asset id */
46
46
  session_id: string;
47
- /** Billed cost of the whole session in USD, carried by the session's first row only and null on its other rows, so summing the column never double-counts (same convention as the CSV export) */
47
+ /** Billed cost of the whole session in USD, carried by the session's first row only and null on its other rows, so summing the column never double-counts (same convention as the CSV export). Already includes the workspace's LLM cost multiplier, applied once to the provider's rate; never apply it again. Sessions priced before the in-house token ledger carry their legacy figure, without it. See docs/SESSION_TOKEN_USAGE_AND_TOKEN_COST_GUIDE.md#which-cost-field-do-i-sum. */
48
48
  session_total_cost_usd: number | null;
49
49
  /** Outcome of the aggregated calls; `untracked` marks a session metered before token tracking existed, whose token counters are null */
50
50
  status: string;
@@ -15,7 +15,7 @@ export interface WorkspaceUsageUserOut {
15
15
  session_count: number;
16
16
  /** Token counters across the user's sessions */
17
17
  tokens: AthenaIntelligence.WorkspaceUsageTokensOut;
18
- /** Total LLM cost in USD */
18
+ /** Total LLM cost in USD. Already includes the workspace's LLM cost multiplier, applied once to the provider's rate; never apply it again. Sessions priced before the in-house token ledger carry their legacy figure, without it. See docs/SESSION_TOKEN_USAGE_AND_TOKEN_COST_GUIDE.md#which-cost-field-do-i-sum. */
19
19
  total_cost_usd: number;
20
20
  /** The user ID */
21
21
  user_id: string;
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "4.3.2303";
1
+ export declare const SDK_VERSION = "4.3.2305";
@@ -1 +1 @@
1
- export const SDK_VERSION = "4.3.2303";
1
+ export const SDK_VERSION = "4.3.2305";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@athenaintel/sdk",
3
- "version": "4.3.2303",
3
+ "version": "4.3.2305",
4
4
  "private": false,
5
5
  "repository": "github:Athena-Intel/athena-typescript",
6
6
  "type": "commonjs",
package/reference.md CHANGED
@@ -5783,11 +5783,14 @@ Read a tabular asset as a JSON data frame.
5783
5783
  Returns `columns`, an optional `index`, and `data` rows (pandas "split"
5784
5784
  orientation) for an asset the caller can read: an Athena spreadsheet, a
5785
5785
  file-backed live spreadsheet (SharePoint, OneDrive, Drive, iManage), or an
5786
- uploaded CSV, Excel or Parquet file. `row_limit` caps the rows returned,
5787
- `columns` selects columns by name or position, `sheet_name` picks the sheet
5788
- of an Excel file (the first by default), and `separator` sets the delimiter
5789
- of a CSV file. Any other asset type is a 415; a file the parser cannot read
5790
- is a 500 carrying the parser's message.
5786
+ uploaded CSV, TSV, Excel or Parquet file. `row_limit` caps the rows
5787
+ returned, `columns` selects columns by name or position, `sheet_name` picks
5788
+ the sheet of an Excel file (the first by default), and `separator` sets the
5789
+ delimiter of a CSV file (a TSV file is always read tab-separated). A CSV or
5790
+ TSV whose rows have different numbers of fields, such as a multi-section
5791
+ export, is read whole: every row is padded with empty cells to the widest
5792
+ row, and the first row is the header. Any other asset type is a 415; a file
5793
+ the parser cannot read is a 500 carrying the parser's message.
5791
5794
  </dd>
5792
5795
  </dl>
5793
5796
  </dd>