llm

type BaseCache struct {
	Config      *CacheConfig
	Embedder    embedding.Embedder
	VectorStore vdb.VDB
	Ranker      Scorer
}

type Cache interface {
	Fetch(context.Context, []Message) (*CachedDocument, bool, error)
	Store(context.Context, *CachedDocument, string) error
}

type CacheConfig struct {
	TTL             time.Duration
	MaxEntries      int
	CleanupInterval time.Duration
	EnableMetrics   bool
	QueryProcessor  QueryProcessor
}

type CacheFactory func() Cache

type CachedDocument struct {
	ID     string
	Query  string
	Answer string
	Score  float64
	Vector []float64
}

type ChatCompletionMessage struct {
	Role    string `json:"role"`
	Content string `json:"content,omitempty"`
	// 多种类型内容（支持图片和文本）
	MultipartContent []*MultipartContent `json:"contents,omitnil,omitempty" name:"contents"`
	// For Role=assistant prompts this may be set to the tool calls generated by the model, such as function calls.
	ToolCalls []*ToolCall `json:"tool_calls,omitempty"`
	// For Role=tool prompts this should be set to the ID given in the assistant's prior request to call a tool.
	ToolCallID string `json:"tool_call_id,omitempty"`
}

type ChatCompletionRequest struct {
	Messages       []*ChatCompletionMessage `json:"messages,omitnil,omitempty" name:"messages"`
	*InvokeOptions                          // base request options
}

type ChatCompletionResponseFormat struct {
	Type       ChatCompletionResponseFormatType        `json:"type,omitempty"`
	JSONSchema *ChatCompletionResponseFormatJSONSchema `json:"json_schema,omitempty"`
}

type ChatCompletionResponseFormatJSONSchema struct {
	Name        string         `json:"name"`
	Description string         `json:"description,omitempty"`
	Schema      json.Marshaler `json:"schema"`
	Strict      bool           `json:"strict"`
}

type ChatCompletionResponseFormatType string

type ChatContent struct {
	// 内容类型
	// 注意：
	// 当前只支持传入单张图片，传入多张图片时，以第一个图片为准。
	// 注意：此字段可能返回 null，表示取不到有效值。
	Type string `json:"type,omitnil,omitempty" name:"type"`

	// 当 Type 为 text 时使用，表示具体的文本内容
	// 注意：此字段可能返回 null，表示取不到有效值。
	Text string `json:"text,omitnil,omitempty" name:"text"`

	// 图片的url，当 Type 为 image_url 时使用，表示具体的图片内容
	// 如"https://example.com/1.png" 或 图片的base64（注意 "data:image/jpeg;base64," 为必要部分）："data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAA......"
	// 注意：此字段可能返回 null，表示取不到有效值。
	ImageURL *ChatImageURL `json:"image_url,omitnil,omitempty" name:"image_url"`
}

type ChatImageURL struct {
	// 图片的 Url（以 http:// 或 https:// 开头）
	// 注意：此字段可能返回 null，表示取不到有效值。
	URL string `json:"url,omitnil,omitempty" name:"url"`
}

type Chunk struct {
	ID                string        `json:"id"`
	CreatedAt         int64         `json:"created_at"`
	Model             string        `json:"model"`
	Object            string        `json:"object"`
	SystemFingerprint string        `json:"system_fingerprint"`
	Choices           []*ChunkDelta `json:"choices"`
	Usage             *Usage        `json:"usage"`
	Delta             *ChunkDelta   `json:"-"`
}

type ChunkDelta struct {
	Index        int                     `json:"index"`
	FinishReason string                  `json:"finish_reason"`
	Logprobs     any                     `json:"logprobs"`
	Message      *assistantPromptMessage `json:"delta"`
}

type ConfigSupplier interface {
	Get(key string) any
}

type ConfigSupplierFunc func(key string) any

type ExactMatchScorer struct {
}

type FunctionCallBehavior string

type FunctionDefinition struct {
	// Name is the name of the function.
	Name string `json:"name"`
	// Description is a description of the function.
	Description string `json:"description"`
	// Parameters is a list of parameters for the function.
	Parameters map[string]any `json:"parameters,omitempty"`
}

type FunctionReference struct {
	// Name is the name of the function.
	Name string `json:"name"`
}

type Hook interface {
	OnBeforeInvoke(context.Context) context.Context
	OnAfterInvoke(ctx context.Context, err error)
	OnFirstChunk(context.Context, error) context.Context
}

type HookOption func(*OtelHook)

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

type InvokeOption func(*InvokeOptions)

