Contracts
=========

.. This page is generated by smarter-nodejs's scripts/generate-reference.ts. Do not edit it.

The mirrors of the platform's api contracts: the Smarter Chat api (version 2), the Smarter Journal, and the Django-React integration.

.. js:class:: ViteManifest(chunks, buildInfo)

   A React app's Vite-generated ``manifest.json``: its chunks, keyed by source path, and Smarter's build information.

   **Example**

   .. code-block:: typescript

      const manifest = ViteManifest.parse(JSON.parse(readFileSync("manifest.json", "utf-8")));
      const entry = manifest.entryKey();
      if (entry) console.log(manifest.collectAssets(entry, "js"));

   :param chunks: The chunks, keyed by source path.
   :type chunks: Record<string, ViteManifestChunk>
   :param buildInfo: The build information.
   :type buildInfo: object | null

   .. js:attribute:: buildInfo

      The ``_custom`` build information, if the package's vite.config.ts adds it.

      :type: object | null

   .. js:attribute:: chunks

      The manifest's chunks, keyed by source path.

      :type: Record<string, ViteManifestChunk>

   .. js:attribute:: isEmpty

      Whether the manifest has any chunks.

      :type: boolean

   .. js:method:: collectAssets(key, assetType, seen)

      Recursively collect the JS or CSS files of a chunk and of its static imports.

      A chunk's own files come first, followed by those of each of its ``imports``, depth first, in the
      order they are listed. Each chunk is visited once, so circular imports terminate.

      :param key: The manifest key of the chunk to collect assets for.
      :type key: string
      :param assetType: ``js`` for the chunks' ``file``, ``css`` for their ``css`` files.
      :type assetType: ReactAssetType
      :param seen: The keys already visited, used by the recursion.
      :type seen: Set<string>
      :returns: The asset file paths, relative to the app's static directory.
      :rtype: string[]

   .. js:method:: entryKey()

      The key of the manifest's entry point, the first chunk with ``"isEntry": true``.

      :returns: The entry point's key, or null if the manifest has no entry point.
      :rtype: string | null

   .. js:method:: toJSON()

      The manifest in the shape of manifest.json, with the build information as its ``_custom`` entry.

      :returns: The chunks, keyed by source path, and ``_custom``.
      :rtype: Record<string, ViteManifestChunk | ReactAppBuildInfo>

   .. js:method:: parse(data)

      Validate a manifest.json's content, and split its ``_custom`` entry from its chunks.

      :param data: The parsed manifest.json.
      :type data: unknown
      :returns: The manifest.
      :throws ZodError: If an entry is not a chunk.
      :rtype: ViteManifest

.. js:function:: messageText(message)

   A message's text: its content, or the text of its text parts, joined by blank lines.

   :param message: The message.
   :type message: object
   :returns: The text, or an empty string.
   :rtype: string

.. js:function:: promptText(result)

   The text of the LLM's final reply: the last assistant message that has content, or an empty string.

   :param result: A prompt's result, e.g. a prompt response's ``data``.
   :type result: object
   :returns: The text.
   :rtype: string

.. js:function:: SmarterJournaledResponse(data)

   The schema of a successful journaled response: the envelope, the response's ``data``, and an optional ``message``.

   :param data: The schema of the endpoint's ``data``.
   :type data: T
   :returns: The response's schema.
   :rtype: object

.. js:function:: withPromptText(response)

   Add the non-enumerable ``text`` getter to a prompt response.

   :param response: The response.
   :type response: object
   :returns: The same object, as a ``PromptResponse``.
   :rtype: PromptResponse

.. js:data:: BUILD_INFO_KEY

   The key of the build information that each React package's ``vite.config.ts`` adds to its manifest.json.

   :type: "_custom"

.. js:data:: CHAT_CONTRACT_V2

   The version of the Smarter Chat api contract that the SDK reads.

   :type: 2

.. js:data:: CHAT_CONTRACT_V2_CAPABILITY

   The ``X-Smarter-Capabilities`` value with which the SDK asks for version 2 of the contract.

   :type: "chat-contract-v2"

.. js:class:: JournalEntry

   A Smarter Journal entry, as ``/api/v1/journal/`` returns it.

   The list returns entries without ``request`` and ``response``. Retrieving one entry by its key
   includes them. Only superusers may read the journal, because the request documents hold the
   callers' credentials.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: command

      :type: string

   .. js:attribute:: createdAt

      :type: string | null | undefined

   .. js:attribute:: key

      :type: string

   .. js:attribute:: request

      :type: JsonValue | null | undefined

   .. js:attribute:: response

      :type: JsonValue | null | undefined

   .. js:attribute:: statusCode

      :type: number

   .. js:attribute:: thing

      :type: string

   .. js:attribute:: user

      The username of the caller, or null for an anonymous request.

      :type: string | null | undefined

