fawn-memory 0.0.3

package/dist/knowpro/interfaces.d.ts

@@ -0,0 +1,637 @@
+import type { Result, TypeChatJsonTranslator } from "typechat";
+import type { KnowledgeResponse, ConcreteEntity, Action } from "./knowledgeSchema.js";
+/**
+ * A Knowledge Source is any object that returns knowledge
+ * Knowledge is returned in the form of a KnowledgeResponse {@link KnowledgeResponse}
+ */
+export interface IKnowledgeSource {
+    /**
+     * Retrieves knowledge from the source.
+     * @returns {KnowledgeResponse | undefined} The knowledge response or undefined if no knowledge is available.
+     */
+    getKnowledge(): KnowledgeResponse | undefined;
+}
+/**
+ * Messages are referenced by their sequential ordinal numbers
+ */
+export type MessageOrdinal = number;
+/**
+ * Metadata associated with a message.
+ */
+export interface IMessageMetadata {
+    /**
+     * The source ("sender/s") of the message
+     */
+    readonly source?: string | string[] | undefined;
+    /**
+     * The dest ("recipients") of the message
+     */
+    readonly dest?: string | string[] | undefined;
+}
+/**
+ * A message in a conversation
+ * A Message contains one or more text chunks
+ */
+export interface IMessage extends IKnowledgeSource {
+    /**
+     * The text of the message, split into chunks
+     */
+    textChunks: string[];
+    /**
+     * The (optional) timestamp of the message.
+     */
+    timestamp?: string | undefined;
+    /**
+     * (Optional) tags associated with the message
+     */
+    tags: MessageTag[];
+    /**
+     * (Future) Information about the deletion of the message.
+     */
+    deletionInfo?: DeletionInfo | undefined;
+    /**
+     * Metadata associated with the message such as its source.
+     */
+    metadata?: IMessageMetadata | undefined;
+}
+/**
+ * Represents a message ordinal with an associated score.
+ */
+export type ScoredMessageOrdinal = {
+    /**
+     * The ordinal number of the message.
+     * Use this ordinal to get the message frm the conversation's message collection {@link IMessageCollection}
+     * @see {@link IConversation.messages}
+     */
+    messageOrdinal: MessageOrdinal;
+    /**
+     * The score associated with the message.
+     */
+    score: number;
+};
+/**
+ * (Future)
+ */
+export interface DeletionInfo {
+    timestamp: string;
+    reason?: string;
+}
+/**
+ * Types of knowledge objects {@link Knowledge}
+ */
+export type KnowledgeType = "entity" | "action" | "topic" | "tag" | "sTag";
+/**
+ * Knowledge objects
+ */
+export type Knowledge = ConcreteEntity | Action | Topic | Tag | StructuredTag;
+/**
+ * Semantic Refs are referenced by their sequential ordinal numbers
+ */
+export type SemanticRefOrdinal = number;
+/**
+ * A semantic reference represents semantic knowledge that was extracted
+ * from a source text range
+ */
+export interface SemanticRef {
+    semanticRefOrdinal: SemanticRefOrdinal;
+    /**
+     * Range of text where this semantic reference was found/extracted.
+     */
+    range: TextRange;
+    /**
+     * Type of knowledge the reference points to.
+     */
+    knowledgeType: KnowledgeType;
+    /**
+     * The actual knowledge object.
+     */
+    knowledge: Knowledge;
+}
+/**
+ * Knowledge of type "topic"
+ */
+export interface Topic {
+    /**
+     * Text of the topic.
+     */
+    text: string;
+}
+/**
+ * Tags
+ */
+export interface Tag {
+    /**
+     * Text of the tag.
+     */
+    text: string;
+}
+export type StructuredTag = ConcreteEntity;
+export type MessageTag = string | StructuredTag;
+/**
+ * A conversation is a sequence of messages
+ * The conversation can also store semantic refs {@link SemanticRef} that was found
+ * in the source text of the messages.
+ *
+ * Messages and semantic refs are indexed for retrieval.
+ *
+ * @template TMessage - Type of the message in the conversation.
+ */
+export interface IConversation<TMessage extends IMessage = IMessage> {
+    /**
+     * Name tag for the conversation.
+     */
+    nameTag: string;
+    /**
+     * Array of tags associated with the conversation.
+     */
+    tags: string[];
+    /**
+     * Collection of messages in the conversation.
+     */
+    messages: IMessageCollection<TMessage>;
+    /**
+     * Collection of semantic references, if any.
+     */
+    semanticRefs: ISemanticRefCollection | undefined;
+    /**
+     * Index mapping terms to semantic references.
+     */
+    semanticRefIndex?: ITermToSemanticRefIndex | undefined;
+    /**
+     * Secondary indexes for the conversation.
+     */
+    secondaryIndexes?: IConversationSecondaryIndexes | undefined;
+}
+/**
+ * Represents a scored semantic reference ordinal.
+ */
+export type ScoredSemanticRefOrdinal = {
+    /**
+     * Ordinal number for the SemanticRef {@link SemanticRef}.
+     * Use this ordinal to resolve the SemanticRef from the conversation's semantic refs collection {@link ISemanticRefCollection}
+     * @see {@link IConversation.semanticRefs}
+     */
+    semanticRefOrdinal: SemanticRefOrdinal;
+    /**
+     * Score associated with the semantic reference.
+     */
+    score: number;
+};
+/**
+ * Inverted Index from term to Semantic Refs {@link SemanticRef}
+ */
+export interface ITermToSemanticRefIndex {
+    /**
+     * Retrieves all terms in the index.
+     *
+     * @returns An array of terms.
+     */
+    getTerms(): string[];
+    /**
+     * Adds a term with its associated semantic reference ordinal.
+     *
+     * @param term - The term to add.
+     * @param semanticRefOrdinal - The semantic reference ordinal or scored semantic reference ordinal.
+     * @returns The added term.
+     */
+    addTerm(term: string, semanticRefOrdinal: SemanticRefOrdinal | ScoredSemanticRefOrdinal): string;
+    /**
+     * Removes a term with its associated semantic reference ordinal.
+     *
+     * @param term - The term to remove.
+     * @param semanticRefOrdinal - The semantic reference ordinal.
+     */
+    removeTerm(term: string, semanticRefOrdinal: SemanticRefOrdinal): void;
+    /**
+     * Looks up a term and retrieves its associated scored semantic reference ordinals.
+     *
+     * @param term - The term to look up.
+     * @returns An array of scored semantic reference ordinals or undefined if the term is not found.
+     */
+    lookupTerm(term: string): ScoredSemanticRefOrdinal[] | undefined;
+}
+/**
+ * Represents a specific location of within a text {@link IMessage}.
+ * A message can contain one or more text chunks
+ */
+export interface TextLocation {
+    /**
+     * The ordinal of the message.
+     */
+    messageOrdinal: MessageOrdinal;
+    /**
+     * [Optional] The ordinal index of the chunk within the message.
+     */
+    chunkOrdinal?: number;
+}
+/**
+ * A text range within a conversation
+ * TextRange can represent both a text range and a point location
+ * If 'end' is undefined, the text range represents a point location, identified by 'start'
+ */
+export interface TextRange {
+    /**
+     * The start of the range.
+     */
+    start: TextLocation;
+    /**
+     * The (optional) end of the range (exclusive).
+     */
+    end?: TextLocation | undefined;
+}
+/**
+ * Represents a date range.
+ */
+export type DateRange = {
+    /**
+     * The start date of the range (inclusive).
+     */
+    start: Date;
+    /**
+     * The (optional) end date of the range (inclusive).
+     */
+    end?: Date | undefined;
+};
+/**
+ * Represents a term with optional weighting.
+ */
+export type Term = {
+    /**
+     * The text of the term.
+     */
+    text: string;
+    /**
+     * Optional weighting for any matches for this term
+     */
+    weight?: number | undefined;
+};
+/**
+ * Represents scored knowledge.
+ * Scored knowledge is typically returned by search APIs
+ */
+export type ScoredKnowledge = {
+    /**
+     * Type of knowledge.
+     */
+    knowledgeType: KnowledgeType;
+    /**
+     * The actual knowledge object.
+     */
+    knowledge: Knowledge;
+    /**
+     * Score associated with the knowledge.
+     */
+    score: number;
+};
+/**
+ * Interface for conversation secondary indexes.
+ * {@link IConversation}
+ */
+export interface IConversationSecondaryIndexes {
+    /**
+     * Index mapping properties to semantic references.
+     */
+    propertyToSemanticRefIndex?: IPropertyToSemanticRefIndex | undefined;
+    /**
+     * Index mapping timestamps to text ranges.
+     */
+    timestampIndex?: ITimestampToTextRangeIndex | undefined;
+    /**
+     * Index mapping terms to related terms.
+     */
+    termToRelatedTermsIndex?: ITermToRelatedTermsIndex | undefined;
+    /**
+     * Optional threads in the conversation.
+     */
+    threads?: IConversationThreads | undefined;
+    /**
+     * Optional index for message text.
+     */
+    messageIndex?: IMessageTextIndex | undefined;
+}
+/**
+ * Allows for faster retrieval of name, value properties
+ */
+export interface IPropertyToSemanticRefIndex {
+    /**
+     * All property values
+     */
+    getValues(): string[];
+    /**
+     * Adds a property name, value and the ordinal of the semantic ref this
+     * property was found in (associated with)
+     *
+     * @param propertyName - The name of the property.
+     * @param value - The value of the property.
+     * @param semanticRefOrdinal - The semantic reference ordinal or scored semantic reference ordinal.
+     */
+    addProperty(propertyName: string, value: string, semanticRefOrdinal: SemanticRefOrdinal | ScoredSemanticRefOrdinal): void;
+    /**
+     * Looks up a property (name, value) returning the associated scored semantic reference ordinals.
+     *
+     * @param propertyName - The name of the property.
+     * @param value - The value of the property.
+     * @returns An array of scored semantic reference ordinals or undefined if the property is not found.
+     */
+    lookupProperty(propertyName: string, value: string): ScoredSemanticRefOrdinal[] | undefined;
+}
+/**
+ * Represents a timestamped text range.
+ */
+export type TimestampedTextRange = {
+    /**
+     * The timestamp associated with the text range.
+     */
+    timestamp: string;
+    /**
+     * The text range.
+     */
+    range: TextRange;
+};
+/**
+ * Interface for timestamp to text range index.
+ * Allows for retrieval of text ranges within a given date range.
+ */
+export interface ITimestampToTextRangeIndex {
+    /**
+     * Adds a message ordinal with the given timestamp
+     * The message ordinal represents a {@link TextLocation} {messageOrdinal}
+     * @param messageOrdinal - The ordinal of the message.
+     * @param timestamp - The timestamp to add.
+     * @returns True if the timestamp was added successfully, false otherwise.
+     */
+    addTimestamp(messageOrdinal: MessageOrdinal, timestamp: string): boolean;
+    /**
+     * Add multiple {messageOrdinal, timestamp} pairs
+     * @param messageTimestamps
+     */
+    addTimestamps(messageTimestamps: [MessageOrdinal, string][]): ListIndexingResult;
+    /**
+     * Looks up text ranges within a given date range.
+     *
+     * @param dateRange - The date range to look up.
+     * @returns An array of timestamped text ranges.
+     */
+    lookupRange(dateRange: DateRange): TimestampedTextRange[];
+}
+/**
+ * Returns related terms for a given term
+ * This is ideal for local synonym and other tables
+ */
+export interface ITermToRelatedTerms {
+    /**
+     * Lookup terms related to the given term text
+     * @param text
+     */
+    lookupTerm(text: string): Term[] | undefined;
+}
+/**
+ * An index that maintains fuzzy (approximate) relationships between terms
+ * The fuzzy relationship may be determined dynamically
+ * Given a term, can return terms approximately related to it.
+ */
+export interface ITermToRelatedTermsFuzzy {
+    /**
+     * Add a term to the index.
+     * @param terms
+     * @param eventHandler
+     */
+    addTerms(terms: string[], eventHandler?: IndexingEventHandlers): Promise<ListIndexingResult>;
+    /**
+     * Looks up a term and retrieves related terms
+     *
+     * @param text - The text of the term to look up.
+     * @param maxMatches - Optional maximum number of matches to retrieve.
+     * @param thresholdScore - Optional threshold similarity score for matches.
+     * @returns A promise that resolves to an array of related terms.
+     */
+    lookupTerm(text: string, maxMatches?: number, thresholdScore?: number): Promise<Term[]>;
+    /**
+     * Looks up terms in a batch
+     * @param textArray
+     * @param maxMatches
+     * @param thresholdScore
+     */
+    lookupTerms(textArray: string[], maxMatches?: number, thresholdScore?: number): Promise<Term[][]>;
+}
+/**
+ * Interface for term to related terms index.
+ */
+export interface ITermToRelatedTermsIndex {
+    /**
+     * Return the alias index, if available
+     */
+    get aliases(): ITermToRelatedTerms | undefined;
+    /**
+     * Return a fuzzy index, if available
+     */
+    get fuzzyIndex(): ITermToRelatedTermsFuzzy | undefined;
+}
+/**
+ * A Thread is a set of text ranges in a conversation
+ */
+export type Thread = {
+    description: string;
+    ranges: TextRange[];
+};
+export type ThreadOrdinal = number;
+export type ScoredThreadOrdinal = {
+    threadOrdinal: ThreadOrdinal;
+    score: number;
+};
+export interface IConversationThreads {
+    readonly threads: Thread[];
+    addThread(thread: Thread): Promise<void>;
+    lookupThread(threadDescription: string, maxMatches?: number, thresholdScore?: number): Promise<ScoredThreadOrdinal[] | undefined>;
+    removeThread(threadOrdinal: ThreadOrdinal): void;
+}
+export interface IMessageTextIndex {
+    addMessages(messages: IMessage[], eventHandler?: IndexingEventHandlers): Promise<ListIndexingResult>;
+    lookupMessages(messageText: string, maxMatches?: number, thresholdScore?: number): Promise<ScoredMessageOrdinal[]>;
+    lookupMessagesInSubset(messageText: string, ordinalsToSearch: MessageOrdinal[], maxMatches?: number, thresholdScore?: number): Promise<ScoredMessageOrdinal[]>;
+}
+export interface SearchTerm {
+    /**
+     * Term being searched for
+     */
+    term: Term;
+    /**
+     * Additional terms related to term.
+     * These can be supplied from synonym tables and so on.
+     *  - Zero length array: no related matches for this term. That will force an exact match
+     *  - undefined array: the search processor may try to resolve related terms from any  {@link IConversationSecondaryIndexes}
+     * related term {@link ITermToRelatedTermsIndex} indexes available to it
+     */
+    relatedTerms?: Term[] | undefined;
+}
+/**
+ * Well known knowledge properties
+ */
+export type KnowledgePropertyName = "name" | "type" | "verb" | "subject" | "object" | "indirectObject" | "tag" | "topic";
+export type PropertySearchTerm = {
+    /**
+     * PropertySearch terms let you match named property, values
+     * - You can  match a well known property name (name("Bach") type("book"))
+     * - Or you can provide a SearchTerm as a propertyName.
+     *   E.g. to match hue(red)
+     *      - propertyName as SearchTerm, set to 'hue'
+     *      - propertyValue as SearchTerm, set to 'red'
+     *    We also want hue(red) to match any facets called color(red)
+     * SearchTerms can included related terms
+     *   E.g you could include "color" as a related term for the propertyName "hue". Or 'crimson' for red.
+     *
+     * See {@link KnowledgePropertyName} for well known property names
+     *
+     * The the query processor can also related terms using a related terms secondary index, if one is available
+     */
+    propertyName: KnowledgePropertyName | SearchTerm;
+    propertyValue: SearchTerm;
+};
+/**
+ * Terms in a SearchTermGroup can of these types
+ */
+export type SearchTermGroupTypes = SearchTerm | PropertySearchTerm | SearchTermGroup;
+/**
+ * A Group of search terms
+ */
+export type SearchTermGroup = {
+    booleanOp: "and" | "or" | "or_max";
+    terms: SearchTermGroupTypes[];
+};
+/**
+ * An expression used to select contents structured contents of the conversation
+ */
+export type SearchSelectExpr = {
+    /**
+     * A Term group that matches information
+     */
+    searchTermGroup: SearchTermGroup;
+    /**
+     * A filter that scopes what information to match
+     */
+    when?: WhenFilter | undefined;
+};
+/**
+ * A WhenFilter provides additional constraints on when a SemanticRef that matches a term.. is actually considered a match
+ * when the following optional conditions are met:
+ *   knowledgeType matches. E.g. knowledgeType == 'entity'
+ *   dateRange matches...E.g. (Jan 3rd to Jan 10th)
+ *   Semantic Refs are within supplied SCOPE.. i.e. only Semantic Refs from a 'scoping' set of text ranges will match
+ */
+export type WhenFilter = {
+    /**
+     * Match SemanticRefs of this knowledge type
+     */
+    knowledgeType?: KnowledgeType | undefined;
+    /**
+     * Match only in this date range
+     */
+    dateRange?: DateRange | undefined;
+    /**
+     * If a thread index is available, match in a thread closest to ths description
+     */
+    threadDescription?: string | undefined;
+    /**
+     * Scope matches to only those text ranges matching tags
+     */
+    tags?: string[] | undefined;
+    tagMatchingTerms?: SearchTermGroup | undefined;
+    /**
+     * Use this SearchTermGroup as a sub-query to find matching text ranges
+     * Match SemanticRefs the scope for this query
+     */
+    scopeDefiningTerms?: SearchTermGroup | undefined;
+    /**
+     * Additional scoping ranges separately computed by caller
+     */
+    textRangesInScope?: TextRange[] | undefined;
+};
+export type SemanticRefSearchResult = {
+    /**
+     * The search terms that caused these semantic refs to match
+     */
+    termMatches: Set<string>;
+    /**
+     * Scored semantic ref matches
+     */
+    semanticRefMatches: ScoredSemanticRefOrdinal[];
+};
+export interface IConversationData<TMessage = unknown> {
+    nameTag: string;
+    messages: TMessage[];
+    tags: string[];
+    semanticRefs: SemanticRef[];
+    semanticIndexData?: ITermToSemanticRefIndexData | undefined;
+}
+export interface ITermToSemanticRefIndexData {
+    items: ITermToSemanticRefIndexItem[];
+}
+export interface ITermToSemanticRefIndexItem {
+    term: string;
+    semanticRefOrdinals: ScoredSemanticRefOrdinal[];
+}
+export interface IndexingEventHandlers {
+    onKnowledgeExtracted?: (chunk: TextLocation, knowledgeResult: KnowledgeResponse) => boolean;
+    onEmbeddingsCreated?: (sourceTexts: string[], batch: string[], batchStartAt: number) => boolean;
+    onTextIndexed?: (textAndLocations: [string, TextLocation][], batch: [string, TextLocation][], batchStartAt: number) => boolean;
+}
+export type IndexingResults = {
+    semanticRefs?: TextIndexingResult | undefined;
+    secondaryIndexResults?: SecondaryIndexingResults | undefined;
+};
+export type SecondaryIndexingResults = {
+    properties?: ListIndexingResult | undefined;
+    timestamps?: ListIndexingResult | undefined;
+    relatedTerms?: ListIndexingResult | undefined;
+    message?: ListIndexingResult | undefined;
+};
+export type TextIndexingResult = {
+    completedUpto?: TextLocation | undefined;
+    error?: string | undefined;
+};
+export type ListIndexingResult = {
+    numberCompleted: number;
+    error?: string | undefined;
+};
+export interface IReadonlyCollection<T, TOrdinal = number> extends Iterable<T> {
+    readonly length: number;
+    get(ordinal: TOrdinal): T;
+    getMultiple(ordinals: TOrdinal[]): T[];
+    getSlice(start: TOrdinal, end: TOrdinal): T[];
+    getAll(): T[];
+}
+/**
+ * ICollection is an APPEND ONLY collection
+ */
+export interface ICollection<T, TOrdinal = number> extends IReadonlyCollection<T, TOrdinal> {
+    readonly isPersistent: boolean;
+    append(...items: T[]): void;
+}
+export interface IMessageCollection<TMessage extends IMessage = IMessage> extends ICollection<TMessage, MessageOrdinal> {
+}
+export interface ISemanticRefCollection extends ICollection<SemanticRef, SemanticRefOrdinal> {
+}
+export interface IStorageProvider {
+    createMessageCollection<TMessage extends IMessage = IMessage>(serializer?: JsonSerializer<TMessage>): IMessageCollection<TMessage>;
+    createSemanticRefCollection(): ISemanticRefCollection;
+    close(): void;
+}
+export interface JsonSerializer<T> {
+    serialize(value: T): string;
+    deserialize(json: string): T;
+}
+export type KnowledgeExtractorSettings = {
+    maxContextLength: number;
+    mergeActionKnowledge?: boolean;
+    mergeEntityFacets?: boolean;
+};
+export interface KnowledgeExtractor {
+    readonly settings: KnowledgeExtractorSettings;
+    extract(message: string): Promise<KnowledgeResponse | undefined>;
+    extractWithRetry(message: string, maxRetries: number): Promise<Result<KnowledgeResponse>>;
+    /**
+     * Custom translator to use
+     */
+    translator?: TypeChatJsonTranslator<KnowledgeResponse> | undefined;
+}
+//# sourceMappingURL=interfaces.d.ts.map

