Genkit JS API reference
    Preparing search index...

    Module beta

    Beta features including interrupts, stream managers, and the experimental GenkitBeta class.

    import { genkit } from 'genkit/beta';

    Classes

    AsyncTaskQueue
    GenkitBeta
    InMemoryStreamManager
    StreamNotFoundError

    Interfaces

    ActionStreamInput
    StreamManager

    Type Aliases

    ActionStreamSubscriber

    Functions

    genkit
    lazy

    References

    Action → Action
    ActionContext → ActionContext
    ActionMetadata → ActionMetadata
    BaseDataPointSchema → BaseDataPointSchema
    Chat → Chat
    Document → Document
    DocumentData → DocumentData
    DocumentDataSchema → DocumentDataSchema
    DynamicActionProviderAction → DynamicActionProviderAction
    dynamicResource → dynamicResource
    DynamicResourceAction → DynamicResourceAction
    dynamicTool → dynamicTool
    EmbedderAction → EmbedderAction
    embedderActionMetadata → embedderActionMetadata
    EmbedderArgument → EmbedderArgument
    EmbedderInfo → EmbedderInfo
    EmbedderParams → EmbedderParams
    embedderRef → embedderRef
    EmbedderReference → EmbedderReference
    Embedding → Embedding
    ErrorResponseMetadata → ErrorResponseMetadata
    EvalResponses → EvalResponses
    EvaluatorAction → EvaluatorAction
    EvaluatorInfo → EvaluatorInfo
    EvaluatorParams → EvaluatorParams
    evaluatorRef → evaluatorRef
    EvaluatorReference → EvaluatorReference
    ExecutablePrompt → ExecutablePrompt
    Flow → Flow
    FlowConfig → FlowConfig
    FlowFn → FlowFn
    FlowSideChannel → FlowSideChannel
    generateMiddleware → generateMiddleware
    GenerateMiddleware → GenerateMiddleware
    GenerateMiddlewareDef → GenerateMiddlewareDef
    GenerateOptions → GenerateOptions
    GenerateRequest → GenerateRequest
    GenerateRequestData → GenerateRequestData
    GenerateResponse → GenerateResponse
    GenerateResponseChunk → GenerateResponseChunk
    GenerateResponseChunkData → GenerateResponseChunkData
    GenerateResponseData → GenerateResponseData
    GenerateStreamOptions → GenerateStreamOptions
    GenerateStreamResponse → GenerateStreamResponse
    GenerationBlockedError → GenerationBlockedError
    GenerationCommonConfigSchema → GenerationCommonConfigSchema
    GenerationResponseError → GenerationResponseError
    GenerationUsage → GenerationUsage
    GENKIT_CLIENT_HEADER → GENKIT_CLIENT_HEADER
    GENKIT_VERSION → GENKIT_VERSION
    GenkitBetaOptions → GenkitOptions
    GenkitError → GenkitError
    GenkitRuntimeConfig → GenkitRuntimeConfig
    getClientHeader → getClientHeader
    getGenkitRuntimeConfig → getGenkitRuntimeConfig
    IndexerAction → IndexerAction
    IndexerArgument → IndexerArgument
    IndexerInfo → IndexerInfo
    IndexerParams → IndexerParams
    indexerRef → indexerRef
    IndexerReference → IndexerReference
    InterruptConfig → InterruptConfig
    isDevEnv → isDevEnv
    JSONSchema → JSONSchema
    JSONSchema7 → JSONSchema7
    LlmResponse → LlmResponse
    LlmResponseSchema → LlmResponseSchema
    LlmStats → LlmStats
    LlmStatsSchema → LlmStatsSchema
    MediaPart → MediaPart
    Message → Message
    MessageData → MessageData
    MessageSchema → MessageSchema
    Middleware → Middleware
    MiddlewareDesc → MiddlewareDesc
    MiddlewareDescSchema → MiddlewareDescSchema
    MiddlewareRef → MiddlewareRef
    MiddlewareRefSchema → MiddlewareRefSchema
    modelActionMetadata → modelActionMetadata
    ModelArgument → ModelArgument
    modelRef → modelRef
    ModelReference → ModelReference
    ModelReferenceSchema → ModelReferenceSchema
    ModelRequest → ModelRequest
    ModelRequestSchema → ModelRequestSchema
    ModelResponseData → ModelResponseData
    ModelResponseSchema → ModelResponseSchema
    MultipartToolAction → MultipartToolAction
    Operation → Operation
    OperationSchema → OperationSchema
    OutputOptions → OutputOptions
    Part → Part
    PartSchema → PartSchema
    PromptAction → PromptAction
    PromptConfig → PromptConfig
    PromptGenerateOptions → PromptGenerateOptions
    RankedDocument → RankedDocument
    ReflectionServerOptions → ReflectionServerOptions
    RerankerAction → RerankerAction
    RerankerArgument → RerankerArgument
    RerankerInfo → RerankerInfo
    RerankerParams → RerankerParams
    rerankerRef → rerankerRef
    RerankerReference → RerankerReference
    resetGenkitRuntimeConfig → resetGenkitRuntimeConfig
    resource → resource
    ResourceAction → ResourceAction
    respondTool → respondTool
    restartTool → restartTool
    ResumeOptions → ResumeOptions
    RetrieverAction → RetrieverAction
    RetrieverArgument → RetrieverArgument
    RetrieverInfo → RetrieverInfo
    RetrieverParams → RetrieverParams
    retrieverRef → retrieverRef
    RetrieverReference → RetrieverReference
    Role → Role
    RoleSchema → RoleSchema
    RunActionResponse → RunActionResponse
    runWithStreamingCallback → runWithStreamingCallback
    Session → Session
    SessionData → SessionData
    SessionStore → SessionStore
    setGenkitRuntimeConfig → setGenkitRuntimeConfig
    Status → Status
    StatusCodes → StatusCodes
    StatusName → StatusName
    StatusSchema → StatusSchema
    StreamingCallback → StreamingCallback
    StreamingResponse → StreamingResponse
    TelemetryConfig → TelemetryConfig
    tool → tool
    Tool → Tool
    ToolAction → ToolAction
    ToolArgument → ToolArgument
    ToolCall → ToolCall
    ToolCallSchema → ToolCallSchema
    ToolChoice → ToolChoice
    ToolConfig → ToolConfig
    ToolInterruptError → ToolInterruptError
    ToolRequest → ToolRequest
    ToolRequestPart → ToolRequestPart
    ToolResponse → ToolResponse
    ToolResponsePart → ToolResponsePart
    ToolSchema → ToolSchema
    UserFacingError → UserFacingError
    z → z

    Settings

    Member Visibility

    On This Page

    Classes
    Interfaces
    Type Aliases
    Functions
    References
    ActionActionContextActionMetadataBaseDataPointSchemaChatDocumentDocumentDataDocumentDataSchemaDynamicActionProviderActiondynamicResourceDynamicResourceActiondynamicToolEmbedderActionembedderActionMetadataEmbedderArgumentEmbedderInfoEmbedderParamsembedderRefEmbedderReferenceEmbeddingErrorResponseMetadataEvalResponsesEvaluatorActionEvaluatorInfoEvaluatorParamsevaluatorRefEvaluatorReferenceExecutablePromptFlowFlowConfigFlowFnFlowSideChannelgenerateMiddlewareGenerateMiddlewareGenerateMiddlewareDefGenerateOptionsGenerateRequestGenerateRequestDataGenerateResponseGenerateResponseChunkGenerateResponseChunkDataGenerateResponseDataGenerateStreamOptionsGenerateStreamResponseGenerationBlockedErrorGenerationCommonConfigSchemaGenerationResponseErrorGenerationUsageGENKIT_CLIENT_HEADERGENKIT_VERSIONGenkitBetaOptionsGenkitErrorGenkitRuntimeConfiggetClientHeadergetGenkitRuntimeConfigIndexerActionIndexerArgumentIndexerInfoIndexerParamsindexerRefIndexerReferenceInterruptConfigisDevEnvJSONSchemaJSONSchema7LlmResponseLlmResponseSchemaLlmStatsLlmStatsSchemaMediaPartMessageMessageDataMessageSchemaMiddlewareMiddlewareDescMiddlewareDescSchemaMiddlewareRefMiddlewareRefSchemamodelActionMetadataModelArgumentmodelRefModelReferenceModelReferenceSchemaModelRequestModelRequestSchemaModelResponseDataModelResponseSchemaMultipartToolActionOperationOperationSchemaOutputOptionsPartPartSchemaPromptActionPromptConfigPromptGenerateOptionsRankedDocumentReflectionServerOptionsRerankerActionRerankerArgumentRerankerInfoRerankerParamsrerankerRefRerankerReferenceresetGenkitRuntimeConfigresourceResourceActionrespondToolrestartToolResumeOptionsRetrieverActionRetrieverArgumentRetrieverInfoRetrieverParamsretrieverRefRetrieverReferenceRoleRoleSchemaRunActionResponserunWithStreamingCallbackSessionSessionDataSessionStoresetGenkitRuntimeConfigStatusStatusCodesStatusNameStatusSchemaStreamingCallbackStreamingResponseTelemetryConfigtoolToolToolActionToolArgumentToolCallToolCallSchemaToolChoiceToolConfigToolInterruptErrorToolRequestToolRequestPartToolResponseToolResponsePartToolSchemaUserFacingErrorz