.. js:class:: JournalPage

   One page of the journal's entries.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: objects

      :type: object[]

   .. js:attribute:: pagination

      :type: object

.. js:class:: JournalPagination

   The description of one page of the journal's entries.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: count

      :type: number

   .. js:attribute:: numPages

      :type: number

   .. js:attribute:: ordering

      :type: string

   .. js:attribute:: page

      :type: number

   .. js:attribute:: pageSize

      :type: number

   .. js:attribute:: search

      :type: string

   .. js:attribute:: sortFields

      :type: string[]

.. js:data:: LLM_MESSAGE_ROLES

   The message roles that the LLM providers accept. Smarter's own roles, ``smarter`` and ``smarter_error``, are informational.

   :type: unknown

.. js:class:: PromptChatApiAudioPart

   An audio part of a message's content.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: input_audio

      :type: object

   .. js:attribute:: type

      :type: "input_audio"

.. js:class:: PromptChatApiChoice

   A choice of a chat completion.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: finish_reason

      e.g. stop, length or tool_calls.

      :type: string | null | undefined

   .. js:attribute:: index

      :type: number

   .. js:attribute:: message

      :type: object | null | undefined

.. js:class:: PromptChatApiCompletion

   The LLM's chat completion, in the format of the OpenAI api.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: choices

      :type: object[]

   .. js:attribute:: created

      :type: number | null | undefined

   .. js:attribute:: id

      :type: string | null | undefined

   .. js:attribute:: model

      :type: string | null | undefined

   .. js:attribute:: object

      :type: string | null | undefined

   .. js:attribute:: service_tier

      :type: string | null | undefined

   .. js:attribute:: system_fingerprint

      :type: string | null | undefined

   .. js:attribute:: usage

      :type: object | null | undefined

.. js:class:: PromptChatApiConfig

   An LLMClient's chat configuration: the LLMClient, the chat session's key and history, and its plugins and functions.

   A new session's configuration has an empty history. Pass its ``session_key`` to the prompt api to
   continue the session.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: contract

      :type: number

   .. js:attribute:: debug_mode

      The platform's ``ENABLE_REACTAPP_DEBUG_MODE`` waffle switch.

      :type: boolean

   .. js:attribute:: functions

      :type: object | null | undefined

   .. js:attribute:: history

      :type: object

   .. js:attribute:: llmclient

      :type: object

   .. js:attribute:: meta_data

      :type: object

   .. js:attribute:: plugins

      :type: object

   .. js:attribute:: sandbox_mode

      True for a workbench url.

      :type: boolean

   .. js:attribute:: session_key

      The chat session's key.

      :type: string

.. js:class:: PromptChatApiConfigRequest

   The configuration api's request body.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: session_key

      The chat session's key, or null for a new session.

      :type: string | null | undefined

.. js:class:: PromptChatApiConfigResponse

   The configuration api's response.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: api

      The api version, e.g. ``smarter.sh/v1``.

      :type: string

   .. js:attribute:: data

      :type: object

   .. js:attribute:: metadata

      :type: object

.. js:data:: PromptChatApiContentPart

   A part of a message whose content is a list of parts, by its ``type``.

   :type: object | object | object | object | object

.. js:class:: PromptChatApiEnvelope

   The fields that every chat response adds beside ``data``.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: api

      The api version, e.g. ``smarter.sh/v1``.

      :type: string

   .. js:attribute:: metadata

      :type: object

.. js:class:: PromptChatApiErrorBody

   The ``error`` of a chat error response.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: description

      A human-readable description.

      :type: string

   .. js:attribute:: errorClass

      The name of the error's class, e.g. ``NotFound`` or ``LLMProviderError``.

      :type: string

   .. js:attribute:: status

      The http status.

      :type: number

.. js:class:: PromptChatApiErrorResponse

   A chat error response.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: api

      :type: string | null | undefined

   .. js:attribute:: error

      :type: object

   .. js:attribute:: metadata

      :type: object | null | undefined

.. js:class:: PromptChatApiFilePart

   A file part of a message's content.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: file

      :type: object

   .. js:attribute:: type

      :type: "file"

