Preparing search index...
The search index is not available
Genkit JS API reference
Genkit JS API reference
genkit
/
z
OK
Type Alias OK<T>
OK
:
{
status
:
"valid"
;
value
:
T
}
Type Parameters
T
Type declaration
status
:
"valid"
value
:
T
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Genkit JS API reference
genkit
/
z
objectUtil
addQuestionMarks
extendShape
flatten
identity
MergeShapes
noNever
noNeverKeys
mergeShapes
util
Exactly
flatten
identity
isAny
MakePartial
noUndefined
Omit
OmitKeys
arrayToEnum
assertEqual
assertIs
assertNever
find
getValidEnumValues
isInteger
joinValues
jsonStringifyReplacer
objectKeys
objectValues
ZodFirstPartyTypeKind
ParseStatus
ZodAny
ZodArray
ZodBigInt
ZodBoolean
ZodBranded
ZodCatch
ZodDate
ZodDefault
ZodDiscriminatedUnion
ZodEffects
ZodEnum
ZodError
ZodFunction
ZodIntersection
ZodLazy
ZodLiteral
ZodMap
ZodNaN
ZodNativeEnum
ZodNever
ZodNull
ZodNullable
ZodNumber
ZodObject
ZodOptional
ZodPipeline
ZodPromise
ZodReadonly
ZodRecord
ZodSet
ZodString
ZodSymbol
ZodTuple
ZodType
ZodUndefined
ZodUnion
ZodUnknown
ZodVoid
ParseContext
ParseResult
RefinementCtx
ZodAnyDef
ZodArrayDef
ZodBigIntDef
ZodBooleanDef
ZodBrandedDef
ZodCatchDef
ZodCustomIssue
ZodDateDef
ZodDefaultDef
ZodDiscriminatedUnionDef
ZodEffectsDef
ZodEnumDef
ZodFunctionDef
ZodIntersectionDef
ZodInvalidArgumentsIssue
ZodInvalidDateIssue
ZodInvalidEnumValueIssue
ZodInvalidIntersectionTypesIssue
ZodInvalidLiteralIssue
ZodInvalidReturnTypeIssue
ZodInvalidStringIssue
ZodInvalidTypeIssue
ZodInvalidUnionDiscriminatorIssue
ZodInvalidUnionIssue
ZodLazyDef
ZodLiteralDef
ZodMapDef
ZodNaNDef
ZodNativeEnumDef
ZodNeverDef
ZodNotFiniteIssue
ZodNotMultipleOfIssue
ZodNullableDef
ZodNullDef
ZodNumberDef
ZodObjectDef
ZodOptionalDef
ZodPipelineDef
ZodPromiseDef
ZodReadonlyDef
ZodRecordDef
ZodSetDef
ZodStringDef
ZodSymbolDef
ZodTooBigIssue
ZodTooSmallIssue
ZodTupleDef
ZodTypeDef
ZodUndefinedDef
ZodUnionDef
ZodUnknownDef
ZodUnrecognizedKeysIssue
ZodVoidDef
AnyZodObject
AnyZodTuple
ArrayCardinality
ArrayKeys
arrayOutputType
AssertArray
AsyncParseReturnType
baseObjectInputType
baseObjectOutputType
BRAND
CatchallInput
CatchallOutput
CustomErrorParams
DenormalizedError
deoptional
DIRTY
Effect
EnumLike
EnumValues
ErrorMapCtx
FilterEnum
Indices
inferFlattenedErrors
inferFormattedError
InnerTypeOfFunction
input
InputTypeOfTuple
InputTypeOfTupleWithRest
INVALID
IpVersion
IssueData
KeySchema
mergeTypes
noUnrecognized
objectInputType
objectOutputType
ObjectPair
OK
OuterTypeOfFunction
output
OutputTypeOfTuple
OutputTypeOfTupleWithRest
ParseInput
ParseParams
ParsePath
ParsePathComponent
ParseReturnType
PassthroughType
PreprocessEffect
Primitive
ProcessedCreateParams
RawCreateParams
RecordType
Refinement
RefinementEffect
SafeParseError
SafeParseReturnType
SafeParseSuccess
Scalars
SomeZodObject
StringValidation
SuperRefinement
SyncParseReturnType
TransformEffect
typecast
TypeOf
typeToFlattenedError
UnknownKeysParam
Values
Writeable
ZodBigIntCheck
ZodDateCheck
ZodDiscriminatedUnionOption
ZodErrorMap
ZodFirstPartySchemaTypes
ZodFormattedError
ZodIssue
ZodIssueBase
ZodIssueCode
ZodIssueOptionalMessage
ZodNonEmptyArray
ZodNullableType
ZodNumberCheck
ZodOptionalType
ZodParsedType
ZodRawShape
ZodStringCheck
ZodTupleItems
ZodTypeAny
ZodUnionOptions
BRAND
coerce
EMPTY_PATH
INVALID
late
NEVER
ZodIssueCode
ZodParsedType
addIssueToContext
any
array
bigint
boolean
custom
date
datetimeRegex
defaultErrorMap
DIRTY
discriminatedUnion
effect
enum
function
getErrorMap
getParsedType
instanceof
intersection
isAborted
isAsync
isDirty
isValid
lazy
literal
makeIssue
map
nan
nativeEnum
never
null
nullable
number
object
oboolean
OK
onumber
optional
ostring
pipeline
preprocess
promise
quotelessJson
record
set
setErrorMap
strictObject
string
symbol
tuple
undefined
union
unknown
void
StatusCodes
Chat
Document
GenerateResponse
GenerateResponseChunk
GenerationBlockedError
GenerationResponseError
Genkit
GenkitError
Message
RankedDocument
Session
UserFacingError
ActionContext
ActionMetadata
EmbedderParams
EmbedderReference
EvaluatorParams
EvaluatorReference
Flow
FlowConfig
FlowSideChannel
GenerateOptions
GenerateRequest
GenerateStreamResponse
GenkitOptions
IndexerParams
IndexerReference
JSONSchema7
ModelReference
ModelRequest
PromptConfig
ReflectionServerOptions
RerankerParams
RerankerReference
ResumeOptions
RetrieverParams
RetrieverReference
SessionData
SessionStore
StreamingResponse
ToolConfig
Action
DocumentData
EmbedderAction
EmbedderArgument
EmbedderInfo
Embedding
EvalResponses
EvaluatorAction
EvaluatorInfo
FlowFn
GenerateRequestData
GenerateResponseChunkData
GenerateResponseData
GenerateStreamOptions
GenerationUsage
IndexerAction
IndexerArgument
IndexerInfo
InterruptConfig
JSONSchema
LlmResponse
LlmStats
MediaPart
MessageData
Middleware
ModelArgument
ModelResponseData
Part
PromptAction
RerankerAction
RerankerArgument
RerankerInfo
RetrieverAction
RetrieverArgument
RetrieverInfo
Role
RunActionResponse
Status
StatusName
StreamingCallback
TelemetryConfig
Tool
ToolAction
ToolArgument
ToolCall
ToolRequestPart
ToolResponsePart
BaseDataPointSchema
DocumentDataSchema
GenerationCommonConfigSchema
GENKIT_CLIENT_HEADER
GENKIT_VERSION
LlmResponseSchema
LlmStatsSchema
MessageSchema
ModelRequestSchema
ModelResponseSchema
PartSchema
RoleSchema
StatusSchema
ToolCallSchema
ToolSchema
embedderRef
evaluatorRef
genkit
indexerRef
isDevEnv
rerankerRef
retrieverRef
runWithStreamingCallback
beta
GenkitBeta
genkit
client
runFlow
streamFlow
embedder
EmbeddingBatch
EmbedderInfoSchema
evaluator
BaseDataPoint
BaseEvalDataPoint
Dataset
EvalResponse
EvaluatorArgument
Score
BaseEvalDataPointSchema
EvalResponseSchema
EvalResponsesSchema
EvaluatorInfoSchema
ScoreSchema
extract
extractJson
parsePartialJson
logging
logger
middleware
AugmentWithContextOptions
augmentWithContext
downloadRequestMedia
simulateSystemPrompt
validateSupport
model
CandidateData
CandidateError
CustomPart
DataPart
DefineModelOptions
GenerationCommonConfig
ModelAction
ModelInfo
ModelMiddleware
ModelResponseChunkData
OutputConfig
TextPart
ToolDefinition
CandidateErrorSchema
CandidateSchema
CustomPartSchema
DataPartSchema
GenerateRequestSchema
GenerateResponseChunkSchema
GenerateResponseSchema
GenerationUsageSchema
MediaPartSchema
ModelInfoSchema
TextPartSchema
ToolDefinitionSchema
ToolRequestPartSchema
ToolResponsePartSchema
getBasicUsageStats
modelRef
simulateConstrainedGeneration
plugin
PluginProvider
GenkitPlugin
genkitPlugin
registry
Registry
Schema
ActionType
AsyncProvider
reranker
RankedDocumentData
CommonRerankerOptionsSchema
RankedDocumentDataSchema
RerankerInfoSchema
retriever
SimpleRetrieverOptions
IndexerFn
MediaPart
Part
RetrieverFn
TextPart
CommonRetrieverOptionsSchema
IndexerInfoSchema
RetrieverInfoSchema
schema
ValidationError
ProvidedSchema
ValidationErrorDetail
ValidationResponse
parseSchema
toJsonSchema
validateSchema
testing
testModels
tool
asTool
toToolDefinition
tracing
TraceServerExporter
PathMetadata
SpanData
SpanMetadata
TraceData
TraceMetadata
SpanContextSchema
SpanDataSchema
SpanMetadataSchema
SpanStatusSchema
TimeEventSchema
TraceDataSchema
TraceMetadataSchema
enableTelemetry
@genkit-ai/googleai
PluginOptions
GeminiConfig
GeminiVersionString
gemini10Pro
gemini15Flash
gemini15Flash8b
gemini15Pro
gemini20Flash
textEmbedding004
textEmbeddingGecko001
gemini
googleAI
@genkit-ai/vertexai
/
PluginOptions
GeminiConfig
gemini10Pro
gemini15Flash
gemini15Pro
gemini20Flash001
gemini20FlashLitePreview0205
gemini20ProExp0205
imagen2
imagen3
imagen3Fast
multimodalEmbedding001
textEmbedding004
textEmbedding005
textEmbeddingGecko003
textEmbeddingGeckoMultilingual001
textMultilingualEmbedding002
gemini
vertexAI
evaluation
VertexAIEvaluationMetricType
PluginOptions
vertexAIEvaluation
modelgarden
PluginOptions
claude35Sonnet
claude35SonnetV2
claude3Haiku
claude3Opus
claude3Sonnet
codestral
llama3
llama31
llama32
mistralLarge
mistralNemo
vertexAIModelGarden
rerankers
PluginOptions
vertexAIRerankers
vectorsearch
VectorSearchOptions
DocumentIndexer
DocumentRetriever
Neighbor
getBigQueryDocumentIndexer
getBigQueryDocumentRetriever
getFirestoreDocumentIndexer
getFirestoreDocumentRetriever
vertexAiIndexerRef
vertexAiIndexers
vertexAiRetrieverRef
vertexAiRetrievers
vertexAIVectorSearch
@genkit-ai/firebase
defineFirestoreRetriever
enableFirebaseTelemetry
@genkit-ai/google-cloud
GcpLogger
GcpOpenTelemetry
GcpTelemetryConfigOptions
enableGoogleCloudTelemetry
@genkit-ai/checks
ChecksEvaluationMetricType
PluginOptions
checks
checksMiddleware
@genkit-ai/dev-local-vectorstore
devLocalIndexerRef
devLocalRetrieverRef
devLocalVectorstore
@genkit-ai/evaluator
GenkitMetric
PluginOptions
genkitEval
genkitEvalRef
genkitEvaluators
@genkit-ai/express
FlowServerOptions
FlowWithContextProvider
expressHandler
startFlowServer
withContextProvider
genkitx-ollama
OllamaPluginParams
ollama
genkitx-chromadb
IncludeEnum
ChromaIndexerOptionsSchema
chroma
chromaIndexer
chromaIndexerRef
chromaRetriever
chromaRetrieverRef
createChromaCollection
deleteChromaCollection
genkitx-pinecone
configurePineconeIndexer
configurePineconeRetriever
createPineconeIndex
deletePineconeIndex
describePineconeIndex
pinecone
pineconeIndexerRef
pineconeRetrieverRef
genkitx-mcp
M
M
N
E
P
V
F
C
I
C
P
M
F
P
C
P
T
T
A
A
A
T
R