Documentation
¶
Overview ¶
Package summary is designed to provide a comprehensive set of tools for automated text summarization.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Cohere ¶
type Cohere struct {
// contains filtered or unexported fields
}
Cohere represents a text summarization algorithm powered by Cohere's AI models.
type Legacy ¶
Legacy implements the Summarizer interface using the tldr.Bag package to perform local summarization.
type Ollama ¶
type Ollama struct {
// contains filtered or unexported fields
}
Ollama represents a text summarization client for Ollama LLM service.
type OpenRouter ¶
type OpenRouter struct {
// contains filtered or unexported fields
}
OpenRouter represents a text summarization client for OpenRouter LLM service.
func NewOpenRouter ¶
func NewOpenRouter(c *http.Client, opts *config.Options) *OpenRouter
NewOpenRouter creates a `OpenRouter` instance with the specified `http.Client` and options. If the `http.Client` instance is `nil`, the default client is used. This function returns a pointer to the newly created `OpenRouter` instance and an error, if any.
type Requesty ¶
type Requesty struct {
// contains filtered or unexported fields
}
Requesty represents a text summarization client for Requesty LLM service.
func NewRequesty ¶
NewRequesty creates a `Requesty` instance with the specified `http.Client` and options. If the `http.Client` instance is `nil`, the default client is used. This function returns a pointer to the newly created `Requesty` instance and an error, if any.
type Summarizer ¶
Summarizer is the interface that wraps the basic Summarize method.
Summarize takes in a string of text and returns a summary.
func NewSummary ¶
func NewSummary(opts *config.Options) Summarizer
NewSummary creates and returns a Summarizer based on the configured LLM provider. It inspects opts.LLMProvider() (case-insensitive) and constructs a provider-specific handler. It falls back to the legacy summarizer implementation. The returned Summarizer wraps the chosen handler.