schema

type AIChatMessage struct {
	// contains filtered or unexported fields
}

type Agent interface {
	// Plan plans the agent's action given the intermediate steps and inputs.
	Plan(ctx context.Context, intermediateSteps []AgentStep, inputs ChainValues) ([]*AgentAction, *AgentFinish, error)
	// InputKeys returns the keys for expected input values for the agent.
	InputKeys() []string
	// OutputKeys returns the keys for the agent's output values.
	OutputKeys() []string
}

type AgentAction struct {
	// Name of the tool to use for the action.
	Tool string
	// Input for the tool action.
	ToolInput *ToolInput
	// Log message associated with the action.
	Log string
	// Message log associated with the action.
	MessageLog ChatMessages
}

type AgentActionInput struct {
	*AgentActionManagerInput
	RunID string
}

type AgentActionManagerInput struct {
	Action *AgentAction
}

type AgentFinish struct {
	// Return values from the agent.
	ReturnValues map[string]any
	Log          string
}

type AgentFinishInput struct {
	*AgentFinishManagerInput
	RunID string
}

type AgentFinishManagerInput struct {
	Finish *AgentFinish
}

type AgentStep struct {
	// Action to be taken by the agent.
	Action *AgentAction
	// Observation made during the step.
	Observation string
}

type AudioStream interface {
	// Play plays the audio stream.
	Play() error
	// Save saves the audio stream to the provided writer.
	Save(dst io.Writer) error
	// Format returns the output format of the audio stream.
	Format() OutputFormat
	// Read reads from the audio stream into the given byte slice.
	Read(p []byte) (n int, err error)
	// Close closes the audio stream.
	Close() error
}

type CallOptions struct {
	CallbackManger CallbackManagerForChainRun
	Stop           []string
}

type Callback interface {
	AlwaysVerbose() bool
	RaiseError() bool
	OnLLMStart(ctx context.Context, input *LLMStartInput) error
	OnChatModelStart(ctx context.Context, input *ChatModelStartInput) error
	OnModelNewToken(ctx context.Context, input *ModelNewTokenInput) error
	OnModelEnd(ctx context.Context, input *ModelEndInput) error
	OnModelError(ctx context.Context, input *ModelErrorInput) error
	OnChainStart(ctx context.Context, input *ChainStartInput) error
	OnChainEnd(ctx context.Context, input *ChainEndInput) error
	OnChainError(ctx context.Context, input *ChainErrorInput) error
	OnAgentAction(ctx context.Context, input *AgentActionInput) error
	OnAgentFinish(ctx context.Context, input *AgentFinishInput) error
	OnToolStart(ctx context.Context, input *ToolStartInput) error
	OnToolEnd(ctx context.Context, input *ToolEndInput) error
	OnToolError(ctx context.Context, input *ToolErrorInput) error
	OnText(ctx context.Context, input *TextInput) error
	OnRetrieverStart(ctx context.Context, input *RetrieverStartInput) error
	OnRetrieverEnd(ctx context.Context, input *RetrieverEndInput) error
	OnRetrieverError(ctx context.Context, input *RetrieverErrorInput) error
}

type CallbackManager interface {
	OnLLMStart(ctx context.Context, input *LLMStartManagerInput) (CallbackManagerForModelRun, error)
	OnChatModelStart(ctx context.Context, input *ChatModelStartManagerInput) (CallbackManagerForModelRun, error)
	OnChainStart(ctx context.Context, input *ChainStartManagerInput) (CallbackManagerForChainRun, error)
	OnToolStart(ctx context.Context, input *ToolStartManagerInput) (CallbackManagerForToolRun, error)
	OnRetrieverStart(ctx context.Context, input *RetrieverStartManagerInput) (CallbackManagerForRetrieverRun, error)
	RunID() string
}