.. js:class:: PromptChatApiFileRef

   A file, base64 encoded, or by the provider's file id.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: file_data

      :type: string | null | undefined

   .. js:attribute:: file_id

      :type: string | null | undefined

   .. js:attribute:: filename

      :type: string | null | undefined

.. js:class:: PromptChatApiFunctionCall

   The function that a tool call calls.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: arguments

      The function's arguments, as a JSON string.

      :type: string

   .. js:attribute:: name

      :type: string

.. js:class:: PromptChatApiFunctionList

   The LLMClient's built-in functions.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: functions

      :type: object[]

   .. js:attribute:: meta_data

      :type: object

.. js:class:: PromptChatApiHistory

   The chat session's history.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: chat_history

      The session's messages, which restore the chat thread.

      :type: object[]

   .. js:attribute:: llmclient_request_history

      :type: object[] | null | undefined

   .. js:attribute:: plugin_selector_history

      :type: object[] | null | undefined

   .. js:attribute:: prompt_plugin_usage_history

      :type: object[] | null | undefined

   .. js:attribute:: prompt_tool_call_history

      :type: object[] | null | undefined

.. js:class:: PromptChatApiImagePart

   An image part of a message's content.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: image_url

      :type: object

   .. js:attribute:: type

      :type: "image_url"

.. js:class:: PromptChatApiImageUrl

   An image, by its url or as a data url.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: detail

      :type: string | null | undefined

   .. js:attribute:: url

      :type: string

.. js:class:: PromptChatApiInputAudio

   Audio, base64 encoded.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: data

      :type: string

   .. js:attribute:: format

      :type: string

.. js:class:: PromptChatApiJournalMetadata

   The ``metadata`` of a chat response.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: command

      The journal's command, e.g. ``prompt``.

      :type: string | null | undefined

   .. js:attribute:: key

      :type: string | null | undefined

   .. js:attribute:: thing

      The journal's thing, e.g. ``LLMClient``.

      :type: string | null | undefined

.. js:class:: PromptChatApiListMetaData

   The counts of a list of the LLMClient's plugins or functions.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: functions_returned

      :type: number | null | undefined

   .. js:attribute:: plugins_returned

      :type: number | null | undefined

   .. js:attribute:: total_functions

      :type: number | null | undefined

   .. js:attribute:: total_plugins

      :type: number | null | undefined

.. js:class:: PromptChatApiLLMClient

   The LLMClient, as its configuration describes it.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: app_assistant

      :type: string | null | undefined

   .. js:attribute:: app_example_prompts

      :type: string[] | null | undefined

   .. js:attribute:: app_file_attachment

      :type: boolean | null | undefined

   .. js:attribute:: app_info_url

      :type: string | null | undefined

   .. js:attribute:: app_name

      :type: string | null | undefined

   .. js:attribute:: app_placeholder

      :type: string | null | undefined

   .. js:attribute:: app_welcome_message

      :type: string | null | undefined

   .. js:attribute:: default_model

      :type: string | null | undefined

   .. js:attribute:: default_system_role

      The system prompt of a new chat session.

      :type: string | null | undefined

   .. js:attribute:: deployed

      :type: boolean | null | undefined

   .. js:attribute:: id

      :type: number

   .. js:attribute:: name

      :type: string

   .. js:attribute:: provider

      :type: string | null | undefined

   .. js:attribute:: styles

      :type: object | null | undefined

   .. js:attribute:: url_llmclient

      The url of the LLMClient's prompt api.

      :type: string | null | undefined

   .. js:attribute:: version

      :type: string | null | undefined

.. js:class:: PromptChatApiLLMClientFunction

   A built-in function of the LLMClient.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: created_at

      :type: string | null | undefined

   .. js:attribute:: id

      :type: number

   .. js:attribute:: llmclient

      :type: number

   .. js:attribute:: name

      get_current_weather, date_calculator or calculator.

      :type: string | null | undefined

   .. js:attribute:: updated_at

      :type: string | null | undefined

.. js:class:: PromptChatApiLLMClientPlugin

   A plugin of the LLMClient.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: created_at

      :type: string | null | undefined

   .. js:attribute:: id

      :type: number

   .. js:attribute:: llmclient

      :type: number

   .. js:attribute:: plugin_meta

      :type: object

   .. js:attribute:: updated_at

      :type: string | null | undefined

