@gentrace/core
Version:
Core Gentrace Node.JS library
925 lines (807 loc) • 47 kB
Markdown
## API Report File for "@gentrace/core"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import type { AxiosInstance } from 'axios';
import type { AxiosPromise } from 'axios';
import type { AxiosRequestConfig } from 'axios';
import { AxiosResponse } from 'axios';
import type { ZodType } from 'zod';
// Warning: (ae-forgotten-export) The symbol "CreateEvaluationV2" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "V2EvaluationsBulkPost200Response" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export function bulkCreateEvaluations(evaluations: Array<CreateEvaluationV2>): Promise<V2EvaluationsBulkPost200Response>;
// @public (undocumented)
export class Configuration {
constructor(param?: ConfigurationParameters);
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
baseOptions?: any;
basePath?: string;
formDataCtor?: new () => any;
isJsonMime(mime: string): boolean;
logger?: {
info: (message: string, context?: any) => void;
warn: (message: string | Error, context?: any) => void;
};
password?: string;
username?: string;
}
// @public
export interface ConfigurationParameters {
// (undocumented)
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
// (undocumented)
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
// (undocumented)
baseOptions?: any;
// (undocumented)
basePath?: string;
// (undocumented)
formDataCtor?: new () => any;
// (undocumented)
logger?: {
info: (message: string, context?: any) => void;
warn: (message: string | Error, context?: any) => void;
};
// (undocumented)
password?: string;
// (undocumented)
username?: string;
}
// @public (undocumented)
export const constructSubmissionPayloadAdvanced: (pipelineIdentifier: string, testRuns: TestRun[], context?: ResultContext, triggerRemoteEvals?: boolean) => TestResultPostRequest;
// Warning: (ae-forgotten-export) The symbol "V1TestResultSimplePostRequestTestRunsInner" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "V1TestResultSimplePostRequest" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export const constructSubmissionPayloadSimple: (pipelineSlug: string, testRuns: V1TestResultSimplePostRequestTestRunsInner[], context?: ResultContext) => V1TestResultSimplePostRequest;
// Warning: (ae-forgotten-export) The symbol "PipelineRunContext" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export type Context = PipelineRunContext & CoreStepRunContext;
// @public (undocumented)
export type CoreStepRunContext = {
render?: {
type: "html";
key: string;
};
metadata?: Metadata;
};
// Warning: (ae-forgotten-export) The symbol "CreateDatasetV2" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "DatasetV2" needs to be exported by the entry point index.d.ts
//
// @public
export const createDataset: (payload: CreateDatasetV2) => Promise<DatasetV2>;
// @public (undocumented)
export type CreateEvaluationType = CreateEvaluationV2;
// Warning: (ae-forgotten-export) The symbol "CreateSingleTestCase" needs to be exported by the entry point index.d.ts
//
// @public
export const createTestCase: (payload: CreateSingleTestCase) => Promise<string>;
// Warning: (ae-forgotten-export) The symbol "CreateMultipleTestCases" needs to be exported by the entry point index.d.ts
//
// @public
export const createTestCases: (payload: CreateMultipleTestCases) => Promise<number>;
// @public
export function createTestRunners(pipeline: Pipeline<{
[key: string]: GentracePlugin<any, any>;
}>, localData: LocalTestData[]): Array<PipelineRunDataTuple>;
// Warning: (ae-forgotten-export) The symbol "InteractionFn" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "InteractionDefinition" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export function defineInteraction<T = any, Fn extends InteractionFn<T> = InteractionFn<T>>(interaction: InteractionDefinition<T, Fn>): Fn;
// Warning: (ae-forgotten-export) The symbol "AnyFn" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export function defineTestSuite<Fn extends AnyFn>(testSuite: {
name: string;
fn: Fn;
}): Fn;
// @public (undocumented)
export function deinit(): void;
// @public
export const deleteTestCase: (id: string) => Promise<boolean>;
// @public (undocumented)
export const enumParameter: ({ name, options, defaultValue, }: {
name: string;
options: string[];
defaultValue: string;
}) => {
name: string;
getValue: () => string;
};
// Warning: (ae-forgotten-export) The symbol "EvaluationV2" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export type EvaluationType = EvaluationV2;
// @public
export interface FeedbackRequest {
details?: string | null;
pipelineRunId: string;
recordedTime: string;
score: number;
}
// @public
export interface FeedbackResponse {
message: string;
}
// @public (undocumented)
export function flush(): Promise<boolean>;
// @public (undocumented)
export let GENTRACE_API_KEY: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
// @public (undocumented)
export let GENTRACE_BASE_PATH: string;
// @public (undocumented)
export let GENTRACE_BRANCH: string;
// @public (undocumented)
export let GENTRACE_COMMIT: string;
// @public (undocumented)
export let GENTRACE_ENVIRONMENT_NAME: string;
// @public (undocumented)
export let GENTRACE_RESULT_NAME: string;
// @public (undocumented)
export let GENTRACE_RUN_NAME: string;
// @public (undocumented)
export let GENTRACE_SHOW_CONNECTION_ERRORS: string;
// @public (undocumented)
export abstract class GentracePlugin<C, A> {
// (undocumented)
abstract advanced<T extends {
[key: string]: GentracePlugin<any, any>;
}>(params: {
pipeline: Pipeline<T>;
pipelineRun: PipelineRun;
gentraceConfig: Configuration;
}): A;
// (undocumented)
abstract config: C;
// (undocumented)
abstract getConfig(): C;
}
// @public
export const getDataset: (id: string) => Promise<DatasetV2>;
// @public
export const getDatasets: (params?: {
pipelineSlug?: string;
pipelineId?: string;
archived?: boolean;
}) => Promise<DatasetV2[]>;
// Warning: (ae-forgotten-export) The symbol "EvaluationV3" needs to be exported by the entry point index.d.ts
//
// @public
export const getEvaluations: ({ resultId, }: {
resultId: string;
}) => Promise<EvaluationV3[]>;
// Warning: (ae-forgotten-export) The symbol "EvaluatorV2" needs to be exported by the entry point index.d.ts
//
// @public
export const getEvaluators: (pipelineIdentifier: string | null) => Promise<EvaluatorV2[]>;
// @public (undocumented)
export function getGentraceApiKey(): string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
// @public (undocumented)
export function getGentraceBasePath(): string;
// Warning: (ae-forgotten-export) The symbol "PipelineParams" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "V1PipelinesGet200ResponsePipelinesInner" needs to be exported by the entry point index.d.ts
//
// @public
export const getPipelines: (params?: PipelineParams) => Promise<V1PipelinesGet200ResponsePipelinesInner[]>;
// Warning: (ae-forgotten-export) The symbol "RunV2" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export const getRun: (id: string) => Promise<RunV2>;
// Warning: (ae-forgotten-export) The symbol "TestCaseV2" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export const getTestCase: (id: string) => Promise<TestCaseV2>;
// @public
export const getTestCases: (pipelineSlug: string) => Promise<TestCase[]>;
// @public
export const getTestCasesForDataset: (datasetId: string) => Promise<TestCase[]>;
// Warning: (ae-forgotten-export) The symbol "ExpandedTestResult" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export const getTestResult: (resultId: string) => Promise<ExpandedTestResult>;
// @public (undocumented)
export const getTestResults: (pipelineSlug?: string) => Promise<TestResult[]>;
// Warning: (ae-forgotten-export) The symbol "StatusInfo" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export const getTestResultStatus: (resultId: string) => Promise<StatusInfo>;
// @public
export const getTestRunners: (pipeline: Pipeline<{
[key: string]: GentracePlugin<any, any>;
}>, datasetId?: string, caseFilter?: (testCase: Omit<TestCase, "createdAt" | "updatedAt" | "archivedAt">) => boolean) => Promise<Array<PipelineRunDataTuple>>;
// @public (undocumented)
export let globalGentraceApi: V1Api | null;
// @public (undocumented)
export let globalGentraceApiV2: V2Api | null;
// @public (undocumented)
export let globalGentraceApiV3: V3Api | null;
// @public (undocumented)
export let globalGentraceConfig: Configuration | null;
// @public (undocumented)
export let globalRequestBuffer: {
[pipelineRunId: string]: Promise<any>;
};
// Warning: (ae-forgotten-export) The symbol "OutboundMessage" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export function handleWebhook(body: any, sendResponse: (response: OutboundMessage) => void): Promise<void>;
// @public (undocumented)
export function init(values?: {
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
basePath?: string;
branch?: string;
commit?: string;
showConnectionErrors?: string;
environmentName?: string;
runName?: string;
resultName?: string;
}): void;
// @public (undocumented)
export type InitPluginFunction<C extends object, A> = (config: C | SimpleHandler<C>) => Promise<GentracePlugin<C, A>>;
// @public (undocumented)
export function isConfig<C extends object>(f: C | SimpleHandler<C>): f is C;
// @public (undocumented)
export function listen(values?: {
environmentName?: string | undefined;
}): Promise<void>;
// @public
export interface LocalEvaluation {
debug?: LocalEvaluationDebug;
label?: string | null;
name: string;
value: number;
}
// @public
export interface LocalEvaluationDebug {
error?: LocalEvaluationDebugError;
finalClassification?: string;
logs?: Array<Array<any>>;
processorLogs?: Array<Array<any>>;
resolvedPrompt?: string;
response?: string;
}
// @public
export interface LocalEvaluationDebugError {
date?: string;
message?: string;
}
// @public (undocumented)
export type LocalTestData = {
name: string;
inputs: Record<string, any>;
expectedOutputs?: Record<string, any>;
};
// @public (undocumented)
export const numericParameter: ({ name, defaultValue, }: {
name: string;
defaultValue: number;
}) => {
name: string;
getValue: () => number;
};
// @public (undocumented)
export type PartialStepRunType = Partial<StepRun>;
// @public (undocumented)
export class Pipeline<T extends {
[key: string]: GentracePlugin<any, any>;
}> {
constructor({ slug, id, apiKey, basePath, logger, plugins, }: {
slug?: string;
id?: string;
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
basePath?: string;
logger?: {
info: (message: string, context?: any) => void;
warn: (message: string | Error, context?: any) => void;
};
plugins?: T;
});
// (undocumented)
config: Configuration;
// (undocumented)
getLogger(): {
info: (message: string, context?: any) => void;
warn: (message: string | Error, context?: any) => void;
};
// (undocumented)
id: string;
// (undocumented)
logInfo(message: string): void;
// (undocumented)
logWarn(e: Error | string): void;
// (undocumented)
plugins: T;
// (undocumented)
slug: string;
// (undocumented)
start(context?: PluginContext): PipelineRun & {
[key in keyof T]: ReturnType<T[key]["advanced"]>;
};
}
// @public (undocumented)
export class PipelineRun {
constructor({ pipeline, context, }: {
pipeline: PipelineLike;
context?: Context;
});
addEval(evaluation: LocalEvaluation): void;
// (undocumented)
addStepRunNode(stepRun: StepRun): Promise<void>;
// Warning: (ae-forgotten-export) The symbol "PRStepRunType" needs to be exported by the entry point index.d.ts
checkpoint(step: PRStepRunType & {
inputs: any;
outputs: any;
}): void;
// (undocumented)
context?: Context;
// (undocumented)
getContext(): Context;
// (undocumented)
getError(): string;
// (undocumented)
getId(): string;
getLocalEvaluations(): LocalEvaluation[];
// (undocumented)
getPipeline(): PipelineLike;
// (undocumented)
static getRedactedRunFromJson(json: string | object, options?: {
waitForServer?: boolean;
pipeline?: PipelineLike;
selectFields?: StepRunWhitelistDescriptor | ((steps: StepRun[]) => StepRunWhitelistDescriptor[]);
}): PipelineRunPayload;
measure<F extends (...args: any[]) => any>(func: F, inputs: Parameters<F>, stepInfo?: Omit<PRStepRunType, "inputs" | "outputs">): Promise<ReturnType<F>>;
// (undocumented)
setError(error: string | undefined): void;
// (undocumented)
stepRuns: StepRun[];
// (undocumented)
submit({ waitForServer, selectFields, }?: {
waitForServer?: boolean;
selectFields?: StepRunWhitelistDescriptor | ((steps: StepRun[]) => StepRunWhitelistDescriptor[]);
}): Promise<RunResponse>;
// (undocumented)
static submitFromJson(json: string | object, options?: {
waitForServer?: boolean;
pipeline?: PipelineLike;
selectFields?: StepRunWhitelistDescriptor | ((steps: StepRun[]) => StepRunWhitelistDescriptor[]);
}): Promise<RunResponse>;
// (undocumented)
toJson(): string;
// Warning: (ae-forgotten-export) The symbol "PipelineRunPayload" needs to be exported by the entry point index.d.ts
//
// (undocumented)
toObject(): PipelineRunPayload;
// (undocumented)
updateContext(updatedContext: Partial<Context>): Context;
}
// @public
export type PipelineRunDataTuple = [
PipelineRun,
TestCaseForSubmission | TestCase | TestCaseV2
];
// @public @deprecated (undocumented)
export type PipelineRunTestCaseTuple = PipelineRunDataTuple;
// @public
export interface PipelinesGet200Response {
pipelines: Array<V1PipelinesGet200ResponsePipelinesInner>;
}
// @public (undocumented)
export type PluginContext = PipelineRunContext;
// @public (undocumented)
export type PluginStepRunContext = {
metadata?: Metadata;
};
// @public (undocumented)
export let resetGlobalGentraceApi: () => void;
// @public (undocumented)
export type ResultContext = {
name?: string;
metadata?: Metadata;
};
// @public
export interface RunRequest {
// Warning: (ae-forgotten-export) The symbol "RunRequestCollectionMethodEnum" needs to be exported by the entry point index.d.ts
collectionMethod?: RunRequestCollectionMethodEnum;
error?: string | null;
id: string;
metadata?: {
[key: string]: MetadataValueObject;
} | null;
previousRunId?: string | null;
slug?: string;
// Warning: (ae-forgotten-export) The symbol "StepRun_2" needs to be exported by the entry point index.d.ts
stepRuns: Array<StepRun_2>;
}
// @public
export interface RunResponse {
pipelineRunId?: string;
}
// @public (undocumented)
export function runTest(pipelineSlug: string, handler: (testCase: Omit<TestCase, "createdAt" | "updatedAt" | "archivedAt">) => Promise<[any, PipelineRun]>, contextOrCaseFilter?: ResultContext | ((testCase: Omit<TestCase, "createdAt" | "updatedAt" | "archivedAt">) => boolean), caseFilterOrUndefined?: (testCase: Omit<TestCase, "createdAt" | "updatedAt" | "archivedAt">) => boolean): Promise<TestResultPost200Response>;
// @public
export function runTestWithDataset(pipelineSlug: string, datasetId: string, handler: (testCase: Omit<TestCase, "createdAt" | "updatedAt" | "archivedAt">) => Promise<[any, PipelineRun]>, context?: ResultContext, caseFilter?: (testCase: Omit<TestCase, "createdAt" | "updatedAt" | "archivedAt">) => boolean): Promise<TestResultPost200Response>;
// @public
export function runTestWithDataset(pipelineSlug: string, datasetId: string, handler: (testCase: Omit<TestCase, "createdAt" | "updatedAt" | "archivedAt">) => Promise<[any, PipelineRun]>, caseFilter?: (testCase: Omit<TestCase, "createdAt" | "updatedAt" | "archivedAt">) => boolean): Promise<TestResultPost200Response>;
// @public (undocumented)
export interface SimpleHandler<C extends object> {
// (undocumented)
getConfig(): C;
// (undocumented)
setPipelineRun(pipelineRun: PipelineRun): void;
}
// @public (undocumented)
export class StepRun {
constructor(providerName: string, invocation: string, elapsedTime: number, startTime: string, endTime: string, inputs: any, modelParams: any, outputs: any, context: Context, error: string | undefined);
// (undocumented)
context: Context;
// (undocumented)
elapsedTime: number;
// (undocumented)
endTime: string;
// (undocumented)
error: string | undefined;
// (undocumented)
inputs: any;
// (undocumented)
invocation: string;
// (undocumented)
modelParams: any;
// (undocumented)
outputs: any;
// (undocumented)
providerName: string;
// (undocumented)
startTime: string;
}
// @public (undocumented)
export type StepRunType = typeof StepRun;
// @public (undocumented)
export const stringParameter: ({ name, defaultValue, }: {
name: string;
defaultValue: string;
}) => {
name: string;
getValue: () => string;
};
// @public (undocumented)
export function submitTestResult(pipelineSlug: string, testCases: (TestCase | TestCaseV2)[], outputsList: Record<string, any>[], context?: ResultContext): Promise<TestResultPost200Response>;
// Warning: (ae-forgotten-export) The symbol "SubmitTestRunnersOptions" needs to be exported by the entry point index.d.ts
//
// @public
export function submitTestRunners(pipeline: Pipeline<{
[key: string]: GentracePlugin<any, any>;
}>, pipelineRunTestCases: Array<PipelineRunDataTuple>, options?: SubmitTestRunnersOptions): Promise<TestResultPost200Response>;
// @public (undocumented)
export const templateParameter: <T extends Record<string, any>>({ name, defaultValue, variables, }: {
name: string;
defaultValue: string;
variables?: {
name: keyof T;
example: T[keyof T];
}[];
}) => {
name: string;
render: (values: T) => string;
};
// @public
export interface TestCase {
// @deprecated
archivedAt: string | null;
createdAt: string;
datasetId: string;
deletedAt: string | null;
expectedOutputs?: object | null;
id: string;
inputs: {
[key: string]: any;
};
name: string;
pipelineId: string;
updatedAt: string;
}
// @public
export type TestCaseForSubmission = {
id?: string;
name?: string;
inputs?: Record<string, any>;
};
// @public
export interface TestCaseGet200Response {
testCases?: Array<TestCase>;
}
// @public
export interface TestResult {
branch?: string | null;
commit?: string | null;
createdAt: string;
id: string;
metadata?: {
[key: string]: MetadataValueObject;
} | null;
name?: string | null;
pipelineId: string;
updatedAt: string;
}
// @public
export interface TestResultGet200Response {
testResults?: Array<TestResult>;
}
// @public
export interface TestResultPost200Response {
resultId: string;
}
// @public
export interface TestResultPostRequest {
branch?: string | null;
// Warning: (ae-forgotten-export) The symbol "V1TestResultPostRequestCollectionMethodEnum" needs to be exported by the entry point index.d.ts
collectionMethod?: V1TestResultPostRequestCollectionMethodEnum;
commit?: string | null;
metadata?: {
[key: string]: MetadataValueObject;
} | null;
name?: string | null;
pipelineId?: string;
pipelineSlug?: string;
testRuns: Array<TestResultPostRequestTestRunsInner>;
triggerRemoteEvals?: boolean;
}
// @public
export interface TestResultPostRequestTestRunsInner {
caseId?: string;
error?: string | null;
evaluations?: Array<LocalEvaluation>;
expectedOutputs?: {
[key: string]: any;
};
id?: string | null;
inputs?: {
[key: string]: any;
};
metadata?: {
[key: string]: MetadataValueObject;
} | null;
name?: string;
// Warning: (ae-forgotten-export) The symbol "RunPathSection" needs to be exported by the entry point index.d.ts
path?: Array<RunPathSection> | null;
stepRuns: Array<StepRun_2>;
}
// @public
export interface TestResultStatusGet200Response {
done: number;
failure: number;
pending: number;
total: number;
}
// @public (undocumented)
export type TestRun = TestResultPostRequestTestRunsInner;
// Warning: (ae-forgotten-export) The symbol "UpdateDatasetV2" needs to be exported by the entry point index.d.ts
//
// @public
export const updateDataset: (id: string, payload: UpdateDatasetV2) => Promise<DatasetV2>;
// Warning: (ae-forgotten-export) The symbol "UpdateTestCase" needs to be exported by the entry point index.d.ts
//
// @public
export const updateTestCase: (payload: UpdateTestCase) => Promise<string>;
// @public (undocumented)
export function updateTestResult(resultId: string, testCases: (TestCase | TestCaseV2)[], outputsList: Record<string, any>[]): Promise<TestResultPost200Response>;
// @public
export function updateTestResultWithRunners(resultId: string, runners: PipelineRunDataTuple[]): Promise<TestResultPost200Response>;
// @public (undocumented)
export function uploadBuffer(fileName: string, buffer: Buffer, options?: undefined | FilePropertyBag): Promise<string>;
// @public (undocumented)
export function uploadFile(file: File): Promise<string>;
// Warning: (ae-forgotten-export) The symbol "BaseAPI" needs to be exported by the entry point index.d.ts
//
// @public
export class V1Api extends BaseAPI {
v1FeedbackPost(feedbackRequest: FeedbackRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<FeedbackResponse, any>>;
// Warning: (ae-forgotten-export) The symbol "V1FilesUploadPost201Response" needs to be exported by the entry point index.d.ts
v1FilesUploadPost(org?: string, file?: File, options?: AxiosRequestConfig): Promise<AxiosResponse<V1FilesUploadPost201Response, any>>;
v1PipelinesGet(label?: string, slug?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<PipelinesGet200Response, any>>;
v1RunPost(runRequest: RunRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<RunResponse, any>>;
v1TestCaseGet(datasetId?: string, pipelineId?: string, pipelineSlug?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<TestCaseGet200Response, any>>;
// Warning: (ae-forgotten-export) The symbol "V1TestCasePatch200Response" needs to be exported by the entry point index.d.ts
v1TestCasePatch(updateTestCase: UpdateTestCase, options?: AxiosRequestConfig): Promise<AxiosResponse<V1TestCasePatch200Response, any>>;
// Warning: (ae-forgotten-export) The symbol "V1TestCasePostRequest" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "V1TestCasePost200Response" needs to be exported by the entry point index.d.ts
v1TestCasePost(v1TestCasePostRequest: V1TestCasePostRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<V1TestCasePost200Response, any>>;
v1TestResultGet(pipelineSlug: string, options?: AxiosRequestConfig): Promise<AxiosResponse<TestResultGet200Response, any>>;
v1TestResultIdGet(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<ExpandedTestResult, any>>;
// Warning: (ae-forgotten-export) The symbol "V1TestResultIdPostRequest" needs to be exported by the entry point index.d.ts
v1TestResultIdPost(id: string, v1TestResultIdPostRequest: V1TestResultIdPostRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<TestResultPost200Response, any>>;
v1TestResultPost(v1TestResultPostRequest: TestResultPostRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<TestResultPost200Response, any>>;
// Warning: (ae-forgotten-export) The symbol "V1TestResultSimpleIdPostRequest" needs to be exported by the entry point index.d.ts
v1TestResultSimpleIdPost(id: string, v1TestResultSimpleIdPostRequest: V1TestResultSimpleIdPostRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<TestResultPost200Response, any>>;
v1TestResultSimplePost(v1TestResultSimplePostRequest: V1TestResultSimplePostRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<TestResultPost200Response, any>>;
v1TestResultStatusGet(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<TestResultStatusGet200Response, any>>;
}
// @public
export const V1ApiAxiosParamCreator: (configuration?: Configuration) => {
v1FeedbackPost: (feedbackRequest: FeedbackRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v1FilesUploadPost: (org?: string, file?: File, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v1PipelinesGet: (label?: string, slug?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v1RunPost: (runRequest: RunRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v1TestCaseGet: (datasetId?: string, pipelineId?: string, pipelineSlug?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v1TestCasePatch: (updateTestCase: UpdateTestCase, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v1TestCasePost: (v1TestCasePostRequest: V1TestCasePostRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v1TestResultGet: (pipelineSlug: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v1TestResultIdGet: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v1TestResultIdPost: (id: string, v1TestResultIdPostRequest: V1TestResultIdPostRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v1TestResultPost: (v1TestResultPostRequest: TestResultPostRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v1TestResultSimpleIdPost: (id: string, v1TestResultSimpleIdPostRequest: V1TestResultSimpleIdPostRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v1TestResultSimplePost: (v1TestResultSimplePostRequest: V1TestResultSimplePostRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v1TestResultStatusGet: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
// @public
export const V1ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
v1FeedbackPost(feedbackRequest: FeedbackRequest, options?: any): AxiosPromise<FeedbackResponse>;
v1FilesUploadPost(org?: string, file?: File, options?: any): AxiosPromise<V1FilesUploadPost201Response>;
v1PipelinesGet(label?: string, slug?: string, options?: any): AxiosPromise<PipelinesGet200Response>;
v1RunPost(runRequest: RunRequest, options?: any): AxiosPromise<RunResponse>;
v1TestCaseGet(datasetId?: string, pipelineId?: string, pipelineSlug?: string, options?: any): AxiosPromise<TestCaseGet200Response>;
v1TestCasePatch(updateTestCase: UpdateTestCase, options?: any): AxiosPromise<V1TestCasePatch200Response>;
v1TestCasePost(v1TestCasePostRequest: V1TestCasePostRequest, options?: any): AxiosPromise<V1TestCasePost200Response>;
v1TestResultGet(pipelineSlug: string, options?: any): AxiosPromise<TestResultGet200Response>;
v1TestResultIdGet(id: string, options?: any): AxiosPromise<ExpandedTestResult>;
v1TestResultIdPost(id: string, v1TestResultIdPostRequest: V1TestResultIdPostRequest, options?: any): AxiosPromise<TestResultPost200Response>;
v1TestResultPost(v1TestResultPostRequest: TestResultPostRequest, options?: any): AxiosPromise<TestResultPost200Response>;
v1TestResultSimpleIdPost(id: string, v1TestResultSimpleIdPostRequest: V1TestResultSimpleIdPostRequest, options?: any): AxiosPromise<TestResultPost200Response>;
v1TestResultSimplePost(v1TestResultSimplePostRequest: V1TestResultSimplePostRequest, options?: any): AxiosPromise<TestResultPost200Response>;
v1TestResultStatusGet(id: string, options?: any): AxiosPromise<TestResultStatusGet200Response>;
};
// @public
export const V1ApiFp: (configuration?: Configuration) => {
v1FeedbackPost(feedbackRequest: FeedbackRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FeedbackResponse>>;
v1FilesUploadPost(org?: string, file?: File, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1FilesUploadPost201Response>>;
v1PipelinesGet(label?: string, slug?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PipelinesGet200Response>>;
v1RunPost(runRequest: RunRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunResponse>>;
v1TestCaseGet(datasetId?: string, pipelineId?: string, pipelineSlug?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TestCaseGet200Response>>;
v1TestCasePatch(updateTestCase: UpdateTestCase, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1TestCasePatch200Response>>;
v1TestCasePost(v1TestCasePostRequest: V1TestCasePostRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1TestCasePost200Response>>;
v1TestResultGet(pipelineSlug: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TestResultGet200Response>>;
v1TestResultIdGet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExpandedTestResult>>;
v1TestResultIdPost(id: string, v1TestResultIdPostRequest: V1TestResultIdPostRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TestResultPost200Response>>;
v1TestResultPost(v1TestResultPostRequest: TestResultPostRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TestResultPost200Response>>;
v1TestResultSimpleIdPost(id: string, v1TestResultSimpleIdPostRequest: V1TestResultSimpleIdPostRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TestResultPost200Response>>;
v1TestResultSimplePost(v1TestResultSimplePostRequest: V1TestResultSimplePostRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TestResultPost200Response>>;
v1TestResultStatusGet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TestResultStatusGet200Response>>;
};
// @public
export class V2Api extends BaseAPI {
// Warning: (ae-forgotten-export) The symbol "V2DatasetsGet200Response" needs to be exported by the entry point index.d.ts
v2DatasetsGet(pipelineSlug?: string, pipelineId?: string, archived?: boolean, options?: AxiosRequestConfig): Promise<AxiosResponse<V2DatasetsGet200Response, any>>;
v2DatasetsIdGet(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<DatasetV2, any>>;
v2DatasetsIdPost(id: string, updateDatasetV2: UpdateDatasetV2, options?: AxiosRequestConfig): Promise<AxiosResponse<DatasetV2, any>>;
v2DatasetsPost(createDatasetV2: CreateDatasetV2, options?: AxiosRequestConfig): Promise<AxiosResponse<DatasetV2, any>>;
// Warning: (ae-forgotten-export) The symbol "V2EvaluationsBulkPostRequest" needs to be exported by the entry point index.d.ts
v2EvaluationsBulkPost(v2EvaluationsBulkPostRequest: V2EvaluationsBulkPostRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<V2EvaluationsBulkPost200Response, any>>;
// Warning: (ae-forgotten-export) The symbol "V2EvaluationsGet200Response" needs to be exported by the entry point index.d.ts
v2EvaluationsGet(resultId: string, options?: AxiosRequestConfig): Promise<AxiosResponse<V2EvaluationsGet200Response, any>>;
// Warning: (ae-forgotten-export) The symbol "V2EvaluatorsGet200Response" needs to be exported by the entry point index.d.ts
v2EvaluatorsGet(pipelineId?: string, pipelineSlug?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<V2EvaluatorsGet200Response, any>>;
// Warning: (ae-forgotten-export) The symbol "FeedbackV2" needs to be exported by the entry point index.d.ts
v2FeedbackIdGet(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<FeedbackV2, any>>;
// Warning: (ae-forgotten-export) The symbol "UpdateFeedbackV2" needs to be exported by the entry point index.d.ts
v2FeedbackIdPatch(id: string, updateFeedbackV2: UpdateFeedbackV2, options?: AxiosRequestConfig): Promise<AxiosResponse<FeedbackV2, any>>;
// Warning: (ae-forgotten-export) The symbol "CreateFeedbackV2" needs to be exported by the entry point index.d.ts
v2FeedbackPost(createFeedbackV2: CreateFeedbackV2, options?: AxiosRequestConfig): Promise<AxiosResponse<FeedbackV2, any>>;
// Warning: (ae-forgotten-export) The symbol "V2FoldersGet200Response" needs to be exported by the entry point index.d.ts
v2FoldersGet(parentFolderId?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<V2FoldersGet200Response, any>>;
// Warning: (ae-forgotten-export) The symbol "FolderV2" needs to be exported by the entry point index.d.ts
v2FoldersIdGet(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<FolderV2, any>>;
// Warning: (ae-forgotten-export) The symbol "SearchableStringInput" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "V2PipelinesGet200Response" needs to be exported by the entry point index.d.ts
v2PipelinesGet(label?: string, slug?: SearchableStringInput, folderId?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<V2PipelinesGet200Response, any>>;
v2RunsIdGet(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<RunV2, any>>;
// Warning: (ae-forgotten-export) The symbol "V2TestCasesGet200Response" needs to be exported by the entry point index.d.ts
v2TestCasesGet(datasetId?: string, pipelineId?: string, pipelineSlug?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<V2TestCasesGet200Response, any>>;
// Warning: (ae-forgotten-export) The symbol "V2TestCasesIdDelete200Response" needs to be exported by the entry point index.d.ts
v2TestCasesIdDelete(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<V2TestCasesIdDelete200Response, any>>;
v2TestCasesIdGet(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<TestCaseV2, any>>;
// Warning: (ae-forgotten-export) The symbol "SearchableUnixSecondsInput" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "V2TestResultsGet200Response" needs to be exported by the entry point index.d.ts
v2TestResultsGet(pipelineId?: string, pipelineSlug?: string, createdAt?: SearchableUnixSecondsInput, metadata?: {
[key: string]: FilterableMetadataInputValue;
}, options?: AxiosRequestConfig): Promise<AxiosResponse<V2TestResultsGet200Response, any>>;
}
// @public
export const V2ApiAxiosParamCreator: (configuration?: Configuration) => {
v2DatasetsGet: (pipelineSlug?: string, pipelineId?: string, archived?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v2DatasetsIdGet: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v2DatasetsIdPost: (id: string, updateDatasetV2: UpdateDatasetV2, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v2DatasetsPost: (createDatasetV2: CreateDatasetV2, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v2EvaluationsBulkPost: (v2EvaluationsBulkPostRequest: V2EvaluationsBulkPostRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v2EvaluationsGet: (resultId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v2EvaluatorsGet: (pipelineId?: string, pipelineSlug?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v2FeedbackIdGet: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v2FeedbackIdPatch: (id: string, updateFeedbackV2: UpdateFeedbackV2, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v2FeedbackPost: (createFeedbackV2: CreateFeedbackV2, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v2FoldersGet: (parentFolderId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v2FoldersIdGet: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v2PipelinesGet: (label?: string, slug?: SearchableStringInput, folderId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v2RunsIdGet: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v2TestCasesGet: (datasetId?: string, pipelineId?: string, pipelineSlug?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v2TestCasesIdDelete: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v2TestCasesIdGet: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
v2TestResultsGet: (pipelineId?: string, pipelineSlug?: string, createdAt?: SearchableUnixSecondsInput, metadata?: {
[key: string]: FilterableMetadataInputValue;
}, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
// @public
export const V2ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
v2DatasetsGet(pipelineSlug?: string, pipelineId?: string, archived?: boolean, options?: any): AxiosPromise<V2DatasetsGet200Response>;
v2DatasetsIdGet(id: string, options?: any): AxiosPromise<DatasetV2>;
v2DatasetsIdPost(id: string, updateDatasetV2: UpdateDatasetV2, options?: any): AxiosPromise<DatasetV2>;
v2DatasetsPost(createDatasetV2: CreateDatasetV2, options?: any): AxiosPromise<DatasetV2>;
v2EvaluationsBulkPost(v2EvaluationsBulkPostRequest: V2EvaluationsBulkPostRequest, options?: any): AxiosPromise<V2EvaluationsBulkPost200Response>;
v2EvaluationsGet(resultId: string, options?: any): AxiosPromise<V2EvaluationsGet200Response>;
v2EvaluatorsGet(pipelineId?: string, pipelineSlug?: string, options?: any): AxiosPromise<V2EvaluatorsGet200Response>;
v2FeedbackIdGet(id: string, options?: any): AxiosPromise<FeedbackV2>;
v2FeedbackIdPatch(id: string, updateFeedbackV2: UpdateFeedbackV2, options?: any): AxiosPromise<FeedbackV2>;
v2FeedbackPost(createFeedbackV2: CreateFeedbackV2, options?: any): AxiosPromise<FeedbackV2>;
v2FoldersGet(parentFolderId?: string, options?: any): AxiosPromise<V2FoldersGet200Response>;
v2FoldersIdGet(id: string, options?: any): AxiosPromise<FolderV2>;
v2PipelinesGet(label?: string, slug?: SearchableStringInput, folderId?: string, options?: any): AxiosPromise<V2PipelinesGet200Response>;
v2RunsIdGet(id: string, options?: any): AxiosPromise<RunV2>;
v2TestCasesGet(datasetId?: string, pipelineId?: string, pipelineSlug?: string, options?: any): AxiosPromise<V2TestCasesGet200Response>;
v2TestCasesIdDelete(id: string, options?: any): AxiosPromise<V2TestCasesIdDelete200Response>;
v2TestCasesIdGet(id: string, options?: any): AxiosPromise<TestCaseV2>;
v2TestResultsGet(pipelineId?: string, pipelineSlug?: string, createdAt?: SearchableUnixSecondsInput, metadata?: {
[key: string]: FilterableMetadataInputValue;
}, options?: any): AxiosPromise<V2TestResultsGet200Response>;
};
// @public
export const V2ApiFp: (configuration?: Configuration) => {
v2DatasetsGet(pipelineSlug?: string, pipelineId?: string, archived?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2DatasetsGet200Response>>;
v2DatasetsIdGet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetV2>>;
v2DatasetsIdPost(id: string, updateDatasetV2: UpdateDatasetV2, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetV2>>;
v2DatasetsPost(createDatasetV2: CreateDatasetV2, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetV2>>;
v2EvaluationsBulkPost(v2EvaluationsBulkPostRequest: V2EvaluationsBulkPostRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2EvaluationsBulkPost200Response>>;
v2EvaluationsGet(resultId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2EvaluationsGet200Response>>;
v2EvaluatorsGet(pipelineId?: string, pipelineSlug?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2EvaluatorsGet200Response>>;
v2FeedbackIdGet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FeedbackV2>>;
v2FeedbackIdPatch(id: string, updateFeedbackV2: UpdateFeedbackV2, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FeedbackV2>>;
v2FeedbackPost(createFeedbackV2: CreateFeedbackV2, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FeedbackV2>>;
v2FoldersGet(parentFolderId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2FoldersGet200Response>>;
v2FoldersIdGet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FolderV2>>;
v2PipelinesGet(label?: string, slug?: SearchableStringInput, folderId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2PipelinesGet200Response>>;
v2RunsIdGet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunV2>>;
v2TestCasesGet(datasetId?: string, pipelineId?: string, pipelineSlug?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2TestCasesGet200Response>>;
v2TestCasesIdDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2TestCasesIdDelete200Response>>;
v2TestCasesIdGet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TestCaseV2>>;
v2TestResultsGet(pipelineId?: string, pipelineSlug?: string, createdAt?: SearchableUnixSecondsInput, metadata?: {
[key: string]: FilterableMetadataInputValue;
}, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2TestResultsGet200Response>>;
};
// @public
export class V3Api extends BaseAPI {
// Warning: (ae-forgotten-export) The symbol "V3EvaluationsGet200Response" needs to be exported by the entry point index.d.ts
v3EvaluationsGet(resultId: string, options?: AxiosRequestConfig): Promise<AxiosResponse<V3EvaluationsGet200Response, any>>;
}
// @public
export const V3ApiAxiosParamCreator: (configuration?: Configuration) => {
v3EvaluationsGet: (resultId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
// @public
export const V3ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
v3EvaluationsGet(resultId: string, options?: any): AxiosPromise<V3EvaluationsGet200Response>;
};
// @public
export const V3ApiFp: (configuration?: Configuration) => {
v3EvaluationsGet(resultId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V3EvaluationsGet200Response>>;
};
// Warnings were encountered during analysis:
//
// dist/api/v1-api.d.ts:46:5 - (ae-forgotten-export) The symbol "RequestArgs" needs to be exported by the entry point index.d.ts
// dist/api/v2-api.d.ts:710:9 - (ae-forgotten-export) The symbol "FilterableMetadataInputValue" needs to be exported by the entry point index.d.ts
// dist/models/run-request.d.ts:50:9 - (ae-forgotten-export) The symbol "MetadataValueObject" needs to be exported by the entry point index.d.ts
// dist/providers/context.d.ts:15:5 - (ae-forgotten-export) The symbol "Metadata" needs to be exported by the entry point index.d.ts
// dist/providers/pipeline-run.d.ts:40:9 - (ae-forgotten-export) The symbol "PipelineLike" needs to be exported by the entry point index.d.ts
// dist/providers/pipeline-run.d.ts:106:9 - (ae-forgotten-export) The symbol "StepRunWhitelistDescriptor" needs to be exported by the entry point index.d.ts
// (No @packageDocumentation comment for this package)
```