diff --git a/scripts/reference-generation/weave/generate_typescript_sdk_docs.py b/scripts/reference-generation/weave/generate_typescript_sdk_docs.py index 3951daa32e..b995968e59 100755 --- a/scripts/reference-generation/weave/generate_typescript_sdk_docs.py +++ b/scripts/reference-generation/weave/generate_typescript_sdk_docs.py @@ -76,8 +76,8 @@ def download_weave_source(version="main"): "--single-branch" ] - # Add branch/tag specification - if version != "main": + # Default branch on wandb/weave is `master`; either alias clones HEAD. + if version not in ("main", "master"): clone_cmd.extend(["--branch", version]) clone_cmd.extend([ @@ -104,36 +104,53 @@ def download_weave_source(version="main"): sys.exit(1) +def _npm_install_args(sdk_path: Path) -> list[str]: + """ + Build npm install args for doc generation. + + --ignore-scripts: the SDK's `prepare` script runs `npm run build`, which + can fail on upstream type errors (for example Buffer vs BlobPart). + Doc generation does not need a build, only type information. + --legacy-peer-deps: needed when the SDK ships a pnpm lockfile but we + install with npm (the case on master). + """ + args = ["npm", "install", "--ignore-scripts"] + if (sdk_path / "pnpm-lock.yaml").exists(): + args.append("--legacy-peer-deps") + return args + + def setup_typescript_project(weave_source): """Set up the TypeScript project and install dependencies.""" sdk_path = Path(weave_source) / "sdks" / "node" - + if not sdk_path.exists(): print(f"TypeScript SDK not found at {sdk_path}", file=sys.stderr) sys.exit(1) - + print(f"\nSetting up TypeScript project...") os.chdir(sdk_path) - + try: - # Install dependencies print(" Installing dependencies...") - subprocess.run(["npm", "install"], check=True) - - # Install typedoc and markdown plugin with compatible versions + subprocess.run(_npm_install_args(sdk_path), check=True) + print(" Installing typedoc...") - subprocess.run([ - "npm", "install", "--save-dev", + typedoc_install = ["npm", "install", "--save-dev", "--ignore-scripts"] + if (sdk_path / "pnpm-lock.yaml").exists(): + typedoc_install.append("--legacy-peer-deps") + typedoc_install.extend([ "typedoc@0.25.13", - "typedoc-plugin-markdown@3.17.1" - ], check=True) - + "typedoc-plugin-markdown@3.17.1", + ]) + subprocess.run(typedoc_install, check=True) + print(" ✓ Dependencies installed") - + except subprocess.CalledProcessError as e: print(f"✗ Failed to install dependencies: {e}", file=sys.stderr) sys.exit(1) - + return sdk_path @@ -153,7 +170,10 @@ def generate_typedoc(sdk_path, output_path): "excludeProtected": True, "excludeInternal": True, "disableSources": False, - "cleanOutputDir": True + "cleanOutputDir": True, + # Skip TypeScript type checking so upstream SDK type errors + # (for example Buffer vs BlobPart in weaveClient.ts) do not block docs. + "skipErrorChecking": True, } config_path = sdk_path / "typedoc.json" @@ -174,6 +194,48 @@ def generate_typedoc(sdk_path, output_path): config_path.unlink() +def escape_mdx_angle_brackets(content: str) -> str: + """ + Escape raw angle brackets outside code so MDX does not parse them as JSX. + + TypeDoc sometimes emits return descriptions like `Promise - ...` + outside inline code. MDX interprets `` as an HTML/JSX tag. + """ + result_lines = [] + in_fence = False + for line in content.split("\n"): + if line.strip().startswith("```"): + in_fence = not in_fence + result_lines.append(line) + continue + if in_fence: + result_lines.append(line) + continue + result_lines.append(_escape_angle_brackets_outside_inline_code(line)) + return "\n".join(result_lines) + + +def _escape_angle_brackets_outside_inline_code(line: str) -> str: + parts = re.split(r"(`[^`]*`)", line) + escaped = [] + for i, part in enumerate(parts): + if i % 2 == 1: + escaped.append(part) + else: + escaped.append(_escape_raw_angle_brackets(part)) + return "".join(escaped) + + +def _escape_raw_angle_brackets(text: str) -> str: + def repl(match: re.Match[str]) -> str: + inner = match.group(1) + if inner.startswith("/"): + return match.group(0) + return f"<{inner}>" + + return re.sub(r"(?\n]+)>", repl, text) + + def convert_to_mintlify_format(docs_dir): """Convert TypeDoc markdown to Mintlify MDX format.""" print(f"\nConverting to Mintlify format...") @@ -279,7 +341,9 @@ def fix_readme_anchor(match): # Links like [Dataset](classes/Dataset.md) are already relative # Just ensure .md extension is removed (already done above) pass - + + content = escape_mdx_angle_brackets(content) + # Write as .mdx file with lowercase filename (avoid Git case sensitivity issues) lowercase_stem = md_file.stem.lower() mdx_file = md_file.parent / f"{lowercase_stem}.mdx" @@ -356,6 +420,7 @@ def extract_members_to_separate_files(docs_path): --- {func_content.replace(f'### {func_name}', f'# {func_name}')}""" + func_file_content = escape_mdx_angle_brackets(func_file_content) # Write the function file with lowercase filename (avoid Git case sensitivity issues) func_filename = func_name.lower() @@ -423,6 +488,7 @@ def extract_members_to_separate_files(docs_path): --- {alias_content.replace(f'### {alias_name}', f'# {alias_name}')}""" + alias_file_content = escape_mdx_angle_brackets(alias_file_content) # Write the type alias file with lowercase filename (avoid Git case sensitivity issues) alias_filename = alias_name.lower() @@ -505,13 +571,20 @@ def cleanup_temp_dirs(*paths): shutil.rmtree(path, ignore_errors=True) +def _resolve_weave_version() -> str: + """Resolve Weave ref from CLI arg, WEAVE_VERSION env var, or latest.""" + if len(sys.argv) > 1: + return sys.argv[1] + return os.environ.get("WEAVE_VERSION", "latest") + + def main(): """Main function.""" # Check dependencies check_node_dependencies() - - # Get Weave version from environment or use latest - weave_version = os.environ.get("WEAVE_VERSION", "latest") + + # Get Weave version from CLI arg, environment variable, or latest + weave_version = _resolve_weave_version() # Store the original working directory original_cwd = os.getcwd() diff --git a/weave/reference/typescript-sdk.mdx b/weave/reference/typescript-sdk.mdx index 999c0bb894..9fea0b12fa 100644 --- a/weave/reference/typescript-sdk.mdx +++ b/weave/reference/typescript-sdk.mdx @@ -14,10 +14,15 @@ 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) @@ -25,18 +30,40 @@ weave - [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) @@ -44,6 +71,12 @@ weave - [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) @@ -53,3 +86,6 @@ weave ## Type Aliases + + + diff --git a/weave/reference/typescript-sdk/classes/dataset.mdx b/weave/reference/typescript-sdk/classes/dataset.mdx index fa297ae42d..f944de5d12 100644 --- a/weave/reference/typescript-sdk/classes/dataset.mdx +++ b/weave/reference/typescript-sdk/classes/dataset.mdx @@ -1,5 +1,5 @@ --- -title: "Class: Dataset" +title: "Class: Dataset<R>" description: "TypeScript SDK reference" --- @@ -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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/dataset.ts#L51) ## Properties @@ -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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L73) ___ @@ -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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/dataset.ts#L49) ## Accessors @@ -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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L100) ___ @@ -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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/dataset.ts#L64) ___ @@ -167,21 +167,21 @@ 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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L96) ## Methods ### [asyncIterator] -▸ **[asyncIterator]**(): `AsyncIterator`\<`any`, `any`, `undefined`\> +▸ **[asyncIterator]**(): `AsyncIterator`\<`any`, `any`, `any`\> #### Returns -`AsyncIterator`\<`any`, `any`, `undefined`\> +`AsyncIterator`\<`any`, `any`, `any`\> #### 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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/dataset.ts#L68) ___ @@ -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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/dataset.ts#L74) ___ @@ -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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/dataset.ts#L60) ___ @@ -233,4 +233,4 @@ ___ #### Defined in -[weaveObject.ts:77](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L77) \ No newline at end of file +[weaveObject.ts:77](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L77) \ No newline at end of file diff --git a/weave/reference/typescript-sdk/classes/evaluation.mdx b/weave/reference/typescript-sdk/classes/evaluation.mdx index fc648413df..8dd30d56a4 100644 --- a/weave/reference/typescript-sdk/classes/evaluation.mdx +++ b/weave/reference/typescript-sdk/classes/evaluation.mdx @@ -1,5 +1,5 @@ --- -title: "Class: Evaluation" +title: "Class: Evaluation<R, E, M>" description: "TypeScript SDK reference" --- @@ -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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/evaluation.ts#L148) ## Properties @@ -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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L73) ## Accessors @@ -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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L100) ___ @@ -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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L96) ## Methods @@ -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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/evaluation.ts#L163) ___ @@ -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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/evaluation.ts#L231) ___ @@ -226,4 +226,4 @@ ___ #### Defined in -[weaveObject.ts:77](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L77) \ No newline at end of file +[weaveObject.ts:77](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L77) \ No newline at end of file diff --git a/weave/reference/typescript-sdk/classes/evaluationlogger.mdx b/weave/reference/typescript-sdk/classes/evaluationlogger.mdx index 63e1b898d2..e12e0c1380 100644 --- a/weave/reference/typescript-sdk/classes/evaluationlogger.mdx +++ b/weave/reference/typescript-sdk/classes/evaluationlogger.mdx @@ -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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/evaluationLogger.ts#L570) ## Methods @@ -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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/evaluationLogger.ts#L657) ___ @@ -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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/evaluationLogger.ts#L682) ___ @@ -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) \ No newline at end of file +[evaluationLogger.ts:783](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/evaluationLogger.ts#L783) \ No newline at end of file diff --git a/weave/reference/typescript-sdk/classes/messagesprompt.mdx b/weave/reference/typescript-sdk/classes/messagesprompt.mdx index 5a71477b77..c54171a9d0 100644 --- a/weave/reference/typescript-sdk/classes/messagesprompt.mdx +++ b/weave/reference/typescript-sdk/classes/messagesprompt.mdx @@ -57,7 +57,7 @@ Prompt.constructor #### Defined in -[prompt.ts:40](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/prompt.ts#L40) +[prompt.ts:40](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/prompt.ts#L40) ## Properties @@ -71,7 +71,7 @@ Prompt.\_\_savedRef #### 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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L73) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[prompt.ts:38](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/prompt.ts#L38) +[prompt.ts:38](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/prompt.ts#L38) ## Accessors @@ -99,7 +99,7 @@ Prompt.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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L100) ___ @@ -117,7 +117,7 @@ Prompt.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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L96) ## Methods @@ -137,7 +137,7 @@ Prompt.name #### Defined in -[prompt.ts:67](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/prompt.ts#L67) +[prompt.ts:67](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/prompt.ts#L67) ___ @@ -155,7 +155,7 @@ Prompt.saveAttrs #### 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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L77) ___ @@ -176,4 +176,4 @@ ___ #### Defined in -[prompt.ts:73](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/prompt.ts#L73) \ No newline at end of file +[prompt.ts:73](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/prompt.ts#L73) \ No newline at end of file diff --git a/weave/reference/typescript-sdk/classes/objectref.mdx b/weave/reference/typescript-sdk/classes/objectref.mdx index 27c3e5e8e0..fca3dcb241 100644 --- a/weave/reference/typescript-sdk/classes/objectref.mdx +++ b/weave/reference/typescript-sdk/classes/objectref.mdx @@ -60,7 +60,7 @@ const uri = ref.uri(); // weave:///my-project/object/abc123:def456 #### Defined in -[weaveObject.ts:26](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L26) +[weaveObject.ts:26](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L26) ## Properties @@ -70,7 +70,7 @@ const uri = ref.uri(); // weave:///my-project/object/abc123:def456 #### Defined in -[weaveObject.ts:29](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L29) +[weaveObject.ts:29](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L29) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[weaveObject.ts:28](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L28) +[weaveObject.ts:28](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L28) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[weaveObject.ts:27](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L27) +[weaveObject.ts:27](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L27) ## Methods @@ -104,7 +104,7 @@ ___ #### Defined in -[weaveObject.ts:66](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L66) +[weaveObject.ts:66](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L66) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[weaveObject.ts:61](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L61) +[weaveObject.ts:61](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L61) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[weaveObject.ts:57](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L57) +[weaveObject.ts:57](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L57) ___ @@ -166,4 +166,4 @@ const ref = ObjectRef.fromUri('weave:///my-entity/my-project/object/my-dataset:a #### Defined in -[weaveObject.ts:44](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L44) \ No newline at end of file +[weaveObject.ts:44](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L44) \ No newline at end of file diff --git a/weave/reference/typescript-sdk/classes/scorelogger.mdx b/weave/reference/typescript-sdk/classes/scorelogger.mdx index f25b623b66..8f666cb815 100644 --- a/weave/reference/typescript-sdk/classes/scorelogger.mdx +++ b/weave/reference/typescript-sdk/classes/scorelogger.mdx @@ -52,7 +52,7 @@ await pred.finish(); // Finalizes the prediction #### Defined in -[evaluationLogger.ts:319](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/evaluationLogger.ts#L319) +[evaluationLogger.ts:335](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/evaluationLogger.ts#L335) ## Accessors @@ -69,7 +69,7 @@ Used by EvaluationLogger to detect unfinished predictions. #### Defined in -[evaluationLogger.ts:349](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/evaluationLogger.ts#L349) +[evaluationLogger.ts:365](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/evaluationLogger.ts#L365) ## Methods @@ -87,7 +87,7 @@ Updates incremental aggregates and frees memory. #### Defined in -[evaluationLogger.ts:451](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/evaluationLogger.ts#L451) +[evaluationLogger.ts:467](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/evaluationLogger.ts#L467) ___ @@ -111,4 +111,4 @@ Creates a scorer call as a child of predict_and_score. #### Defined in -[evaluationLogger.ts:360](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/evaluationLogger.ts#L360) \ No newline at end of file +[evaluationLogger.ts:376](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/evaluationLogger.ts#L376) \ No newline at end of file diff --git a/weave/reference/typescript-sdk/classes/stringprompt.mdx b/weave/reference/typescript-sdk/classes/stringprompt.mdx index 08ab9515f2..2e522eee86 100644 --- a/weave/reference/typescript-sdk/classes/stringprompt.mdx +++ b/weave/reference/typescript-sdk/classes/stringprompt.mdx @@ -57,7 +57,7 @@ Prompt.constructor #### Defined in -[prompt.ts:17](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/prompt.ts#L17) +[prompt.ts:17](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/prompt.ts#L17) ## Properties @@ -71,7 +71,7 @@ Prompt.\_\_savedRef #### 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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L73) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[prompt.ts:15](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/prompt.ts#L15) +[prompt.ts:15](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/prompt.ts#L15) ## Accessors @@ -99,7 +99,7 @@ Prompt.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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L100) ___ @@ -117,7 +117,7 @@ Prompt.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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L96) ## Methods @@ -137,7 +137,7 @@ Prompt.name #### Defined in -[prompt.ts:22](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/prompt.ts#L22) +[prompt.ts:22](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/prompt.ts#L22) ___ @@ -155,7 +155,7 @@ Prompt.saveAttrs #### 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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L77) ___ @@ -176,4 +176,4 @@ ___ #### Defined in -[prompt.ts:26](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/prompt.ts#L26) \ No newline at end of file +[prompt.ts:26](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/prompt.ts#L26) \ No newline at end of file diff --git a/weave/reference/typescript-sdk/classes/weaveclient.mdx b/weave/reference/typescript-sdk/classes/weaveclient.mdx index f4ba9ad90a..100e8c7bab 100644 --- a/weave/reference/typescript-sdk/classes/weaveclient.mdx +++ b/weave/reference/typescript-sdk/classes/weaveclient.mdx @@ -31,6 +31,7 @@ description: "TypeScript SDK reference" - [getCalls](./weaveclient#getcalls) - [getCallsIterator](./weaveclient#getcallsiterator) - [getCurrentAttributes](./weaveclient#getcurrentattributes) +- [linkPromptToRegistry](./weaveclient#linkprompttoregistry) - [publish](./weaveclient#publish) - [pushNewCall](./weaveclient#pushnewcall) - [runWithAttributes](./weaveclient#runwithattributes) @@ -63,7 +64,7 @@ description: "TypeScript SDK reference" #### Defined in -[weaveClient.ts:100](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L100) +[weaveClient.ts:190](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L190) ## Properties @@ -73,7 +74,7 @@ description: "TypeScript SDK reference" #### Defined in -[weaveClient.ts:103](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L103) +[weaveClient.ts:193](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L193) ___ @@ -83,7 +84,7 @@ ___ #### Defined in -[weaveClient.ts:104](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L104) +[weaveClient.ts:194](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L194) ___ @@ -93,7 +94,7 @@ ___ #### Defined in -[weaveClient.ts:101](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L101) +[weaveClient.ts:191](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L191) ## Methods @@ -119,7 +120,7 @@ Used in imperative evaluation to attach scorer results to predict calls. #### Defined in -[weaveClient.ts:908](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L908) +[weaveClient.ts:1128](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L1128) ___ @@ -148,7 +149,7 @@ ___ #### Defined in -[weaveClient.ts:763](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L763) +[weaveClient.ts:975](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L975) ___ @@ -174,7 +175,7 @@ ___ #### Defined in -[weaveClient.ts:815](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L815) +[weaveClient.ts:1035](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L1035) ___ @@ -199,7 +200,7 @@ ___ #### Defined in -[weaveClient.ts:855](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L855) +[weaveClient.ts:1075](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L1075) ___ @@ -219,7 +220,7 @@ ___ #### Defined in -[weaveClient.ts:289](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L289) +[weaveClient.ts:435](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L435) ___ @@ -240,7 +241,7 @@ ___ #### Defined in -[weaveClient.ts:220](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L220) +[weaveClient.ts:312](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L312) ___ @@ -254,21 +255,19 @@ ___ #### Defined in -[weaveClient.ts:674](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L674) +[weaveClient.ts:886](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L886) ___ ### getCalls -▸ **getCalls**(`filter?`, `includeCosts?`, `limit?`): `Promise`\<`Call`[]\> +▸ **getCalls**(`options?`): `Promise`\<`Call`[]\> #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `filter` | [`CallsFilter`](../interfaces/callsfilter) | `{}` | -| `includeCosts` | `boolean` | `false` | -| `limit` | `number` | `1000` | +| Name | Type | +| :------ | :------ | +| `options?` | [`GetCallsOptions`](../interfaces/getcallsoptions) | #### Returns @@ -276,29 +275,63 @@ ___ #### Defined in -[weaveClient.ts:230](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L230) +[weaveClient.ts:345](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L345) + +▸ **getCalls**(`options?`, `includeCosts?`, `limit?`): `Promise`\<`Call`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | [`CallsFilter`](../interfaces/callsfilter) | +| `includeCosts?` | `boolean` | +| `limit?` | `number` | + +#### Returns + +`Promise`\<`Call`[]\> + +#### Defined in + +[weaveClient.ts:346](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L346) ___ ### getCallsIterator -▸ **getCallsIterator**(`filter?`, `includeCosts?`, `limit?`): `AsyncIterableIterator`\<[`CallSchema`](../interfaces/callschema)\> +▸ **getCallsIterator**(`options?`, `includeCosts?`, `limit?`): `AsyncIterableIterator`\<[`CallSchema`](../interfaces/callschema), `any`, `any`\> #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `filter` | [`CallsFilter`](../interfaces/callsfilter) | `{}` | -| `includeCosts` | `boolean` | `false` | -| `limit` | `number` | `1000` | +| Name | Type | +| :------ | :------ | +| `options?` | [`CallsFilter`](../interfaces/callsfilter) | +| `includeCosts?` | `boolean` | +| `limit?` | `number` | #### Returns -`AsyncIterableIterator`\<[`CallSchema`](../interfaces/callschema)\> +`AsyncIterableIterator`\<[`CallSchema`](../interfaces/callschema), `any`, `any`\> #### Defined in -[weaveClient.ts:244](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L244) +[weaveClient.ts:367](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L367) + +▸ **getCallsIterator**(`options?`): `AsyncIterableIterator`\<[`CallSchema`](../interfaces/callschema), `any`, `any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | [`GetCallsOptions`](../interfaces/getcallsoptions) | + +#### Returns + +`AsyncIterableIterator`\<[`CallSchema`](../interfaces/callschema), `any`, `any`\> + +#### Defined in + +[weaveClient.ts:372](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L372) ___ @@ -312,7 +345,30 @@ ___ #### Defined in -[weaveClient.ts:678](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L678) +[weaveClient.ts:890](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L890) + +___ + +### linkPromptToRegistry + +▸ **linkPromptToRegistry**(`prompt`, `options`): `Promise`\<`LinkAssetToRegistryRes`\> + +Link a published prompt version into a registry portfolio. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `prompt` | `RegistryLinkable` | +| `options` | `LinkPromptToRegistryOptions` | + +#### Returns + +`Promise`\<`LinkAssetToRegistryRes`\> + +#### Defined in + +[weaveClient.ts:591](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L591) ___ @@ -333,7 +389,7 @@ ___ #### Defined in -[weaveClient.ts:208](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L208) +[weaveClient.ts:300](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L300) ___ @@ -353,7 +409,7 @@ ___ #### Defined in -[weaveClient.ts:682](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L682) +[weaveClient.ts:894](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L894) ___ @@ -380,7 +436,7 @@ ___ #### Defined in -[weaveClient.ts:690](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L690) +[weaveClient.ts:902](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L902) ___ @@ -407,7 +463,7 @@ ___ #### Defined in -[weaveClient.ts:686](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L686) +[weaveClient.ts:898](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L898) ___ @@ -427,7 +483,7 @@ ___ #### Defined in -[weaveClient.ts:669](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L669) +[weaveClient.ts:881](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L881) ___ @@ -447,13 +503,13 @@ ___ #### Defined in -[weaveClient.ts:664](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L664) +[weaveClient.ts:876](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L876) ___ ### saveOp -▸ **saveOp**(`op`, `objId?`): `Promise`\<`any`\> +▸ **saveOp**(`op`, `objId?`): `Promise`\<`OpRef`\> #### Parameters @@ -464,17 +520,17 @@ ___ #### Returns -`Promise`\<`any`\> +`Promise`\<`OpRef`\> #### Defined in -[weaveClient.ts:729](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L729) +[weaveClient.ts:941](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L941) ___ ### serializeAudio -▸ **serializeAudio**(`data`, `audioType?`): `Promise`\<`any`\> +▸ **serializeAudio**(`data`, `audioType?`): `Promise`\<`SerializedFileBlob`\> Upload raw audio bytes to the Weave content store and return the `CustomWeaveType` placeholder that can be embedded in a call output. @@ -486,16 +542,16 @@ where the automatic serialization pipeline from `finishCall` is not used. | Name | Type | Default value | Description | | :------ | :------ | :------ | :------ | -| `data` | `Buffer` | `undefined` | Raw audio bytes (WAV for best browser compatibility) | +| `data` | `Buffer`\<`ArrayBufferLike`\> | `undefined` | Raw audio bytes (WAV for best browser compatibility) | | `audioType` | ``"wav"`` | `DEFAULT_AUDIO_TYPE` | File format — currently only 'wav' is supported | #### Returns -`Promise`\<`any`\> +`Promise`\<`SerializedFileBlob`\> #### Defined in -[weaveClient.ts:616](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L616) +[weaveClient.ts:828](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L828) ___ @@ -516,7 +572,7 @@ ___ #### Defined in -[weaveClient.ts:891](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L891) +[weaveClient.ts:1111](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L1111) ___ @@ -530,4 +586,4 @@ ___ #### Defined in -[weaveClient.ts:121](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveClient.ts#L121) \ No newline at end of file +[weaveClient.ts:211](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L211) \ No newline at end of file diff --git a/weave/reference/typescript-sdk/classes/weaveobject.mdx b/weave/reference/typescript-sdk/classes/weaveobject.mdx index b4af0bfb7c..4d9c6d2b12 100644 --- a/weave/reference/typescript-sdk/classes/weaveobject.mdx +++ b/weave/reference/typescript-sdk/classes/weaveobject.mdx @@ -52,7 +52,7 @@ description: "TypeScript SDK reference" #### Defined in -[weaveObject.ts:75](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L75) +[weaveObject.ts:75](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L75) ## Properties @@ -62,7 +62,7 @@ description: "TypeScript SDK reference" #### 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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L73) ## Accessors @@ -76,7 +76,7 @@ description: "TypeScript SDK reference" #### 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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L100) ___ @@ -90,7 +90,7 @@ ___ #### 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/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L96) ## Methods @@ -104,4 +104,4 @@ ___ #### Defined in -[weaveObject.ts:77](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/weaveObject.ts#L77) \ No newline at end of file +[weaveObject.ts:77](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveObject.ts#L77) \ No newline at end of file diff --git a/weave/reference/typescript-sdk/functions/createopenaiagentstracingprocessor.mdx b/weave/reference/typescript-sdk/functions/createopenaiagentstracingprocessor.mdx index 629fa4be5c..fef0588f35 100644 --- a/weave/reference/typescript-sdk/functions/createopenaiagentstracingprocessor.mdx +++ b/weave/reference/typescript-sdk/functions/createopenaiagentstracingprocessor.mdx @@ -27,6 +27,6 @@ addTraceProcessor(processor); #### Defined in -[integrations/openai.agent.ts:612](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/integrations/openai.agent.ts#L612) +[integrations/openai.agent.ts:665](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/integrations/openai.agent.ts#L665) ___ diff --git a/weave/reference/typescript-sdk/functions/createotelextension.mdx b/weave/reference/typescript-sdk/functions/createotelextension.mdx new file mode 100644 index 0000000000..f9ad189412 --- /dev/null +++ b/weave/reference/typescript-sdk/functions/createotelextension.mdx @@ -0,0 +1,51 @@ +--- +title: "createOtelExtension" +description: "TypeScript SDK reference" +--- + +# createOtelExtension + +▸ **createOtelExtension**(`opts?`): (`pi`: `PiExtensionApi`) => `void` + +Creates a pi coding agent extension that emits OTEL spans for the full +agent lifecycle, conforming to the GenAI semantic conventions. + +When `weave.init(...)` has been called, spans are automatically exported +to the Weave trace server at `/agents/otel/v1/traces`. Otherwise, pass a +custom `tracer` in `opts`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `OtelExtensionOptions` | + +#### Returns + +`fn` + +▸ (`pi`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `pi` | `PiExtensionApi` | + +##### Returns + +`void` + +`Example` + +```typescript +const resourceLoader = new DefaultResourceLoader({ + extensionFactories: [createOtelExtension()], +}); +``` + +#### Defined in + +[integrations/piCodingAgent.ts:629](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/integrations/piCodingAgent.ts#L629) + +___ diff --git a/weave/reference/typescript-sdk/functions/endllm.mdx b/weave/reference/typescript-sdk/functions/endllm.mdx new file mode 100644 index 0000000000..efba448efb --- /dev/null +++ b/weave/reference/typescript-sdk/functions/endllm.mdx @@ -0,0 +1,20 @@ +--- +title: "endLLM" +description: "TypeScript SDK reference" +--- + +# endLLM + +▸ **endLLM**(): `void` + +End the current LLM. No-op if no LLM is active. + +#### Returns + +`void` + +#### Defined in + +[genai/api.ts:102](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/genai/api.ts#L102) + +___ diff --git a/weave/reference/typescript-sdk/functions/endsession.mdx b/weave/reference/typescript-sdk/functions/endsession.mdx new file mode 100644 index 0000000000..13b8d0dce5 --- /dev/null +++ b/weave/reference/typescript-sdk/functions/endsession.mdx @@ -0,0 +1,20 @@ +--- +title: "endSession" +description: "TypeScript SDK reference" +--- + +# endSession + +▸ **endSession**(): `void` + +End the current Session. No-op if no Session is active. + +#### Returns + +`void` + +#### Defined in + +[genai/api.ts:82](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/genai/api.ts#L82) + +___ diff --git a/weave/reference/typescript-sdk/functions/endturn.mdx b/weave/reference/typescript-sdk/functions/endturn.mdx new file mode 100644 index 0000000000..30c5f1f369 --- /dev/null +++ b/weave/reference/typescript-sdk/functions/endturn.mdx @@ -0,0 +1,20 @@ +--- +title: "endTurn" +description: "TypeScript SDK reference" +--- + +# endTurn + +▸ **endTurn**(): `void` + +End the current Turn. No-op if no Turn is active. + +#### Returns + +`void` + +#### Defined in + +[genai/api.ts:92](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/genai/api.ts#L92) + +___ diff --git a/weave/reference/typescript-sdk/functions/flushotel.mdx b/weave/reference/typescript-sdk/functions/flushotel.mdx new file mode 100644 index 0000000000..d62954cac9 --- /dev/null +++ b/weave/reference/typescript-sdk/functions/flushotel.mdx @@ -0,0 +1,29 @@ +--- +title: "flushOTel" +description: "TypeScript SDK reference" +--- + +# flushOTel + +▸ **flushOTel**(): `Promise`\<`void`\> + +Force-flush any GenAI spans buffered by the active span processor. + +Resolves immediately if `weave.init()` has not been called. Otherwise +delegates to `BasicTracerProvider.forceFlush()`, which waits for the +underlying span processor to drain its queue and complete its OTLP export +round-trip. + +Call before process exit when using `'simple'` or any other processor that +may have in-flight work, or in tests that need to observe exported spans +synchronously. + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[genai/flush.ts:15](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/genai/flush.ts#L15) + +___ diff --git a/weave/reference/typescript-sdk/functions/getcurrentllm.mdx b/weave/reference/typescript-sdk/functions/getcurrentllm.mdx new file mode 100644 index 0000000000..f7fc096b9a --- /dev/null +++ b/weave/reference/typescript-sdk/functions/getcurrentllm.mdx @@ -0,0 +1,20 @@ +--- +title: "getCurrentLLM" +description: "TypeScript SDK reference" +--- + +# getCurrentLLM + +▸ **getCurrentLLM**(): [`LLM`](../classes/llm) \| `undefined` + +Returns the current LLM, or undefined. + +#### Returns + +[`LLM`](../classes/llm) \| `undefined` + +#### Defined in + +[genai/context.ts:103](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/genai/context.ts#L103) + +___ diff --git a/weave/reference/typescript-sdk/functions/getcurrentsession.mdx b/weave/reference/typescript-sdk/functions/getcurrentsession.mdx new file mode 100644 index 0000000000..fd90cf9fb2 --- /dev/null +++ b/weave/reference/typescript-sdk/functions/getcurrentsession.mdx @@ -0,0 +1,20 @@ +--- +title: "getCurrentSession" +description: "TypeScript SDK reference" +--- + +# getCurrentSession + +▸ **getCurrentSession**(): [`Session`](../classes/session) \| `undefined` + +Returns the current Session, or undefined. + +#### Returns + +[`Session`](../classes/session) \| `undefined` + +#### Defined in + +[genai/context.ts:93](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/genai/context.ts#L93) + +___ diff --git a/weave/reference/typescript-sdk/functions/getcurrentturn.mdx b/weave/reference/typescript-sdk/functions/getcurrentturn.mdx new file mode 100644 index 0000000000..447a299e8f --- /dev/null +++ b/weave/reference/typescript-sdk/functions/getcurrentturn.mdx @@ -0,0 +1,20 @@ +--- +title: "getCurrentTurn" +description: "TypeScript SDK reference" +--- + +# getCurrentTurn + +▸ **getCurrentTurn**(): [`Turn`](../classes/turn) \| `undefined` + +Returns the current Turn, or undefined. + +#### Returns + +[`Turn`](../classes/turn) \| `undefined` + +#### Defined in + +[genai/context.ts:98](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/genai/context.ts#L98) + +___ diff --git a/weave/reference/typescript-sdk/functions/init.mdx b/weave/reference/typescript-sdk/functions/init.mdx index 473ef29dc6..7297d5afa8 100644 --- a/weave/reference/typescript-sdk/functions/init.mdx +++ b/weave/reference/typescript-sdk/functions/init.mdx @@ -13,7 +13,7 @@ Initialize the Weave client, which is required for weave tracing to work. | Name | Type | Description | | :------ | :------ | :------ | -| `project` | `string` | The W&B project name (can be project or entity/project). If you don't specify a W&B team (e.g., 'team/project'), your default entity is used. To find or update your default entity, refer to User Settings at https://docs.wandb.ai/guides/models/app/settings-page/user-settings/#default-team | +| `project` | `string` | The W&B project name (can be project or entity/project). If you don't specify a W&B team (e.g., 'team/project'), your default entity is used. To find or update your default entity, refer to User Settings at https://docs.wandb.ai/platform/app/settings-page/user-settings#default-team | | `settings?` | `SettingsInit` | (Optional) Weave tracing settings | #### Returns @@ -28,6 +28,6 @@ If the initialization fails #### Defined in -[clientApi.ts:83](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/clientApi.ts#L83) +[clientApi.ts:90](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/clientApi.ts#L90) ___ diff --git a/weave/reference/typescript-sdk/functions/instrumentopenaiagents.mdx b/weave/reference/typescript-sdk/functions/instrumentopenaiagents.mdx index 0e976ccdbe..74afadbdac 100644 --- a/weave/reference/typescript-sdk/functions/instrumentopenaiagents.mdx +++ b/weave/reference/typescript-sdk/functions/instrumentopenaiagents.mdx @@ -22,7 +22,7 @@ throwing an error. `Promise`\<`boolean`\> -Promise\<`boolean`\> - true if registration succeeded, false if @openai/agents not available +Promise<boolean> - true if registration succeeded, false if @openai/agents not available `Example` @@ -73,6 +73,6 @@ addTraceProcessor(processor); #### Defined in -[integrations/openai.agent.ts:674](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/integrations/openai.agent.ts#L674) +[integrations/openai.agent.ts:727](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/integrations/openai.agent.ts#L727) ___ diff --git a/weave/reference/typescript-sdk/functions/login.mdx b/weave/reference/typescript-sdk/functions/login.mdx index 1f4a825313..13d931fc57 100644 --- a/weave/reference/typescript-sdk/functions/login.mdx +++ b/weave/reference/typescript-sdk/functions/login.mdx @@ -28,6 +28,6 @@ If the API key is not specified or if the connection to the weave trace server c #### Defined in -[clientApi.ts:23](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/clientApi.ts#L23) +[clientApi.ts:30](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/clientApi.ts#L30) ___ diff --git a/weave/reference/typescript-sdk/functions/op.mdx b/weave/reference/typescript-sdk/functions/op.mdx index 0681c70a13..4806f7cc47 100644 --- a/weave/reference/typescript-sdk/functions/op.mdx +++ b/weave/reference/typescript-sdk/functions/op.mdx @@ -26,7 +26,7 @@ description: "TypeScript SDK reference" #### Defined in -[op.ts:381](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/op.ts#L381) +[op.ts:381](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/op.ts#L381) ▸ **op**\<`T`\>(`thisArg`, `fn`, `options?`): [`Op`](../type-aliases/op)\<`T`\> @@ -50,7 +50,7 @@ description: "TypeScript SDK reference" #### Defined in -[op.ts:386](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/op.ts#L386) +[op.ts:386](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/op.ts#L386) ▸ **op**(`target`, `propertyKey`, `descriptor`): `TypedPropertyDescriptor`\<`any`\> @@ -68,7 +68,7 @@ description: "TypeScript SDK reference" #### Defined in -[op.ts:392](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/op.ts#L392) +[op.ts:392](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/op.ts#L392) ▸ **op**\<`T`\>(`value`, `context`): [`Op`](../type-aliases/op)\<`T`\> @@ -91,7 +91,7 @@ description: "TypeScript SDK reference" #### Defined in -[op.ts:398](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/op.ts#L398) +[op.ts:398](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/op.ts#L398) ▸ **op**(`options`): `MethodDecorator` @@ -107,6 +107,6 @@ description: "TypeScript SDK reference" #### Defined in -[op.ts:403](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/op.ts#L403) +[op.ts:403](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/op.ts#L403) ___ diff --git a/weave/reference/typescript-sdk/functions/patchrealtimesession.mdx b/weave/reference/typescript-sdk/functions/patchrealtimesession.mdx index 136cc414f0..6496b3d5db 100644 --- a/weave/reference/typescript-sdk/functions/patchrealtimesession.mdx +++ b/weave/reference/typescript-sdk/functions/patchrealtimesession.mdx @@ -5,7 +5,7 @@ description: "TypeScript SDK reference" # patchRealtimeSession -▸ **patchRealtimeSession**(): `void` +▸ **patchRealtimeSession**(): `Promise`\<`boolean`\> Manually patch the `RealtimeSession` class from `@openai/agents-realtime` so that every new instance is automatically traced by Weave. @@ -20,18 +20,21 @@ The function is idempotent — safe to call multiple times. #### Returns -`void` +`Promise`\<`boolean`\> + +`true` if the patch was applied (or was already in place), `false` if +`@openai/agents-realtime` could not be loaded. `Example` ```typescript import { patchRealtimeSession } from 'weave'; -patchRealtimeSession(); +await patchRealtimeSession(); // Every new RealtimeSession(...) is now auto-instrumented ``` #### Defined in -[integrations/openai.realtime.agent.ts:797](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/integrations/openai.realtime.agent.ts#L797) +[integrations/openai.realtime.agent.ts:808](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/integrations/openai.realtime.agent.ts#L808) ___ diff --git a/weave/reference/typescript-sdk/functions/requirecurrentcallstackentry.mdx b/weave/reference/typescript-sdk/functions/requirecurrentcallstackentry.mdx index 98d598e0a4..f40c83c45a 100644 --- a/weave/reference/typescript-sdk/functions/requirecurrentcallstackentry.mdx +++ b/weave/reference/typescript-sdk/functions/requirecurrentcallstackentry.mdx @@ -13,6 +13,6 @@ description: "TypeScript SDK reference" #### Defined in -[clientApi.ts:147](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/clientApi.ts#L147) +[clientApi.ts:155](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/clientApi.ts#L155) ___ diff --git a/weave/reference/typescript-sdk/functions/requirecurrentchildsummary.mdx b/weave/reference/typescript-sdk/functions/requirecurrentchildsummary.mdx index 7405e76972..84ec10172a 100644 --- a/weave/reference/typescript-sdk/functions/requirecurrentchildsummary.mdx +++ b/weave/reference/typescript-sdk/functions/requirecurrentchildsummary.mdx @@ -13,6 +13,6 @@ description: "TypeScript SDK reference" #### Defined in -[clientApi.ts:159](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/clientApi.ts#L159) +[clientApi.ts:167](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/clientApi.ts#L167) ___ diff --git a/weave/reference/typescript-sdk/functions/runisolated.mdx b/weave/reference/typescript-sdk/functions/runisolated.mdx new file mode 100644 index 0000000000..387aff9ad0 --- /dev/null +++ b/weave/reference/typescript-sdk/functions/runisolated.mdx @@ -0,0 +1,45 @@ +--- +title: "runIsolated" +description: "TypeScript SDK reference" +--- + +# runIsolated + +▸ **runIsolated**\<`T`\>(`fn`): `T` + +Run `fn` in a fresh, isolated GenAI state frame. Any Session / Turn / LLM +started inside `fn` lives in this frame only — it does not clash with +sibling `runIsolated` frames running concurrently, and it does not leak +to the outer async chain. + +Use this to safely run parallel GenAI work: + + await Promise.all([ + weave.runIsolated(async () => { ... }), + weave.runIsolated(async () => { ... }), + ]); + +Sequential single-flight usage doesn't require this wrapper — the +process-wide default state handles it. + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fn` | () => `T` | + +#### Returns + +`T` + +#### Defined in + +[genai/context.ts:88](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/genai/context.ts#L88) + +___ diff --git a/weave/reference/typescript-sdk/functions/startllm.mdx b/weave/reference/typescript-sdk/functions/startllm.mdx new file mode 100644 index 0000000000..1bcca061ca --- /dev/null +++ b/weave/reference/typescript-sdk/functions/startllm.mdx @@ -0,0 +1,27 @@ +--- +title: "startLLM" +description: "TypeScript SDK reference" +--- + +# startLLM + +▸ **startLLM**(`opts`): [`LLM`](../classes/llm) + +Start an LLM span as a child of the current Turn. Throws if no Turn is +active. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | [`LLMInit`](../interfaces/llminit) | + +#### Returns + +[`LLM`](../classes/llm) + +#### Defined in + +[genai/api.ts:32](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/genai/api.ts#L32) + +___ diff --git a/weave/reference/typescript-sdk/functions/startsession.mdx b/weave/reference/typescript-sdk/functions/startsession.mdx new file mode 100644 index 0000000000..549b684222 --- /dev/null +++ b/weave/reference/typescript-sdk/functions/startsession.mdx @@ -0,0 +1,27 @@ +--- +title: "startSession" +description: "TypeScript SDK reference" +--- + +# startSession + +▸ **startSession**(`opts?`): [`Session`](../classes/session) + +Start a new Session and install it as the current session. +Subsequent calls to `startTurn` will pick it up automatically. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | [`SessionInit`](../interfaces/sessioninit) | + +#### Returns + +[`Session`](../classes/session) + +#### Defined in + +[genai/api.ts:12](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/genai/api.ts#L12) + +___ diff --git a/weave/reference/typescript-sdk/functions/startsubagent.mdx b/weave/reference/typescript-sdk/functions/startsubagent.mdx new file mode 100644 index 0000000000..0396ee55a2 --- /dev/null +++ b/weave/reference/typescript-sdk/functions/startsubagent.mdx @@ -0,0 +1,26 @@ +--- +title: "startSubagent" +description: "TypeScript SDK reference" +--- + +# startSubagent + +▸ **startSubagent**(`opts`): [`SubAgent`](../classes/subagent) + +Start a SubAgent span. Same parent-resolution rules as `startTool`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | [`SubAgentInit`](../interfaces/subagentinit) | + +#### Returns + +[`SubAgent`](../classes/subagent) + +#### Defined in + +[genai/api.ts:66](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/genai/api.ts#L66) + +___ diff --git a/weave/reference/typescript-sdk/functions/starttool.mdx b/weave/reference/typescript-sdk/functions/starttool.mdx new file mode 100644 index 0000000000..a4f6ce4ff8 --- /dev/null +++ b/weave/reference/typescript-sdk/functions/starttool.mdx @@ -0,0 +1,31 @@ +--- +title: "startTool" +description: "TypeScript SDK reference" +--- + +# startTool + +▸ **startTool**(`opts`): [`Tool`](../classes/tool) + +Start a Tool span. Parent resolution (matches the design's "flat by +default, hierarchical if you nest"): +- If an LLM is active, the Tool nests under it. +- Otherwise, the Tool is a sibling under the current Turn. + +Throws if neither a Turn nor an LLM is active. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | [`ToolInit`](../interfaces/toolinit) | + +#### Returns + +[`Tool`](../classes/tool) + +#### Defined in + +[genai/api.ts:50](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/genai/api.ts#L50) + +___ diff --git a/weave/reference/typescript-sdk/functions/startturn.mdx b/weave/reference/typescript-sdk/functions/startturn.mdx new file mode 100644 index 0000000000..20a56c6ca3 --- /dev/null +++ b/weave/reference/typescript-sdk/functions/startturn.mdx @@ -0,0 +1,27 @@ +--- +title: "startTurn" +description: "TypeScript SDK reference" +--- + +# startTurn + +▸ **startTurn**(`opts?`): [`Turn`](../classes/turn) + +Start a new Turn. If a Session is active, the turn inherits its +`conversationId`; otherwise the turn has no conversation id. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | [`TurnInit`](../interfaces/turninit) | + +#### Returns + +[`Turn`](../classes/turn) + +#### Defined in + +[genai/api.ts:20](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/genai/api.ts#L20) + +___ diff --git a/weave/reference/typescript-sdk/functions/weaveaudio.mdx b/weave/reference/typescript-sdk/functions/weaveaudio.mdx index 749c8d4331..0a93698007 100644 --- a/weave/reference/typescript-sdk/functions/weaveaudio.mdx +++ b/weave/reference/typescript-sdk/functions/weaveaudio.mdx @@ -28,6 +28,6 @@ const weaveAudio = weaveAudio({ data: audioBuffer }); #### Defined in -[media.ts:62](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/media.ts#L62) +[media.ts:62](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/media.ts#L62) ___ diff --git a/weave/reference/typescript-sdk/functions/weaveimage.mdx b/weave/reference/typescript-sdk/functions/weaveimage.mdx index e81a5c72a1..6ffdeec177 100644 --- a/weave/reference/typescript-sdk/functions/weaveimage.mdx +++ b/weave/reference/typescript-sdk/functions/weaveimage.mdx @@ -28,6 +28,6 @@ const weaveImage = weaveImage({ data: imageBuffer }); #### Defined in -[media.ts:28](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/media.ts#L28) +[media.ts:28](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/media.ts#L28) ___ diff --git a/weave/reference/typescript-sdk/functions/withattributes.mdx b/weave/reference/typescript-sdk/functions/withattributes.mdx index b4b6cb2a0c..22df6e43fd 100644 --- a/weave/reference/typescript-sdk/functions/withattributes.mdx +++ b/weave/reference/typescript-sdk/functions/withattributes.mdx @@ -38,6 +38,6 @@ await withAttributes({requestId: 'abc'}, async () => { #### Defined in -[clientApi.ts:193](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/clientApi.ts#L193) +[clientApi.ts:201](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/clientApi.ts#L201) ___ diff --git a/weave/reference/typescript-sdk/functions/wrapgooglegenai.mdx b/weave/reference/typescript-sdk/functions/wrapgooglegenai.mdx index e0bd88e73c..ee3cc563cb 100644 --- a/weave/reference/typescript-sdk/functions/wrapgooglegenai.mdx +++ b/weave/reference/typescript-sdk/functions/wrapgooglegenai.mdx @@ -25,6 +25,6 @@ description: "TypeScript SDK reference" #### Defined in -[integrations/googleGenAI.ts:223](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/integrations/googleGenAI.ts#L223) +[integrations/googleGenAI.ts:223](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/integrations/googleGenAI.ts#L223) ___ diff --git a/weave/reference/typescript-sdk/functions/wrapopenai.mdx b/weave/reference/typescript-sdk/functions/wrapopenai.mdx index 506a12296c..8b60e60648 100644 --- a/weave/reference/typescript-sdk/functions/wrapopenai.mdx +++ b/weave/reference/typescript-sdk/functions/wrapopenai.mdx @@ -37,4 +37,4 @@ const result = await openai.chat.completions.create({ #### Defined in -[integrations/openai.ts:505](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/integrations/openai.ts#L505) \ No newline at end of file +[integrations/openai.ts:703](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/integrations/openai.ts#L703) \ No newline at end of file diff --git a/weave/reference/typescript-sdk/interfaces/callschema.mdx b/weave/reference/typescript-sdk/interfaces/callschema.mdx index 53387ef4a7..4c29675910 100644 --- a/weave/reference/typescript-sdk/interfaces/callschema.mdx +++ b/weave/reference/typescript-sdk/interfaces/callschema.mdx @@ -40,7 +40,7 @@ Attributes #### Defined in -[generated/traceServerApi.ts:118](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L118) +[generated/traceServerApi.ts:120](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L120) ___ @@ -52,7 +52,7 @@ Deleted At #### Defined in -[generated/traceServerApi.ts:133](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L133) +[generated/traceServerApi.ts:135](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L135) ___ @@ -64,7 +64,7 @@ Display Name #### Defined in -[generated/traceServerApi.ts:107](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L107) +[generated/traceServerApi.ts:109](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L109) ___ @@ -76,7 +76,7 @@ Ended At #### Defined in -[generated/traceServerApi.ts:122](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L122) +[generated/traceServerApi.ts:124](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L124) ___ @@ -88,7 +88,7 @@ Exception #### Defined in -[generated/traceServerApi.ts:124](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L124) +[generated/traceServerApi.ts:126](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L126) ___ @@ -100,7 +100,7 @@ Id #### Defined in -[generated/traceServerApi.ts:101](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L101) +[generated/traceServerApi.ts:103](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L103) ___ @@ -112,7 +112,7 @@ Inputs #### Defined in -[generated/traceServerApi.ts:120](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L120) +[generated/traceServerApi.ts:122](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L122) ___ @@ -124,7 +124,7 @@ Op Name #### Defined in -[generated/traceServerApi.ts:105](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L105) +[generated/traceServerApi.ts:107](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L107) ___ @@ -136,7 +136,7 @@ Output #### Defined in -[generated/traceServerApi.ts:126](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L126) +[generated/traceServerApi.ts:128](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L128) ___ @@ -148,7 +148,7 @@ Parent Id #### Defined in -[generated/traceServerApi.ts:111](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L111) +[generated/traceServerApi.ts:113](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L113) ___ @@ -160,7 +160,7 @@ Project Id #### Defined in -[generated/traceServerApi.ts:103](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L103) +[generated/traceServerApi.ts:105](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L105) ___ @@ -176,7 +176,7 @@ date-time #### Defined in -[generated/traceServerApi.ts:116](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L116) +[generated/traceServerApi.ts:118](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L118) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[generated/traceServerApi.ts:127](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L127) +[generated/traceServerApi.ts:129](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L129) ___ @@ -198,7 +198,7 @@ Trace Id #### Defined in -[generated/traceServerApi.ts:109](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L109) +[generated/traceServerApi.ts:111](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L111) ___ @@ -210,7 +210,7 @@ Wb Run Id #### Defined in -[generated/traceServerApi.ts:131](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L131) +[generated/traceServerApi.ts:133](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L133) ___ @@ -222,4 +222,4 @@ Wb User Id #### Defined in -[generated/traceServerApi.ts:129](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L129) \ No newline at end of file +[generated/traceServerApi.ts:131](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L131) \ No newline at end of file diff --git a/weave/reference/typescript-sdk/interfaces/callsfilter.mdx b/weave/reference/typescript-sdk/interfaces/callsfilter.mdx index e939523978..5b2c5fb680 100644 --- a/weave/reference/typescript-sdk/interfaces/callsfilter.mdx +++ b/weave/reference/typescript-sdk/interfaces/callsfilter.mdx @@ -33,7 +33,7 @@ Call Ids #### Defined in -[generated/traceServerApi.ts:196](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L196) +[generated/traceServerApi.ts:198](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L198) ___ @@ -45,7 +45,7 @@ Input Refs #### Defined in -[generated/traceServerApi.ts:188](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L188) +[generated/traceServerApi.ts:190](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L190) ___ @@ -57,7 +57,7 @@ Op Names #### Defined in -[generated/traceServerApi.ts:186](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L186) +[generated/traceServerApi.ts:188](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L188) ___ @@ -69,7 +69,7 @@ Output Refs #### Defined in -[generated/traceServerApi.ts:190](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L190) +[generated/traceServerApi.ts:192](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L192) ___ @@ -81,7 +81,7 @@ Parent Ids #### Defined in -[generated/traceServerApi.ts:192](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L192) +[generated/traceServerApi.ts:194](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L194) ___ @@ -93,7 +93,7 @@ Trace Ids #### Defined in -[generated/traceServerApi.ts:194](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L194) +[generated/traceServerApi.ts:196](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L196) ___ @@ -105,7 +105,7 @@ Trace Roots Only #### Defined in -[generated/traceServerApi.ts:198](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L198) +[generated/traceServerApi.ts:200](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L200) ___ @@ -117,7 +117,7 @@ Wb Run Ids #### Defined in -[generated/traceServerApi.ts:202](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L202) +[generated/traceServerApi.ts:204](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L204) ___ @@ -129,4 +129,4 @@ Wb User Ids #### Defined in -[generated/traceServerApi.ts:200](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/generated/traceServerApi.ts#L200) \ No newline at end of file +[generated/traceServerApi.ts:202](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L202) \ No newline at end of file diff --git a/weave/reference/typescript-sdk/interfaces/getcallsoptions.mdx b/weave/reference/typescript-sdk/interfaces/getcallsoptions.mdx new file mode 100644 index 0000000000..0b3ee32946 --- /dev/null +++ b/weave/reference/typescript-sdk/interfaces/getcallsoptions.mdx @@ -0,0 +1,112 @@ +--- +title: "Interface: GetCallsOptions" +description: "TypeScript SDK reference" +--- + +[weave](../) / GetCallsOptions + + + +## Table of contents + +### Properties + +- [columns](./getcallsoptions#columns) +- [expandColumns](./getcallsoptions#expandcolumns) +- [filter](./getcallsoptions#filter) +- [includeCosts](./getcallsoptions#includecosts) +- [includeFeedback](./getcallsoptions#includefeedback) +- [limit](./getcallsoptions#limit) +- [offset](./getcallsoptions#offset) +- [query](./getcallsoptions#query) +- [sortBy](./getcallsoptions#sortby) + +## Properties + +### columns + +• `Optional` **columns**: `string`[] + +#### Defined in + +[weaveClient.ts:84](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L84) + +___ + +### expandColumns + +• `Optional` **expandColumns**: `string`[] + +#### Defined in + +[weaveClient.ts:85](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L85) + +___ + +### filter + +• `Optional` **filter**: [`CallsFilter`](./callsfilter) + +#### Defined in + +[weaveClient.ts:77](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L77) + +___ + +### includeCosts + +• `Optional` **includeCosts**: `boolean` + +#### Defined in + +[weaveClient.ts:79](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L79) + +___ + +### includeFeedback + +• `Optional` **includeFeedback**: `boolean` + +#### Defined in + +[weaveClient.ts:80](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L80) + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +[weaveClient.ts:81](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L81) + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +[weaveClient.ts:82](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L82) + +___ + +### query + +• `Optional` **query**: [`Query`](./query) + +#### Defined in + +[weaveClient.ts:78](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L78) + +___ + +### sortBy + +• `Optional` **sortBy**: [`SortBy`](./sortby)[] + +#### Defined in + +[weaveClient.ts:83](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/weaveClient.ts#L83) \ No newline at end of file diff --git a/weave/reference/typescript-sdk/interfaces/query.mdx b/weave/reference/typescript-sdk/interfaces/query.mdx new file mode 100644 index 0000000000..3faa430632 --- /dev/null +++ b/weave/reference/typescript-sdk/interfaces/query.mdx @@ -0,0 +1,28 @@ +--- +title: "Interface: Query" +description: "TypeScript SDK reference" +--- + +[weave](../) / Query + + + +Query + +## Table of contents + +### Properties + +- [$expr](./query#$expr) + +## Properties + +### $expr + +• **$expr**: `AndOperation` \| `OrOperation` \| `NotOperation` \| `EqOperation` \| `GtOperation` \| `GteOperation` \| `InOperation` \| `ContainsOperation` + +$Expr + +#### Defined in + +[generated/traceServerApi.ts:817](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L817) \ No newline at end of file diff --git a/weave/reference/typescript-sdk/interfaces/sortby.mdx b/weave/reference/typescript-sdk/interfaces/sortby.mdx new file mode 100644 index 0000000000..0c771656d8 --- /dev/null +++ b/weave/reference/typescript-sdk/interfaces/sortby.mdx @@ -0,0 +1,41 @@ +--- +title: "Interface: SortBy" +description: "TypeScript SDK reference" +--- + +[weave](../) / SortBy + + + +SortBy + +## Table of contents + +### Properties + +- [direction](./sortby#direction) +- [field](./sortby#field) + +## Properties + +### direction + +• **direction**: ``"asc"`` \| ``"desc"`` + +Direction + +#### Defined in + +[generated/traceServerApi.ts:851](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L851) + +___ + +### field + +• **field**: `string` + +Field + +#### Defined in + +[generated/traceServerApi.ts:849](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/generated/traceServerApi.ts#L849) \ No newline at end of file diff --git a/weave/reference/typescript-sdk/interfaces/weaveaudio.mdx b/weave/reference/typescript-sdk/interfaces/weaveaudio.mdx index fa3eb4a21e..bd89586843 100644 --- a/weave/reference/typescript-sdk/interfaces/weaveaudio.mdx +++ b/weave/reference/typescript-sdk/interfaces/weaveaudio.mdx @@ -29,7 +29,7 @@ description: "TypeScript SDK reference" #### Defined in -[media.ts:48](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/media.ts#L48) +[media.ts:48](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/media.ts#L48) ___ @@ -43,13 +43,13 @@ WeaveAudioInput.audioType #### Defined in -[media.ts:44](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/media.ts#L44) +[media.ts:44](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/media.ts#L44) ___ ### data -• **data**: `Buffer` +• **data**: `Buffer`\<`ArrayBufferLike`\> #### Inherited from @@ -57,4 +57,4 @@ WeaveAudioInput.data #### Defined in -[media.ts:43](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/media.ts#L43) \ No newline at end of file +[media.ts:43](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/media.ts#L43) \ No newline at end of file diff --git a/weave/reference/typescript-sdk/interfaces/weaveimage.mdx b/weave/reference/typescript-sdk/interfaces/weaveimage.mdx index c00c10026a..416cf945c5 100644 --- a/weave/reference/typescript-sdk/interfaces/weaveimage.mdx +++ b/weave/reference/typescript-sdk/interfaces/weaveimage.mdx @@ -29,13 +29,13 @@ description: "TypeScript SDK reference" #### Defined in -[media.ts:14](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/media.ts#L14) +[media.ts:14](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/media.ts#L14) ___ ### data -• **data**: `Buffer` +• **data**: `Buffer`\<`ArrayBufferLike`\> #### Inherited from @@ -43,7 +43,7 @@ WeaveImageInput.data #### Defined in -[media.ts:9](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/media.ts#L9) +[media.ts:9](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/media.ts#L9) ___ @@ -57,4 +57,4 @@ WeaveImageInput.imageType #### Defined in -[media.ts:10](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/media.ts#L10) \ No newline at end of file +[media.ts:10](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/media.ts#L10) \ No newline at end of file diff --git a/weave/reference/typescript-sdk/type-aliases/messagepart.mdx b/weave/reference/typescript-sdk/type-aliases/messagepart.mdx new file mode 100644 index 0000000000..0a71704b20 --- /dev/null +++ b/weave/reference/typescript-sdk/type-aliases/messagepart.mdx @@ -0,0 +1,14 @@ +--- +title: "MessagePart" +description: "TypeScript SDK reference" +--- + +# MessagePart + +Ƭ **MessagePart**: \{ `content`: `string` ; `type`: ``"text"`` } \| \{ `content`: `string` ; `type`: ``"reasoning"`` } \| \{ `arguments?`: `string` ; `toolCallId`: `string` ; `toolName`: `string` ; `type`: ``"tool_call"`` } \| \{ `result?`: `string` ; `toolCallId`: `string` ; `type`: ``"tool_result"`` } \| \{ `fileId`: `string` ; `mimeType?`: `string` ; `modality`: [`Modality`](./modality) ; `type`: ``"file"`` } \| \{ `content`: `string` ; `mimeType`: `string` ; `modality`: [`Modality`](./modality) ; `type`: ``"blob"`` } \| \{ `modality`: [`Modality`](./modality) ; `type`: ``"uri"`` ; `uri`: `string` } + +#### Defined in + +[genai/types.ts:17](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/genai/types.ts#L17) + +___ diff --git a/weave/reference/typescript-sdk/type-aliases/modality.mdx b/weave/reference/typescript-sdk/type-aliases/modality.mdx new file mode 100644 index 0000000000..4b5542b829 --- /dev/null +++ b/weave/reference/typescript-sdk/type-aliases/modality.mdx @@ -0,0 +1,14 @@ +--- +title: "Modality" +description: "TypeScript SDK reference" +--- + +# Modality + +Ƭ **Modality**: ``"image"`` \| ``"audio"`` \| ``"video"`` \| ``"document"`` + +#### Defined in + +[genai/types.ts:7](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/genai/types.ts#L7) + +___ diff --git a/weave/reference/typescript-sdk/type-aliases/op.mdx b/weave/reference/typescript-sdk/type-aliases/op.mdx index 60ab2ba440..91c2472893 100644 --- a/weave/reference/typescript-sdk/type-aliases/op.mdx +++ b/weave/reference/typescript-sdk/type-aliases/op.mdx @@ -15,6 +15,6 @@ description: "TypeScript SDK reference" #### Defined in -[opType.ts:7](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/opType.ts#L7) +[opType.ts:7](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/opType.ts#L7) ___ diff --git a/weave/reference/typescript-sdk/type-aliases/opdecorator.mdx b/weave/reference/typescript-sdk/type-aliases/opdecorator.mdx index 5fe24e796c..e04bbeba75 100644 --- a/weave/reference/typescript-sdk/type-aliases/opdecorator.mdx +++ b/weave/reference/typescript-sdk/type-aliases/opdecorator.mdx @@ -27,19 +27,6 @@ For legacy decorators: #### Defined in -[opType.ts:41](https://github.com/wandb/weave/blob/62f1e46098095776ee29b730ad10b3b3d1a68307/sdks/node/src/opType.ts#L41) - -## Functions - - - - - - - - - - - - +[opType.ts:41](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/opType.ts#L41) +___ diff --git a/weave/reference/typescript-sdk/type-aliases/role.mdx b/weave/reference/typescript-sdk/type-aliases/role.mdx new file mode 100644 index 0000000000..671089d30d --- /dev/null +++ b/weave/reference/typescript-sdk/type-aliases/role.mdx @@ -0,0 +1,43 @@ +--- +title: "Role" +description: "TypeScript SDK reference" +--- + +# Role + +Ƭ **Role**: ``"user"`` \| ``"assistant"`` \| ``"system"`` \| ``"tool"`` + +Public data types for the Weave GenAI session SDK. + +#### Defined in + +[genai/types.ts:5](https://github.com/wandb/weave/blob/68509dddcf91f8cd4bfacf04fc6849c92bff20d6/sdks/node/src/genai/types.ts#L5) + +## Functions + + + + + + + + + + + + + + + + + + + + + + + + + + +