Genkit JS API reference
    Preparing search index...

    Module model

    Model types and helpers — request/response schemas, message and part types, model references, and middleware interfaces for building model plugins.

    import { modelRef, type ModelAction, type MessageData } from 'genkit/model';
    

    Type Aliases

    BackgroundModelAction
    CandidateData
    CandidateError
    CustomPart
    DataPart
    DefineBackgroundModelOptions
    DefineModelOptions
    GenerationCommonConfig
    ModelAction
    ModelInfo
    ModelMiddleware
    ModelMiddlewareArgument
    ModelMiddlewareWithOptions
    ModelResponseChunkData
    OutputConfig
    TextPart
    ToolDefinition

    Variables

    CandidateErrorSchema
    CandidateSchema
    CustomPartSchema
    DataPartSchema
    GenerateRequestSchema
    GenerateResponseChunkSchema
    GenerateResponseSchema
    GenerationCommonConfigDescriptions
    GenerationUsageSchema
    MediaPartSchema
    ModelInfoSchema
    TextPartSchema
    ToolDefinitionSchema
    ToolRequestPartSchema
    ToolResponsePartSchema

    Functions

    getBasicUsageStats
    simulateConstrainedGeneration

    References

    GenerateRequest → GenerateRequest
    GenerateRequestData → GenerateRequestData
    GenerateResponseChunkData → GenerateResponseChunkData
    GenerateResponseData → GenerateResponseData
    GenerationCommonConfigSchema → GenerationCommonConfigSchema
    GenerationUsage → GenerationUsage
    MediaPart → MediaPart
    MessageData → MessageData
    MessageSchema → MessageSchema
    ModelArgument → ModelArgument
    modelRef → modelRef
    ModelReference → ModelReference
    ModelRequest → ModelRequest
    ModelRequestSchema → ModelRequestSchema
    ModelResponseData → ModelResponseData
    ModelResponseSchema → ModelResponseSchema
    Part → Part
    PartSchema → PartSchema
    Role → Role
    RoleSchema → RoleSchema
    ToolRequestPart → ToolRequestPart
    ToolResponsePart → ToolResponsePart