Genkit JS API reference
    Preparing search index...

    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

    Index

    Properties

    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