Skip to main content

Namespace: VerifiedAnswers

index.VerifiedAnswers

Type Aliases

FindVerifiedAnswerFunc

Ƭ FindVerifiedAnswerFunc: (args: FindVerifiedAnswerFuncArgs) => Promise<FindVerifiedAnswerResult>

Type declaration

▸ (args): Promise<FindVerifiedAnswerResult>

Parameters
NameType
argsFindVerifiedAnswerFuncArgs
Returns

Promise<FindVerifiedAnswerResult>

Defined in

packages/mongodb-rag-core/src/verifiedAnswers/FindVerifiedAnswerFunc.ts:8


FindVerifiedAnswerFuncArgs

Ƭ FindVerifiedAnswerFuncArgs: Object

Type declaration

NameType
querystring

Defined in

packages/mongodb-rag-core/src/verifiedAnswers/FindVerifiedAnswerFunc.ts:4


FindVerifiedAnswerResult

Ƭ FindVerifiedAnswerResult: Object

Type declaration

NameType
answer?WithScore<VerifiedAnswer>
queryEmbeddingnumber[]

Defined in

packages/mongodb-rag-core/src/verifiedAnswers/FindVerifiedAnswerFunc.ts:12


MakeDefaultFindVerifiedAnswerFuncArgs

Ƭ MakeDefaultFindVerifiedAnswerFuncArgs: Object

Type declaration

NameType
embedderEmbedder
findNearestNeighborsOptions?Partial<FindNearestNeighborsOptions>
storeVerifiedAnswerStore

Defined in

packages/mongodb-rag-core/src/verifiedAnswers/DefaultFindVerifiedAnswer.ts:6


Question

Ƭ Question: z.infer<typeof Question>

Defined in

packages/mongodb-rag-core/src/verifiedAnswers/VerifiedAnswer.ts:5

packages/mongodb-rag-core/src/verifiedAnswers/VerifiedAnswer.ts:22


VerifiedAnswer

Ƭ VerifiedAnswer: z.infer<typeof VerifiedAnswer>

Defined in

packages/mongodb-rag-core/src/verifiedAnswers/VerifiedAnswer.ts:24

packages/mongodb-rag-core/src/verifiedAnswers/VerifiedAnswer.ts:49


VerifiedAnswerStore

Ƭ VerifiedAnswerStore: VectorStore<VerifiedAnswer> & { find: <FindArgs>(args: FindArgs) => Promise<{ _id: string ; answer: string ; author_email: string ; created: Date ; hidden?: boolean ; question: { text: string; embedding: number[]; embedding_model: string; embedding_model_version: string; } = Question; references: { url: string; title: string; metadata?: objectOutputType<{ sourceName: ZodOptional<ZodString>; sourceType: ZodOptional<ZodString>; tags: ZodOptional<ZodArray<ZodString, "many">>; }, ZodTypeAny, "passthrough"> | undefined; }[] ; updated?: Date }[]> }

Defined in

packages/mongodb-rag-core/src/verifiedAnswers/VerifiedAnswer.ts:50

Variables

Question

Const Question: ZodObject<{ embedding: ZodArray<ZodNumber, "many"> ; embedding_model: ZodString ; embedding_model_version: ZodString ; text: ZodString }, "strip", ZodTypeAny, { embedding: number[] ; embedding_model: string ; embedding_model_version: string ; text: string }, { embedding: number[] ; embedding_model: string ; embedding_model_version: string ; text: string }>

Defined in

packages/mongodb-rag-core/src/verifiedAnswers/VerifiedAnswer.ts:5

packages/mongodb-rag-core/src/verifiedAnswers/VerifiedAnswer.ts:22


VerifiedAnswer

