model/dist¶

Interfaces¶

BundledPromptProfile¶

Properties¶

metadata¶

metadata: PromptProfileMetadata;

templates¶

templates: PromptTemplateMap;

CognideskEmbeddingModelOptions¶

Properties¶

headers?¶

optional headers?: Record<string, string>;

model¶

model: EmbeddingModel;

modelId?¶

optional modelId?: string;

providerId?¶

optional providerId?: string;

providerOptions?¶

optional providerOptions?: AiSdkProviderOptions;

CognideskModelOptions¶

Properties¶

headers?¶

optional headers?: Record<string, string>;

logicalModelSlug?¶

optional logicalModelSlug?: string;

maxOutputTokens?¶

optional maxOutputTokens?: number;

model¶

model: LanguageModel;

modelId?¶

optional modelId?: string;

modelProfiles?¶

optional modelProfiles?: ModelProfileRegistration[];

promptOverrideBaseDir?¶

optional promptOverrideBaseDir?: string;

promptOverrides?¶

optional promptOverrides?: PromptOverrideRegistry;

promptProfile?¶

optional promptProfile?: ModelPromptProfile;

providerId?¶

optional providerId?: string;

providerOptions?¶

optional providerOptions?: AiSdkProviderOptions;

temperature?¶

optional temperature?: number;

CreateModelSetOptions¶

Properties¶

modelProfiles?¶

optional modelProfiles?: ModelProfileRegistration[];

promptOverrideBaseDir?¶

optional promptOverrideBaseDir?: string;

promptOverrides?¶

optional promptOverrides?: PromptOverrideRegistry;

ModelJsonObject¶

Indexable¶

[key: string]: ModelProviderExtensionValue

ModelProfileRegistration¶

Properties¶

aliases?¶

optional aliases?: string[];

slug¶

slug: string;

ModelProviderExtensionFields¶

Extends¶

ModelJsonObject

Indexable¶

[key: string]: ModelProviderExtensionValue

ModelProviderResponse¶

Extends¶

ModelJsonObject

Indexable¶

[key: string]: ModelProviderExtensionValue

PromptProfileMetadata¶

Properties¶

displayName¶

displayName: string;

researchBasis¶

researchBasis: PromptResearchBasis[];

slug¶

slug: string;

taskNotes¶

taskNotes: Partial<Record<PromptTask, string>>;

PromptProfileOptions¶

Properties¶

baseDir?¶

optional baseDir?: string;

logicalModelSlug?¶

optional logicalModelSlug?: string;

modelProfiles?¶

optional modelProfiles?: ModelProfileRegistration[];

promptOverrides?¶

optional promptOverrides?: PromptOverrideRegistry;

providerModelId?¶

optional providerModelId?: string;

PromptResearchBasis¶

Properties¶

note¶

note: string;

source¶

source: string;

Type Aliases¶

AiSdkProviderOptions¶

type AiSdkProviderOptions = NonNullable<Parameters<typeof generateText>[0]["providerOptions"]>;

EmbeddingModelRoleEntry¶

type EmbeddingModelRoleEntry =
  | EmbeddingModel
  | CognideskEmbeddingModelOptions;

LanguageModelRole¶

type LanguageModelRole = Exclude<keyof AgentModelSet, "journeyEmbedding">;

ModelJsonPrimitive¶

type ModelJsonPrimitive = string | number | boolean | null;

ModelJsonValue¶

type ModelJsonValue =
  | ModelJsonPrimitive
  | ModelJsonObject
  | readonly ModelJsonValue[];

ModelProviderExtensionValue¶

type ModelProviderExtensionValue = ModelJsonValue | object | undefined;

ModelProviderPayload¶

type ModelProviderPayload = ModelJsonObject | object;

ModelProviderQuery¶

type ModelProviderQuery = Record<string, ModelProviderExtensionValue>;

ModelRoleEntry¶

type ModelRoleEntry =
  | LanguageModel
  | Omit<CognideskModelOptions,
  | "promptProfile"
  | "modelProfiles"
  | "promptOverrides"
  | "promptOverrideBaseDir"> & {
  promptProfile?: ModelPromptProfile;
};

ModelSetDefinition¶

type ModelSetDefinition = { [Role in LanguageModelRole]: ModelRoleEntry } & {
  journeyEmbedding: EmbeddingModelRoleEntry;
};

Type Declaration¶

Name	Type
`journeyEmbedding`	`EmbeddingModelRoleEntry`

PromptOverrideRegistry¶

