Struct GenerateTextResult 

pub struct GenerateTextResult {

    pub text: String,
    pub tool_calls: Vec<ToolCall>,
    pub finish_reason: FinishReason,
    pub usage: Usage,
    pub warnings: Vec<Warning>,
    pub raw: GenerateResult,
    pub reasoning: Vec<ReasoningPart>,
    pub reasoning_text: String,
    pub sources: Vec<SourcePart>,
    pub files: Vec<FilePart>,
    pub response_messages: Vec<ModelMessage>,
    pub raw_finish_reason: Option<String>,
    pub provider_metadata: Option<Value>,
    pub response: ResponseMetadata,
    pub total_usage: Usage,
}

Result of generate_text (user-facing).

Fields

text: String

The generated text (concatenated from all text content parts).

tool_calls: Vec<ToolCall>

Tool calls requested by the model.

finish_reason: FinishReason

Why generation stopped.

usage: Usage

Token usage.

warnings: Vec<Warning>

Warnings from the provider.

raw: GenerateResult

Raw provider result (for advanced use).

reasoning: Vec<ReasoningPart>

Reasoning / thinking segments from the model.

reasoning_text: String

Concatenated reasoning text (convenience for reasoning.iter().map(text).join("")).

sources: Vec<SourcePart>

Sources / citations (search-preview models).

files: Vec<FilePart>

Files generated by the model.

response_messages: Vec<ModelMessage>

Assistant messages ready to append to the prompt for the next turn (solves the multi-turn “manually build assistant message” footgun).

raw_finish_reason: Option<String>

The raw provider-specific finish reason string (e.g. “stop”, “end_turn”, “safety”). Useful when finish_reason.unified is Other.

provider_metadata: Option<Value>

Provider-specific metadata (e.g. Anthropic cache info). Mirrored from raw.provider_metadata for top-level convenience.

response: ResponseMetadata

Response metadata (id, timestamp, model_id). Mirrored from raw.response for top-level convenience.

total_usage: Usage

Total token usage across all steps. In single-step mode (aimux’s default), total_usage equals usage. Provided for AI SDK parity.

Trait Implementations

impl Debug for GenerateTextResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GenerateTextResult

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GenerateTextResult

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for GenerateTextResult

type WithoutGenerics = GenerateTextResult

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = GenerateTextResult

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.