Conversations
runConversation, the tool loop of @tensorpass/aiconnect, with its options and hooks, finalAnswer and the chat content helpers, with their types generated from the source.
Part of the @tensorpass/aiconnect reference. The tables are generated from the package's TypeScript source each time the docs are built. Open a row to see its full type.
runConversation
Runs the agent loop in the browser: the model answers or asks for tools, the site's tools run, their results go back to the model, until it answers in plain text.
Prop
Type
It returns the messages the conversation gained: the assistant turns and the tool results, ending with the final assistant answer. It leaves options.messages untouched, so append the result to your transcript yourself.
- It lists the tools once, then sends
messagesand the tool definitions tosession.chat. It sends no generation options; callsession.chatdirectly to set them. - It runs the tools the model asks for one after the other, in the model's order, and adds each result as a
toolmessage. - A tool that throws becomes a result with the text
Tool error:and the error's message, which the model reads. - A tool runs only when it was offered to the model at that step. A call to any other name gets a
Tool error:result and stays out of your tool source. One answer runsmaxToolCallstools at most (8 by default), and the calls past it get aTool error:result. - It stops when an answer has no tool calls, when no
toolswere given, or aftermaxStepssteps (6 by default). The last step offers no tools, so the model has to conclude. Tool calls in that last answer do not run, and the answer is kept as its text. - An error from
session.chat, such as a provider refusal or the visitor stopping the answer in the wallet, rejects the promise.
const { state } = client;
if (state.status === 'connected') {
const asked: ChatMessage = { role: 'user', content: 'A calm book for tonight' };
const added = await runConversation({
session: state.session,
tools,
messages: [{ role: 'system', content: SYSTEM }, asked],
onText: (delta) => output.append(delta),
});
transcript.push(asked, ...added);
}ConversationOptions
Prop
Type
- session. The
sessionof aconnectedstate. - messages. The conversation so far, system prompt first.
- tools. The tool source. Without it, the model answers once.
- maxSteps. The number of model calls at most. The default is 6.
- maxToolCalls. The number of tools one answer of the model runs at most. The default is 8.
- signal. Passed to
session.chaton each step, and checked before each tool runs. With the wallet's session, aborting it stops the chat in AI Wallet, and the promise rejects with the signal's reason. - onText, onToolCall, onToolResult. The hooks.
const controller = new AbortController();
stopButton.onclick = () => controller.abort();
const added = await runConversation({ session: state.session, tools, messages, maxSteps: 3, signal: controller.signal });ConversationHooks
Prop
Type
- onText. Each piece of the answer's text as it streams, across every step of the loop.
- onToolCall. A tool call, before the tool runs.
- onToolResult. The same call with its result, after the tool ran or failed.
await runConversation({
session: state.session,
tools,
messages,
onToolCall: (call) => showStatus(`Running ${call.name}`),
onToolResult: (call, result) => renderCards(call.name, result),
});finalAnswer
Prop
Type
Returns the last message when it is an assistant message, and null otherwise.
const added = await runConversation({ session: state.session, tools, messages });
const answer = finalAnswer(added)?.content ?? '';Chat content helpers
The functions that read a message's content, as parts or as text, and an image's data: URL as its media type and base64 data. AI Wallet's connectors use them in every translation.
Prop
Type
- contentParts(content). The content as parts. A string becomes one text part, and an empty string none.
- textOf(content). The text of the parts joined, without the images.
- inlineData(url). The media type and data of a base64
data:URL, ornullfor any other URL. - dataUrl(data). The
data:URL of anInlineData.
InlineData
Prop
Type
const question: UserMessage = {
role: 'user',
content: [
{ type: 'text', text: 'What does this label say?' },
{ type: 'image', url: dataUrl({ mediaType: 'image/png', data: PNG_BASE64 }) },
],
};
textOf(question.content); // 'What does this label say?'
// An Anthropic image block: inline data when the URL carries it, the URL otherwise.
const blocks = contentParts(question.content).map((part) => {
if (part.type === 'text') {
return { type: 'text', text: part.text };
}
const inline = inlineData(part.url);
return inline
? { type: 'image', source: { type: 'base64', media_type: inline.mediaType, data: inline.data } }
: { type: 'image', source: { type: 'url', url: part.url } };
});The client: AiConnect
AiConnect, the site's connection to the visitor's AI through AI Wallet, its connection states and options, the fetch for AI SDKs, WalletRequestError and the MCP tool source, with their types generated from the source.
Chat, tool and generation types
The messages, content parts, tools, JSON Schema, generation options, tool choice and response format that @tensorpass/aiconnect exchanges with AI Wallet, with their types generated from the source.