para

head

OpenRouter::API::Result::Generation - Post-hoc generation metadata


code

=begin code :lang<raku>

# Look up a single call by its gen-id.
my $g = $or.get-generation('gen-abc123');
say "cost: \$", $g.total-cost;
say "latency: {$g.latency} ms";
say "finish: ", $g.finish-reason;
say "provider: ", $g.provider-name;

# Include the stored prompt + completion text (only when request
# logging was enabled on the account).
my $full = $or.get-generation-content($g.id);
say $full.prompt-text;
say $full.completion-text;

=end code


Unified wrapper over C<GET /generation> and C<GET /generation/content>.
The former returns cost / token / latency metadata; the latter
additionally returns the stored prompt messages and completion text
(when logging is enabled).


The Client merges both responses into a single C<Generation> when
C<get-generation-content> is called — C<prompt-text> /
C<completion-text> / C<reasoning-text> stay Nil unless the content
fetch happened.



unit class OpenRouter::API::Result::Generation;

has %!data;           # /generation response
has %!content;        # /generation/content response (optional)

submethod BUILD(:%!data, :%!content) { }

method new(:%data, :%content --> OpenRouter::API::Result::Generation:D) {
	self.bless(:%data, :%content);
}

# --- core identifiers + model routing --------------------------------

method id(--> Str)             { %!data<id> }
method upstream-id(--> Str)    { %!data<upstream_id> }
method model(--> Str)          { %!data<model> }
method provider-name(--> Str)  { %!data<provider_name> }
method api-type(--> Str)       { %!data<api_type> }
method streamed(--> Bool)      { %!data<streamed> // False }
method cancelled(--> Bool)     { %!data<cancelled> // False }
method created-at(--> Str)     { %!data<created_at> }
method finish-reason(--> Str)  { %!data<finish_reason> }
method native-finish-reason(--> Str) { %!data<native_finish_reason> }

# --- usage / cost ----------------------------------------------------

method tokens-prompt(--> Int)               { %!data<tokens_prompt> // 0 }
method tokens-completion(--> Int)           { %!data<tokens_completion> // 0 }
method native-tokens-prompt(--> Int)        { %!data<native_tokens_prompt> // 0 }
method native-tokens-completion(--> Int)    { %!data<native_tokens_completion> // 0 }
method native-tokens-reasoning(--> Int)     { %!data<native_tokens_reasoning> // 0 }
method native-tokens-cached(--> Int)        { %!data<native_tokens_cached> // 0 }

method total-cost(--> Numeric)              { %!data<total_cost> // %!data<usage> // 0 }
method upstream-inference-cost(--> Numeric) { %!data<upstream_inference_cost> }
method cache-discount(--> Numeric)          { %!data<cache_discount> }
method is-byok(--> Bool)                    { %!data<is_byok> // False }

#|( USD per token, derived from C<total-cost> and the sum of prompt
    + completion tokens. Returns 0 when tokens aren't recorded. )
method cost-per-token(--> Numeric) {
	my $tokens = self.tokens-prompt + self.tokens-completion;
	return 0 unless $tokens;
	return self.total-cost / $tokens;
}

# --- latency ---------------------------------------------------------

method latency(--> Int)             { %!data<latency> // 0 }
method generation-time(--> Int)     { %!data<generation_time> // 0 }
method moderation-latency(--> Int)  { %!data<moderation_latency> // 0 }

# --- stored content (only when content-fetch happened) --------------

#|( Stored prompt messages, as an array of C<{role, content}> hashes.
    Only populated when constructed from C<get-generation-content>.
    Returns the empty list otherwise. )
method prompt-messages(--> List) {
	(%!content<input><messages> // []).List;
}

#|( Convenience: join stored prompt-message contents into a single
    string. Returns the empty string when content wasn't fetched. )
method prompt-text(--> Str) {
	self.prompt-messages.map({ $_<content> // '' }).join("\n");
}

method completion-text(--> Str) {
	%!content<output><completion> // '';
}

method reasoning-text(--> Str) {
	%!content<output><reasoning> // '';
}

method has-content(--> Bool:D) {
	%!content.elems.Bool;
}

# --- raw -------------------------------------------------------------

method raw(--> Hash)         { %!data.Hash }
method raw-content(--> Hash) { %!content.Hash }


root

Model

Endpoint

React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<AI|file:../mcp/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>
    =item2 L<Hand these documents to an AI assistant|file:../mcp/index.podlite>

=end nested
=begin nested :!nested
=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>

=end nested
=end React


Built with L<Podlite|https://podlite.org> — the markup and publishing tools behind this site.


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


Generation

NAME

SYNOPSIS

DESCRIPTION

OpenRouter::API v0.1.1

Authors

License

Dependencies

Test Dependencies

Provides

Documentation