.. js:class:: PromptChatApiLLMClientRequest

   A request that Smarter sent to the LLM.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: created_at

      :type: string | null | undefined

   .. js:attribute:: id

      :type: number

   .. js:attribute:: is_aggregation

      :type: boolean | null | undefined

   .. js:attribute:: llmclient

      :type: number

   .. js:attribute:: request

      :type: object | null | undefined

   .. js:attribute:: session_key

      :type: string | null | undefined

   .. js:attribute:: updated_at

      :type: string | null | undefined

.. js:class:: PromptChatApiMessage

   A message of a chat thread, in the format of the OpenAI api.

   Smarter adds its own roles: ``smarter`` for informational messages (e.g. the prompt's
   configuration, the tools presented to the LLM, and its token charges), and ``smarter_error``. These
   are saved in the session's history, and are never sent to the LLM.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: content

      The message's text, or a list of content parts.

      :type: unknown | null | undefined

   .. js:attribute:: name

      The name of a tool message's function.

      :type: string | null | undefined

   .. js:attribute:: role

      system, assistant, user, tool, smarter or smarter_error.

      :type: string

   .. js:attribute:: tool_call_id

      The tool call that a tool message answers.

      :type: string | null | undefined

   .. js:attribute:: tool_calls

      An assistant message's tool calls.

      :type: object[] | null | undefined

.. js:class:: PromptChatApiMetaData

   The LLMClient's state.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: is_deployed

      :type: boolean | null | undefined

   .. js:attribute:: is_valid

      :type: boolean | null | undefined

   .. js:attribute:: ready

      :type: boolean | null | undefined

.. js:class:: PromptChatApiOrmModel

   The fields of a Django row that the contract returns.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: created_at

      :type: string | null | undefined

   .. js:attribute:: id

      :type: number

   .. js:attribute:: updated_at

      :type: string | null | undefined

.. js:class:: PromptChatApiPluginList

   The LLMClient's plugins.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: meta_data

      :type: object

   .. js:attribute:: plugins

      :type: object[]

.. js:class:: PromptChatApiPluginMeta

   A plugin's metadata.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: annotations

      :type: unknown | null | undefined

   .. js:attribute:: created_at

      :type: string | null | undefined

   .. js:attribute:: description

      :type: string | null | undefined

   .. js:attribute:: id

      :type: number

   .. js:attribute:: name

      :type: string

   .. js:attribute:: plugin_class

      api, skill, sql, static, websearch or imagesearch.

      :type: string

   .. js:attribute:: tags

      :type: string[]

   .. js:attribute:: updated_at

      :type: string | null | undefined

   .. js:attribute:: version

      :type: string | null | undefined

.. js:class:: PromptChatApiPluginSelection

   A plugin selector's decision in the chat session.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: created_at

      :type: string | null | undefined

   .. js:attribute:: id

      :type: number

   .. js:attribute:: messages

      :type: object[] | null | undefined

   .. js:attribute:: plugin_selector

      :type: number

   .. js:attribute:: search_term

      :type: string | null | undefined

   .. js:attribute:: session_key

      :type: string | null | undefined

   .. js:attribute:: updated_at

      :type: string | null | undefined

.. js:class:: PromptChatApiProgressEvent

   The data of a ``progress`` event: a step of a running prompt.

   Events may carry more fields, depending on their type, e.g. ``tool`` and ``arguments``.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: message

      A short sentence, which a chat ui can display as is.

      :type: string

   .. js:attribute:: type

      llm_request, tool_requested, tool_responded, plugin_called, mcp_tool_called, mcp_tool_responded or mcp_tool_failed.

      :type: string

.. js:class:: PromptChatApiProgressResult

   The data of the final ``result`` event.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: response

      Exactly the JSON of a non-streaming response.

      :type: unknown

   .. js:attribute:: status

      The prompt's http status.

      :type: number

.. js:class:: PromptChatApiPromptPluginUsage

   A use of a plugin in the chat session.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: created_at

      :type: string | null | undefined

   .. js:attribute:: id

      :type: number

   .. js:attribute:: input_text

      :type: string | null | undefined

   .. js:attribute:: plugin

      :type: number

   .. js:attribute:: prompt

      :type: number

   .. js:attribute:: updated_at

      :type: string | null | undefined

.. js:class:: PromptChatApiPromptRequest

   The prompt api's request body.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: messages

      :type: object[]

   .. js:attribute:: session_key

      :type: string | null | undefined

