dotprompt

type Config struct {
	// The prompt variant.
	Variant string
	// The name of the model for which the prompt is input.
	// If this is non-empty, Model should be nil.
	ModelName string

	// The Model to use.
	// If this is non-nil, Model should be the empty string.
	Model *ai.Model

	// TODO(iant): document
	Tools []*ai.ToolDefinition

	// Number of candidates to generate when passing the prompt
	// to a model. If 0, uses 1.
	Candidates int

	// Details for the model.
	GenerationConfig *ai.GenerationCommonConfig

	InputSchema      *jsonschema.Schema // schema for input variables
	VariableDefaults map[string]any     // default input variable values

	// Desired output format.
	OutputFormat ai.OutputFormat

	// Desired output schema, for JSON output.
	OutputSchema map[string]any // TODO: use *jsonschema.Schema

	// Arbitrary metadata.
	Metadata map[string]any
}

type Prompt struct {
	// The name of the prompt. Optional unless the prompt is
	// registered as an action.
	Name string

	Config

	// The parsed prompt template.
	Template *raymond.Template

	// The original prompt template text.
	TemplateText string
	// contains filtered or unexported fields
}

type PromptRequest struct {
	// Input fields for the prompt. If not nil this should be a struct
	// or pointer to a struct that matches the prompt's input schema.
	Variables any `json:"variables,omitempty"`
	// Number of candidates to return; if 0, will be taken
	// from the prompt config; if still 0, will use 1.
	Candidates int `json:"candidates,omitempty"`
	// Model configuration. If nil will be taken from the prompt config.
	Config *ai.GenerationCommonConfig `json:"config,omitempty"`
	// Context to pass to model, if any.
	Context []any `json:"context,omitempty"`
	// The model to use. This overrides any model specified by the prompt.
	Model string `json:"model,omitempty"`
}