type CallbackManagerForChainRun interface {
	OnChainEnd(ctx context.Context, input *ChainEndManagerInput) error
	OnChainError(ctx context.Context, input *ChainErrorManagerInput) error
	OnAgentAction(ctx context.Context, input *AgentActionManagerInput) error
	OnAgentFinish(ctx context.Context, input *AgentFinishManagerInput) error
	OnText(ctx context.Context, input *TextManagerInput) error
	GetInheritableCallbacks() []Callback
	RunID() string
}

type CallbackManagerForModelRun interface {
	OnModelNewToken(ctx context.Context, input *ModelNewTokenManagerInput) error
	OnModelEnd(ctx context.Context, input *ModelEndManagerInput) error
	OnModelError(ctx context.Context, input *ModelErrorManagerInput) error
	OnText(ctx context.Context, input *TextManagerInput) error
	GetInheritableCallbacks() []Callback
	RunID() string
}

type CallbackManagerForRetrieverRun interface {
	OnRetrieverEnd(ctx context.Context, input *RetrieverEndManagerInput) error
	OnRetrieverError(ctx context.Context, input *RetrieverErrorManagerInput) error
}

type CallbackManagerForToolRun interface {
	OnToolEnd(ctx context.Context, input *ToolEndManagerInput) error
	OnToolError(ctx context.Context, input *ToolErrorManagerInput) error
	OnText(ctx context.Context, input *TextManagerInput) error
}

type CallbackOptions struct {
	Callbacks []Callback
	Verbose   bool
}

type Chain interface {
	// Call executes the chain with the given context and inputs.
	// It returns the outputs of the chain or an error, if any.
	Call(ctx context.Context, inputs ChainValues, optFns ...func(o *CallOptions)) (ChainValues, error)
	// Type returns the type of the chain.
	Type() string
	// Verbose returns the verbosity setting of the chain.
	Verbose() bool
	// Callbacks returns the callbacks associated with the chain.
	Callbacks() []Callback
	// Memory returns the memory associated with the chain.
	Memory() Memory
	// InputKeys returns the expected input keys.
	InputKeys() []string
	// OutputKeys returns the output keys the chain will return.
	OutputKeys() []string
}

type ChainEndInput struct {
	*ChainEndManagerInput
	RunID string
}

type ChainEndManagerInput struct {
	Outputs ChainValues
}

type ChainErrorInput struct {
	*ChainErrorManagerInput
	RunID string
}

type ChainErrorManagerInput struct {
	Error error
}

type ChainStartInput struct {
	*ChainStartManagerInput
	RunID string
}

type ChainStartManagerInput struct {
	ChainType string
	Inputs    ChainValues
}

type ChainValues map[string]any

type ChatMessage interface {
	// Content returns the content of the chat message.
	Content() string
	// Type returns the type of the chat message.
	Type() ChatMessageType
}

type ChatMessageExtension struct {
	FunctionCall *FunctionCall `json:"functionCall,omitempty"`
}

type ChatMessageHistory interface {
	// Messages returns the messages stored in the store.
	Messages(ctx context.Context) (ChatMessages, error)
	// AddUserMessage adds a user message to the store.
	AddUserMessage(ctx context.Context, text string) error
	// AddAIMessage adds an AI message to the store.
	AddAIMessage(ctx context.Context, text string) error
	// AddMessage adds a self-created message to the store.
	AddMessage(ctx context.Context, message ChatMessage) error
	// Clear removes all messages from the store.
	Clear(ctx context.Context) error
}

type ChatMessageType string

type ChatMessages []ChatMessage

type ChatModel interface {
	Model
	// Generate generates text based on the provided chat messages and options.
	Generate(ctx context.Context, messages ChatMessages, optFns ...func(o *GenerateOptions)) (*ModelResult, error)
}

type ChatModelStartInput struct {
	*ChatModelStartManagerInput
	RunID string
}

type ChatModelStartManagerInput struct {
	ChatModelType    string
	Messages         ChatMessages
	InvocationParams map[string]any
}

