@manta-eu/client/shared/tools

Type Aliases

ActionPlanShowcaseInput

ActionPlanShowcaseInput = object

Properties

actionPlanIRI

actionPlanIRI: string

---

ActionPlanShowcaseOutput

ActionPlanShowcaseOutput = { planIri: string; planName: string; status: ActionPlanStatus; } | ToolErrorResult

---

ActionPlanStatus

ActionPlanStatus = "DRAFT" | "RUNNING" | "COMPLETED" | "FAILED" | "TIMED_OUT"

---

AddFactsInput

AddFactsInput = object

Properties

facts

facts: string

humanIntent

humanIntent: string

---

AddFactsOutput

AddFactsOutput = string | ToolErrorResult

---

CancelScheduleInput

CancelScheduleInput = object

Properties

id

id: string

---

CancelScheduleOutput

CancelScheduleOutput = ToolObjectOutput

---

ExecuteActionPlanInput

ExecuteActionPlanInput = object

Properties

autoApprove?

optional autoApprove?: boolean

dryRun?

optional dryRun?: boolean

namedGraphIri

namedGraphIri: string

shaclShapeIri?

optional shaclShapeIri?: string

---

ExecuteActionPlanOutput

ExecuteActionPlanOutput = { data?: unknown; planValidation?: { completeness: number; issues?: string[]; valid: boolean; }; semanticDiff?: { creates: number; deletes: number; operations: unknown[]; updates: number; }; workflowId?: string; } | ToolErrorResult

---

ExplainFactToolInput

ExplainFactToolInput = object

Properties

object

object: string

predicate?

optional predicate?: string

subject

subject: string

---

ExplainFactToolOutput

ExplainFactToolOutput = ToolObjectOutput

---

GenerateChartInput

GenerateChartInput = object

Properties

barLabel?

optional barLabel?: string

data

data: GenerateChartInputData[]

height?

optional height?: number

lineLabel?

optional lineLabel?: string

title?

optional title?: string

type

type: GenerateChartType

xAxisLabel?

optional xAxisLabel?: string

yAxisLabel?

optional yAxisLabel?: string

---

GenerateChartOutput

GenerateChartOutput = object

Properties

chartType

chartType: GenerateChartType

data

data: object

message

message: string

type

type: "chart"

---

GetRulesInput

GetRulesInput = object

Properties

limit?

optional limit?: number

namedGraphIri?

optional namedGraphIri?: string

rdfTypes?

optional rdfTypes?: string[]

---

GetRulesOutput

GetRulesOutput = GetRulesOutputSuccess | ToolErrorResult

---

ListScheduledTasksInput

ListScheduledTasksInput = Record<string, never>

---

ListScheduledTasksOutput

ListScheduledTasksOutput = object[] | ToolErrorResult

---

QueryKnowledgeGraphInput

QueryKnowledgeGraphInput = object

Properties

humanIntent

humanIntent: string

keepPrefixes?

optional keepPrefixes?: boolean

sparql

sparql: string

---

QueryKnowledgeGraphOutput

QueryKnowledgeGraphOutput = JsonLdGraphDocument | SparqlJsonResults | ToolErrorResult

---

ScheduleTaskInput

ScheduleTaskInput = object

Indexable

[key: string]: unknown

Properties

description

description: string

when

when: "scheduled" | "delayed" | "cron"

---

ScheduleTaskOutput

ScheduleTaskOutput = ToolObjectOutput

---

ShowEntitiesInput

ShowEntitiesInput = object

Properties

entityIris

entityIris: string[]

---

ShowEntitiesOutput

ShowEntitiesOutput = { entityIris: string[]; graph: JsonLdGraphDocument; message?: string; } | ToolErrorResult

---

SparqlJsonBinding

SparqlJsonBinding = SparqlBinding

---

SparqlJsonResults

SparqlJsonResults = object

Properties

head

head: object

link?

optional link?: string[]

vars?

optional vars?: string[]

results

results: object

bindings

bindings: SparqlBinding[]

---

SparqlValue

SparqlValue = object

W3C SPARQL Query Results JSON Format https://www.w3.org/TR/sparql11-results-json/

Properties

datatype?

optional datatype?: string

type

type: "uri" | "literal" | "bnode"

value

value: string

xml:lang?

optional xml:lang?: string

---

ToolCategory

ToolCategory = "knowledge-graph" | "scheduler" | "charts" | "action" | "auto-pilot"

---

ToolDefinition

ToolDefinition<TInput, _TOutput> = object

Type Parameters

TInput

TInput = unknown

_TOutput

_TOutput = unknown

Properties

category

category: ToolCategory

description

description: string

getHumanName

getHumanName: (input?) => string

Parameters

input?

TInput

Returns

string

humanName

humanName: string

inputSchema

inputSchema: ToolInputSchema<TInput>

name

name: ToolName

---

ToolDefinitions

ToolDefinitions = object

Properties

actionPlanShowcase

actionPlanShowcase: ToolDefinition<ActionPlanShowcaseInput, ActionPlanShowcaseOutput>

addFacts

addFacts: ToolDefinition<AddFactsInput, AddFactsOutput>

cancelSchedule

cancelSchedule: ToolDefinition<CancelScheduleInput, CancelScheduleOutput>

