Skip to content

[WIP] Update TS SDK reference #2691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
drtangible wants to merge 1 commit into from
Closed

[WIP] Update TS SDK reference #2691

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions scripts/reference-generation/weave/generate_typescript_sdk_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -517,8 +517,10 @@ def main():
original_cwd = os.getcwd()

# Download Weave source
weave_source = download_weave_source(weave_version)

# weave_source = download_weave_source(weave_version)
# TODO: Remove. Just pointing to more recent branch than tag v0.52.41
weave_source = download_weave_source("05-27-chore_weave_ts_update_openai_move_to_devdependencies")

try:
# Set up TypeScript project
sdk_path = setup_typescript_project(weave_source)
Expand Down
36 changes: 36 additions & 0 deletions weave/reference/typescript-sdk.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,36 +14,69 @@ weave
- [Dataset](./typescript-sdk/classes/dataset)
- [Evaluation](./typescript-sdk/classes/evaluation)
- [EvaluationLogger](./typescript-sdk/classes/evaluationlogger)
- [LLM](./typescript-sdk/classes/llm)
- [MessagesPrompt](./typescript-sdk/classes/messagesprompt)
- [ObjectRef](./typescript-sdk/classes/objectref)
- [ScoreLogger](./typescript-sdk/classes/scorelogger)
- [Session](./typescript-sdk/classes/session)
- [StringPrompt](./typescript-sdk/classes/stringprompt)
- [SubAgent](./typescript-sdk/classes/subagent)
- [Tool](./typescript-sdk/classes/tool)
- [Turn](./typescript-sdk/classes/turn)
- [WeaveClient](./typescript-sdk/classes/weaveclient)
- [WeaveObject](./typescript-sdk/classes/weaveobject)

### Interfaces

- [CallSchema](./typescript-sdk/interfaces/callschema)
- [CallsFilter](./typescript-sdk/interfaces/callsfilter)
- [GetCallsOptions](./typescript-sdk/interfaces/getcallsoptions)
- [LLMInit](./typescript-sdk/interfaces/llminit)
- [Message](./typescript-sdk/interfaces/message)
- [Query](./typescript-sdk/interfaces/query)
- [Reasoning](./typescript-sdk/interfaces/reasoning)
- [SessionInit](./typescript-sdk/interfaces/sessioninit)
- [SortBy](./typescript-sdk/interfaces/sortby)
- [SubAgentInit](./typescript-sdk/interfaces/subagentinit)
- [ToolInit](./typescript-sdk/interfaces/toolinit)
- [TurnInit](./typescript-sdk/interfaces/turninit)
- [Usage](./typescript-sdk/interfaces/usage)
- [WeaveAudio](./typescript-sdk/interfaces/weaveaudio)
- [WeaveImage](./typescript-sdk/interfaces/weaveimage)


### Type Aliases

- [MessagePart](./typescript-sdk/type-aliases/messagepart)
- [Modality](./typescript-sdk/type-aliases/modality)
- [OpDecorator](./typescript-sdk/type-aliases/opdecorator)
- [Op](./typescript-sdk/type-aliases/op)
- [Role](./typescript-sdk/type-aliases/role)

### Functions

- [createopenaiagentstracingprocessor](./typescript-sdk/functions/createopenaiagentstracingprocessor)
- [createotelextension](./typescript-sdk/functions/createotelextension)
- [endllm](./typescript-sdk/functions/endllm)
- [endsession](./typescript-sdk/functions/endsession)
- [endturn](./typescript-sdk/functions/endturn)
- [flushotel](./typescript-sdk/functions/flushotel)
- [getcurrentllm](./typescript-sdk/functions/getcurrentllm)
- [getcurrentsession](./typescript-sdk/functions/getcurrentsession)
- [getcurrentturn](./typescript-sdk/functions/getcurrentturn)
- [init](./typescript-sdk/functions/init)
- [instrumentopenaiagents](./typescript-sdk/functions/instrumentopenaiagents)
- [login](./typescript-sdk/functions/login)
- [op](./typescript-sdk/functions/op)
- [patchrealtimesession](./typescript-sdk/functions/patchrealtimesession)
- [requirecurrentcallstackentry](./typescript-sdk/functions/requirecurrentcallstackentry)
- [requirecurrentchildsummary](./typescript-sdk/functions/requirecurrentchildsummary)
- [runisolated](./typescript-sdk/functions/runisolated)
- [startllm](./typescript-sdk/functions/startllm)
- [startsession](./typescript-sdk/functions/startsession)
- [startsubagent](./typescript-sdk/functions/startsubagent)
- [starttool](./typescript-sdk/functions/starttool)
- [startturn](./typescript-sdk/functions/startturn)
- [weaveaudio](./typescript-sdk/functions/weaveaudio)
- [weaveimage](./typescript-sdk/functions/weaveimage)
- [withattributes](./typescript-sdk/functions/withattributes)
Expand All @@ -53,3 +86,6 @@ weave
## Type Aliases





