Genkit JS API reference
Preparing search index...
genkitx-chromadb
chromaRetriever
Function chromaRetriever
chromaRetriever
<
EmbedderCustomOptions
extends
z
.
ZodTypeAny
>
(
ai
:
Genkit
,
params
:
{
clientParams
?:
ChromaClientParams
;
collectionName
:
string
;
createCollectionIfMissing
?:
boolean
;
embedder
:
EmbedderArgument
<
EmbedderCustomOptions
>
;
embedderOptions
?:
z
.
TypeOf
<
EmbedderCustomOptions
>
;
}
,
)
:
RetrieverAction
<
z
.
ZodOptional
<
z
.
ZodObject
<
{
k
:
z
.
ZodOptional
<
z
.
ZodNumber
>
}
&
{
include
:
z
.
ZodOptional
<
z
.
ZodArray
<
z
.
ZodEnum
<
[
"documents"
,
"embeddings"
,
"metadatas"
,
"distances"
]
>
,
"many"
,
>
,
>
;
where
:
z
.
ZodOptional
<
z
.
ZodType
<
Where
,
z
.
ZodTypeDef
,
Where
>
>
;
whereDocument
:
z
.
ZodOptional
<
z
.
ZodType
<
WhereDocument
,
z
.
ZodTypeDef
,
WhereDocument
>
,
>
;
}
,
"strip"
,
z
.
ZodTypeAny
,
{
include
?:
(
"documents"
|
"embeddings"
|
"metadatas"
|
"distances"
)
[]
;
k
?:
number
;
where
?:
Where
;
whereDocument
?:
WhereDocument
;
}
,
{
include
?:
(
"documents"
|
"embeddings"
|
"metadatas"
|
"distances"
)
[]
;
k
?:
number
;
where
?:
Where
;
whereDocument
?:
WhereDocument
;
}
,
>
,
>
,
>
Configures a Chroma vector store retriever.
Type Parameters
EmbedderCustomOptions
extends
z
.
ZodTypeAny
Parameters
ai
:
Genkit
params
:
{
clientParams
?:
ChromaClientParams
;
collectionName
:
string
;
createCollectionIfMissing
?:
boolean
;
embedder
:
EmbedderArgument
<
EmbedderCustomOptions
>
;
embedderOptions
?:
z
.
TypeOf
<
EmbedderCustomOptions
>
;
}
Returns
RetrieverAction
<
z
.
ZodOptional
<
z
.
ZodObject
<
{
k
:
z
.
ZodOptional
<
z
.
ZodNumber
>
}
&
{
include
:
z
.
ZodOptional
<
z
.
ZodArray
<
z
.
ZodEnum
<
[
"documents"
,
"embeddings"
,
"metadatas"
,
"distances"
]
>
,
"many"
,
>
,
>
;
where
:
z
.
ZodOptional
<
z
.
ZodType
<
Where
,
z
.
ZodTypeDef
,
Where
>
>
;
whereDocument
:
z
.
ZodOptional
<
z
.
ZodType
<
WhereDocument
,
z
.
ZodTypeDef
,
WhereDocument
>
,
>
;
}
,
"strip"
,
z
.
ZodTypeAny
,
{
include
?:
(
"documents"
|
"embeddings"
|
"metadatas"
|
"distances"
)
[]
;
k
?:
number
;
where
?:
Where
;
whereDocument
?:
WhereDocument
;
}
,
{
include
?:
(
"documents"
|
"embeddings"
|
"metadatas"
|
"distances"
)
[]
;
k
?:
number
;
where
?:
Where
;
whereDocument
?:
WhereDocument
;
}
,
>
,
>
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Genkit JS API reference
Loading...
Configures a Chroma vector store retriever.