type Document struct {
	PageContent string
	Metadata    map[string]any
}

type DocumentCompressor interface {
	// Compress compresses the input documents.
	Compress(ctx context.Context, docs []Document, query string) ([]Document, error)
}

type DocumentLoader interface {
	Load(ctx context.Context) ([]Document, error)
	LoadAndSplit(ctx context.Context, splitter TextSplitter) ([]Document, error)
}

type DocumentTransformer interface {
	Transform(ctx context.Context, docs []Document) ([]Document, error)
}

type Embedder interface {
	// BatchEmbedText embeds a list of texts and returns their embeddings.
	BatchEmbedText(ctx context.Context, texts []string) ([][]float32, error)
	// EmbedText embeds a single text and returns its embedding.
	EmbedText(ctx context.Context, text string) ([]float32, error)
}

type FunctionCall struct {
	Name string `json:"name,omitempty"`
	// call function with arguments in JSON format
	Arguments string `json:"arguments,omitempty"`
}

type FunctionChatMessage struct {
	// contains filtered or unexported fields
}

type FunctionDefinition struct {
	Name        string                       `json:"name"`
	Description string                       `json:"description,omitempty"`
	Parameters  FunctionDefinitionParameters `json:"parameters"`
}

type FunctionDefinitionParameters struct {
	Type       string                        `json:"type"`
	Properties map[string]*jsonschema.Schema `json:"properties"`
	Required   []string                      `json:"required"`
}

type GenerateOptions struct {
	CallbackManger    CallbackManagerForModelRun
	Stop              []string
	Functions         []FunctionDefinition
	ForceFunctionCall bool
}

type Generation struct {
	Text    string
	Message ChatMessage
	Info    map[string]any
}

type GenericChatMessage struct {
	// contains filtered or unexported fields
}

type HumanChatMessage struct {
	// contains filtered or unexported fields
}

type LLM interface {
	Model
	// Generate generates text based on the provided prompt and options.
	Generate(ctx context.Context, prompt string, optFns ...func(o *GenerateOptions)) (*ModelResult, error)
}

type LLMStartInput struct {
	*LLMStartManagerInput
	RunID string
}

type LLMStartManagerInput struct {
	LLMType          string
	Prompt           string
	InvocationParams map[string]any
}

type Memory interface {
	// MemoryKeys returns the memory keys.
	MemoryKeys() []string
	// LoadMemoryVariables returns key-value pairs given the text input to the chain.
	LoadMemoryVariables(ctx context.Context, inputs map[string]interface{}) (map[string]interface{}, error)
	// SaveContext saves the context of this model run to memory.
	SaveContext(ctx context.Context, inputs map[string]interface{}, outputs map[string]interface{}) error
	// Clear clears memory contents.
	Clear(ctx context.Context) error
}

type Model interface {
	Tokenizer
	// Type returns the type of the model.
	Type() string
	// Verbose returns the verbosity setting of the model.
	Verbose() bool
	// Callbacks returns the registered callbacks of the model.
	Callbacks() []Callback
	// InvocationParams returns the parameters used in the model invocation.
	InvocationParams() map[string]any
}

type ModelEndInput struct {
	*ModelEndManagerInput
	RunID string
}

type ModelEndManagerInput struct {
	Result *ModelResult
}

type ModelErrorInput struct {
	*ModelErrorManagerInput
	RunID string
}

type ModelErrorManagerInput struct {
	Error error
}

type ModelNewTokenInput struct {
	*ModelNewTokenManagerInput
	RunID string
}

type ModelNewTokenManagerInput struct {
	Token string
}

type ModelResult struct {
	Generations []Generation
	LLMOutput   map[string]any
}

type OutputFormat string

