Module completion

Expand description

High-level prompting traits and runtime errors for the classic agent runtime.

Modules§

CompletionRequest: Struct representing a general completion request that can be sent to a completion model provider.
CompletionRequestBuilder: Builder struct for constructing a completion request.
CompletionResponse: General completion response struct: the completion choice plus normalized response metadata. The completion choice contains one or more assistant content items.
Document
ProviderCapabilities: Provider behavior that affects how runtimes prepare completion requests.
ProviderToolDefinition: Provider-native tool definition.
ResponseIdentity: Response identity metadata for one completed model call: which provider objects this exact attempt produced. The three axes stay distinct — message-scoped, response-scoped, and transport — and every field is None when the provider did not report it: a documented outcome, never an error.
ToolDefinition
Usage: Struct representing the token usage for a completion request. If tokens used are 0, then the provider failed to supply token usage metrics.

AssistantContent: Describes responses from a provider which is either text or a tool call.
CompletionError: Errors returned by completion models.
FinishReason: Why the model stopped generating, normalized across providers.
Message: A provider-agnostic chat message.
MessageError: Error type to represent issues with converting messages to and from specific provider messages.
PromptError: Errors from classic agent prompting.
StructuredOutputError: Errors returned by typed structured prompting.

Chat: High-level prompting with caller-owned canonical chat history.
CompletionModel: Trait defining a completion model that can be used to generate completion responses. This trait is meant to be implemented by the user to define a custom completion model, either from a third party provider (e.g.: OpenAI) or a local model.
NormalizeCompletionResponse: Convert a provider’s own completion payload into the normalized CompletionResponse.
Prompt: High-level one-shot prompting for the classic runtime.
TypedPrompt: High-level typed structured prompting for the classic runtime.