Preparing search index...
The search index is not available
Genkit JS API reference
Genkit JS API reference
genkit
/
RetrieverParams
Interface RetrieverParams<CustomOptions>
interface
RetrieverParams
<
CustomOptions
extends
ZodTypeAny
=
ZodTypeAny
>
{
options
?:
TypeOf
<
CustomOptions
>
;
query
:
|
string
|
{
content
:
(
|
{
media
?:
undefined
;
text
:
string
}
|
{
media
:
{
contentType
?:
string
;
url
:
string
}
;
text
?:
undefined
}
)
[]
;
metadata
?:
Record
<
string
,
any
>
;
}
;
retriever
:
RetrieverArgument
<
CustomOptions
>
;
}
Type Parameters
CustomOptions
extends
ZodTypeAny
=
ZodTypeAny
Index
Properties
options?
query
retriever
Properties
Optional
options
options
?:
TypeOf
<
CustomOptions
>
query
query
:
|
string
|
{
content
:
(
|
{
media
?:
undefined
;
text
:
string
}
|
{
media
:
{
contentType
?:
string
;
url
:
string
}
;
text
?:
undefined
}
)
[]
;
metadata
?:
Record
<
string
,
any
>
;
}
retriever
retriever
:
RetrieverArgument
<
CustomOptions
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
options
query
retriever
Genkit JS API reference
Loading...