package/dist/knowpro/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../src/knowpro/interfaces.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAEtF;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;OAGG;IACH,YAAY,IAAI,iBAAiB,GAAG,SAAS,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AAEpC;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;IAChD;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,WAAW,QAAS,SAAQ,gBAAgB;IAC9C;;OAEG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,IAAI,EAAE,UAAU,EAAE,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAC/B;;;;OAIG;IACH,cAAc,EAAE,cAAc,CAAC;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;AAC3E;;GAEG;AACH,MAAM,MAAM,SAAS,GACf,cAAc,GACd,MAAM,GACN,KAAK,GACL,GAAG,GACH,aAAa,CAAC;AAEpB;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAExC;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB,kBAAkB,EAAE,kBAAkB,CAAC;IACvC;;OAEG;IACH,KAAK,EAAE,SAAS,CAAC;IACjB;;OAEG;IACH,aAAa,EAAE,aAAa,CAAC;IAC7B;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IAClB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,GAAG;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,aAAa,GAAG,cAAc,CAAC;AAE3C,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,aAAa,CAAC;AAEhD;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa,CAAC,QAAQ,SAAS,QAAQ,GAAG,QAAQ;IAC/D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACvC;;OAEG;IACH,YAAY,EAAE,sBAAsB,GAAG,SAAS,CAAC;IACjD;;OAEG;IACH,gBAAgB,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAC;IACvD;;OAEG;IACH,gBAAgB,CAAC,EAAE,6BAA6B,GAAG,SAAS,CAAC;CAChE;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACnC;;;;OAIG;IACH,kBAAkB,EAAE,kBAAkB,CAAC;IACvC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;;OAIG;IACH,QAAQ,IAAI,MAAM,EAAE,CAAC;IACrB;;;;;;OAMG;IACH,OAAO,CACH,IAAI,EAAE,MAAM,EACZ,kBAAkB,EAAE,kBAAkB,GAAG,wBAAwB,GAClE,MAAM,CAAC;IACV;;;;;OAKG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,kBAAkB,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACvE;;;;;OAKG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,wBAAwB,EAAE,GAAG,SAAS,CAAC;CACpE;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,cAAc,EAAE,cAAc,CAAC;IAE/B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACtB;;OAEG;IACH,KAAK,EAAE,YAAY,CAAC;IACpB;;OAEG;IACH,GAAG,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACpB;;OAEG;IACH,KAAK,EAAE,IAAI,CAAC;IACZ;;OAEG;IACH,GAAG,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG;IACf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC1B;;OAEG;IACH,aAAa,EAAE,aAAa,CAAC;IAC7B;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC1C;;OAEG;IACH,0BAA0B,CAAC,EAAE,2BAA2B,GAAG,SAAS,CAAC;IACrE;;OAEG;IACH,cAAc,CAAC,EAAE,0BAA0B,GAAG,SAAS,CAAC;IACxD;;OAEG;IACH,uBAAuB,CAAC,EAAE,wBAAwB,GAAG,SAAS,CAAC;IAC/D;;OAEG;IACH,OAAO,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAC3C;;OAEG;IACH,YAAY,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IACxC;;OAEG;IACH,SAAS,IAAI,MAAM,EAAE,CAAC;IACtB;;;;;;;OAOG;IACH,WAAW,CACP,YAAY,EAAE,MAAM,EACpB,KAAK,EAAE,MAAM,EACb,kBAAkB,EAAE,kBAAkB,GAAG,wBAAwB,GAClE,IAAI,CAAC;IACR;;;;;;OAMG;IACH,cAAc,CACV,YAAY,EAAE,MAAM,EACpB,KAAK,EAAE,MAAM,GACd,wBAAwB,EAAE,GAAG,SAAS,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAC/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,SAAS,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACvC;;;;;;OAMG;IACH,YAAY,CAAC,cAAc,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;IACzE;;;OAGG;IACH,aAAa,CACT,iBAAiB,EAAE,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,GAC9C,kBAAkB,CAAC;IACtB;;;;;OAKG;IACH,WAAW,CAAC,SAAS,EAAE,SAAS,GAAG,oBAAoB,EAAE,CAAC;CAC7D;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,GAAG,SAAS,CAAC;CAChD;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACrC;;;;OAIG;IACH,QAAQ,CACJ,KAAK,EAAE,MAAM,EAAE,EACf,YAAY,CAAC,EAAE,qBAAqB,GACrC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC/B;;;;;;;OAOG;IACH,UAAU,CACN,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,MAAM,EACnB,cAAc,CAAC,EAAE,MAAM,GACxB,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACnB;;;;;OAKG;IACH,WAAW,CACP,SAAS,EAAE,MAAM,EAAE,EACnB,UAAU,CAAC,EAAE,MAAM,EACnB,cAAc,CAAC,EAAE,MAAM,GACxB,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC;;OAEG;IACH,IAAI,OAAO,IAAI,mBAAmB,GAAG,SAAS,CAAC;IAC/C;;OAEG;IACH,IAAI,UAAU,IAAI,wBAAwB,GAAG,SAAS,CAAC;CAC1D;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,SAAS,EAAE,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC,MAAM,MAAM,mBAAmB,GAAG;IAC9B,aAAa,EAAE,aAAa,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,WAAW,oBAAoB;IACjC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAE3B,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,YAAY,CACR,iBAAiB,EAAE,MAAM,EACzB,UAAU,CAAC,EAAE,MAAM,EACnB,cAAc,CAAC,EAAE,MAAM,GACxB,OAAO,CAAC,mBAAmB,EAAE,GAAG,SAAS,CAAC,CAAC;IAC9C,YAAY,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI,CAAC;CACpD;AAED,MAAM,WAAW,iBAAiB;IAC9B,WAAW,CACP,QAAQ,EAAE,QAAQ,EAAE,EACpB,YAAY,CAAC,EAAE,qBAAqB,GACrC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC/B,cAAc,CACV,WAAW,EAAE,MAAM,EACnB,UAAU,CAAC,EAAE,MAAM,EACnB,cAAc,CAAC,EAAE,MAAM,GACxB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;IACnC,sBAAsB,CAClB,WAAW,EAAE,MAAM,EACnB,gBAAgB,EAAE,cAAc,EAAE,EAClC,UAAU,CAAC,EAAE,MAAM,EACnB,cAAc,CAAC,EAAE,MAAM,GACxB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;CACtC;AAKD,MAAM,WAAW,UAAU;IACvB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IACX;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;CACrC;AAED;;GAEG;AAEH,MAAM,MAAM,qBAAqB,GAC3B,MAAM,GACN,MAAM,GACN,MAAM,GACN,SAAS,GACT,QAAQ,GACR,gBAAgB,GAChB,KAAK,GACL,OAAO,CAAC;AAEd,MAAM,MAAM,kBAAkB,GAAG;IAC7B;;;;;;;;;;;;;;OAcG;IACH,YAAY,EAAE,qBAAqB,GAAG,UAAU,CAAC;IACjD,aAAa,EAAE,UAAU,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAC1B,UAAU,GACV,kBAAkB,GAClB,eAAe,CAAC;AAEtB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC1B,SAAS,EACH,KAAK,GACL,IAAI,GACJ,QAAQ,CAAC;IAEf,KAAK,EAAE,oBAAoB,EAAE,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC3B;;OAEG;IACH,eAAe,EAAE,eAAe,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IAC1C;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAE5B,gBAAgB,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IAC/C;;;OAGG;IACH,kBAAkB,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IACjD;;OAEG;IACH,iBAAiB,CAAC,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IAClC;;OAEG;IACH,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACzB;;OAEG;IACH,kBAAkB,EAAE,wBAAwB,EAAE,CAAC;CAClD,CAAC;AAOF,MAAM,WAAW,iBAAiB,CAAC,QAAQ,GAAG,OAAO;IACjD,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,QAAQ,EAAE,CAAC;IACrB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,iBAAiB,CAAC,EAAE,2BAA2B,GAAG,SAAS,CAAC;CAC/D;AAGD,MAAM,WAAW,2BAA2B;IACxC,KAAK,EAAE,2BAA2B,EAAE,CAAC;CACxC;AAED,MAAM,WAAW,2BAA2B;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB,EAAE,wBAAwB,EAAE,CAAC;CACnD;AAMD,MAAM,WAAW,qBAAqB;IAClC,oBAAoB,CAAC,EAAE,CACnB,KAAK,EAAE,YAAY,EACnB,eAAe,EAAE,iBAAiB,KACjC,OAAO,CAAC;IACb,mBAAmB,CAAC,EAAE,CAClB,WAAW,EAAE,MAAM,EAAE,EACrB,KAAK,EAAE,MAAM,EAAE,EACf,YAAY,EAAE,MAAM,KACnB,OAAO,CAAC;IACb,aAAa,CAAC,EAAE,CACZ,gBAAgB,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,EAC1C,KAAK,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,EAC/B,YAAY,EAAE,MAAM,KACnB,OAAO,CAAC;CAChB;AAED,MAAM,MAAM,eAAe,GAAG;IAC1B,YAAY,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC9C,qBAAqB,CAAC,EAAE,wBAAwB,GAAG,SAAS,CAAC;CAChE,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACnC,UAAU,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC5C,UAAU,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC5C,YAAY,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC9C,OAAO,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC7B,aAAa,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACzC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC7B,eAAe,EAAE,MAAM,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B,CAAC;AAKF,MAAM,WAAW,mBAAmB,CAAC,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAE,SAAQ,QAAQ,CAAC,CAAC,CAAC;IAC1E,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,GAAG,CAAC,OAAO,EAAE,QAAQ,GAAG,CAAC,CAAC;IAC1B,WAAW,CAAC,QAAQ,EAAE,QAAQ,EAAE,GAAG,CAAC,EAAE,CAAC;IACvC,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,GAAG,CAAC,EAAE,CAAC;IAC9C,MAAM,IAAI,CAAC,EAAE,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,EAAE,QAAQ,GAAG,MAAM,CAC7C,SAAQ,mBAAmB,CAAC,CAAC,EAAE,QAAQ,CAAC;IACxC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAE/B,MAAM,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC;CAC/B;AAGD,MAAM,WAAW,kBAAkB,CAAC,QAAQ,SAAS,QAAQ,GAAG,QAAQ,CACpE,SAAQ,WAAW,CAAC,QAAQ,EAAE,cAAc,CAAC;CAAG;AAGpD,MAAM,WAAW,sBACb,SAAQ,WAAW,CAAC,WAAW,EAAE,kBAAkB,CAAC;CAAG;AAE3D,MAAM,WAAW,gBAAgB;IAC7B,uBAAuB,CAAC,QAAQ,SAAS,QAAQ,GAAG,QAAQ,EACxD,UAAU,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC,GACtC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAChC,2BAA2B,IAAI,sBAAsB,CAAC;IACtD,KAAK,IAAI,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,cAAc,CAAC,CAAC;IAC7B,SAAS,CAAC,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC;IAC5B,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,CAAC;CAChC;AAMD,MAAM,MAAM,0BAA0B,GAAG;IACrC,gBAAgB,EAAE,MAAM,CAAC;IACzB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC;AAEF,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,CAAC,QAAQ,EAAE,0BAA0B,CAAC;IAC9C,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAC;IACjE,gBAAgB,CACZ,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,GACnB,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACtC;;OAEG;IACH,UAAU,CAAC,EAAE,sBAAsB,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC;CACtE"}