20 changes: 10 additions & 10 deletions weave/reference/typescript-sdk/classes/dataset.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ const ref = await dataset.save()

#### Defined in

[dataset.ts:51](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/dataset.ts#L51)
[dataset.ts:51](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/dataset.ts#L51)

## Properties

Expand All @@ -107,7 +107,7 @@ const ref = await dataset.save()

#### Defined in

[weaveObject.ts:73](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L73)
[weaveObject.ts:73](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/weaveObject.ts#L73)

___

Expand All @@ -117,7 +117,7 @@ ___

#### Defined in

[dataset.ts:49](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/dataset.ts#L49)
[dataset.ts:49](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/dataset.ts#L49)

## Accessors

Expand All @@ -135,7 +135,7 @@ WeaveObject.description

#### Defined in

[weaveObject.ts:100](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L100)
[weaveObject.ts:100](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/weaveObject.ts#L100)

___

Expand All @@ -149,7 +149,7 @@ ___

#### Defined in

[dataset.ts:64](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/dataset.ts#L64)
[dataset.ts:64](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/dataset.ts#L64)

___

Expand All @@ -167,7 +167,7 @@ WeaveObject.name

#### Defined in

[weaveObject.ts:96](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L96)
[weaveObject.ts:96](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/weaveObject.ts#L96)

## Methods

Expand All @@ -181,7 +181,7 @@ WeaveObject.name

#### Defined in

[dataset.ts:68](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/dataset.ts#L68)
[dataset.ts:68](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/dataset.ts#L68)

___

Expand All @@ -201,7 +201,7 @@ ___

#### Defined in

[dataset.ts:74](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/dataset.ts#L74)
[dataset.ts:74](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/dataset.ts#L74)

___

Expand All @@ -215,7 +215,7 @@ ___

#### Defined in

[dataset.ts:60](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/dataset.ts#L60)
[dataset.ts:60](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/dataset.ts#L60)

___

Expand All @@ -233,4 +233,4 @@ ___

#### Defined in

[weaveObject.ts:77](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L77)
[weaveObject.ts:77](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/weaveObject.ts#L77)
14 changes: 7 additions & 7 deletions weave/reference/typescript-sdk/classes/evaluation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ const results = await evaluation.evaluate({ model });

#### Defined in

[evaluation.ts:148](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/evaluation.ts#L148)
[evaluation.ts:148](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/evaluation.ts#L148)

## Properties

Expand All @@ -126,7 +126,7 @@ const results = await evaluation.evaluate({ model });

#### Defined in

[weaveObject.ts:73](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L73)
[weaveObject.ts:73](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/weaveObject.ts#L73)

## Accessors

Expand All @@ -144,7 +144,7 @@ WeaveObject.description

#### Defined in

[weaveObject.ts:100](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L100)
[weaveObject.ts:100](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/weaveObject.ts#L100)

___

Expand All @@ -162,7 +162,7 @@ WeaveObject.name

#### Defined in

[weaveObject.ts:96](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L96)
[weaveObject.ts:96](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/weaveObject.ts#L96)

## Methods

Expand All @@ -185,7 +185,7 @@ WeaveObject.name

#### Defined in

[evaluation.ts:163](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/evaluation.ts#L163)
[evaluation.ts:163](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/evaluation.ts#L163)

___

Expand All @@ -208,7 +208,7 @@ ___

#### Defined in

[evaluation.ts:231](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/evaluation.ts#L231)
[evaluation.ts:231](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/evaluation.ts#L231)

___

Expand All @@ -226,4 +226,4 @@ ___

#### Defined in

[weaveObject.ts:77](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L77)
[weaveObject.ts:77](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/weaveObject.ts#L77)
8 changes: 4 additions & 4 deletions weave/reference/typescript-sdk/classes/evaluationlogger.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ await ev.logSummary();

#### Defined in

[evaluationLogger.ts:554](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/evaluationLogger.ts#L554)
[evaluationLogger.ts:570](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/evaluationLogger.ts#L570)

## Methods

Expand Down Expand Up @@ -98,7 +98,7 @@ await evalLogger.logSummary(); // Waits for everything

#### Defined in

[evaluationLogger.ts:641](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/evaluationLogger.ts#L641)
[evaluationLogger.ts:657](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/evaluationLogger.ts#L657)

___

Expand Down Expand Up @@ -134,7 +134,7 @@ await scoreLogger.finish();

#### Defined in

[evaluationLogger.ts:666](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/evaluationLogger.ts#L666)
[evaluationLogger.ts:682](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/evaluationLogger.ts#L682)

___

Expand All @@ -160,4 +160,4 @@ it will wait for all pending operations to complete.

#### Defined in

[evaluationLogger.ts:767](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/evaluationLogger.ts#L767)
[evaluationLogger.ts:783](https://github.com/wandb/weave/blob/6d1ea4600b8b01c98d2636433c2989c4d163539e/sdks/node/src/evaluationLogger.ts#L783)
Loading
Loading