127 lines
2.7 KiB
TypeScript
127 lines
2.7 KiB
TypeScript
import type { JsonValue, TopicCategory, TopicGranularity } from './domain';
|
|
|
|
export interface SpaceScopedInput {
|
|
spaceName?: string | undefined;
|
|
}
|
|
|
|
export interface UpsertSpaceInput {
|
|
name: string;
|
|
description?: string | null;
|
|
metadata?: JsonValue | null;
|
|
}
|
|
|
|
export interface Space {
|
|
id: string;
|
|
name: string;
|
|
normalizedName: string;
|
|
description: string | null;
|
|
metadata: JsonValue | null;
|
|
createdAt: string;
|
|
updatedAt: string;
|
|
}
|
|
|
|
export interface UpsertTopicInput extends SpaceScopedInput {
|
|
name: string;
|
|
category?: TopicCategory;
|
|
granularity?: TopicGranularity;
|
|
description?: string | null;
|
|
metadata?: JsonValue | null;
|
|
}
|
|
|
|
export interface TopicLinkInput extends UpsertTopicInput {
|
|
role?: string | null;
|
|
}
|
|
|
|
export interface AddFactInput extends SpaceScopedInput {
|
|
statement: string;
|
|
summary?: string | null;
|
|
source?: string | null;
|
|
confidence?: number | null;
|
|
metadata?: JsonValue | null;
|
|
topics: TopicLinkInput[];
|
|
}
|
|
|
|
export interface LinkTopicsInput extends SpaceScopedInput {
|
|
parentName: string;
|
|
childName: string;
|
|
}
|
|
|
|
export interface Topic {
|
|
id: string;
|
|
spaceId: string;
|
|
name: string;
|
|
normalizedName: string;
|
|
category: TopicCategory;
|
|
granularity: TopicGranularity;
|
|
description: string | null;
|
|
metadata: JsonValue | null;
|
|
createdAt: string;
|
|
updatedAt: string;
|
|
}
|
|
|
|
export interface FactTopic extends Topic {
|
|
role: string | null;
|
|
position: number;
|
|
}
|
|
|
|
export interface Fact {
|
|
id: string;
|
|
spaceId: string;
|
|
statement: string;
|
|
summary: string | null;
|
|
source: string | null;
|
|
confidence: number | null;
|
|
metadata: JsonValue | null;
|
|
createdAt: string;
|
|
updatedAt: string;
|
|
topics: FactTopic[];
|
|
}
|
|
|
|
export interface TopicWithFacts extends Topic {
|
|
facts: Fact[];
|
|
}
|
|
|
|
export interface ConnectedTopic extends Topic {
|
|
sharedFactCount: number;
|
|
}
|
|
|
|
export interface TopicLookupOptions extends SpaceScopedInput {
|
|
includeFacts?: boolean;
|
|
}
|
|
|
|
export interface ListTopicsOptions extends SpaceScopedInput {
|
|
includeFacts?: boolean;
|
|
limit?: number;
|
|
}
|
|
|
|
export interface EmbeddingProvider {
|
|
model: string;
|
|
dimensions: number;
|
|
embed(input: string): Promise<number[]>;
|
|
embedMany?(inputs: string[]): Promise<number[][]>;
|
|
}
|
|
|
|
export interface IndexFactEmbeddingsInput extends SpaceScopedInput {
|
|
provider: EmbeddingProvider;
|
|
}
|
|
|
|
export interface SearchFactsInput extends SpaceScopedInput {
|
|
query: string;
|
|
provider: EmbeddingProvider;
|
|
topicNames?: string[];
|
|
limit?: number;
|
|
minimumScore?: number;
|
|
}
|
|
|
|
export interface FindSimilarFactsInput extends SpaceScopedInput {
|
|
statement: string;
|
|
provider: EmbeddingProvider;
|
|
topicNames?: string[];
|
|
limit?: number;
|
|
minimumScore?: number;
|
|
}
|
|
|
|
export interface ScoredFact extends Fact {
|
|
score: number;
|
|
}
|