checkAutoPilotStatus

checkAutoPilotStatus: ToolDefinition<AutoPilotInput, CheckAutoPilotStatusOutput>

executeActionPlan

executeActionPlan: ToolDefinition<ExecuteActionPlanInput, ExecuteActionPlanOutput>

explainFact

explainFact: ToolDefinition<ExplainFactToolInput, ExplainFactToolOutput>

generateChart

generateChart: ToolDefinition<GenerateChartInput, GenerateChartOutput>

getRules

getRules: ToolDefinition<GetRulesInput, GetRulesOutput>

listScheduledTasks

listScheduledTasks: ToolDefinition<ListScheduledTasksInput, ListScheduledTasksOutput>

manageFacts

manageFacts: ToolDefinition<ManageFactsInput, ManageFactsOutput>

manageRules

manageRules: ToolDefinition<ManageRulesInput, ManageRulesOutput>

markAsLowRisk

markAsLowRisk: ToolDefinition<AutoPilotInput, AutoPilotOutput>

queryKnowledgeGraph

queryKnowledgeGraph: ToolDefinition<QueryKnowledgeGraphInput, QueryKnowledgeGraphOutput>

readUploadedFile

readUploadedFile: ToolDefinition<ReadUploadedFileInput, ReadUploadedFileOutput>

requestBudgetChange

requestBudgetChange: ToolDefinition<RequestBudgetChangeInput, unknown>

scheduleTask

scheduleTask: ToolDefinition<ScheduleTaskInput, ScheduleTaskOutput>

setDailyChangeLimit

setDailyChangeLimit: ToolDefinition<SetDailyChangeLimitInput, AutoPilotOutput>

showEntities

showEntities: ToolDefinition<ShowEntitiesInput, ShowEntitiesOutput>

---

ToolErrorResult

ToolErrorResult = object

Properties

content

content: string

is_error

is_error: true

---

ToolInputSchema

ToolInputSchema<T> = z.ZodSchema<T>

Type Parameters

T

T = unknown

---

ToolMetadata

ToolMetadata = { [K in ToolName]: { category: ToolCategory; description: string; getHumanName: (input?: ToolDefinitions[K] extends ToolDefinition<infer TInput, unknown> ? TInput : unknown) => string; humanName: string; name: K } }

---

ToolName

ToolName = "queryKnowledgeGraph" | "addFacts" | "getRules" | "explainFact" | "scheduleTask" | "listScheduledTasks" | "cancelSchedule" | "generateChart" | "executeActionPlan" | "manageRules" | "manageFacts" | "actionPlanShowcase" | "showEntities" | "checkAutoPilotStatus" | "setDailyChangeLimit" | "markAsLowRisk" | "readUploadedFile" | "requestBudgetChange"

---

ToolOutput

ToolOutput<T> = T | ToolErrorResult

Type Parameters

T

T = unknown

---

ToolOutputCoercer

ToolOutputCoercer<T> = (raw) => ToolOutputType<T>

Type Parameters

T

T extends ToolName

Parameters

raw

unknown

Returns

ToolOutputType<T>

---

ToolOutputType

ToolOutputType<T> = ToolDefinitions[T] extends ToolDefinition<unknown, infer TOutput> ? TOutput : unknown

Type Parameters

T

T extends ToolName

Variables

allToolNames

const allToolNames: readonly ToolName[]

---

toolMetadata

const toolMetadata: ToolMetadata

Functions

assertValidToolName()

assertValidToolName(toolName): asserts toolName is ToolName

Parameters

toolName

string

Returns

asserts toolName is ToolName

---

coerceToolOutput()

coerceToolOutput<T>(toolName, raw): ToolOutputType<T>

Type Parameters

T

T extends ToolName

Parameters

toolName

T

raw

unknown

Returns

ToolOutputType<T>

---

getHumanToolName()

getHumanToolName<T>(toolName, input?): string

Type Parameters

T

T extends ToolName

Parameters

toolName

T

input?

Record<string, unknown>

Returns

string

---

getSkillToolLabel()

getSkillToolLabel(toolUIPart): string | undefined

Parameters

toolUIPart

object & UIToolInvocation<UITool>

Returns

string | undefined

---

getToolMetadata()

getToolMetadata<T>(toolName): ToolMetadata[T]

Type Parameters

T

T extends ToolName

Parameters

toolName

T

Returns

ToolMetadata[T]

---

getToolUIPartLabel()

getToolUIPartLabel(toolUIPart): string

Parameters

toolUIPart

object & UIToolInvocation<UITool>

Returns

string

---

isErrorToolResult()

isErrorToolResult(data): data is ToolErrorResult

Parameters

data

unknown

Returns

data is ToolErrorResult

---

isShowEntitiesResult()

isShowEntitiesResult(data): data is { entityIris: string[]; graph: JsonLdGraphDocument; message?: string }

Parameters

data

unknown

Returns

data is { entityIris: string[]; graph: JsonLdGraphDocument; message?: string }

---

isSparqlJsonResults()

isSparqlJsonResults(data): data is SparqlJsonResults

Parameters

data

unknown

Returns

data is SparqlJsonResults

---

isValidToolName()

isValidToolName(toolName): toolName is ToolName

Parameters

toolName

string

Returns

toolName is ToolName