Namespace: VerifiedAnswers
ragCore.VerifiedAnswers
Type Aliases
FindVerifiedAnswerFunc
Ƭ FindVerifiedAnswerFunc: (args
: FindVerifiedAnswerFuncArgs
) => Promise
<FindVerifiedAnswerResult
>
Type declaration
▸ (args
): Promise
<FindVerifiedAnswerResult
>
Parameters
Name | Type |
---|---|
args | FindVerifiedAnswerFuncArgs |
Returns
Promise
<FindVerifiedAnswerResult
>
Defined in
mongodb-rag-core/build/verifiedAnswers/FindVerifiedAnswerFunc.d.ts:6
FindVerifiedAnswerFuncArgs
Ƭ FindVerifiedAnswerFuncArgs: Object
Type declaration
Name | Type |
---|---|
query | string |
Defined in
mongodb-rag-core/build/verifiedAnswers/FindVerifiedAnswerFunc.d.ts:3
FindVerifiedAnswerResult
Ƭ FindVerifiedAnswerResult: Object
Type declaration
Name | Type |
---|---|
answer? | WithScore <VerifiedAnswer > |
queryEmbedding | number [] |
Defined in
mongodb-rag-core/build/verifiedAnswers/FindVerifiedAnswerFunc.d.ts:7
MakeDefaultFindVerifiedAnswerFuncArgs
Ƭ MakeDefaultFindVerifiedAnswerFuncArgs: Object
Type declaration
Name | Type |
---|---|
embedder | Embedder |
findNearestNeighborsOptions? | Partial <FindNearestNeighborsOptions > |
store | VerifiedAnswerStore |
Defined in
mongodb-rag-core/build/verifiedAnswers/DefaultFindVerifiedAnswer.d.ts:5
Question
Ƭ Question: z.infer
<typeof Question
>
Defined in
mongodb-rag-core/build/verifiedAnswers/VerifiedAnswer.d.ts:3
mongodb-rag-core/build/verifiedAnswers/VerifiedAnswer.d.ts:19
VerifiedAnswer
Ƭ VerifiedAnswer: z.infer
<typeof VerifiedAnswer
>
Defined in
mongodb-rag-core/build/verifiedAnswers/VerifiedAnswer.d.ts:20
mongodb-rag-core/build/verifiedAnswers/VerifiedAnswer.d.ts:121
VerifiedAnswerStore
Ƭ VerifiedAnswerStore: VectorStore
<VerifiedAnswer
> & { find
: <FindArgs>(args
: FindArgs
) => Promise
<{ _id
: string
; answer
: string
; author_email
: string
; created
: Date
; hidden?
: boolean
; question
: { embedding
: number
[] ; embedding_model
: string
; embedding_model_version
: string
; text
: string
} ; references
: { metadata?
: z.objectOutputType
<{ sourceName
: z.ZodOptional
<z.ZodString
> ; sourceType
: z.ZodOptional
<z.ZodString
> ; tags
: z.ZodOptional
<z.ZodArray
<z.ZodString
, "many"
>> }, z.ZodTypeAny
, "passthrough"
> ; title
: string
; url
: string
}[] ; updated?
: Date
}[]> }
Defined in
mongodb-rag-core/build/verifiedAnswers/VerifiedAnswer.d.ts:122
Variables
Question
• Const
Question: z.ZodObject
<{ embedding
: z.ZodArray
<z.ZodNumber
, "many"
> ; embedding_model
: z.ZodString
; embedding_model_version
: z.ZodString
; text
: z.ZodString
}, "strip"
, z.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
mongodb-rag-core/build/verifiedAnswers/VerifiedAnswer.d.ts:3
mongodb-rag-core/build/verifiedAnswers/VerifiedAnswer.d.ts:19
VerifiedAnswer
• Const
VerifiedAnswer: z.ZodObject
<{ _id
: z.ZodString
; answer
: z.ZodString
; author_email
: z.ZodString
; created
: z.ZodDate
; hidden
: z.ZodOptional
<z.ZodBoolean
> ; question
: z.ZodObject
<{ embedding
: z.ZodArray
<z.ZodNumber
, "many"
> ; embedding_model
: z.ZodString
; embedding_model_version
: z.ZodString
; text
: z.ZodString
}, "strip"
, z.ZodTypeAny
, { embedding
: number
[] ; embedding_model
: string
; embedding_model_version
: string
; text
: string
}, { embedding
: number
[] ; embedding_model
: string
; embedding_model_version
: string
; text
: string
}> ; references
: z.ZodArray
<z.ZodObject
<{ metadata
: z.ZodOptional
<z.ZodObject
<{ sourceName
: z.ZodOptional
<z.ZodString
> ; sourceType
: z.ZodOptional
<z.ZodString
> ; tags
: z.ZodOptional
<z.ZodArray
<z.ZodString
, "many"
>> }, "passthrough"
, z.ZodTypeAny
, z.objectOutputType
<{ sourceName
: z.ZodOptional
<z.ZodString
> ; sourceType
: z.ZodOptional
<z.ZodString
> ; tags
: z.ZodOptional
<z.ZodArray
<z.ZodString
, "many"
>> }, z.ZodTypeAny
, "passthrough"
>, z.objectInputType
<{ sourceName
: z.ZodOptional
<z.ZodString
> ; sourceType
: z.ZodOptional
<z.ZodString
> ; tags
: z.ZodOptional
<z.ZodArray
<z.ZodString
, "many"
>> }, z.ZodTypeAny
, "passthrough"
>>> ; title
: z.ZodString
; url
: z.ZodString
}, "strip"
, z.ZodTypeAny
, { metadata?
: z.objectOutputType
<{ sourceName
: z.ZodOptional
<z.ZodString
> ; sourceType
: z.ZodOptional
<z.ZodString
> ; tags
: z.ZodOptional
<z.ZodArray
<z.ZodString
, "many"
>> }, z.ZodTypeAny
, "passthrough"
> ; title
: string
; url
: string
}, { metadata?
: z.objectInputType
<{ sourceName
: z.ZodOptional
<z.ZodString
> ; sourceType
: z.ZodOptional
<z.ZodString
> ; tags
: z.ZodOptional
<z.ZodArray
<z.ZodString
, "many"
>> }, z.ZodTypeAny
, "passthrough"
> ; title
: string
; url
: string
}>, "many"
> ; updated
: z.ZodOptional
<z.ZodDate
> }, "strip"
, z.ZodTypeAny
, { _id
: string
; answer
: string
; author_email
: string
; created
: Date
; hidden?
: boolean
; question
: { embedding
: number
[] ; embedding_model
: string
; embedding_model_version
: string
; text
: string
} ; references
: { metadata?
: z.objectOutputType
<{ sourceName
: z.ZodOptional
<z.ZodString
> ; sourceType
: z.ZodOptional
<z.ZodString
> ; tags
: z.ZodOptional
<z.ZodArray
<z.ZodString
, "many"
>> }, z.ZodTypeAny
, "passthrough"
> ; title
: string
; url
: string
}[] ; updated?
: Date
}, { _id
: string
; answer
: string
; author_email
: string
; created
: Date
; hidden?
: boolean
; question
: { embedding
: number
[] ; embedding_model
: string
; embedding_model_version
: string
; text
: string
} ; references
: { metadata?
: z.objectInputType
<{ sourceName
: z.ZodOptional
<z.ZodString
> ; sourceType
: z.ZodOptional
<z.ZodString
> ; tags
: z.ZodOptional
<z.ZodArray
<z.ZodString
, "many"
>> }, z.ZodTypeAny
, "passthrough"
> ; title
: string
; url
: string
}[] ; updated?
: Date
}>
Defined in
mongodb-rag-core/build/verifiedAnswers/VerifiedAnswer.d.ts:20
mongodb-rag-core/build/verifiedAnswers/VerifiedAnswer.d.ts:121
Functions
makeDefaultFindVerifiedAnswer
▸ makeDefaultFindVerifiedAnswer(«destructured»
): FindVerifiedAnswerFunc
Basic implementation of FindVerifiedAnswerFunc.
Parameters
Name | Type |
---|---|
«destructured» | MakeDefaultFindVerifiedAnswerFuncArgs |
Returns
Defined in
mongodb-rag-core/build/verifiedAnswers/DefaultFindVerifiedAnswer.d.ts:13
makeMongoDbVerifiedAnswerStore
▸ makeMongoDbVerifiedAnswerStore(«destructured»
): VerifiedAnswerStore
& DatabaseConnection
Parameters
Name | Type |
---|---|
«destructured» | MakeMongoDbDatabaseConnectionParams & { collectionName : string } |
Returns
VerifiedAnswerStore
& DatabaseConnection
Defined in
mongodb-rag-core/build/verifiedAnswers/MongoDbVerifiedAnswerStore.d.ts:4