@gentrace/core
Version:
Core Gentrace Node.JS library
1,572 lines (1,571 loc) • 555 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.49.0",
"schemaVersion": 1011,
"oldestForwardsCompatibleVersion": 1001,
"tsdocConfig": {
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
"noStandardTags": true,
"tagDefinitions": [
{
"tagName": "@alpha",
"syntaxKind": "modifier"
},
{
"tagName": "@beta",
"syntaxKind": "modifier"
},
{
"tagName": "@defaultValue",
"syntaxKind": "block"
},
{
"tagName": "@decorator",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@deprecated",
"syntaxKind": "block"
},
{
"tagName": "@eventProperty",
"syntaxKind": "modifier"
},
{
"tagName": "@example",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@experimental",
"syntaxKind": "modifier"
},
{
"tagName": "@inheritDoc",
"syntaxKind": "inline"
},
{
"tagName": "@internal",
"syntaxKind": "modifier"
},
{
"tagName": "@label",
"syntaxKind": "inline"
},
{
"tagName": "@link",
"syntaxKind": "inline",
"allowMultiple": true
},
{
"tagName": "@override",
"syntaxKind": "modifier"
},
{
"tagName": "@packageDocumentation",
"syntaxKind": "modifier"
},
{
"tagName": "@param",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@privateRemarks",
"syntaxKind": "block"
},
{
"tagName": "@public",
"syntaxKind": "modifier"
},
{
"tagName": "@readonly",
"syntaxKind": "modifier"
},
{
"tagName": "@remarks",
"syntaxKind": "block"
},
{
"tagName": "@returns",
"syntaxKind": "block"
},
{
"tagName": "@sealed",
"syntaxKind": "modifier"
},
{
"tagName": "@see",
"syntaxKind": "block"
},
{
"tagName": "@throws",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@typeParam",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@virtual",
"syntaxKind": "modifier"
},
{
"tagName": "@betaDocumentation",
"syntaxKind": "modifier"
},
{
"tagName": "@internalRemarks",
"syntaxKind": "block"
},
{
"tagName": "@preapproved",
"syntaxKind": "modifier"
}
],
"supportForTags": {
"@alpha": true,
"@beta": true,
"@defaultValue": true,
"@decorator": true,
"@deprecated": true,
"@eventProperty": true,
"@example": true,
"@experimental": true,
"@inheritDoc": true,
"@internal": true,
"@label": true,
"@link": true,
"@override": true,
"@packageDocumentation": true,
"@param": true,
"@privateRemarks": true,
"@public": true,
"@readonly": true,
"@remarks": true,
"@returns": true,
"@sealed": true,
"@see": true,
"@throws": true,
"@typeParam": true,
"@virtual": true,
"@betaDocumentation": true,
"@internalRemarks": true,
"@preapproved": true
},
"reportUnsupportedHtmlElements": false
}
},
"kind": "Package",
"canonicalReference": "@gentrace/core!",
"docComment": "",
"name": "@gentrace/core",
"preserveMemberOrder": false,
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@gentrace/core!",
"name": "",
"preserveMemberOrder": false,
"members": [
{
"kind": "Function",
"canonicalReference": "@gentrace/core!bulkCreateEvaluations:function(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function bulkCreateEvaluations(evaluations: "
},
{
"kind": "Reference",
"text": "Array",
"canonicalReference": "!Array:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "CreateEvaluationV2",
"canonicalReference": "@gentrace/core!~CreateEvaluationV2:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<import(\"../models\")."
},
{
"kind": "Reference",
"text": "V2EvaluationsBulkPost200Response",
"canonicalReference": "@gentrace/core!~V2EvaluationsBulkPost200Response:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "dist/providers/evaluation.d.ts",
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 10
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "evaluations",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isOptional": false
}
],
"name": "bulkCreateEvaluations"
},
{
"kind": "Class",
"canonicalReference": "@gentrace/core!Configuration:class",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class Configuration "
}
],
"fileUrlPath": "dist/configuration.d.ts",
"releaseTag": "Public",
"isAbstract": false,
"name": "Configuration",
"preserveMemberOrder": false,
"members": [
{
"kind": "Constructor",
"canonicalReference": "@gentrace/core!Configuration:constructor(1)",
"docComment": "/**\n * Constructs a new instance of the `Configuration` class\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor(param?: "
},
{
"kind": "Reference",
"text": "ConfigurationParameters",
"canonicalReference": "@gentrace/core!ConfigurationParameters:interface"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "param",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": true
}
]
},
{
"kind": "Property",
"canonicalReference": "@gentrace/core!Configuration#accessToken:member",
"docComment": "/**\n * parameter for oauth2 security\n *\n * @param name - security name\n *\n * @param scopes - oauth2 scope @memberof Configuration\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "accessToken?: "
},
{
"kind": "Content",
"text": "string | "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<string>)"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "accessToken",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@gentrace/core!Configuration#apiKey:member",
"docComment": "/**\n * parameter for apiKey security\n *\n * @param name - security name @memberof Configuration\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "apiKey?: "
},
{
"kind": "Content",
"text": "string | "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<string> | ((name: string) => string) | ((name: string) => "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<string>)"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "apiKey",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@gentrace/core!Configuration#baseOptions:member",
"docComment": "/**\n * base options for axios calls\n *\n * @type {any} @memberof Configuration\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "baseOptions?: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "baseOptions",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@gentrace/core!Configuration#basePath:member",
"docComment": "/**\n * override base path\n *\n * @type {string} @memberof Configuration\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "basePath?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "basePath",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@gentrace/core!Configuration#formDataCtor:member",
"docComment": "/**\n * The FormData constructor that will be used to create multipart form data requests. You can inject this here so that execution environments that do not support the FormData class can still run the generated client.\n *\n * @type {new () => FormData}\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "formDataCtor?: "
},
{
"kind": "Content",
"text": "new () => any"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "formDataCtor",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Method",
"canonicalReference": "@gentrace/core!Configuration#isJsonMime:member(1)",
"docComment": "/**\n * Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json\n *\n * @param mime - MIME (Multipurpose Internet Mail Extensions) @return True if the given MIME is JSON, false otherwise.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "isJsonMime(mime: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "mime",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "isJsonMime"
},
{
"kind": "Property",
"canonicalReference": "@gentrace/core!Configuration#logger:member",
"docComment": "/**\n * Custom logger that clients can provide to capture logs/warnings/errors from the SDK.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "logger?: "
},
{
"kind": "Content",
"text": "{\n info: (message: string, context?: any) => void;\n warn: (message: string | "
},
{
"kind": "Reference",
"text": "Error",
"canonicalReference": "!Error:interface"
},
{
"kind": "Content",
"text": ", context?: any) => void;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "logger",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@gentrace/core!Configuration#password:member",
"docComment": "/**\n * parameter for basic security\n *\n * @type {string} @memberof Configuration\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "password?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "password",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
},
{
"kind": "Property",
"canonicalReference": "@gentrace/core!Configuration#username:member",
"docComment": "/**\n * parameter for basic security\n *\n * @type {string} @memberof Configuration\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "username?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "username",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false,
"isProtected": false,
"isAbstract": false
}
],
"implementsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "@gentrace/core!ConfigurationParameters:interface",
"docComment": "/**\n * Gentrace API These API routes are designed to ingest events from clients.\n *\n * The version of the OpenAPI document: 0.27.0\n *\n * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface ConfigurationParameters "
}
],
"fileUrlPath": "dist/configuration.d.ts",
"releaseTag": "Public",
"name": "ConfigurationParameters",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@gentrace/core!ConfigurationParameters#accessToken:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "accessToken?: "
},
{
"kind": "Content",
"text": "string | "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<string>)"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "accessToken",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@gentrace/core!ConfigurationParameters#apiKey:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "apiKey?: "
},
{
"kind": "Content",
"text": "string | "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<string> | ((name: string) => string) | ((name: string) => "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<string>)"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "apiKey",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@gentrace/core!ConfigurationParameters#baseOptions:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "baseOptions?: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "baseOptions",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@gentrace/core!ConfigurationParameters#basePath:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "basePath?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "basePath",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@gentrace/core!ConfigurationParameters#formDataCtor:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "formDataCtor?: "
},
{
"kind": "Content",
"text": "new () => any"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "formDataCtor",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@gentrace/core!ConfigurationParameters#logger:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "logger?: "
},
{
"kind": "Content",
"text": "{\n info: (message: string, context?: any) => void;\n warn: (message: string | "
},
{
"kind": "Reference",
"text": "Error",
"canonicalReference": "!Error:interface"
},
{
"kind": "Content",
"text": ", context?: any) => void;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "logger",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@gentrace/core!ConfigurationParameters#password:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "password?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "password",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@gentrace/core!ConfigurationParameters#username:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "username?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "username",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Function",
"canonicalReference": "@gentrace/core!constructSubmissionPayloadAdvanced:function(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "constructSubmissionPayloadAdvanced: (pipelineIdentifier: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", testRuns: "
},
{
"kind": "Reference",
"text": "TestRun",
"canonicalReference": "@gentrace/core!TestRun:type"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ", context?: "
},
{
"kind": "Reference",
"text": "ResultContext",
"canonicalReference": "@gentrace/core!ResultContext:type"
},
{
"kind": "Content",
"text": ", triggerRemoteEvals?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Reference",
"text": "V1TestResultPostRequest",
"canonicalReference": "@gentrace/core!TestResultPostRequest:interface"
}
],
"fileUrlPath": "dist/providers/test-result.d.ts",
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "pipelineIdentifier",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "testRuns",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"isOptional": false
},
{
"parameterName": "context",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"isOptional": true
},
{
"parameterName": "triggerRemoteEvals",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
},
"isOptional": true
}
],
"name": "constructSubmissionPayloadAdvanced"
},
{
"kind": "Function",
"canonicalReference": "@gentrace/core!constructSubmissionPayloadSimple:function(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "constructSubmissionPayloadSimple: (pipelineSlug: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", testRuns: "
},
{
"kind": "Reference",
"text": "V1TestResultSimplePostRequestTestRunsInner",
"canonicalReference": "@gentrace/core!~V1TestResultSimplePostRequestTestRunsInner:interface"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ", context?: "
},
{
"kind": "Reference",
"text": "ResultContext",
"canonicalReference": "@gentrace/core!ResultContext:type"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Reference",
"text": "V1TestResultSimplePostRequest",
"canonicalReference": "@gentrace/core!~V1TestResultSimplePostRequest:interface"
}
],
"fileUrlPath": "dist/providers/test-result.d.ts",
"returnTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "pipelineSlug",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "testRuns",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"isOptional": false
},
{
"parameterName": "context",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"isOptional": true
}
],
"name": "constructSubmissionPayloadSimple"
},
{
"kind": "TypeAlias",
"canonicalReference": "@gentrace/core!Context:type",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export type Context = "
},
{
"kind": "Reference",
"text": "PipelineRunContext",
"canonicalReference": "@gentrace/core!~PipelineRunContext:type"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "CoreStepRunContext",
"canonicalReference": "@gentrace/core!CoreStepRunContext:type"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "dist/providers/context.d.ts",
"releaseTag": "Public",
"name": "Context",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@gentrace/core!CoreStepRunContext:type",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export type CoreStepRunContext = "
},
{
"kind": "Content",
"text": "{\n render?: {\n type: \"html\";\n key: string;\n };\n metadata?: "
},
{
"kind": "Reference",
"text": "Metadata",
"canonicalReference": "@gentrace/core!~Metadata:type"
},
{
"kind": "Content",
"text": ";\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "dist/providers/context.d.ts",
"releaseTag": "Public",
"name": "CoreStepRunContext",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "Function",
"canonicalReference": "@gentrace/core!createDataset:function(1)",
"docComment": "/**\n * Creates a new dataset in the Gentrace API. @async\n *\n * @param payload - The dataset creation payload.\n *\n * @returns {Promise<DatasetV2>} - A promise that resolves to the created dataset.\n *\n * @throws\n *\n * {Error} - Throws an error if the Gentrace API key is not initialized.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "createDataset: (payload: "
},
{
"kind": "Reference",
"text": "CreateDatasetV2",
"canonicalReference": "@gentrace/core!~CreateDatasetV2:interface"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "DatasetV2",
"canonicalReference": "@gentrace/core!~DatasetV2:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/providers/dataset.d.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "payload",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "createDataset"
},
{
"kind": "TypeAlias",
"canonicalReference": "@gentrace/core!CreateEvaluationType:type",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export type CreateEvaluationType = "
},
{
"kind": "Reference",
"text": "CreateEvaluationV2",
"canonicalReference": "@gentrace/core!~CreateEvaluationV2:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "dist/providers/evaluation.d.ts",
"releaseTag": "Public",
"name": "CreateEvaluationType",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Function",
"canonicalReference": "@gentrace/core!createTestCase:function(1)",
"docComment": "/**\n * Creates a single test case for a given pipeline ID from the Gentrace API\n *\n * @async\n *\n * @remarks\n *\n * If a pipeline slug is specified, the golden dataset will be used. If a datasetId is provided, it will be used instead.\n *\n * @param payload - New test case payload\n *\n * @returns {Promise<string>} A Promise that resolves to the created case ID\n *\n * @throws\n *\n * {Error} Throws an error if the SDK is not initialized. Call init() first.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "createTestCase: (payload: "
},
{
"kind": "Reference",
"text": "CreateSingleTestCase",
"canonicalReference": "@gentrace/core!~CreateSingleTestCase:interface"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<string>"
}
],
"fileUrlPath": "dist/providers/test-case.d.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "payload",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "createTestCase"
},
{
"kind": "Function",
"canonicalReference": "@gentrace/core!createTestCases:function(1)",
"docComment": "/**\n * Creates multiple test cases for a given pipeline ID from the Gentrace API\n *\n * @async\n *\n * @remarks\n *\n * If a pipeline slug is specified, the golden dataset will be used. If a datasetId is provided, it will be used instead.\n *\n * @param payload - New test case payloads\n *\n * @returns {Promise<string>} A Promise that resolves to the number of test cases successfully created\n *\n * @throws\n *\n * {Error} Throws an error if the SDK is not initialized. Call init() first.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "createTestCases: (payload: "
},
{
"kind": "Reference",
"text": "CreateMultipleTestCases",
"canonicalReference": "@gentrace/core!~CreateMultipleTestCases:interface"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<number>"
}
],
"fileUrlPath": "dist/providers/test-case.d.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "payload",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "createTestCases"
},
{
"kind": "Function",
"canonicalReference": "@gentrace/core!createTestRunners:function(1)",
"docComment": "/**\n * Creates test runners for a given pipeline using locally provided test data\n *\n * @param pipeline - The pipeline instance\n *\n * @param localData - Array of local test data objects\n *\n * @returns {Array<PipelineRunLocalDataTuple>} An array of PipelineRunTestCaseTuple\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function createTestRunners(pipeline: "
},
{
"kind": "Reference",
"text": "Pipeline",
"canonicalReference": "@gentrace/core!Pipeline:class"
},
{
"kind": "Content",
"text": "<{\n [key: string]: "
},
{
"kind": "Reference",
"text": "GentracePlugin",
"canonicalReference": "@gentrace/core!GentracePlugin:class"
},
{
"kind": "Content",
"text": "<any, any>;\n}>"
},
{
"kind": "Content",
"text": ", localData: "
},
{
"kind": "Reference",
"text": "LocalTestData",
"canonicalReference": "@gentrace/core!LocalTestData:type"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Array",
"canonicalReference": "!Array:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "PipelineRunDataTuple",
"canonicalReference": "@gentrace/core!PipelineRunDataTuple:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "dist/providers/runners.d.ts",
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 13
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "pipeline",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isOptional": false
},
{
"parameterName": "localData",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 8
},
"isOptional": false
}
],
"name": "createTestRunners"
},
{
"kind": "Function",
"canonicalReference": "@gentrace/core!defineInteraction:function(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function defineInteraction<T = "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ", Fn extends "
},
{
"kind": "Reference",
"text": "InteractionFn",
"canonicalReference": "@gentrace/core!~InteractionFn:type"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Reference",
"text": "InteractionFn",
"canonicalReference": "@gentrace/core!~InteractionFn:type"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(interaction: "
},
{
"kind": "Reference",
"text": "InteractionDefinition",
"canonicalReference": "@gentrace/core!~InteractionDefinition:type"
},
{
"kind": "Content",
"text": "<T, Fn>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "Fn"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "dist/providers/test-job-runner.d.ts",
"returnTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "interaction",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 11
},
"isOptional": false
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"typeParameterName": "Fn",
"constraintTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 6,
"endIndex": 8
}
}
],
"name": "defineInteraction"
},
{
"kind": "Function",
"canonicalReference": "@gentrace/core!defineTestSuite:function(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function defineTestSuite<Fn extends "
},
{
"kind": "Reference",
"text": "AnyFn",
"canonicalReference": "@gentrace/core!~AnyFn:type"
},
{
"kind": "Content",
"text": ">(testSuite: "
},
{
"kind": "Content",
"text": "{\n name: string;\n fn: Fn;\n}"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "Fn"
},
{
"kind": "Content",
"text": ";"
}