proposit-core
    Preparing search index...

    Type Alias TRetrievedResponse

    The structured result of a retrieveResponse call. All fields except status and rawResponseId are absent for non-terminal or failed responses.

    type TRetrievedResponse = {
        errorMessage?: string;
        incompleteReason?: string;
        output?: string;
        rawResponseId: string;
        status: TResponseStatus;
        tokenUsage?: TLlmTokenUsage;
    }
    Index

    Properties

    errorMessage? incompleteReason? output? rawResponseId status tokenUsage?

    Properties

    errorMessage?: string

    The envelope's error.message, present when status === "failed".

    incompleteReason?: string

    The envelope's incomplete_details.reason, present when status === "incomplete" (e.g. max_output_tokens, content_filter). Lets a completion-side consumer classify an incomplete response without re-deriving it.

    output?: string

    Parsed text output, present when status === "completed" and the response carried a message output item.

    rawResponseId: string

    The OpenAI response id that was retrieved.

    status: TResponseStatus

    Current status of the stored response.

    tokenUsage?: TLlmTokenUsage

    Token usage reported by OpenAI, when available.

    Settings

    Member Visibility

    On This Page

    Properties