type OutputParser[T any] interface {
	// Parse parses the output of an LLM call.
	ParseResult(result Generation) (any, error)
	// Parse parses the output of an LLM call.
	Parse(text string) (T, error)
	// ParseWithPrompt parses the output of an LLM call with the prompt used.
	ParseWithPrompt(text string, prompt PromptValue) (T, error)
	// GetFormatInstructions returns a string describing the format of the output.
	GetFormatInstructions() string
	// Type returns the string type key uniquely identifying this class of parser
	Type() string
}

type PromptTemplate interface {
	// Format applies values to the template and returns the formatted result as a string.
	Format(values map[string]any) (string, error)

	// FormatPrompt applies values to the template and returns a PromptValue representation of the formatted result.
	FormatPrompt(values map[string]any) (PromptValue, error)

	// InputVariables returns a list of input variables used in the template.
	InputVariables() []string

	// OutputParser returns the output parser function and a boolean indicating if an output parser is defined.
	OutputParser() (OutputParser[any], bool)
}

type PromptValue interface {
	// String returns the string representation of the prompt value.
	String() string

	// Messages returns the chat messages associated with the prompt value.
	Messages() ChatMessages
}

type Retriever interface {
	GetRelevantDocuments(ctx context.Context, query string) ([]Document, error)
	// Verbose returns the verbosity setting of the retriever.
	Verbose() bool
	// Callbacks returns the registered callbacks of the retriever.
	Callbacks() []Callback
}

type RetrieverEndInput struct {
	*RetrieverEndManagerInput
	RunID string
}

type RetrieverEndManagerInput struct {
	Docs []Document
}

type RetrieverErrorInput struct {
	*RetrieverErrorManagerInput
	RunID string
}

type RetrieverErrorManagerInput struct {
	Error error
}

type RetrieverStartInput struct {
	*RetrieverStartManagerInput
	RunID string
}

type RetrieverStartManagerInput struct {
	Query string
}

type StringifyChatMessagesOptions struct {
	HumanPrefix    string
	AIPrefix       string
	SystemPrefix   string
	FunctionPrefix string
}

type SystemChatMessage struct {
	// contains filtered or unexported fields
}

type TextInput struct {
	*TextManagerInput
	RunID string
}

type TextManagerInput struct {
	Text string
}

type TextSplitter interface {
	SplitDocuments(docs []Document) ([]Document, error)
}

type TextToSpeech interface {
	// SynthesizeSpeech converts the given text to an audio stream.
	SynthesizeSpeech(ctx context.Context, text string) (AudioStream, error)
}

type Tokenizer interface {
	// GetNumTokens returns the number of tokens in the provided text.
	GetNumTokens(ctx context.Context, text string) (uint, error)
	// GetNumTokensFromMessage returns the number of tokens in the provided chat messages.
	GetNumTokensFromMessage(ctx context.Context, messages ChatMessages) (uint, error)
}

type Tool interface {
	// Name returns the name of the tool.
	Name() string
	// Description returns the description of the tool.
	Description() string
	// Run executes the tool with the given input and returns the output.
	Run(ctx context.Context, input any) (string, error)
	// ArgsType returns the type of the input argument expected by the tool.
	ArgsType() reflect.Type
	// Verbose returns the verbosity setting of the tool.
	Verbose() bool
	// Callbacks returns the registered callbacks of the tool.
	Callbacks() []Callback
}

type ToolEndInput struct {
	*ToolEndManagerInput
	RunID string
}

type ToolEndManagerInput struct {
	Output string
}

type ToolErrorInput struct {
	*ToolErrorManagerInput
	RunID string
}

type ToolErrorManagerInput struct {
	Error error
}

type ToolInput struct {
	// contains filtered or unexported fields
}

type ToolStartInput struct {
	*ToolStartManagerInput
	RunID string
}

type ToolStartManagerInput struct {
	ToolName string
	Input    *ToolInput
}

type VectorStore interface {
	AddDocuments(ctx context.Context, docs []Document) error
	SimilaritySearch(ctx context.Context, query string) ([]Document, error)
}