package/dist/knowpro/interfaces.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export {};
+//# sourceMappingURL=interfaces.js.map

package/dist/knowpro/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/knowpro/interfaces.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC"}

package/dist/knowpro/knowledge.d.ts

@@ -0,0 +1,19 @@
+import type { TypeChatJsonTranslator, TypeChatLanguageModel } from "typechat";
+import type { KnowledgeExtractor, KnowledgeExtractorSettings } from "./interfaces.js";
+import type { KnowledgeResponse } from "./knowledgeSchema.js";
+export declare function createKnowledgeTranslator(model: TypeChatLanguageModel): TypeChatJsonTranslator<KnowledgeResponse>;
+/**
+ * Return default settings
+ * @param maxCharsPerChunk (optional)
+ * @returns
+ */
+export declare function createKnowledgeExtractorSettings(maxCharsPerChunk?: number): KnowledgeExtractorSettings;
+/**
+ * Create a new knowledge extractor
+ * @param model
+ * @param extractorSettings
+ * @param knowledgeTranslator (optional) knowledge translator to use
+ * @returns
+ */
+export declare function createKnowledgeExtractor(model: TypeChatLanguageModel, extractorSettings?: KnowledgeExtractorSettings | undefined, knowledgeTranslator?: TypeChatJsonTranslator<KnowledgeResponse> | undefined): KnowledgeExtractor;
+//# sourceMappingURL=knowledge.d.ts.map

package/dist/knowpro/knowledge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"knowledge.d.ts","sourceRoot":"","sources":["../../src/knowpro/knowledge.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAU,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAEtF,OAAO,KAAK,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC;AACtF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAO9D,wBAAgB,yBAAyB,CACrC,KAAK,EAAE,qBAAqB,GAC7B,sBAAsB,CAAC,iBAAiB,CAAC,CAuB3C;AAED;;;;GAIG;AACH,wBAAgB,gCAAgC,CAC5C,gBAAgB,GAAE,MAAa,GAChC,0BAA0B,CAK5B;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CACpC,KAAK,EAAE,qBAAqB,EAC5B,iBAAiB,CAAC,EAAE,0BAA0B,GAAG,SAAS,EAC1D,mBAAmB,CAAC,EAAE,sBAAsB,CAAC,iBAAiB,CAAC,GAAG,SAAS,GAC5E,kBAAkB,CA6EpB"}