> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-drtangible-wip-test-inline-tag.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# LLM

> TypeScript SDK reference

An LLM call. Emits a `chat` span with `gen_ai.*` attributes.

Created by `weave.startLLM()` (or `turn.startLLM()`) and terminated with
`end()`. Only one LLM may be active in an async context at a time; nest
tool/subagent calls under it via `startTool` / `startSubagent`.

Populate `inputMessages` / `outputMessages` / `usage` / `reasoning` directly,
or via the helper functions (`output`, `think`, `attachMedia`, `record`).

All recorded data is flushed to the span at `end()`.

Defined in: [src/genai/llm.ts:90](https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/genai/llm.ts#L90)

## Examples

```ts twoslash theme={null}
// @noErrors
const llm = weave.startLLM({model: 'gpt-4o-mini', providerName: 'openai'});

try {
  llm.inputMessages = [{role: 'user', content: prompt}];
  const resp = await openai.chat.completions.create({...});
  llm.output(resp.choices[0].message.content ?? '');
  llm.record({usage: {inputTokens: resp.usage?.prompt_tokens}});
} finally {
  llm.end();
}
```

```ts twoslash theme={null}
// @noErrors
const llm = weave.startLLM({
  model: 'gpt-4o-mini',
  providerName: 'openai',
  systemInstructions: ['You are a helpful weather bot.'],
  startTime: new Date('2026-05-29T10:00:00.000Z'),
});

try {
  // ... call the LLM, populate llm.outputMessages / usage ...
} finally {
  llm.end();
}
```

## Extends

* `SpanBase`

## Properties

### inputMessages

> **inputMessages**: [`Message`](./message)\[] = `[]`

Input messages sent to the model. Flushed to `gen_ai.input.messages` on
`end()`.

Defined in: [src/genai/llm.ts:97](https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/genai/llm.ts#L97)

***

### model

> `readonly` **model**: `string`

Defined in: [src/genai/llm.ts:121](https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/genai/llm.ts#L121)

***

### outputMessages

> **outputMessages**: [`Message`](./message)\[] = `[]`

Assistant messages returned by the model. Flushed to
`gen_ai.output.messages` on `end()`.

Defined in: [src/genai/llm.ts:102](https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/genai/llm.ts#L102)

***

### providerName

> `readonly` **providerName**: `string`

Defined in: [src/genai/llm.ts:122](https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/genai/llm.ts#L122)

***

### reasoning

> `optional` **reasoning**: [`Reasoning`](./reasoning)

Chain-of-thought content. Folded into the last assistant message as a
ReasoningPart at serialization time.

Defined in: [src/genai/llm.ts:109](https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/genai/llm.ts#L109)

***

### usage

> **usage**: [`Usage`](./usage) = `{}`

Token counts and cache stats. Flushed to `gen_ai.usage.*` on `end()`.

Defined in: [src/genai/llm.ts:104](https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/genai/llm.ts#L104)

## Methods

### ~~addEvent()~~

<Warning>
  **Deprecated.** Record this data via [setAttributes](#setattributes) instead.
  OpenTelemetry is phasing out the Span Event API (`Span.addEvent`). This
  method still works and existing span-event data stays valid.
  See [https://opentelemetry.io/blog/2026/deprecating-span-events/](https://opentelemetry.io/blog/2026/deprecating-span-events/)
</Warning>

> **addEvent**(`name`, `attributes?`, `startTime?`): `this`

Add a named event to the span. Useful for marking non-span moments such as
context compaction, tool-loop detection, or guardrail trips. Warns and
no-ops after `end()`. Mirrors OTel `Span.addEvent`.

Defined in: [src/genai/spanBase.ts:84](https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/genai/spanBase.ts#L84)

#### Parameters

##### name

`string`

##### attributes?

`Attributes`

##### startTime?

`TimeInput`

#### Returns

`this`

#### Example

```ts twoslash theme={null}
// @noErrors
span.addEvent('context_compacted', {removedMessages: 12});
```

#### Inherited from

`SpanBase.addEvent`

***

### attachMedia()

> **attachMedia**(`opts`): `this`

Stage a media attachment for the LLM call. Pick exactly one of
`content` (inline base64 bytes), `uri` (URI reference), or `fileId`
(pre-uploaded file id). The attachment is glued onto the last user
message in `inputMessages` on `end()`.

Defined in: [src/genai/llm.ts:189](https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/genai/llm.ts#L189)

#### Parameters

##### opts

\{ `content`: `string`; `mimeType`: `string`; `modality`: [`Modality`](../type-aliases/modality); } | \{ `modality`: [`Modality`](../type-aliases/modality); `uri`: `string`; } | \{ `fileId`: `string`; `mimeType?`: `string`; `modality`: [`Modality`](../type-aliases/modality); }

#### Returns

`this`

***

### attachMediaUrl()

> **attachMediaUrl**(`url`, `opts`): `this`

Convenience for `attachMedia({uri, modality})`.

Defined in: [src/genai/llm.ts:198](https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/genai/llm.ts#L198)

#### Parameters

##### url

`string`

##### opts

###### modality

[`Modality`](../type-aliases/modality)

#### Returns

`this`

***

### end()

> **end**(`opts?`): `void`

Flush accumulated state and close the span. Idempotent. Pass `error` to mark failed; pass `endTime` to backdate the close.

Defined in: [src/genai/llm.ts:282](https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/genai/llm.ts#L282)

#### Parameters

##### opts?

###### endTime?

`TimeInput`

###### error?

`Error`

#### Returns

`void`

***

### output()

> **output**(`content`): `this`

Append an assistant message to the response.

Defined in: [src/genai/llm.ts:161](https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/genai/llm.ts#L161)

#### Parameters

##### content

`string`

#### Returns

`this`

***

### record()

> **record**(`opts`): `this`

Bulk-set any subset of the mutable fields. Replaces (does not merge).
Useful for assigning everything at once after a provider call returns.

Defined in: [src/genai/llm.ts:209](https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/genai/llm.ts#L209)

#### Parameters

##### opts

###### finishReasons?

`string`\[]

###### inputMessages?

[`Message`](./message)\[]

###### mediaAttachments?

(\{ `content`: `string`; `mimeType`: `string`; `modality`: [`Modality`](../type-aliases/modality); } | \{ `modality`: [`Modality`](../type-aliases/modality); `uri`: `string`; } | \{ `fileId`: `string`; `mimeType?`: `string`; `modality`: [`Modality`](../type-aliases/modality); })\[]

###### outputMessages?

[`Message`](./message)\[]

###### outputType?

`string`

###### reasoning?

[`Reasoning`](./reasoning)

###### responseId?

`string`

###### responseModel?

`string`

###### usage?

[`Usage`](./usage)

#### Returns

`this`

***

### setAttributes()

> **setAttributes**(`attributes`): `this`

Set multiple attributes on the span at once. Warns and no-ops after
`end()`. Mirrors OTel `Span.setAttributes` (and the Python SDK's
`set_attributes`).

Defined in: [src/genai/spanBase.ts:65](https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/genai/spanBase.ts#L65)

#### Parameters

##### attributes

`Attributes`

#### Returns

`this`

#### Example

```ts twoslash theme={null}
// @noErrors
span.setAttributes({'weave.tag': 'prod', 'gen_ai.response.id': id});
```

#### Inherited from

`SpanBase.setAttributes`

***

### startSubagent()

> **startSubagent**(`opts`): [`SubAgent`](./subagent)

Start a child SubAgent span nested under this LLM.

Defined in: [src/genai/llm.ts:268](https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/genai/llm.ts#L268)

#### Parameters

##### opts

[`SubAgentInit`](./subagentinit)

#### Returns

[`SubAgent`](./subagent)

***

### startTool()

> **startTool**(`opts`): [`Tool`](./tool)

Start a child Tool span nested under this LLM.

Defined in: [src/genai/llm.ts:258](https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/genai/llm.ts#L258)

#### Parameters

##### opts

[`ToolInit`](./toolinit)

#### Returns

[`Tool`](./tool)

***

### think()

> **think**(`content`): `this`

Set or extend the model's reasoning/chain-of-thought content. Accumulates
into `this.reasoning.content`. Folded into the last assistant message as
a `ReasoningPart` at serialization time, matching the Python SDK's
on-the-wire shape.

Defined in: [src/genai/llm.ts:173](https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/genai/llm.ts#L173)

#### Parameters

##### content

`string`

#### Returns

`this`