.. js:class:: PromptChatApiPromptResponse

   The prompt api's response.

   A failed prompt has ``error`` too, and its ``data.messages`` include a ``smarter_error`` message. The SDK
   adds a non-enumerable ``text`` getter to the responses that it returns: see ``promptText``.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: api

      The api version, e.g. ``smarter.sh/v1``.

      :type: string

   .. js:attribute:: data

      :type: object

   .. js:attribute:: error

      :type: object | null | undefined

   .. js:attribute:: metadata

      :type: object

.. js:class:: PromptChatApiPromptResult

   The result of a prompt.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: completion

      The LLM's chat completion.

      :type: object | null | undefined

   .. js:attribute:: contract

      :type: number

   .. js:attribute:: messages

      The messages that the prompt added to the chat thread, in order.

      :type: object[]

   .. js:attribute:: plugins

      The plugins that Smarter selected.

      :type: string[]

   .. js:attribute:: status

      The prompt's http status: 200, or the LLM provider's error status.

      :type: number

   .. js:attribute:: tools

      The functions that the LLM could call.

      :type: string[]

.. js:class:: PromptChatApiPromptToolCall

   A tool call of the chat session.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: created_at

      :type: string | null | undefined

   .. js:attribute:: function_args

      :type: string | null | undefined

   .. js:attribute:: function_name

      :type: string | null | undefined

   .. js:attribute:: id

      :type: number

   .. js:attribute:: plugin

      :type: number | null | undefined

   .. js:attribute:: prompt

      :type: number

   .. js:attribute:: request

      :type: JsonValue | null | undefined

   .. js:attribute:: response

      :type: JsonValue | null | undefined

   .. js:attribute:: updated_at

      :type: string | null | undefined

.. js:class:: PromptChatApiRefusalPart

   The LLM's refusal, as a part of a message's content.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: refusal

      :type: string

   .. js:attribute:: type

      :type: "refusal"

.. js:class:: PromptChatApiStyles

   The LLMClient's chat ui styles.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: app_background_image_size

      :type: string | null | undefined

   .. js:attribute:: app_background_image_url

      :type: string | null | undefined

   .. js:attribute:: app_logo_url

      :type: string | null | undefined

   .. js:attribute:: assistant_avatar_url

      :type: string | null | undefined

   .. js:attribute:: border_radius

      :type: string | null | undefined

   .. js:attribute:: buttons

      :type: object | null | undefined

   .. js:attribute:: conversation_header

      :type: object | null | undefined

   .. js:attribute:: font_family

      :type: string | null | undefined

   .. js:attribute:: font_size

      :type: string | null | undefined

   .. js:attribute:: google_font

      :type: string | null | undefined

   .. js:attribute:: incoming_message

      :type: object | null | undefined

   .. js:attribute:: main_container

      :type: object | null | undefined

   .. js:attribute:: message_input

      :type: object | null | undefined

   .. js:attribute:: message_list

      :type: object | null | undefined

   .. js:attribute:: outgoing_message

      :type: object | null | undefined

   .. js:attribute:: typing_indicator

      :type: object | null | undefined

   .. js:attribute:: user_avatar_url

      :type: string | null | undefined

.. js:class:: PromptChatApiStyleSection

   The colors of one section of the chat ui.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: background_color

      :type: string | null | undefined

   .. js:attribute:: border_color

      :type: string | null | undefined

   .. js:attribute:: color

      :type: string | null | undefined

   .. js:attribute:: editor_background_color

      :type: string | null | undefined

   .. js:attribute:: info_color

      :type: string | null | undefined

   .. js:attribute:: link_color

      :type: string | null | undefined

   .. js:attribute:: placeholder_color

      :type: string | null | undefined

.. js:class:: PromptChatApiTextPart

   A text part of a message's content.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: text

      :type: string

   .. js:attribute:: type

      :type: "text"

.. js:class:: PromptChatApiTokenDetails

   The breakdown of a completion's tokens.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: audio_tokens

      :type: number | null | undefined

   .. js:attribute:: cached_tokens

      :type: number | null | undefined

   .. js:attribute:: reasoning_tokens

      :type: number | null | undefined

.. js:class:: PromptChatApiToolCall

   A tool call of an assistant message.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: function

      :type: object

   .. js:attribute:: id

      :type: string

   .. js:attribute:: type

      :type: string

.. js:class:: PromptChatApiUsage

   A chat completion's token usage.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: completion_tokens

      :type: number | null | undefined

   .. js:attribute:: completion_tokens_details

      :type: object | null | undefined

   .. js:attribute:: prompt_tokens

      :type: number | null | undefined

   .. js:attribute:: prompt_tokens_details

      :type: object | null | undefined

   .. js:attribute:: total_tokens

      :type: number | null | undefined

