chat

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

type CompressionTransformerConfig struct {
	Model corechat.Model

	// PromptTemplate replaces the built-in prompt and must declare
	// {{.History}} and {{.Query}}.
	PromptTemplate *chatclient.Template
}

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

type ContextualAugmenterConfig struct {
	// Instructions is the guidance placed before the evidence block. The
	// augmenter always writes the evidence block and the query itself, so a
	// citation can never claim evidence the prompt omits. Empty uses the default.
	Instructions string

	// EmptyContextMessage is the prompt used when no documents are retrieved and
	// AllowEmptyContext is false. Empty uses the default.
	EmptyContextMessage string

	// AllowEmptyContext returns the query unchanged when no documents are
	// retrieved instead of using EmptyContextMessage.
	AllowEmptyContext bool

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

	// MaxContextTokens limits the encoded evidence block. Zero leaves context
	// unbounded. A positive value requires TokenCounter. Only complete
	// candidates that fit are included, in retrieval order. Oversized candidates
	// are skipped so later candidates can still fit. If none fits, Augment returns
	// ErrContextBudgetExceeded regardless of AllowEmptyContext.
	MaxContextTokens int
	TokenCounter     tokenizer.TextCounter
}

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

type ConversationTransformer interface {
	Transform(context.Context, ConversationQuery) (rag.Query, error)
}

type ConversationTransformerFunc func(context.Context, ConversationQuery) (rag.Query, error)

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

type MultiQueryExpanderConfig struct {
	Model corechat.Model

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

	// NumberOfQueries is the variant count requested from the model. Zero
	// uses [DefaultMultiQueryCount]; negative values are invalid.
	NumberOfQueries int

	// PromptTemplate replaces the built-in prompt and 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 rag.Retriever
	// QueryTransformer resolves conversational context for retrieval only;
	// augmentation still receives the active user question. Nil preserves it.
	QueryTransformer ConversationTransformer

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

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

type RerankModelConfig struct {
	Model corechat.Model
	// Templates must use Query and Documents so the original index remains the
	// only identity a generated ranking can return.
	PromptTemplate *chatclient.Template
}

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

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

type RewriteTransformerConfig struct {
	Model corechat.Model

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

	// PromptTemplate replaces the built-in prompt and must declare
	// {{.Target}} and {{.Query}}.
	PromptTemplate *chatclient.Template
}

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

type TranslationTransformerConfig struct {
	Model corechat.Model

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

	// PromptTemplate replaces the built-in prompt and must declare
	// {{.Target}} and {{.Query}}.
	PromptTemplate *chatclient.Template
}