journey-index-json/dist¶

Interfaces¶

EnsureJourneyIndexOptions¶

Extends¶

BuildJourneyIndexOptions

Properties¶

agent¶

agent: CompiledAgent;

embeddingModel¶

embeddingModel: ModelAdapter;

Inherited from¶

BuildJourneyIndexOptions.embeddingModel

file¶

file: string;

generatedAt?¶

optional generatedAt?: string;

Inherited from¶

BuildJourneyIndexOptions.generatedAt

mode?¶

optional mode?: "development" | "production";

signal?¶

optional signal?: AbortSignal;

Inherited from¶

BuildJourneyIndexOptions.signal

Functions¶

ensureJourneyIndex()¶

function ensureJourneyIndex(options): Promise<{
  agentId: string;
  definitionHash: string;
  embeddingModel: string;
  embeddingProvider: string;
  entries: {
     alwaysInclude: boolean;
     condition: string;
     definitionHash: string;
     embedding: {
        dimensions: number;
        model: string;
        vector: number[];
     };
     examples: string[];
     journeyId: string;
     kind: "stateMachine" | "delegation";
     priority: number;
     routingText: string;
     stickiness: "low" | "medium" | "high";
     tags: string[];
  }[];
  generatedAt: string;
  projectionVersion: "cognidesk.journey-index.v1";
}>;

Parameters¶

Parameter	Type
`options`	`EnsureJourneyIndexOptions`

Returns¶

Promise\<{ agentId: string; definitionHash: string; embeddingModel: string; embeddingProvider: string; entries: { alwaysInclude: boolean; condition: string; definitionHash: string; embedding: { dimensions: number; model: string; vector: number[]; }; examples: string[]; journeyId: string; kind: "stateMachine" | "delegation"; priority: number; routingText: string; stickiness: "low" | "medium" | "high"; tags: string[]; }[]; generatedAt: string; projectionVersion: "cognidesk.journey-index.v1"; }>

loadFreshJourneyIndex()¶

function loadFreshJourneyIndex(
   file,
   agent,
   options?): Promise<{
  agentId: string;
  definitionHash: string;
  embeddingModel: string;
  embeddingProvider: string;
  entries: {
     alwaysInclude: boolean;
     condition: string;
     definitionHash: string;
     embedding: {
        dimensions: number;
        model: string;
        vector: number[];
     };
     examples: string[];
     journeyId: string;
     kind: "stateMachine" | "delegation";
     priority: number;
     routingText: string;
     stickiness: "low" | "medium" | "high";
     tags: string[];
  }[];
  generatedAt: string;
  projectionVersion: "cognidesk.journey-index.v1";
}>;

Parameters¶

Parameter	Type
`file`	`string`
`agent`	`CompiledAgent`
`options?`	{ `embeddingModel?`: `ModelAdapter`; }
`options.embeddingModel?`	`ModelAdapter`

Returns¶

Promise\<{ agentId: string; definitionHash: string; embeddingModel: string; embeddingProvider: string; entries: { alwaysInclude: boolean; condition: string; definitionHash: string; embedding: { dimensions: number; model: string; vector: number[]; }; examples: string[]; journeyId: string; kind: "stateMachine" | "delegation"; priority: number; routingText: string; stickiness: "low" | "medium" | "high"; tags: string[]; }[]; generatedAt: string; projectionVersion: "cognidesk.journey-index.v1"; }>

loadJourneyIndex()¶

function loadJourneyIndex(file): Promise<{
  agentId: string;
  definitionHash: string;
  embeddingModel: string;
  embeddingProvider: string;
  entries: {
     alwaysInclude: boolean;
     condition: string;
     definitionHash: string;
     embedding: {
        dimensions: number;
        model: string;
        vector: number[];
     };
     examples: string[];
     journeyId: string;
     kind: "stateMachine" | "delegation";
     priority: number;
     routingText: string;
     stickiness: "low" | "medium" | "high";
     tags: string[];
  }[];
  generatedAt: string;
  projectionVersion: "cognidesk.journey-index.v1";
}>;

Parameters¶

Parameter	Type
`file`	`string`

Returns¶

Promise\<{ agentId: string; definitionHash: string; embeddingModel: string; embeddingProvider: string; entries: { alwaysInclude: boolean; condition: string; definitionHash: string; embedding: { dimensions: number; model: string; vector: number[]; }; examples: string[]; journeyId: string; kind: "stateMachine" | "delegation"; priority: number; routingText: string; stickiness: "low" | "medium" | "high"; tags: string[]; }[]; generatedAt: string; projectionVersion: "cognidesk.journey-index.v1"; }>

saveJourneyIndex()¶

function saveJourneyIndex(file, index): Promise<void>;

Parameters¶

Parameter	Type
`file`	`string`
`index`	{ `agentId`: `string`; `definitionHash`: `string`; `embeddingModel`: `string`; `embeddingProvider`: `string`; `entries`: { `alwaysInclude`: `boolean`; `condition`: `string`; `definitionHash`: `string`; `embedding`: { `dimensions`: `number`; `model`: `string`; `vector`: `number`[]; }; `examples`: `string`[]; `journeyId`: `string`; `kind`: `"stateMachine"` \| `"delegation"`; `priority`: `number`; `routingText`: `string`; `stickiness`: `"low"` \| `"medium"` \| `"high"`; `tags`: `string`[]; }[]; `generatedAt`: `string`; `projectionVersion`: `"cognidesk.journey-index.v1"`; }
`index.agentId`	`string`
`index.definitionHash`	`string`
`index.embeddingModel`	`string`
`index.embeddingProvider`	`string`
`index.entries`	{ `alwaysInclude`: `boolean`; `condition`: `string`; `definitionHash`: `string`; `embedding`: { `dimensions`: `number`; `model`: `string`; `vector`: `number`[]; }; `examples`: `string`[]; `journeyId`: `string`; `kind`: `"stateMachine"` \| `"delegation"`; `priority`: `number`; `routingText`: `string`; `stickiness`: `"low"` \| `"medium"` \| `"high"`; `tags`: `string`[]; }[]
`index.generatedAt`	`string`
`index.projectionVersion`	`"cognidesk.journey-index.v1"`

Returns¶

Promise\<void>