.. js:class:: ReactAppAssets

   The ordered JS and CSS files of a React app's entry point, which a Django template includes.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: css

      The CSS files, the entry point's first.

      :type: string[]

   .. js:attribute:: js

      The JS files, the entry point's first.

      :type: string[]

.. js:class:: ReactAppBuildInfo

   The build information that each React package's ``vite.config.ts`` adds to its manifest.json, as ``_custom``.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: buildEnv

      The build's NODE_ENV, e.g. production.

      :type: string

   .. js:attribute:: buildTime

      When the app was built.

      :type: string

   .. js:attribute:: version

      The version of the app's npm package.

      :type: string

.. js:class:: SAMJournalApiEnvelope

   The fields that every journaled response adds beside its own data.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: api

      The api version, e.g. ``smarter.sh/v1``.

      :type: string

   .. js:attribute:: metadata

      :type: object | null | undefined

.. js:class:: SAMJournalApiErrorBody

   The ``error`` of a journaled error response. Every error of the cli api has this shape.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: args

      The exception's arguments, or the request's url.

      :type: JsonValue | null | undefined

   .. js:attribute:: cause

      The exception's cause.

      :type: string | null | undefined

   .. js:attribute:: command

      The journal's command, e.g. ``describe``.

      :type: string | null | undefined

   .. js:attribute:: context

      The exception's context, or the response's thing and command.

      :type: string | null | undefined

   .. js:attribute:: description

      A human-readable description of the error.

      :type: string | null | undefined

   .. js:attribute:: errorClass

      The name of the exception's class, e.g. ``SAMBrokerErrorNotFound``.

      :type: string

   .. js:attribute:: stacktrace

      The server's stack trace, when the platform includes it.

      :type: string | null | undefined

   .. js:attribute:: status

      The http status.

      :type: number

   .. js:attribute:: thing

      The journal's thing, e.g. ``Guardrail``.

      :type: string | null | undefined

.. js:class:: SAMJournalApiErrorResponse

   The body of a journaled error response.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: api

      The api version, e.g. ``smarter.sh/v1``.

      :type: string

   .. js:attribute:: error

      :type: object

   .. js:attribute:: metadata

      :type: object | null | undefined

.. js:class:: SAMJournalApiMetadata

   The ``metadata`` of a journaled response: its command and thing, and the key of its journal entry.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: command

      The journal's command, e.g. ``apply``.

      :type: string

   .. js:attribute:: key

      The key of the response's journal entry, when the journal is enabled.

      :type: string | null | undefined

   .. js:attribute:: thing

      The journal's thing, e.g. ``Guardrail``. The string ``None`` when there is none.

      :type: string

.. js:class:: SmarterJournalMessage

   A journaled response that carries only a ``message``, e.g. the response of delete or deploy.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: api

      The api version, e.g. ``smarter.sh/v1``.

      :type: string

   .. js:attribute:: message

      A human-readable message, e.g. ``LLMClient calculator applied``.

      :type: string | null | undefined

   .. js:attribute:: metadata

      :type: object | null | undefined

.. js:class:: ViteManifestChunk

   One entry of a Vite-generated ``manifest.json``: a chunk, or a static asset. See https://vite.dev/guide/backend-integration.

   A Zod schema, and the type of the same name that it validates.

   .. js:attribute:: assets

      The other static files that this chunk references.

      :type: string[]

   .. js:attribute:: css

      The CSS files that this chunk loads.

      :type: string[]

   .. js:attribute:: dynamicImports

      The manifest keys of dynamically imported chunks.

      :type: string[]

   .. js:attribute:: file

      The output file of this chunk, relative to the app's static directory.

      :type: string

   .. js:attribute:: imports

      The manifest keys of statically imported chunks.

      :type: string[]

   .. js:attribute:: isDynamicEntry

      Whether this chunk is a dynamic entry point.

      :type: boolean

   .. js:attribute:: isEntry

      Whether this chunk is an entry point.

      :type: boolean

   .. js:attribute:: name

      The chunk's name.

      :type: string | null | undefined

   .. js:attribute:: names

      The names of a static asset.

      :type: string[]

   .. js:attribute:: src

      The chunk's source path.

      :type: string | null | undefined

.. js:data:: PromptResponse

   A prompt response, with the text of the LLM's final reply.

   :type: unknown

.. js:data:: ReactAssetType

   The kinds of asset that a React app's entry point loads.

   :type: "js" | "css"