chat

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

type CompressionTransformerConfig struct {
	// Model performs the compression. Required.
	Model corechat.Model

	// PromptTemplate is the LLM prompt. Defaults to
	// [compressionDefaultTemplate]. Custom templates must declare
	// {{.History}} and {{.Query}}.
	PromptTemplate *chatclient.Template
}

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

type ContextualAugmenterConfig struct {
	// PromptTemplate is the augmentation template. Defaults to
	// [contextualDefaultTemplate]. Custom templates must declare
	// {{.Context}} and {{.Query}}.
	PromptTemplate *chatclient.Template

	// EmptyContextPromptTemplate is the response template used when no
	// documents are retrieved AND AllowEmptyContext is false. Defaults
	// to [contextualEmptyContextTemplate].
	EmptyContextPromptTemplate *chatclient.Template

	// AllowEmptyContext, when true, returns the user's query unchanged
	// if no documents were retrieved instead of synthesizing the
	// empty-context fallback. Defaults to false.
	AllowEmptyContext bool

	// Formatter renders each retrieved document. The default [rag.TextFormatter]
	// rejects media with [rag.ErrUnsupportedMedia].
	Formatter rag.DocumentFormatter

	// MaxContextTokens limits the encoded evidence block. Zero leaves context
	// unbounded. A positive value requires TokenCounter. Only complete
	// candidates are included, in retrieval order.
	MaxContextTokens int

	// TokenCounter measures the exact encoded evidence block against
	// MaxContextTokens.
	TokenCounter tokenizer.TextCounter
}

type Evidence struct {
	Candidates rag.Candidates
	Citations  rag.Citations
}

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

type MultiQueryExpanderConfig struct {
	// Model produces the variants. Required.
	Model corechat.Model

	// IncludeOriginal prepends the original query to the variant list.
	// Defaults to false.
	IncludeOriginal bool

	// NumberOfQueries is the variant count requested from the model.
	// Defaults to [DefaultMultiQueryCount]. Must be ≥ 0.
	NumberOfQueries int

	// PromptTemplate is the LLM prompt. Defaults to
	// [multiExpanderDefaultTemplate]. Custom templates must declare
	// {{.Number}} and {{.Query}}.
	PromptTemplate *chatclient.Template
}

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

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

type PreparerConfig struct {
	// Retriever fetches documents for the latest user message. Required.
	Retriever rag.Retriever

	// Augmenter folds retrieved documents into the outgoing user message.
	// Required; use [rag.IdentityAugmenter] for retrieval without prompt changes.
	Augmenter rag.Augmenter
}

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

type RerankerConfig struct {
	// Model ranks candidates. Required.
	Model corechat.Model

	// PromptTemplate defaults to [chatRerankerDefaultTemplate]. Custom
	// templates must declare {{.Query}} and {{.Candidates}}.
	PromptTemplate *chatclient.Template

	// Formatter renders candidate content. The default [rag.TextFormatter]
	// rejects media with [rag.ErrUnsupportedMedia].
	Formatter rag.DocumentFormatter
}

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

type RewriteTransformerConfig struct {
	// Model performs the rewrite. Required.
	Model corechat.Model

	// TargetSearchSystem names the downstream search engine — "vector
	// store", "web search engine", "database", etc. Required.
	TargetSearchSystem string

	// PromptTemplate is the LLM prompt. Defaults to
	// [rewriteDefaultTemplate]. Custom templates must declare
	// {{.Target}} and {{.Query}}.
	PromptTemplate *chatclient.Template
}

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

type TranslationTransformerConfig struct {
	// Model performs the translation. Required.
	Model corechat.Model

	// TargetLanguage is the language the embedding model expects —
	// "English", "Chinese", "Spanish", etc. Required.
	TargetLanguage string

	// PromptTemplate is the LLM prompt. Defaults to
	// [translationDefaultTemplate]. Custom templates must declare
	// {{.Target}} and {{.Query}}.
	PromptTemplate *chatclient.Template
}