@spec grouped_task(WeaviateEx.Client.t(), collection_name(), prompt(), opts()) ::
  {:ok, [map()]} | {:error, WeaviateEx.Error.t()}

Generate per-object results (grouped task).

Each retrieved object gets its own generated result with property interpolation.

Parameters

• client - WeaviateEx client
• collection_name - Name of the collection
• prompt - Generation prompt with optional {property} interpolation
• opts - Options (same as single_prompt/4)

Examples

{:ok, results} = Generative.grouped_task(client, "Article",
  "Summarize: {title}",
  provider: :openai,
  limit: 10
)

# Each result has _additional.generate.groupedResult

Returns

• {:ok, [map()]} - List of objects with generated results
• {:error, Error.t()} - Error if generation fails

@spec single_prompt(WeaviateEx.Client.t(), collection_name(), prompt(), opts()) ::
  {:ok, map()} | {:error, WeaviateEx.Error.t()}

Generate a single result from all retrieved objects.

The prompt can use property interpolation with {property_name} syntax.

Parameters

• client - WeaviateEx client
• collection_name - Name of the collection
• prompt - Generation prompt with optional {property} interpolation
• opts - Options:
  • :provider - AI provider (required)
  • :model - Model name (provider-specific)
  • :properties - Properties to retrieve for interpolation
  • :near_text - Semantic search query
  • :where - Filter conditions
  • :limit - Number of objects to retrieve
  • :temperature - Sampling temperature (0.0-1.0)
  • :max_tokens - Maximum tokens to generate
  • :top_p - Nucleus sampling parameter

Examples

# Basic generation with OpenAI
{:ok, result} = Generative.single_prompt(client, "Article",
  "Summarize these articles about {title}",
  provider: :openai
)

# With Anthropic Claude
{:ok, result} = Generative.single_prompt(client, "Article",
  "Explain {title} in simple terms",
  provider: :anthropic,
  model: "claude-3-5-sonnet-20241022",
  temperature: 0.7
)

# With semantic search
{:ok, result} = Generative.single_prompt(client, "Article",
  "What are the main themes?",
  near_text: "artificial intelligence",
  provider: :openai,
  max_tokens: 500
)

Returns

• {:ok, map()} - Generated result with "singleResult" and "error" keys
• {:error, Error.t()} - Error if generation fails

@spec supported_providers() :: [provider()]

List all supported providers.

@spec valid_provider?(atom()) :: boolean()

Check if provider is valid.

Examples

Generative.valid_provider?(:openai)  # => true
Generative.valid_provider?(:invalid) # => false

@spec with_generate(map(), prompt(), opts()) :: map()

Add generation clause to existing query map.

This is a helper for query builder integration.

Examples

query = %{collection: "Article", fields: ["title"]}
query = Generative.with_generate(query, "Summarize {title}", provider: :openai)

Returns

• query - Modified query map with generate clause