type InvokeOptions struct {
	Stop           []string                      `json:"stop,omitempty"`
	ResponseFormat *ChatCompletionResponseFormat `json:"response_format,omitempty"`
	// LogitBias is must be a token id string (specified by their token ID in the tokenizer), not a word string.
	// incorrect: `"logit_bias":{"You": 6}`, correct: `"logit_bias":{"1639": 6}`
	// refs: https://platform.openai.com/docs/api-reference/chat/create#chat/create-logit_bias
	LogitBias map[string]int `json:"logit_bias,omitempty"`
	// LogProbs indicates whether to return log probabilities of the output tokens or not.
	// If true, returns the log probabilities of each output token returned in the content of message.
	// This option is currently not available on the gpt-4-vision-preview model.
	LogProbs bool `json:"logprobs,omitempty"`
	// TopLogProbs is an integer between 0 and 5 specifying the number of most likely tokens to return at each
	// token position, each with an associated log probability.
	// logprobs must be set to true if this parameter is used.
	TopLogProbs int `json:"top_logprobs,omitempty"`
	// Options for streaming response. Only set this when you set stream: true.
	StreamOptions *StreamOptions `json:"stream_options,omitempty"`

	// Model is the model to use.
	Model string `json:"model"`
	// Stream is the stream output.
	Stream bool `json:"stream,omitempty"`
	// CandidateCount is the number of response candidates to generate.
	CandidateCount int `json:"candidate_count,omitempty"`
	// MaxTokens is the maximum number of tokens to generate.
	MaxTokens int `json:"max_tokens,omitempty"`
	// Temperature is the temperature for sampling, between 0 and 1.
	Temperature float64 `json:"temperature,omitempty"`
	// StopWords is a list of words to stop on.
	StopWords []string `json:"stop_words,omitempty"`
	// StreamingFunc is a function to be called for each chunk of a streaming response.
	// Return an error to stop streaming early.
	StreamingFunc func(ctx context.Context, chunk []byte) error `json:"-"`
	// TopK is the number of tokens to consider for top-k sampling.
	TopK int `json:"top_k,omitempty"`
	// TopP is the cumulative probability for top-p sampling.
	TopP float64 `json:"top_p,omitempty"`
	// Seed is a seed for deterministic sampling.
	Seed int `json:"seed,omitempty"`
	// MinLength is the minimum length of the generated text.
	MinLength int `json:"min_length,omitempty"`
	// MaxLength is the maximum length of the generated text.
	MaxLength int `json:"max_length,omitempty"`
	// N is how many chat completion choices to generate for each input message.
	N int `json:"n,omitempty"`
	// RepetitionPenalty is the repetition penalty for sampling.
	RepetitionPenalty float64 `json:"repetition_penalty,omitempty"`
	// FrequencyPenalty is the frequency penalty for sampling.
	FrequencyPenalty float64 `json:"frequency_penalty,omitempty"`
	// PresencePenalty is the presence penalty for sampling.
	PresencePenalty float64 `json:"presence_penalty,omitempty"`

	// JSONMode is a flag to enable JSON mode.
	JSONMode bool `json:"json_mode,omitempty"`

	// Tools is a list of tools to use. Each tool can be a specific tool or a function.
	Tools []*Tool `json:"tools,omitempty"`
	// ToolChoice is the choice of tool to use, it can either be "none", "auto" (the default behavior), or a specific tool as described in the ToolChoice type.
	ToolChoice any `json:"tool_choice,omitempty"`

	// Metadata is a map of metadata to include in the request.
	// The meaning of this field is specific to the backend in use.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
}

type MemoCache struct {
	BaseCache
	// contains filtered or unexported fields
}

type Message interface {
	Content() string
	MultipartContent() []*MultipartContent
	Role() PromptMessageRole
	ToolID() string
	GetToolCalls() []*ToolCall
	String() string
}

type Messages[T PromptMessage | assistantPromptMessage] []T

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

type MultipartContent struct {
	Type string
	Data string
}

type NoneLogger struct {
}

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

type Option func(*Options)

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

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

type PromptMessage struct {
	Name string
	// contains filtered or unexported fields
}

type PromptMessageRole string

type Provider interface {
	Invoke(context.Context, []Message, ...InvokeOption) (*Response, error)
}

type QueryProcessor func([]Message) (string, error)

type RedisCache struct {
	BaseCache
	// contains filtered or unexported fields
}

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

type Result struct {
	Model string `json:"model"`
	// Messages          []*PromptMessage
	Message           *assistantPromptMessage `json:"message"`
	Usage             *Usage                  `json:"usage"`
	SystemFingerprint string                  `json:"system_fingerprint"`
}

type Scorer interface {
	Eval(string) float64
}

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

type StreamOptions struct {
	// If set, an additional chunk will be streamed before the data: [DONE] message.
	// The usage field on this chunk shows the token usage statistics for the entire request,
	// and the choices field will always be an empty array.
	// All other chunks will also include a usage field, but with a null value.
	IncludeUsage bool `json:"include_usage,omitempty"`
}

type Tool struct {
	// Type is the type of the tool.
	Type string `json:"type"`
	// Function is the function to call.
	Function *FunctionDefinition `json:"function,omitempty"`
}

type ToolCall struct {
	ID       string           `json:"id"`
	Type     string           `json:"type"`
	Index    int              `json:"index"`
	Function ToolCallFunction `json:"function"`
}

type ToolCallFunction struct {
	Name      string `json:"name"`
	Arguments string `json:"arguments"`
}

type ToolChoice struct {
	// Type is the type of the tool.
	Type string `json:"type"`
	// Function is the function to call (if the tool is a function).
	Function *FunctionReference `json:"function,omitempty"`
}

type Usage struct {
	PromptTokens     int    `json:"prompt_tokens"`
	CompletionTokens int    `json:"completion_tokens"`
	TotalTokens      int    `json:"total_tokens"`
	Currency         string `json:"currency"`
	Latency          int    `json:"latency"`
}