Const VerifiedAnswer: ZodObject<{ _id: ZodString ; answer: ZodString ; author_email: ZodString ; created: ZodDate ; hidden: ZodOptional<ZodBoolean> ; question: ZodObject<{ embedding: ZodArray<ZodNumber, "many"> ; embedding_model: ZodString ; embedding_model_version: ZodString ; text: ZodString }, "strip", ZodTypeAny, { embedding: number[] ; embedding_model: string ; embedding_model_version: string ; text: string }, { embedding: number[] ; embedding_model: string ; embedding_model_version: string ; text: string }> = Question; references: ZodArray<ZodObject<{ metadata: ZodOptional<ZodObject<{ sourceName: ZodOptional<ZodString> ; sourceType: ZodOptional<ZodString> ; tags: ZodOptional<ZodArray<ZodString, "many">> }, "passthrough", ZodTypeAny, objectOutputType<{ sourceName: ZodOptional<ZodString> ; sourceType: ZodOptional<ZodString> ; tags: ZodOptional<ZodArray<ZodString, "many">> }, ZodTypeAny, "passthrough">, objectInputType<{ sourceName: ZodOptional<ZodString> ; sourceType: ZodOptional<ZodString> ; tags: ZodOptional<ZodArray<ZodString, "many">> }, ZodTypeAny, "passthrough">>> ; title: ZodString ; url: ZodString }, "strip", ZodTypeAny, { metadata?: objectOutputType<{ sourceName: ZodOptional<ZodString> ; sourceType: ZodOptional<ZodString> ; tags: ZodOptional<ZodArray<ZodString, "many">> }, ZodTypeAny, "passthrough"> ; title: string ; url: string }, { metadata?: objectInputType<{ sourceName: ZodOptional<ZodString> ; sourceType: ZodOptional<ZodString> ; tags: ZodOptional<ZodArray<ZodString, "many">> }, ZodTypeAny, "passthrough"> ; title: string ; url: string }>, "many"> ; updated: ZodOptional<ZodDate> }, "strip", ZodTypeAny, { _id: string ; answer: string ; author_email: string ; created: Date ; hidden?: boolean ; question: { text: string; embedding: number[]; embedding_model: string; embedding_model_version: string; } = Question; references: { url: string; title: string; metadata?: objectOutputType<{ sourceName: ZodOptional<ZodString>; sourceType: ZodOptional<ZodString>; tags: ZodOptional<ZodArray<ZodString, "many">>; }, ZodTypeAny, "passthrough"> | undefined; }[] ; updated?: Date }, { _id: string ; answer: string ; author_email: string ; created: Date ; hidden?: boolean ; question: { text: string; embedding: number[]; embedding_model: string; embedding_model_version: string; } = Question; references: { url: string; title: string; metadata?: objectInputType<{ sourceName: ZodOptional<ZodString>; sourceType: ZodOptional<ZodString>; tags: ZodOptional<ZodArray<ZodString, "many">>; }, ZodTypeAny, "passthrough"> | undefined; }[] ; updated?: Date }>

Defined in

packages/mongodb-rag-core/src/verifiedAnswers/VerifiedAnswer.ts:24

packages/mongodb-rag-core/src/verifiedAnswers/VerifiedAnswer.ts:49

Functions

makeDefaultFindVerifiedAnswer

makeDefaultFindVerifiedAnswer(«destructured»): FindVerifiedAnswerFunc

Basic implementation of FindVerifiedAnswerFunc.

Parameters

NameType
«destructured»MakeDefaultFindVerifiedAnswerFuncArgs

Returns

FindVerifiedAnswerFunc

Defined in

packages/mongodb-rag-core/src/verifiedAnswers/DefaultFindVerifiedAnswer.ts:15


makeMongoDbVerifiedAnswerStore

makeMongoDbVerifiedAnswerStore(«destructured»): VerifiedAnswerStore & DatabaseConnection

Parameters

NameType
«destructured»MakeMongoDbDatabaseConnectionParams & { collectionName: string }

Returns

VerifiedAnswerStore & DatabaseConnection

Defined in

packages/mongodb-rag-core/src/verifiedAnswers/MongoDbVerifiedAnswerStore.ts:10