type PromptOverrideRegistry = Record<string, Partial<Record<PromptTask, PromptOverrideValue>>>;

PromptTemplateMap¶

type PromptTemplateMap = Record<PromptTask, string>;

Variables¶

cognideskModelProviderManifest¶

const cognideskModelProviderManifest: {
  capabilities: {
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension?: boolean;
     label?: string;
     metadata?: Record<string, unknown>;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  category: string;
  channelAudiences: ("customer-facing" | "internal-support" | "mixed")[];
  coverage: {
     evidence: {
        label: string;
        url?: string;
     }[];
     notes: string[];
     scope:   | "support-workflow-subset"
        | "provider-api-subset"
        | "connector-required"
        | "local-protocol"
        | "full-provider-api";
  };
  credentialRequirements: {
     description?: string;
     id: string;
     label?: string;
     metadata?: Record<string, unknown>;
     required: boolean;
     scopes: string[];
  }[];
  directions: (
     | "receive-only"
     | "send-only"
     | "inbound-only"
     | "outbound-only"
    | "bidirectional")[];
  id: string;
  limitations: string[];
  maintainers: {
     name: string;
     type: "community" | "official" | "unknown" | "partner";
     url?: string;
  }[];
  metadata?: Record<string, unknown>;
  name: string;
  operations: {
     alias: string;
     audience?: "customer-facing" | "internal-support" | "mixed";
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension: boolean;
     externallyVisible?: boolean;
     inputSchema?: unknown;
     inputSchemaName?: string;
     inputSchemaRef?: string;
     label?: string;
     metadata?: Record<string, unknown>;
     outputSchema?: unknown;
     outputSchemaName?: string;
     outputSchemaRef?: string;
     providerObject?: string;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     providerOperation?: string;
     requiredPolicyIds?: string[];
     requiresApproval?: boolean;
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  packageName: string;
  privacyNotes: string[];
  provider: string;
  trustLevel: "community" | "official" | "verified" | "experimental";
};

Type Declaration¶

Name	Type
`capabilities`	{ `audiences?`: (`"customer-facing"` \| `"internal-support"` \| `"mixed"`)[]; `capability`: `string`; `changesWorkflow?`: `boolean`; `description?`: `string`; `exposesSensitiveData?`: `boolean`; `extension?`: `boolean`; `label?`: `string`; `metadata?`: `Record`\<`string`, `unknown`>; `providerObjects?`: { `description?`: `string`; `kind`: `string`; `label?`: `string`; `metadata?`: `Record`\<`string`, `unknown`>; `schemaName?`: `string`; }[]; `requiresCredential?`: `boolean`; `sideEffect?`: `boolean`; }[]
`category`	`string`
`channelAudiences`	(`"customer-facing"` \| `"internal-support"` \| `"mixed"`)[]
`coverage`	{ `evidence`: { `label`: `string`; `url?`: `string`; }[]; `notes`: `string`[]; `scope`: \| `"support-workflow-subset"` \| `"provider-api-subset"` \| `"connector-required"` \| `"local-protocol"` \| `"full-provider-api"`; }
`coverage.evidence`	{ `label`: `string`; `url?`: `string`; }[]
`coverage.notes`	`string`[]
`coverage.scope`	\| `"support-workflow-subset"` \| `"provider-api-subset"` \| `"connector-required"` \| `"local-protocol"` \| `"full-provider-api"`
`credentialRequirements`	{ `description?`: `string`; `id`: `string`; `label?`: `string`; `metadata?`: `Record`\<`string`, `unknown`>; `required`: `boolean`; `scopes`: `string`[]; }[]
`directions`	( \| `"receive-only"` \| `"send-only"` \| `"inbound-only"` \| `"outbound-only"` \| `"bidirectional"`)[]
`id`	`string`
`limitations`	`string`[]
`maintainers`	{ `name`: `string`; `type`: `"community"` \| `"official"` \| `"unknown"` \| `"partner"`; `url?`: `string`; }[]
`metadata?`	`Record`\<`string`, `unknown`>
`name`	`string`
`operations`	{ `alias`: `string`; `audience?`: `"customer-facing"` \| `"internal-support"` \| `"mixed"`; `audiences?`: (`"customer-facing"` \| `"internal-support"` \| `"mixed"`)[]; `capability`: `string`; `changesWorkflow?`: `boolean`; `description?`: `string`; `exposesSensitiveData?`: `boolean`; `extension`: `boolean`; `externallyVisible?`: `boolean`; `inputSchema?`: `unknown`; `inputSchemaName?`: `string`; `inputSchemaRef?`: `string`; `label?`: `string`; `metadata?`: `Record`\<`string`, `unknown`>; `outputSchema?`: `unknown`; `outputSchemaName?`: `string`; `outputSchemaRef?`: `string`; `providerObject?`: `string`; `providerObjects?`: { `description?`: `string`; `kind`: `string`; `label?`: `string`; `metadata?`: `Record`\<`string`, `unknown`>; `schemaName?`: `string`; }[]; `providerOperation?`: `string`; `requiredPolicyIds?`: `string`[]; `requiresApproval?`: `boolean`; `requiresCredential?`: `boolean`; `sideEffect?`: `boolean`; }[]
`packageName`	`string`
`privacyNotes`	`string`[]
`provider`	`string`
`trustLevel`	`"community"` \| `"official"` \| `"verified"` \| `"experimental"`

promptTasks¶

const promptTasks: readonly ["response", "journey-matcher", "transition-matcher", "delegation-completion", "extraction", "citation-post-processing", "compaction", "generated-preamble"];

promptTemplateFields¶

const promptTemplateFields: {
  citation-post-processing: readonly ["assistantAnswer", "knowledge", "structuredOutput"];
  compaction: readonly ["instructions", "fromOffset", "toOffset", "events", "structuredOutput"];
  delegation-completion: readonly ["journey", "conversationTranscript", "structuredOutput"];
  extraction: readonly ["journey", "state", "latestUserMessage", "currentContext", "fields", "stateInstructions", "structuredOutput"];
  generated-preamble: readonly ["purpose", "maxWords", "history"];
  journey-matcher: readonly ["latestUserMessage", "activeJourneyId", "conversationTranscript", "candidates", "structuredOutput"];
  response: readonly ["selectedJourneyId", "activeStateIds", "journeyContext", "tools", "structuredOutput"];
  transition-matcher: readonly ["journey", "state", "latestUserMessage", "currentContext", "candidates", "structuredOutput"];
};

Type Declaration¶

Name	Type
`citation-post-processing`	readonly [`"assistantAnswer"`, `"knowledge"`, `"structuredOutput"`]
`compaction`	readonly [`"instructions"`, `"fromOffset"`, `"toOffset"`, `"events"`, `"structuredOutput"`]
`delegation-completion`	readonly [`"journey"`, `"conversationTranscript"`, `"structuredOutput"`]
`extraction`	readonly [`"journey"`, `"state"`, `"latestUserMessage"`, `"currentContext"`, `"fields"`, `"stateInstructions"`, `"structuredOutput"`]
`generated-preamble`	readonly [`"purpose"`, `"maxWords"`, `"history"`]
`journey-matcher`	readonly [`"latestUserMessage"`, `"activeJourneyId"`, `"conversationTranscript"`, `"candidates"`, `"structuredOutput"`]
`response`	readonly [`"selectedJourneyId"`, `"activeStateIds"`, `"journeyContext"`, `"tools"`, `"structuredOutput"`]
`transition-matcher`	readonly [`"journey"`, `"state"`, `"latestUserMessage"`, `"currentContext"`, `"candidates"`, `"structuredOutput"`]

Functions¶

cognideskEmbeddingModel()¶

function cognideskEmbeddingModel(options): ModelAdapter;

Parameters¶

Parameter	Type
`options`	`CognideskEmbeddingModelOptions`

Returns¶

ModelAdapter

cognideskModel()¶

function cognideskModel(options): ModelAdapter;

Parameters¶

Parameter	Type
`options`	`CognideskModelOptions`

Returns¶

ModelAdapter

createModelPromptProfile()¶

function createModelPromptProfile(options?): ModelPromptProfile;

Parameters¶

Parameter	Type
`options?`	`PromptProfileOptions`

Returns¶

ModelPromptProfile

createModelSet()¶

function createModelSet(definition, options?): AgentModelSet;

Parameters¶

Parameter	Type
`definition`	`ModelSetDefinition`
`options?`	`CreateModelSetOptions`

Returns¶

AgentModelSet

listBuiltInPromptProfiles()¶

function listBuiltInPromptProfiles(): PromptProfileMetadata[];

Returns¶

PromptProfileMetadata[]

normalizeLogicalModelSlug()¶

function normalizeLogicalModelSlug(providerModelId, modelProfiles?): string;

Parameters¶

Parameter	Type
`providerModelId`	`string`
`modelProfiles?`	`Iterable`\<`ModelProfileRegistration`>

Returns¶

string