mirror of
https://github.com/fabro-sh/fabro.git
synced 2026-10-07 03:00:29 +00:00
3dcf2ad04b
Replay persisted run events for attach requests, keep the SSE stream live only while the run is active, and close on terminal run events instead of returning 410 for completed runs. The CLI now treats premature attach EOF as an error, and the affected integration tests were stabilized around store-backed event ordering and recovered rewind timelines.
1263 lines
69 KiB
TypeScript
1263 lines
69 KiB
TypeScript
/* tslint:disable */
|
|
/* eslint-disable */
|
|
/**
|
|
* Fabro Run API
|
|
* HTTP API for managing Fabro workflow run executions.
|
|
*
|
|
* The version of the OpenAPI document: 0.1.0
|
|
*
|
|
*
|
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
* https://openapi-generator.tech
|
|
* Do not edit the class manually.
|
|
*/
|
|
|
|
|
|
import type { Configuration } from '../configuration';
|
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
import globalAxios from 'axios';
|
|
// Some imports not used depending on template conditions
|
|
// @ts-ignore
|
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
|
|
// @ts-ignore
|
|
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
|
|
// @ts-ignore
|
|
import type { AppendEventResponse } from '../models';
|
|
// @ts-ignore
|
|
import type { ArtifactListResponse } from '../models';
|
|
// @ts-ignore
|
|
import type { ErrorResponse } from '../models';
|
|
// @ts-ignore
|
|
import type { PaginatedEventList } from '../models';
|
|
// @ts-ignore
|
|
import type { PaginatedRunStageList } from '../models';
|
|
// @ts-ignore
|
|
import type { PaginatedStageTurnList } from '../models';
|
|
// @ts-ignore
|
|
import type { RunArtifactListResponse } from '../models';
|
|
// @ts-ignore
|
|
import type { RunCheckpoint } from '../models';
|
|
// @ts-ignore
|
|
import type { RunEvent } from '../models';
|
|
// @ts-ignore
|
|
import type { RunProjection } from '../models';
|
|
// @ts-ignore
|
|
import type { RunSettings } from '../models';
|
|
// @ts-ignore
|
|
import type { WriteBlobResponse } from '../models';
|
|
/**
|
|
* RunInternalsApi - axios parameter creator
|
|
*/
|
|
export const RunInternalsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
return {
|
|
/**
|
|
* Appends a validated event to the run event log. Intended for trusted internal callers.
|
|
* @summary Append Run Event
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {RunEvent} runEvent
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
appendRunEvent: async (id: string, runEvent: RunEvent, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'id' is not null or undefined
|
|
assertParamExists('appendRunEvent', 'id', id)
|
|
// verify required parameter 'runEvent' is not null or undefined
|
|
assertParamExists('appendRunEvent', 'runEvent', runEvent)
|
|
const localVarPath = `/api/v1/runs/{id}/events`
|
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
localVarRequestOptions.data = serializeDataIfNeeded(runEvent, localVarRequestOptions, configuration)
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
/**
|
|
* Opens an ordered server-sent event stream starting at `since_seq`, replaying persisted events and continuing with live updates while the run remains active.
|
|
* @summary Attach Run Events
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {number} [sinceSeq] First event sequence number to include.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
attachRunEvents: async (id: string, sinceSeq?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'id' is not null or undefined
|
|
assertParamExists('attachRunEvents', 'id', id)
|
|
const localVarPath = `/api/v1/runs/{id}/attach`
|
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
if (sinceSeq !== undefined) {
|
|
localVarQueryParameter['since_seq'] = sinceSeq;
|
|
}
|
|
|
|
localVarHeaderParameter['Accept'] = 'text/event-stream,application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
/**
|
|
* Returns the internal event-sourced run projection. This is not a stable public contract.
|
|
* @summary Get Run State
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
getRunState: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'id' is not null or undefined
|
|
assertParamExists('getRunState', 'id', id)
|
|
const localVarPath = `/api/v1/runs/{id}/state`
|
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
/**
|
|
* Downloads an artifact by filename.
|
|
* @summary Get Stage Artifact
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} stageId Identifier of a stage within a run\'s workflow graph, serialized as `node_id@visit`.
|
|
* @param {string} filename Relative artifact path. `/` is allowed as a path separator. Backslash, empty segments, and traversal segments (`.` and `..`) are invalid.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
getStageArtifact: async (id: string, stageId: string, filename: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'id' is not null or undefined
|
|
assertParamExists('getStageArtifact', 'id', id)
|
|
// verify required parameter 'stageId' is not null or undefined
|
|
assertParamExists('getStageArtifact', 'stageId', stageId)
|
|
// verify required parameter 'filename' is not null or undefined
|
|
assertParamExists('getStageArtifact', 'filename', filename)
|
|
const localVarPath = `/api/v1/runs/{id}/stages/{stageId}/artifacts/download`
|
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)))
|
|
.replace(`{${"stageId"}}`, encodeURIComponent(String(stageId)));
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
if (filename !== undefined) {
|
|
localVarQueryParameter['filename'] = filename;
|
|
}
|
|
|
|
localVarHeaderParameter['Accept'] = 'application/octet-stream,application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
/**
|
|
* Lists captured artifact files for a run.
|
|
* @summary List Run Artifacts
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
listRunArtifacts: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'id' is not null or undefined
|
|
assertParamExists('listRunArtifacts', 'id', id)
|
|
const localVarPath = `/api/v1/runs/{id}/artifacts`
|
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
/**
|
|
* Returns a paginated JSON list of stored run events.
|
|
* @summary List Run Events
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {number} [sinceSeq] First event sequence number to include.
|
|
* @param {number} [limit] Maximum number of events to return.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
listRunEvents: async (id: string, sinceSeq?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'id' is not null or undefined
|
|
assertParamExists('listRunEvents', 'id', id)
|
|
const localVarPath = `/api/v1/runs/{id}/events`
|
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
if (sinceSeq !== undefined) {
|
|
localVarQueryParameter['since_seq'] = sinceSeq;
|
|
}
|
|
|
|
if (limit !== undefined) {
|
|
localVarQueryParameter['limit'] = limit;
|
|
}
|
|
|
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
/**
|
|
* Returns the ordered list of stages in a run\'s workflow graph with their current status and timing. Stages are bounded by the workflow graph size, typically fewer than 20.
|
|
* @summary List Run Stages
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {number} [pageLimit] Maximum number of items to return per page.
|
|
* @param {number} [pageOffset] Number of items to skip before returning results.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
listRunStages: async (id: string, pageLimit?: number, pageOffset?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'id' is not null or undefined
|
|
assertParamExists('listRunStages', 'id', id)
|
|
const localVarPath = `/api/v1/runs/{id}/stages`
|
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
if (pageLimit !== undefined) {
|
|
localVarQueryParameter['page[limit]'] = pageLimit;
|
|
}
|
|
|
|
if (pageOffset !== undefined) {
|
|
localVarQueryParameter['page[offset]'] = pageOffset;
|
|
}
|
|
|
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
/**
|
|
* Lists artifact filenames stored for a stage.
|
|
* @summary List Stage Artifacts
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} stageId Identifier of a stage within a run\'s workflow graph, serialized as `node_id@visit`.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
listStageArtifacts: async (id: string, stageId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'id' is not null or undefined
|
|
assertParamExists('listStageArtifacts', 'id', id)
|
|
// verify required parameter 'stageId' is not null or undefined
|
|
assertParamExists('listStageArtifacts', 'stageId', stageId)
|
|
const localVarPath = `/api/v1/runs/{id}/stages/{stageId}/artifacts`
|
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)))
|
|
.replace(`{${"stageId"}}`, encodeURIComponent(String(stageId)));
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
/**
|
|
* Returns a paginated list of conversation turns within a specific stage, including system prompts, assistant responses, and tool invocations.
|
|
* @summary List Stage Turns
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} stageId Identifier of a stage within a run\'s workflow graph, serialized as `node_id@visit`.
|
|
* @param {number} [pageLimit] Maximum number of items to return per page.
|
|
* @param {number} [pageOffset] Number of items to skip before returning results.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
listStageTurns: async (id: string, stageId: string, pageLimit?: number, pageOffset?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'id' is not null or undefined
|
|
assertParamExists('listStageTurns', 'id', id)
|
|
// verify required parameter 'stageId' is not null or undefined
|
|
assertParamExists('listStageTurns', 'stageId', stageId)
|
|
const localVarPath = `/api/v1/runs/{id}/stages/{stageId}/turns`
|
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)))
|
|
.replace(`{${"stageId"}}`, encodeURIComponent(String(stageId)));
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
if (pageLimit !== undefined) {
|
|
localVarQueryParameter['page[limit]'] = pageLimit;
|
|
}
|
|
|
|
if (pageOffset !== undefined) {
|
|
localVarQueryParameter['page[offset]'] = pageOffset;
|
|
}
|
|
|
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
/**
|
|
* Uploads an artifact for a stage. Intended for trusted internal callers.
|
|
* @summary Put Stage Artifact
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} stageId Identifier of a stage within a run\'s workflow graph, serialized as `node_id@visit`.
|
|
* @param {string} filename Relative artifact path. `/` is allowed as a path separator. Backslash, empty segments, and traversal segments (`.` and `..`) are invalid.
|
|
* @param {File} body
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
putStageArtifact: async (id: string, stageId: string, filename: string, body: File, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'id' is not null or undefined
|
|
assertParamExists('putStageArtifact', 'id', id)
|
|
// verify required parameter 'stageId' is not null or undefined
|
|
assertParamExists('putStageArtifact', 'stageId', stageId)
|
|
// verify required parameter 'filename' is not null or undefined
|
|
assertParamExists('putStageArtifact', 'filename', filename)
|
|
// verify required parameter 'body' is not null or undefined
|
|
assertParamExists('putStageArtifact', 'body', body)
|
|
const localVarPath = `/api/v1/runs/{id}/stages/{stageId}/artifacts`
|
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)))
|
|
.replace(`{${"stageId"}}`, encodeURIComponent(String(stageId)));
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
if (filename !== undefined) {
|
|
localVarQueryParameter['filename'] = filename;
|
|
}
|
|
|
|
localVarHeaderParameter['Content-Type'] = 'application/octet-stream';
|
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
/**
|
|
* Reads a previously stored blob by identifier.
|
|
* @summary Read Run Blob
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} blobId Content-addressed blob identifier.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
readRunBlob: async (id: string, blobId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'id' is not null or undefined
|
|
assertParamExists('readRunBlob', 'id', id)
|
|
// verify required parameter 'blobId' is not null or undefined
|
|
assertParamExists('readRunBlob', 'blobId', blobId)
|
|
const localVarPath = `/api/v1/runs/{id}/blobs/{blobId}`
|
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)))
|
|
.replace(`{${"blobId"}}`, encodeURIComponent(String(blobId)));
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
localVarHeaderParameter['Accept'] = 'application/octet-stream,application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
/**
|
|
* Returns the latest checkpoint data for a run, or null if no checkpoint has been recorded yet.
|
|
* @summary Retrieve Run Checkpoint
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
retrieveRunCheckpoint: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'id' is not null or undefined
|
|
assertParamExists('retrieveRunCheckpoint', 'id', id)
|
|
const localVarPath = `/api/v1/runs/{id}/checkpoint`
|
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
/**
|
|
* Returns the structured settings used to launch this run.
|
|
* @summary Retrieve Run Settings
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
retrieveRunSettings: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'id' is not null or undefined
|
|
assertParamExists('retrieveRunSettings', 'id', id)
|
|
const localVarPath = `/api/v1/runs/{id}/settings`
|
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
/**
|
|
* Writes an opaque binary blob and returns its content-addressed blob identifier.
|
|
* @summary Write Run Blob
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {File} body
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
writeRunBlob: async (id: string, body: File, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'id' is not null or undefined
|
|
assertParamExists('writeRunBlob', 'id', id)
|
|
// verify required parameter 'body' is not null or undefined
|
|
assertParamExists('writeRunBlob', 'body', body)
|
|
const localVarPath = `/api/v1/runs/{id}/blobs`
|
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
localVarHeaderParameter['Content-Type'] = 'application/octet-stream';
|
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
}
|
|
};
|
|
|
|
/**
|
|
* RunInternalsApi - functional programming interface
|
|
*/
|
|
export const RunInternalsApiFp = function(configuration?: Configuration) {
|
|
const localVarAxiosParamCreator = RunInternalsApiAxiosParamCreator(configuration)
|
|
return {
|
|
/**
|
|
* Appends a validated event to the run event log. Intended for trusted internal callers.
|
|
* @summary Append Run Event
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {RunEvent} runEvent
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async appendRunEvent(id: string, runEvent: RunEvent, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AppendEventResponse>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.appendRunEvent(id, runEvent, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunInternalsApi.appendRunEvent']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
/**
|
|
* Opens an ordered server-sent event stream starting at `since_seq`, replaying persisted events and continuing with live updates while the run remains active.
|
|
* @summary Attach Run Events
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {number} [sinceSeq] First event sequence number to include.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async attachRunEvents(id: string, sinceSeq?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.attachRunEvents(id, sinceSeq, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunInternalsApi.attachRunEvents']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
/**
|
|
* Returns the internal event-sourced run projection. This is not a stable public contract.
|
|
* @summary Get Run State
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async getRunState(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunProjection>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getRunState(id, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunInternalsApi.getRunState']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
/**
|
|
* Downloads an artifact by filename.
|
|
* @summary Get Stage Artifact
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} stageId Identifier of a stage within a run\'s workflow graph, serialized as `node_id@visit`.
|
|
* @param {string} filename Relative artifact path. `/` is allowed as a path separator. Backslash, empty segments, and traversal segments (`.` and `..`) are invalid.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async getStageArtifact(id: string, stageId: string, filename: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getStageArtifact(id, stageId, filename, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunInternalsApi.getStageArtifact']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
/**
|
|
* Lists captured artifact files for a run.
|
|
* @summary List Run Artifacts
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async listRunArtifacts(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunArtifactListResponse>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listRunArtifacts(id, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunInternalsApi.listRunArtifacts']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
/**
|
|
* Returns a paginated JSON list of stored run events.
|
|
* @summary List Run Events
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {number} [sinceSeq] First event sequence number to include.
|
|
* @param {number} [limit] Maximum number of events to return.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async listRunEvents(id: string, sinceSeq?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedEventList>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listRunEvents(id, sinceSeq, limit, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunInternalsApi.listRunEvents']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
/**
|
|
* Returns the ordered list of stages in a run\'s workflow graph with their current status and timing. Stages are bounded by the workflow graph size, typically fewer than 20.
|
|
* @summary List Run Stages
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {number} [pageLimit] Maximum number of items to return per page.
|
|
* @param {number} [pageOffset] Number of items to skip before returning results.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async listRunStages(id: string, pageLimit?: number, pageOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedRunStageList>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listRunStages(id, pageLimit, pageOffset, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunInternalsApi.listRunStages']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
/**
|
|
* Lists artifact filenames stored for a stage.
|
|
* @summary List Stage Artifacts
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} stageId Identifier of a stage within a run\'s workflow graph, serialized as `node_id@visit`.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async listStageArtifacts(id: string, stageId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArtifactListResponse>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listStageArtifacts(id, stageId, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunInternalsApi.listStageArtifacts']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
/**
|
|
* Returns a paginated list of conversation turns within a specific stage, including system prompts, assistant responses, and tool invocations.
|
|
* @summary List Stage Turns
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} stageId Identifier of a stage within a run\'s workflow graph, serialized as `node_id@visit`.
|
|
* @param {number} [pageLimit] Maximum number of items to return per page.
|
|
* @param {number} [pageOffset] Number of items to skip before returning results.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async listStageTurns(id: string, stageId: string, pageLimit?: number, pageOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedStageTurnList>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listStageTurns(id, stageId, pageLimit, pageOffset, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunInternalsApi.listStageTurns']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
/**
|
|
* Uploads an artifact for a stage. Intended for trusted internal callers.
|
|
* @summary Put Stage Artifact
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} stageId Identifier of a stage within a run\'s workflow graph, serialized as `node_id@visit`.
|
|
* @param {string} filename Relative artifact path. `/` is allowed as a path separator. Backslash, empty segments, and traversal segments (`.` and `..`) are invalid.
|
|
* @param {File} body
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async putStageArtifact(id: string, stageId: string, filename: string, body: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.putStageArtifact(id, stageId, filename, body, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunInternalsApi.putStageArtifact']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
/**
|
|
* Reads a previously stored blob by identifier.
|
|
* @summary Read Run Blob
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} blobId Content-addressed blob identifier.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async readRunBlob(id: string, blobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.readRunBlob(id, blobId, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunInternalsApi.readRunBlob']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
/**
|
|
* Returns the latest checkpoint data for a run, or null if no checkpoint has been recorded yet.
|
|
* @summary Retrieve Run Checkpoint
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async retrieveRunCheckpoint(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunCheckpoint>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.retrieveRunCheckpoint(id, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunInternalsApi.retrieveRunCheckpoint']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
/**
|
|
* Returns the structured settings used to launch this run.
|
|
* @summary Retrieve Run Settings
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async retrieveRunSettings(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunSettings>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.retrieveRunSettings(id, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunInternalsApi.retrieveRunSettings']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
/**
|
|
* Writes an opaque binary blob and returns its content-addressed blob identifier.
|
|
* @summary Write Run Blob
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {File} body
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async writeRunBlob(id: string, body: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WriteBlobResponse>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.writeRunBlob(id, body, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunInternalsApi.writeRunBlob']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
}
|
|
};
|
|
|
|
/**
|
|
* RunInternalsApi - factory interface
|
|
*/
|
|
export const RunInternalsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
const localVarFp = RunInternalsApiFp(configuration)
|
|
return {
|
|
/**
|
|
* Appends a validated event to the run event log. Intended for trusted internal callers.
|
|
* @summary Append Run Event
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {RunEvent} runEvent
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
appendRunEvent(id: string, runEvent: RunEvent, options?: RawAxiosRequestConfig): AxiosPromise<AppendEventResponse> {
|
|
return localVarFp.appendRunEvent(id, runEvent, options).then((request) => request(axios, basePath));
|
|
},
|
|
/**
|
|
* Opens an ordered server-sent event stream starting at `since_seq`, replaying persisted events and continuing with live updates while the run remains active.
|
|
* @summary Attach Run Events
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {number} [sinceSeq] First event sequence number to include.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
attachRunEvents(id: string, sinceSeq?: number, options?: RawAxiosRequestConfig): AxiosPromise<string> {
|
|
return localVarFp.attachRunEvents(id, sinceSeq, options).then((request) => request(axios, basePath));
|
|
},
|
|
/**
|
|
* Returns the internal event-sourced run projection. This is not a stable public contract.
|
|
* @summary Get Run State
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
getRunState(id: string, options?: RawAxiosRequestConfig): AxiosPromise<RunProjection> {
|
|
return localVarFp.getRunState(id, options).then((request) => request(axios, basePath));
|
|
},
|
|
/**
|
|
* Downloads an artifact by filename.
|
|
* @summary Get Stage Artifact
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} stageId Identifier of a stage within a run\'s workflow graph, serialized as `node_id@visit`.
|
|
* @param {string} filename Relative artifact path. `/` is allowed as a path separator. Backslash, empty segments, and traversal segments (`.` and `..`) are invalid.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
getStageArtifact(id: string, stageId: string, filename: string, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
return localVarFp.getStageArtifact(id, stageId, filename, options).then((request) => request(axios, basePath));
|
|
},
|
|
/**
|
|
* Lists captured artifact files for a run.
|
|
* @summary List Run Artifacts
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
listRunArtifacts(id: string, options?: RawAxiosRequestConfig): AxiosPromise<RunArtifactListResponse> {
|
|
return localVarFp.listRunArtifacts(id, options).then((request) => request(axios, basePath));
|
|
},
|
|
/**
|
|
* Returns a paginated JSON list of stored run events.
|
|
* @summary List Run Events
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {number} [sinceSeq] First event sequence number to include.
|
|
* @param {number} [limit] Maximum number of events to return.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
listRunEvents(id: string, sinceSeq?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedEventList> {
|
|
return localVarFp.listRunEvents(id, sinceSeq, limit, options).then((request) => request(axios, basePath));
|
|
},
|
|
/**
|
|
* Returns the ordered list of stages in a run\'s workflow graph with their current status and timing. Stages are bounded by the workflow graph size, typically fewer than 20.
|
|
* @summary List Run Stages
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {number} [pageLimit] Maximum number of items to return per page.
|
|
* @param {number} [pageOffset] Number of items to skip before returning results.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
listRunStages(id: string, pageLimit?: number, pageOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedRunStageList> {
|
|
return localVarFp.listRunStages(id, pageLimit, pageOffset, options).then((request) => request(axios, basePath));
|
|
},
|
|
/**
|
|
* Lists artifact filenames stored for a stage.
|
|
* @summary List Stage Artifacts
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} stageId Identifier of a stage within a run\'s workflow graph, serialized as `node_id@visit`.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
listStageArtifacts(id: string, stageId: string, options?: RawAxiosRequestConfig): AxiosPromise<ArtifactListResponse> {
|
|
return localVarFp.listStageArtifacts(id, stageId, options).then((request) => request(axios, basePath));
|
|
},
|
|
/**
|
|
* Returns a paginated list of conversation turns within a specific stage, including system prompts, assistant responses, and tool invocations.
|
|
* @summary List Stage Turns
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} stageId Identifier of a stage within a run\'s workflow graph, serialized as `node_id@visit`.
|
|
* @param {number} [pageLimit] Maximum number of items to return per page.
|
|
* @param {number} [pageOffset] Number of items to skip before returning results.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
listStageTurns(id: string, stageId: string, pageLimit?: number, pageOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedStageTurnList> {
|
|
return localVarFp.listStageTurns(id, stageId, pageLimit, pageOffset, options).then((request) => request(axios, basePath));
|
|
},
|
|
/**
|
|
* Uploads an artifact for a stage. Intended for trusted internal callers.
|
|
* @summary Put Stage Artifact
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} stageId Identifier of a stage within a run\'s workflow graph, serialized as `node_id@visit`.
|
|
* @param {string} filename Relative artifact path. `/` is allowed as a path separator. Backslash, empty segments, and traversal segments (`.` and `..`) are invalid.
|
|
* @param {File} body
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
putStageArtifact(id: string, stageId: string, filename: string, body: File, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
return localVarFp.putStageArtifact(id, stageId, filename, body, options).then((request) => request(axios, basePath));
|
|
},
|
|
/**
|
|
* Reads a previously stored blob by identifier.
|
|
* @summary Read Run Blob
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} blobId Content-addressed blob identifier.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
readRunBlob(id: string, blobId: string, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
return localVarFp.readRunBlob(id, blobId, options).then((request) => request(axios, basePath));
|
|
},
|
|
/**
|
|
* Returns the latest checkpoint data for a run, or null if no checkpoint has been recorded yet.
|
|
* @summary Retrieve Run Checkpoint
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
retrieveRunCheckpoint(id: string, options?: RawAxiosRequestConfig): AxiosPromise<RunCheckpoint> {
|
|
return localVarFp.retrieveRunCheckpoint(id, options).then((request) => request(axios, basePath));
|
|
},
|
|
/**
|
|
* Returns the structured settings used to launch this run.
|
|
* @summary Retrieve Run Settings
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
retrieveRunSettings(id: string, options?: RawAxiosRequestConfig): AxiosPromise<RunSettings> {
|
|
return localVarFp.retrieveRunSettings(id, options).then((request) => request(axios, basePath));
|
|
},
|
|
/**
|
|
* Writes an opaque binary blob and returns its content-addressed blob identifier.
|
|
* @summary Write Run Blob
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {File} body
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
writeRunBlob(id: string, body: File, options?: RawAxiosRequestConfig): AxiosPromise<WriteBlobResponse> {
|
|
return localVarFp.writeRunBlob(id, body, options).then((request) => request(axios, basePath));
|
|
},
|
|
};
|
|
};
|
|
|
|
/**
|
|
* RunInternalsApi - object-oriented interface
|
|
*/
|
|
export class RunInternalsApi extends BaseAPI {
|
|
/**
|
|
* Appends a validated event to the run event log. Intended for trusted internal callers.
|
|
* @summary Append Run Event
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {RunEvent} runEvent
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public appendRunEvent(id: string, runEvent: RunEvent, options?: RawAxiosRequestConfig) {
|
|
return RunInternalsApiFp(this.configuration).appendRunEvent(id, runEvent, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
|
|
/**
|
|
* Opens an ordered server-sent event stream starting at `since_seq`, replaying persisted events and continuing with live updates while the run remains active.
|
|
* @summary Attach Run Events
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {number} [sinceSeq] First event sequence number to include.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public attachRunEvents(id: string, sinceSeq?: number, options?: RawAxiosRequestConfig) {
|
|
return RunInternalsApiFp(this.configuration).attachRunEvents(id, sinceSeq, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
|
|
/**
|
|
* Returns the internal event-sourced run projection. This is not a stable public contract.
|
|
* @summary Get Run State
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public getRunState(id: string, options?: RawAxiosRequestConfig) {
|
|
return RunInternalsApiFp(this.configuration).getRunState(id, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
|
|
/**
|
|
* Downloads an artifact by filename.
|
|
* @summary Get Stage Artifact
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} stageId Identifier of a stage within a run\'s workflow graph, serialized as `node_id@visit`.
|
|
* @param {string} filename Relative artifact path. `/` is allowed as a path separator. Backslash, empty segments, and traversal segments (`.` and `..`) are invalid.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public getStageArtifact(id: string, stageId: string, filename: string, options?: RawAxiosRequestConfig) {
|
|
return RunInternalsApiFp(this.configuration).getStageArtifact(id, stageId, filename, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
|
|
/**
|
|
* Lists captured artifact files for a run.
|
|
* @summary List Run Artifacts
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public listRunArtifacts(id: string, options?: RawAxiosRequestConfig) {
|
|
return RunInternalsApiFp(this.configuration).listRunArtifacts(id, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
|
|
/**
|
|
* Returns a paginated JSON list of stored run events.
|
|
* @summary List Run Events
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {number} [sinceSeq] First event sequence number to include.
|
|
* @param {number} [limit] Maximum number of events to return.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public listRunEvents(id: string, sinceSeq?: number, limit?: number, options?: RawAxiosRequestConfig) {
|
|
return RunInternalsApiFp(this.configuration).listRunEvents(id, sinceSeq, limit, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
|
|
/**
|
|
* Returns the ordered list of stages in a run\'s workflow graph with their current status and timing. Stages are bounded by the workflow graph size, typically fewer than 20.
|
|
* @summary List Run Stages
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {number} [pageLimit] Maximum number of items to return per page.
|
|
* @param {number} [pageOffset] Number of items to skip before returning results.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public listRunStages(id: string, pageLimit?: number, pageOffset?: number, options?: RawAxiosRequestConfig) {
|
|
return RunInternalsApiFp(this.configuration).listRunStages(id, pageLimit, pageOffset, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
|
|
/**
|
|
* Lists artifact filenames stored for a stage.
|
|
* @summary List Stage Artifacts
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} stageId Identifier of a stage within a run\'s workflow graph, serialized as `node_id@visit`.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public listStageArtifacts(id: string, stageId: string, options?: RawAxiosRequestConfig) {
|
|
return RunInternalsApiFp(this.configuration).listStageArtifacts(id, stageId, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
|
|
/**
|
|
* Returns a paginated list of conversation turns within a specific stage, including system prompts, assistant responses, and tool invocations.
|
|
* @summary List Stage Turns
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} stageId Identifier of a stage within a run\'s workflow graph, serialized as `node_id@visit`.
|
|
* @param {number} [pageLimit] Maximum number of items to return per page.
|
|
* @param {number} [pageOffset] Number of items to skip before returning results.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public listStageTurns(id: string, stageId: string, pageLimit?: number, pageOffset?: number, options?: RawAxiosRequestConfig) {
|
|
return RunInternalsApiFp(this.configuration).listStageTurns(id, stageId, pageLimit, pageOffset, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
|
|
/**
|
|
* Uploads an artifact for a stage. Intended for trusted internal callers.
|
|
* @summary Put Stage Artifact
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} stageId Identifier of a stage within a run\'s workflow graph, serialized as `node_id@visit`.
|
|
* @param {string} filename Relative artifact path. `/` is allowed as a path separator. Backslash, empty segments, and traversal segments (`.` and `..`) are invalid.
|
|
* @param {File} body
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public putStageArtifact(id: string, stageId: string, filename: string, body: File, options?: RawAxiosRequestConfig) {
|
|
return RunInternalsApiFp(this.configuration).putStageArtifact(id, stageId, filename, body, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
|
|
/**
|
|
* Reads a previously stored blob by identifier.
|
|
* @summary Read Run Blob
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {string} blobId Content-addressed blob identifier.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public readRunBlob(id: string, blobId: string, options?: RawAxiosRequestConfig) {
|
|
return RunInternalsApiFp(this.configuration).readRunBlob(id, blobId, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
|
|
/**
|
|
* Returns the latest checkpoint data for a run, or null if no checkpoint has been recorded yet.
|
|
* @summary Retrieve Run Checkpoint
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public retrieveRunCheckpoint(id: string, options?: RawAxiosRequestConfig) {
|
|
return RunInternalsApiFp(this.configuration).retrieveRunCheckpoint(id, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
|
|
/**
|
|
* Returns the structured settings used to launch this run.
|
|
* @summary Retrieve Run Settings
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public retrieveRunSettings(id: string, options?: RawAxiosRequestConfig) {
|
|
return RunInternalsApiFp(this.configuration).retrieveRunSettings(id, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
|
|
/**
|
|
* Writes an opaque binary blob and returns its content-addressed blob identifier.
|
|
* @summary Write Run Blob
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {File} body
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public writeRunBlob(id: string, body: File, options?: RawAxiosRequestConfig) {
|
|
return RunInternalsApiFp(this.configuration).writeRunBlob(id, body, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
}
|
|
|