Genkit JS API reference
Preparing search index...
genkit
/
ActionMetadata
Interface ActionMetadata<I, O, S>
Action metadata.
interface
ActionMetadata
<
I
extends
z
.
ZodTypeAny
=
z
.
ZodTypeAny
,
O
extends
z
.
ZodTypeAny
=
z
.
ZodTypeAny
,
S
extends
z
.
ZodTypeAny
=
z
.
ZodTypeAny
,
>
{
actionType
?:
|
"custom"
|
"prompt"
|
"model"
|
"tool"
|
"dynamic-action-provider"
|
"embedder"
|
"evaluator"
|
"executable-prompt"
|
"flow"
|
"indexer"
|
"background-model"
|
"check-operation"
|
"cancel-operation"
|
"reranker"
|
"retriever"
|
"tool.v2"
|
"util"
|
"resource"
;
description
?:
string
;
inputJsonSchema
?:
JSONSchema7
;
inputSchema
?:
I
;
key
?:
string
;
metadata
?:
Record
<
string
,
any
>
;
name
:
string
;
outputJsonSchema
?:
JSONSchema7
;
outputSchema
?:
O
;
streamSchema
?:
S
;
}
Type Parameters
I
extends
z
.
ZodTypeAny
=
z
.
ZodTypeAny
O
extends
z
.
ZodTypeAny
=
z
.
ZodTypeAny
S
extends
z
.
ZodTypeAny
=
z
.
ZodTypeAny
Index
Properties
action
Type?
description?
input
Json
Schema?
input
Schema?
key?
metadata?
name
output
Json
Schema?
output
Schema?
stream
Schema?
Properties
Optional
action
Type
actionType
?:
|
"custom"
|
"prompt"
|
"model"
|
"tool"
|
"dynamic-action-provider"
|
"embedder"
|
"evaluator"
|
"executable-prompt"
|
"flow"
|
"indexer"
|
"background-model"
|
"check-operation"
|
"cancel-operation"
|
"reranker"
|
"retriever"
|
"tool.v2"
|
"util"
|
"resource"
Optional
description
description
?:
string
Optional
input
Json
Schema
inputJsonSchema
?:
JSONSchema7
Optional
input
Schema
inputSchema
?:
I
Optional
key
key
?:
string
Optional
metadata
metadata
?:
Record
<
string
,
any
>
name
name
:
string
Optional
output
Json
Schema
outputJsonSchema
?:
JSONSchema7
Optional
output
Schema
outputSchema
?:
O
Optional
stream
Schema
streamSchema
?:
S
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
action
Type
description
input
Json
Schema
input
Schema
key
metadata
name
output
Json
Schema
output
Schema
stream
Schema
Genkit JS API reference
Loading...
Action metadata.