@knowledge-stack/ksapi 1.139.1 → 1.140.0

package/docs/AdminWorkflowsApi.md

@@ -0,0 +1,424 @@
+# AdminWorkflowsApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getAdminWorkflowByHour**](AdminWorkflowsApi.md#getadminworkflowbyhour) | **GET** /v1/admin/workflows/by-hour | Get Admin Workflow By Hour Handler |
+| [**getAdminWorkflowLeaderboard**](AdminWorkflowsApi.md#getadminworkflowleaderboard) | **GET** /v1/admin/workflows/leaderboard | Get Admin Workflow Leaderboard Handler |
+| [**getAdminWorkflowOutputStats**](AdminWorkflowsApi.md#getadminworkflowoutputstats) | **GET** /v1/admin/workflows/output-stats | Get Admin Workflow Output Stats Handler |
+| [**getAdminWorkflowSummary**](AdminWorkflowsApi.md#getadminworkflowsummary) | **GET** /v1/admin/workflows/summary | Get Admin Workflow Summary Handler |
+| [**getAdminWorkflowTimeseries**](AdminWorkflowsApi.md#getadminworkflowtimeseries) | **GET** /v1/admin/workflows/timeseries | Get Admin Workflow Timeseries Handler |
+
+
+
+## getAdminWorkflowByHour
+
+> HourHistogramResponse getAdminWorkflowByHour(since, until, timezone, definitionId)
+
+Get Admin Workflow By Hour Handler
+
+Runs per hour-of-day (0-23) in the resolved timezone.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminWorkflowsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetAdminWorkflowByHourRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AdminWorkflowsApi(config);
+
+  const body = {
+    // Date | Window start. (optional)
+    since: 2013-10-20T19:20:30+01:00,
+    // Date | Window end. (optional)
+    until: 2013-10-20T19:20:30+01:00,
+    // string | IANA tz override; defaults to tenant setting. (optional)
+    timezone: timezone_example,
+    // string | Scope to one workflow. (optional)
+    definitionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetAdminWorkflowByHourRequest;
+
+  try {
+    const data = await api.getAdminWorkflowByHour(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **since** | `Date` | Window start. | [Optional] [Defaults to `undefined`] |
+| **until** | `Date` | Window end. | [Optional] [Defaults to `undefined`] |
+| **timezone** | `string` | IANA tz override; defaults to tenant setting. | [Optional] [Defaults to `undefined`] |
+| **definitionId** | `string` | Scope to one workflow. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**HourHistogramResponse**](HourHistogramResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+| **0** | Error response. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getAdminWorkflowLeaderboard
+
+> WorkflowLeaderboardResponse getAdminWorkflowLeaderboard(since, until, limit)
+
+Get Admin Workflow Leaderboard Handler
+
+Top workflows and top run owners by run count.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminWorkflowsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetAdminWorkflowLeaderboardRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AdminWorkflowsApi(config);
+
+  const body = {
+    // Date | Window start. (optional)
+    since: 2013-10-20T19:20:30+01:00,
+    // Date | Window end. (optional)
+    until: 2013-10-20T19:20:30+01:00,
+    // number | Top-N per leaderboard. (optional)
+    limit: 56,
+  } satisfies GetAdminWorkflowLeaderboardRequest;
+
+  try {
+    const data = await api.getAdminWorkflowLeaderboard(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **since** | `Date` | Window start. | [Optional] [Defaults to `undefined`] |
+| **until** | `Date` | Window end. | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` | Top-N per leaderboard. | [Optional] [Defaults to `10`] |
+
+### Return type
+
+[**WorkflowLeaderboardResponse**](WorkflowLeaderboardResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+| **0** | Error response. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getAdminWorkflowOutputStats
+
+> WorkflowOutputStatsResponse getAdminWorkflowOutputStats(since, until)
+
+Get Admin Workflow Output Stats Handler
+
+Average output DOCUMENTs generated per workflow definition (completed runs).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminWorkflowsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetAdminWorkflowOutputStatsRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AdminWorkflowsApi(config);
+
+  const body = {
+    // Date | Window start. (optional)
+    since: 2013-10-20T19:20:30+01:00,
+    // Date | Window end. (optional)
+    until: 2013-10-20T19:20:30+01:00,
+  } satisfies GetAdminWorkflowOutputStatsRequest;
+
+  try {
+    const data = await api.getAdminWorkflowOutputStats(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **since** | `Date` | Window start. | [Optional] [Defaults to `undefined`] |
+| **until** | `Date` | Window end. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**WorkflowOutputStatsResponse**](WorkflowOutputStatsResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+| **0** | Error response. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getAdminWorkflowSummary
+
+> WorkflowRunSummaryResponse getAdminWorkflowSummary(since, until, definitionId)
+
+Get Admin Workflow Summary Handler
+
+Tenant-wide run health: counts, failure rate, durations, approval backlog.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminWorkflowsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetAdminWorkflowSummaryRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AdminWorkflowsApi(config);
+
+  const body = {
+    // Date | Window start (inclusive). Defaults to 7 days ago. (optional)
+    since: 2013-10-20T19:20:30+01:00,
+    // Date | Window end (inclusive). (optional)
+    until: 2013-10-20T19:20:30+01:00,
+    // string | Scope all numbers to one workflow. (optional)
+    definitionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetAdminWorkflowSummaryRequest;
+
+  try {
+    const data = await api.getAdminWorkflowSummary(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **since** | `Date` | Window start (inclusive). Defaults to 7 days ago. | [Optional] [Defaults to `undefined`] |
+| **until** | `Date` | Window end (inclusive). | [Optional] [Defaults to `undefined`] |
+| **definitionId** | `string` | Scope all numbers to one workflow. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**WorkflowRunSummaryResponse**](WorkflowRunSummaryResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+| **0** | Error response. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getAdminWorkflowTimeseries
+
+> RunTimeseriesResponse getAdminWorkflowTimeseries(since, until, bucket, timezone, definitionId)
+
+Get Admin Workflow Timeseries Handler
+
+Run counts bucketed over time, in the resolved timezone.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminWorkflowsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetAdminWorkflowTimeseriesRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AdminWorkflowsApi(config);
+
+  const body = {
+    // Date | Window start. (optional)
+    since: 2013-10-20T19:20:30+01:00,
+    // Date | Window end. (optional)
+    until: 2013-10-20T19:20:30+01:00,
+    // TimeBucket | Bucket size. (optional)
+    bucket: ...,
+    // string | IANA tz override; defaults to tenant setting. (optional)
+    timezone: timezone_example,
+    // string | Scope to one workflow. (optional)
+    definitionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetAdminWorkflowTimeseriesRequest;
+
+  try {
+    const data = await api.getAdminWorkflowTimeseries(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **since** | `Date` | Window start. | [Optional] [Defaults to `undefined`] |
+| **until** | `Date` | Window end. | [Optional] [Defaults to `undefined`] |
+| **bucket** | `TimeBucket` | Bucket size. | [Optional] [Defaults to `undefined`] [Enum: hour, day, week, month] |
+| **timezone** | `string` | IANA tz override; defaults to tenant setting. | [Optional] [Defaults to `undefined`] |
+| **definitionId** | `string` | Scope to one workflow. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**RunTimeseriesResponse**](RunTimeseriesResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+| **0** | Error response. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/DefinitionOutputStat.md

@@ -0,0 +1,41 @@
+
+# DefinitionOutputStat
+
+Average output-document count for one workflow definition.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`definitionId` | string
+`name` | string
+`completedRuns` | number
+`avgDocuments` | number
+
+## Example
+
+```typescript
+import type { DefinitionOutputStat } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "definitionId": null,
+  "name": null,
+  "completedRuns": null,
+  "avgDocuments": null,
+} satisfies DefinitionOutputStat
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DefinitionOutputStat
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/HourHistogramResponse.md

@@ -0,0 +1,37 @@
+
+# HourHistogramResponse
+
+Workflow runs by hour-of-day (0-23) in the resolved timezone.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`timezone` | string
+`countsByHour` | Array<number>
+
+## Example
+
+```typescript
+import type { HourHistogramResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "timezone": null,
+  "countsByHour": null,
+} satisfies HourHistogramResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as HourHistogramResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/KbMetric.md

@@ -0,0 +1,33 @@
+
+# KbMetric
+
+A knowledge-base time series the dashboard can request.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { KbMetric } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies KbMetric
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as KbMetric
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/KbSummaryResponse.md

@@ -0,0 +1,67 @@
+
+# KbSummaryResponse
+
+Point-in-time knowledge-base totals for a tenant.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`documentsTotal` | number
+`documentsByOrigin` | { [key: string]: number; }
+`documentsByType` | { [key: string]: number; }
+`documentVersionsTotal` | number
+`chunksTotal` | number
+`chunksByType` | { [key: string]: number; }
+`tokensTotal` | number
+`sectionsTotal` | number
+`threadsTotal` | number
+`messagesTotal` | number
+`messagesByRole` | { [key: string]: number; }
+`dataSourcesTotal` | number
+`dataSourceTablesTotal` | number
+`documentsCheckedOut` | number
+`quota` | [Array<MeteredQuotaStatus>](MeteredQuotaStatus.md)
+`feedbackUp` | number
+`feedbackDown` | number
+
+## Example
+
+```typescript
+import type { KbSummaryResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "documentsTotal": null,
+  "documentsByOrigin": null,
+  "documentsByType": null,
+  "documentVersionsTotal": null,
+  "chunksTotal": null,
+  "chunksByType": null,
+  "tokensTotal": null,
+  "sectionsTotal": null,
+  "threadsTotal": null,
+  "messagesTotal": null,
+  "messagesByRole": null,
+  "dataSourcesTotal": null,
+  "dataSourceTablesTotal": null,
+  "documentsCheckedOut": null,
+  "quota": null,
+  "feedbackUp": null,
+  "feedbackDown": null,
+} satisfies KbSummaryResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as KbSummaryResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/KbTimeseriesResponse.md

@@ -0,0 +1,41 @@
+
+# KbTimeseriesResponse
+
+A knowledge-base metric bucketed over time.  ``series`` carries one entry per split — two (SOURCE / GENERATED) for ``document_uploads``, one for the ingestion metrics.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`metric` | [KbMetric](KbMetric.md)
+`timezone` | string
+`bucket` | [TimeBucket](TimeBucket.md)
+`series` | [Array<LabeledSeries>](LabeledSeries.md)
+
+## Example
+
+```typescript
+import type { KbTimeseriesResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "metric": null,
+  "timezone": null,
+  "bucket": null,
+  "series": null,
+} satisfies KbTimeseriesResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as KbTimeseriesResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/LabeledSeries.md

@@ -0,0 +1,37 @@
+
+# LabeledSeries
+
+A named series (e.g. one per document origin or ingestion outcome).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`label` | string
+`points` | [Array<TimeseriesPoint>](TimeseriesPoint.md)
+
+## Example
+
+```typescript
+import type { LabeledSeries } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "label": null,
+  "points": null,
+} satisfies LabeledSeries
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as LabeledSeries
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+