diff --git a/docs.json b/docs.json index 7875accd8e..aa280738a6 100644 --- a/docs.json +++ b/docs.json @@ -1310,6 +1310,7 @@ "weave/reference/typescript-sdk/type-aliases/response", "weave/reference/typescript-sdk/type-aliases/role", "weave/reference/typescript-sdk/type-aliases/session", + "weave/reference/typescript-sdk/type-aliases/session-1", "weave/reference/typescript-sdk/type-aliases/sessioninit", "weave/reference/typescript-sdk/type-aliases/settings" ] diff --git a/weave/reference/python-sdk.mdx b/weave/reference/python-sdk.mdx index 094f5e8088..1c15e60258 100644 --- a/weave/reference/python-sdk.mdx +++ b/weave/reference/python-sdk.mdx @@ -10,7 +10,7 @@ import { SourceLink } from '/snippets/_includes/source-link.mdx'; --- - + ## class `Agent` @@ -24,7 +24,7 @@ import { SourceLink } from '/snippets/_includes/source-link.mdx'; - `system_message`: `` - `tools`: `list[typing.Any]` - + ### method `step` @@ -44,7 +44,7 @@ Run a step of the agent. --- - + ## class `AgentState` @@ -57,7 +57,7 @@ Run a step of the agent. --- - + ## class `AnnotationSpec` @@ -69,7 +69,7 @@ Run a step of the agent. - `unique_among_creators`: `` - `op_scope`: `list[str] | None` - + ### classmethod `preprocess_field_schema` @@ -79,7 +79,7 @@ preprocess_field_schema(data: Any) → Any --- - + ### classmethod `validate_field_schema` @@ -89,7 +89,7 @@ validate_field_schema(schema: dict[str, Any]) → dict[str, Any] --- - + ### method `value_is_valid` @@ -109,7 +109,20 @@ Validates a payload against this annotation spec's schema. --- - + + +## class `Any` +Special type indicating an unconstrained type. + +- Any is compatible with every type. +- Any assumed to have all methods. +- All values assumed to be instances of Any. + +Note that all the above statements are true from the point of view of static type checkers. At runtime, Any should not be used with instance checks. + +--- + + ## class `Audio` A class representing audio data in a supported format (wav or mp3). @@ -131,7 +144,7 @@ This class handles audio data storage and provides methods for loading from diff - `ValueError`: If audio data is empty or format is not supported - + ### method `__init__` @@ -145,7 +158,7 @@ __init__( --- - + ### method `export` @@ -160,7 +173,7 @@ Export audio data to a file. --- - + ### classmethod `from_data` @@ -186,7 +199,7 @@ Create an Audio object from raw data and specified format. --- - + ### classmethod `from_path` @@ -210,7 +223,7 @@ Create an Audio object from a file path. --- - + ## class `ClassifierMonitor` A monitor that merges multiple scorers into a single classifier. @@ -232,7 +245,7 @@ Classifier monitors combine prompts from multiple LLMAsAJudgeScorers targeting t - `prompt_header`: `str | None` - `prompt_footer`: `str | None` - + ### method `activate` @@ -247,7 +260,7 @@ Activates the monitor. --- - + ### method `deactivate` @@ -262,7 +275,7 @@ Deactivates the monitor. --- - + ### classmethod `from_obj` @@ -272,7 +285,7 @@ from_obj(obj: WeaveObject) → Self --- - + ### method `get_prompt_footer` @@ -284,7 +297,7 @@ Text to append after the merged classifier prompts. --- - + ### method `get_prompt_header` @@ -296,7 +309,7 @@ Text to prepend before the merged classifier prompts. --- - + ### method `model_post_init` @@ -314,7 +327,7 @@ There is an edge case where a monitor can be created using the SDK without norma --- - + ## class `Content` A class to represent content from various sources, resolving them to a unified byte-oriented representation with associated metadata. @@ -327,7 +340,7 @@ This class must be instantiated using one of its classmethods: - from_base64() - from_data_url() - + ### method `__init__` @@ -358,7 +371,7 @@ Direct initialization is disabled. Please use a classmethod like `Content.from_p --- - + ### method `as_string` @@ -373,7 +386,7 @@ Display the data as a string. Bytes are decoded using the `encoding` attribute I --- - + ### classmethod `from_base64` @@ -390,7 +403,7 @@ Initializes Content from a base64 encoded string or bytes. --- - + ### classmethod `from_bytes` @@ -408,7 +421,7 @@ Initializes Content from raw bytes. --- - + ### classmethod `from_data_url` @@ -420,7 +433,7 @@ Initializes Content from a data URL. --- - + ### classmethod `from_path` @@ -437,7 +450,7 @@ Initializes Content from a local file path. --- - + ### classmethod `from_text` @@ -455,7 +468,7 @@ Initializes Content from a string of text. --- - + ### classmethod `from_url` @@ -474,7 +487,7 @@ Downloads the content, infers mimetype/extension from headers, URL path, and dat --- - + ### classmethod `model_validate` @@ -494,7 +507,7 @@ Override model_validate to handle Content reconstruction from dict. --- - + ### classmethod `model_validate_json` @@ -513,7 +526,7 @@ Override model_validate_json to handle Content reconstruction from JSON. --- - + ### method `open` @@ -531,7 +544,7 @@ This method uses the platform-specific mechanism to open the file with the defau --- - + ### method `save` @@ -546,7 +559,7 @@ Copy the file to the specified destination path. Updates the filename and the pa --- - + ### method `serialize_data` @@ -558,7 +571,7 @@ When dumping model in json mode --- - + ### method `to_data_url` @@ -578,7 +591,7 @@ Constructs a data URL from the content. --- - + ## class `Conversation` A conversation. Groups turns by conversation_id (no span). @@ -598,7 +611,7 @@ A conversation. Groups turns by conversation_id (no span). - `continue_parent_trace`: `` - `attributes`: `dict[str, typing.Any]` - + ### method `end` @@ -608,7 +621,7 @@ end() → None --- - + ### method `model_post_init` @@ -618,7 +631,7 @@ model_post_init(context: 'Any') → None --- - + ### method `start_turn` @@ -642,7 +655,18 @@ Sets the ``_current_turn`` contextvar so the turn is visible via ``get_current_t --- - + + +## class `CustomRuntimeID` + +**Pydantic Fields:** + +- `id`: `` +- `max_tokens`: `` + +--- + + ## class `Dataset` Dataset object with easy saving and automatic versioning. @@ -673,7 +697,7 @@ example_label = dataset_ref.rows[2]['sentence'] - `ref`: `trace.refs.ObjectRef | None` - `rows`: `trace.table.Table | trace.vals.WeaveTable` - + ### method `add_rows` @@ -694,7 +718,7 @@ This is useful for adding examples to large datasets without having to load the --- - + ### classmethod `convert_to_table` @@ -704,7 +728,7 @@ convert_to_table(rows: Any) → Table | WeaveTable --- - + ### classmethod `from_calls` @@ -714,7 +738,7 @@ from_calls(calls: Iterable[Call]) → Self --- - + ### classmethod `from_hf` @@ -724,7 +748,7 @@ from_hf(hf_dataset: 'HFDataset | HFDatasetDict') → Self --- - + ### classmethod `from_obj` @@ -734,7 +758,7 @@ from_obj(obj: WeaveObject) → Self --- - + ### classmethod `from_pandas` @@ -744,7 +768,7 @@ from_pandas(df: 'DataFrame') → Self --- - + ### method `select` @@ -763,7 +787,7 @@ Select rows from the dataset based on the provided indices. --- - + ### method `to_hf` @@ -773,7 +797,7 @@ to_hf() → HFDataset --- - + ### method `to_pandas` @@ -783,11 +807,11 @@ to_pandas() → DataFrame --- - + ## class `EasyPrompt` - + ### method `__init__` @@ -843,7 +867,7 @@ Join all messages into a system prompt object. --- - + ### method `append` @@ -853,7 +877,7 @@ append(item: Any, role: str | None = None, dedent: bool = False) → None --- - + ### method `as_dict` @@ -863,7 +887,7 @@ as_dict() → dict[str, Any] --- - + ### method `as_pydantic_dict` @@ -873,7 +897,7 @@ as_pydantic_dict() → dict[str, Any] --- - + ### method `bind` @@ -883,7 +907,7 @@ bind(*args: Any, **kwargs: Any) → Prompt --- - + ### method `bind_rows` @@ -893,7 +917,7 @@ bind_rows(dataset: list[dict] | Any) → list['Prompt'] --- - + ### method `config_table` @@ -903,7 +927,7 @@ config_table(title: str | None = None) → Table --- - + ### method `configure` @@ -913,7 +937,7 @@ configure(config: dict | None = None, **kwargs: Any) → Prompt --- - + ### method `dump` @@ -923,7 +947,7 @@ dump(fp: ) → None --- - + ### method `dump_file` @@ -933,7 +957,7 @@ dump_file(filepath: str | Path) → None --- - + ### method `format` @@ -943,7 +967,7 @@ format(**kwargs: Any) → Any --- - + ### classmethod `from_obj` @@ -953,7 +977,7 @@ from_obj(obj: WeaveObject) → Self --- - + ### classmethod `load` @@ -963,7 +987,7 @@ load(fp: ) → Self --- - + ### classmethod `load_file` @@ -973,7 +997,7 @@ load_file(filepath: str | Path) → Self --- - + ### method `messages_table` @@ -983,7 +1007,7 @@ messages_table(title: str | None = None) → Table --- - + ### method `print` @@ -993,7 +1017,7 @@ print() → str --- - + ### method `publish` @@ -1007,7 +1031,7 @@ publish( --- - + ### method `require` @@ -1017,7 +1041,7 @@ require(param_name: str, **kwargs: Any) → Prompt --- - + ### method `run` @@ -1027,7 +1051,7 @@ run() → Any --- - + ### method `validate_requirement` @@ -1037,7 +1061,7 @@ validate_requirement(key: str, value: Any) → list --- - + ### method `validate_requirements` @@ -1047,7 +1071,7 @@ validate_requirements(values: dict[str, Any]) → list --- - + ### method `values_table` @@ -1057,7 +1081,7 @@ values_table(title: str | None = None) → Table --- - + ## class `Evaluation` Sets up an evaluation which includes a set of scorers and a dataset. @@ -1105,13 +1129,13 @@ asyncio.run(evaluation.evaluate(function_to_evaluate)) - `description`: `str | None` - `ref`: `trace.refs.ObjectRef | None` - `dataset`: `` -- `scorers`: `list[typing.Annotated[trace.op_protocol.Op | flow.scorer.Scorer, BeforeValidator(func=, json_schema_input_type=PydanticUndefined)]] | None` +- `scorers`: `list[typing.Annotated[trace.op_protocol.Op | flow.scorer.Scorer, BeforeValidator(func=, json_schema_input_type=PydanticUndefined)]] | None` - `preprocess_model_input`: `collections.abc.Callable[[dict], dict] | None` - `trials`: `` - `metadata`: `dict[str, typing.Any] | None` - `evaluation_name`: `str | collections.abc.Callable[trace.call.Call, str] | None` - + ### method `evaluate` @@ -1121,7 +1145,7 @@ evaluate(model: Op | Model) → dict --- - + ### classmethod `from_obj` @@ -1131,7 +1155,7 @@ from_obj(obj: WeaveObject) → Self --- - + ### method `get_eval_results` @@ -1141,7 +1165,7 @@ get_eval_results(model: Op | Model) → EvaluationResults --- - + ### method `get_evaluate_calls` @@ -1172,7 +1196,7 @@ for call in calls: --- - + ### method `get_score_calls` @@ -1200,7 +1224,7 @@ for trace_id, calls in score_calls.items(): --- - + ### method `get_scores` @@ -1242,7 +1266,7 @@ Expected output: --- - + ### method `model_post_init` @@ -1252,7 +1276,7 @@ model_post_init(context: Any) → None --- - + ### method `predict_and_score` @@ -1262,7 +1286,7 @@ predict_and_score(model: Op | Model, example: dict) → dict --- - + ### method `summarize` @@ -1272,7 +1296,7 @@ summarize(eval_table: EvaluationResults) → dict --- - + ## class `EvaluationLogger` This class provides an imperative interface for logging evaluations. @@ -1311,7 +1335,10 @@ with ev.log_prediction(inputs={'q': 'Hello'}) as pred: ev.log_summary({"avg_score": 0.9}) ``` - +**Args:** + + + ### method `__init__` @@ -1321,7 +1348,8 @@ __init__( model: 'Model | dict | str | None' = None, dataset: 'Dataset | list[dict] | str | None' = None, eval_attributes: 'dict[str, Any] | None' = None, - scorers: 'list[str] | None' = None + scorers: 'list[str] | None' = None, + trace_scores: 'bool' = True ) → None ``` @@ -1335,7 +1363,7 @@ __init__( --- - + ### method `fail` @@ -1347,7 +1375,7 @@ Convenience method to fail the evaluation with an exception. --- - + ### method `finish` @@ -1361,7 +1389,7 @@ Ensures all prediction calls and the main evaluation call are finalized. This is --- - + ### method `log_example` @@ -1377,6 +1405,7 @@ Log a complete example with inputs, output, and scores. This is a convenience method that combines log_prediction and log_score for when you have all the data upfront. + - `trace_scores`: Whether each logged score also emits its own scorer call. Defaults to True. `EvalTable` passes False because it already stores each score directly on the row. The score remains on the prediction and in automatic summaries, while skipping the individually inspectable scorer call. This avoids a call per score, the dominant cost when logging tables with many score columns. **Args:** @@ -1395,12 +1424,19 @@ ev.log_example( --- - + ### method `log_prediction` ```python -log_prediction(inputs: 'dict[str, Any]', output: 'Any' = None) → ScoreLogger +log_prediction( + inputs: 'dict[str, Any]', + output: 'Any' = None, + example_id: 'str | None' = None, + row_digest: 'str | None' = None, + trial_index: 'int | None' = None, + eval_kind: 'str | None' = 'agent' +) → ScoreLogger ``` Log a prediction to the Evaluation. @@ -1412,6 +1448,10 @@ Returns a ScoreLogger that can be used directly or as a context manager. - `inputs`: The input data for the prediction - `output`: The output value. Defaults to None. Can be set later using pred.output. + - `example_id`: Optional caller-provided example identifier for OTel spans. + - `row_digest`: Optional stable row identity. Defaults to a digest of inputs. + - `trial_index`: Optional zero-based trial index for this row digest. + - `eval_kind`: Optional eval kind for OTel spans. Defaults to "agent". **Returns:** ScoreLogger for logging scores and optionally finishing the prediction. @@ -1423,7 +1463,7 @@ Example (context manager): --- - + ### method `log_summary` @@ -1437,7 +1477,7 @@ This will calculate the summary, call the summarize op, and then finalize the ev --- - + ### method `set_view` @@ -1475,12 +1515,12 @@ Saves the provided content as an object in the project and writes its reference --- - + ## class `File` A class representing a file with path, mimetype, and size information. - + ### method `__init__` @@ -1507,7 +1547,7 @@ Get the filename of the file. --- - + ### method `open` @@ -1525,7 +1565,7 @@ This method uses the platform-specific mechanism to open the file with the defau --- - + ### method `save` @@ -1540,7 +1580,7 @@ Copy the file to the specified destination path. --- - + ## class `LLM` One LLM API call. Maps to a chat OTel span. @@ -1571,7 +1611,7 @@ One LLM API call. Maps to a chat OTel span. - `started_at`: `datetime.datetime | None` - `ended_at`: `datetime.datetime | None` - + ### method `add_event` @@ -1595,7 +1635,7 @@ Must be called between span start and span end (inside ``with``). Outside that w --- - + ### method `attach_media` @@ -1617,7 +1657,7 @@ The publish (which uploads the media) runs on a dedicated background thread so t --- - + ### method `attach_media_url` @@ -1631,7 +1671,7 @@ Convenience over ``attach_media`` for the common case where the caller has a URL --- - + ### method `end` @@ -1641,7 +1681,7 @@ end() → None --- - + ### method `model_post_init` @@ -1651,7 +1691,7 @@ model_post_init(context: 'Any') → None --- - + ### method `output` @@ -1663,7 +1703,7 @@ Append an assistant message to output_messages. --- - + ### method `record` @@ -1689,7 +1729,19 @@ Only fields explicitly passed (non-``None``) are applied — existing values are --- - + + +### method `record_error` + +```python +record_error(error: 'BaseException') → Self +``` + +Record a failure without ending the span; call ``end()`` when ready. + +--- + + ### method `set_attributes` @@ -1705,7 +1757,7 @@ Must be called between span start and span end — i.e. inside a ``with`` block. --- - + ### method `think` @@ -1717,7 +1769,7 @@ Set reasoning/chain-of-thought content. --- - + ## class `LogResult` Result of a batch log_* call. @@ -1731,7 +1783,7 @@ Result of a batch log_* call. --- - + ## class `Markdown` A Markdown renderable. @@ -1744,7 +1796,7 @@ A Markdown renderable. - `style` (Union[str, Style], optional): Optional style to apply to markdown. - `hyperlinks` (bool, optional): Enable hyperlinks. Defaults to ``True``. - + ### method `__init__` @@ -1762,7 +1814,7 @@ __init__( --- - + ## class `MediaAttachment` A media attachment on an LLM call. @@ -1779,7 +1831,7 @@ Always holds a ``weave://`` content ref URI. Raw bytes, data-URLs, and plain HT --- - + ## class `Message` A single message in a conversation. @@ -1800,7 +1852,7 @@ When ``parts`` is non-empty it is the canonical representation. When empty, the - `tool_name`: `` - `parts`: `list[typing.Annotated[conversation.types.TextPart | conversation.types.ReasoningPart | conversation.types.ToolCallPart | conversation.types.ToolCallResponsePart | conversation.types.BlobPart | conversation.types.UriPart | conversation.types.FilePart, FieldInfo(annotation=NoneType, required=True, discriminator='type')]]` - + ### classmethod `assistant` @@ -1817,7 +1869,7 @@ Use plain text for simple replies; pass ``tool_calls`` when the assistant reques --- - + ### classmethod `system` @@ -1829,7 +1881,7 @@ Build a system message from plain text. --- - + ### classmethod `tool_result` @@ -1843,7 +1895,7 @@ Build a tool-result message for a previously-requested tool call. --- - + ### classmethod `user` @@ -1855,11 +1907,11 @@ Build a user message from plain text. --- - + ## class `MessagesPrompt` - + ### method `__init__` @@ -1874,7 +1926,7 @@ __init__(messages: list[dict]) - `ref`: `trace.refs.ObjectRef | None` - `messages`: `list[dict]` - + ### method `format` @@ -1884,7 +1936,7 @@ format(**kwargs: Any) → list --- - + ### method `format_message` @@ -1898,7 +1950,7 @@ This method delegates to the standalone format_message_with_template_vars functi --- - + ### classmethod `from_obj` @@ -1908,7 +1960,7 @@ from_obj(obj: WeaveObject) → Self --- - + ## class `Model` Intended to capture a combination of code and data the operates on an input. For example it might call an LLM with a prompt to make a prediction or generate text. @@ -1934,7 +1986,7 @@ class YourModel(Model): - `description`: `str | None` - `ref`: `trace.refs.ObjectRef | None` - + ### method `get_infer_method` @@ -1944,7 +1996,7 @@ get_infer_method() → Callable --- - + ## class `Monitor` Sets up a monitor to score incoming calls automatically. @@ -1995,7 +2047,7 @@ my_monitor.activate() - `active`: `` - `scorer_debounce_config`: `flow.monitor.ScorerDebounceConfig | None` - + ### method `activate` @@ -2010,7 +2062,7 @@ Activates the monitor. --- - + ### method `deactivate` @@ -2025,7 +2077,7 @@ Deactivates the monitor. --- - + ### classmethod `from_obj` @@ -2035,7 +2087,7 @@ from_obj(obj: WeaveObject) → Self --- - + ### method `model_post_init` @@ -2053,7 +2105,7 @@ There is an edge case where a monitor can be created using the SDK without norma --- - + ## class `Object` Base class for Weave objects that can be tracked and versioned. @@ -2081,7 +2133,7 @@ obj = Object.from_uri("weave:///entity/project/object:digest") - `description`: `str | None` - `ref`: `trace.refs.ObjectRef | None` - + ### classmethod `from_uri` @@ -2111,7 +2163,7 @@ obj = MyObject.from_uri("weave:///entity/project/object:digest") --- - + ### classmethod `handle_relocatable_object` @@ -2148,7 +2200,7 @@ This validator handles special cases where the input is an ObjectRef or WeaveObj --- - + ### classmethod `strip_weave_serialization_metadata` @@ -2162,12 +2214,12 @@ Weave's serialization adds _type, _class_name, and _bases to dicts for type reco --- - + ## class `ObjectRef` ObjectRef(entity: 'str', project: 'str', name: 'str', _digest: 'str | Future[str]', _extra: 'tuple[str | Future[str], ...]' = ()) - + ### method `__init__` @@ -2195,7 +2247,7 @@ __init__( --- - + ### method `as_param_dict` @@ -2205,7 +2257,7 @@ as_param_dict() → dict --- - + ### method `delete` @@ -2215,7 +2267,7 @@ delete() → None --- - + ### method `get` @@ -2225,7 +2277,7 @@ get(objectify: 'bool' = True) → Any --- - + ### method `is_descended_from` @@ -2235,7 +2287,7 @@ is_descended_from(potential_ancestor: 'ObjectRef') → bool --- - + ### method `maybe_parse_uri` @@ -2245,7 +2297,7 @@ maybe_parse_uri(s: 'str') → AnyRef | None --- - + ### method `parse_uri` @@ -2255,7 +2307,7 @@ parse_uri(uri: 'str') → ObjectRef --- - + ### method `with_attr` @@ -2265,7 +2317,7 @@ with_attr(attr: 'str') → Self --- - + ### method `with_extra` @@ -2275,7 +2327,7 @@ with_extra(extra: 'tuple[str | Future[str], ]') → Self --- - + ### method `with_index` @@ -2285,7 +2337,7 @@ with_index(index: 'int') → Self --- - + ### method `with_item` @@ -2295,7 +2347,7 @@ with_item(item_digest: 'str | Future[str]') → Self --- - + ### method `with_key` @@ -2305,7 +2357,7 @@ with_key(key: 'str') → Self --- - + ## class `Prompt` @@ -2315,7 +2367,7 @@ with_key(key: 'str') → Self - `description`: `str | None` - `ref`: `trace.refs.ObjectRef | None` - + ### method `format` @@ -2325,12 +2377,12 @@ format(**kwargs: Any) → Any --- - + ## class `SavedView` A fluent-style class for working with SavedView objects. - + ### method `__init__` @@ -2356,7 +2408,7 @@ __init__(view_type: 'str' = 'traces', label: 'str' = 'SavedView') → None --- - + ### method `add_column` @@ -2366,7 +2418,7 @@ add_column(path: 'str | ObjectPath', label: 'str | None' = None) → SavedView --- - + ### method `add_columns` @@ -2378,7 +2430,7 @@ Convenience method for adding multiple columns to the grid. --- - + ### method `add_filter` @@ -2392,7 +2444,7 @@ add_filter( --- - + ### method `add_sort` @@ -2402,7 +2454,7 @@ add_sort(field: 'str', direction: 'SortDirection') → SavedView --- - + ### method `column_index` @@ -2412,7 +2464,7 @@ column_index(path: 'int | str | ObjectPath') → int --- - + ### method `filter_op` @@ -2422,7 +2474,7 @@ filter_op(op_name: 'str | None') → SavedView --- - + ### method `get_calls` @@ -2440,7 +2492,7 @@ Get calls matching this saved view's filters and settings. --- - + ### method `get_known_columns` @@ -2452,7 +2504,7 @@ Get the set of columns that are known to exist. --- - + ### method `get_table_columns` @@ -2462,7 +2514,7 @@ get_table_columns() → list[TableColumn] --- - + ### method `hide_column` @@ -2472,7 +2524,7 @@ hide_column(col_name: 'str') → SavedView --- - + ### method `insert_column` @@ -2486,7 +2538,7 @@ insert_column( --- - + ### classmethod `load` @@ -2496,7 +2548,7 @@ load(ref: 'str') → Self --- - + ### method `page_size` @@ -2506,7 +2558,7 @@ page_size(page_size: 'int') → SavedView --- - + ### method `pin_column_left` @@ -2516,7 +2568,7 @@ pin_column_left(col_name: 'str') → SavedView --- - + ### method `pin_column_right` @@ -2526,7 +2578,7 @@ pin_column_right(col_name: 'str') → SavedView --- - + ### method `remove_column` @@ -2536,7 +2588,7 @@ remove_column(path: 'int | str | ObjectPath') → SavedView --- - + ### method `remove_columns` @@ -2548,7 +2600,7 @@ Remove columns from the saved view. --- - + ### method `remove_filter` @@ -2558,7 +2610,7 @@ remove_filter(index_or_field: 'int | str') → SavedView --- - + ### method `remove_filters` @@ -2570,7 +2622,7 @@ Remove all filters from the saved view. --- - + ### method `rename` @@ -2580,7 +2632,7 @@ rename(label: 'str') → SavedView --- - + ### method `rename_column` @@ -2590,7 +2642,7 @@ rename_column(path: 'int | str | ObjectPath', label: 'str') → SavedView --- - + ### method `save` @@ -2602,7 +2654,7 @@ Publish the saved view to the server. --- - + ### method `set_columns` @@ -2614,7 +2666,7 @@ Set the columns to be displayed in the grid. --- - + ### method `show_column` @@ -2624,7 +2676,7 @@ show_column(col_name: 'str') → SavedView --- - + ### method `sort_by` @@ -2634,7 +2686,7 @@ sort_by(field: 'str', direction: 'SortDirection') → SavedView --- - + ### method `to_grid` @@ -2644,7 +2696,7 @@ to_grid(limit: 'int | None' = None) → Grid --- - + ### method `to_rich_table_str` @@ -2654,7 +2706,7 @@ to_rich_table_str() → str --- - + ### method `ui_url` @@ -2668,7 +2720,7 @@ Note this is the "result" page with traces etc, not the URL for the view object. --- - + ### method `unpin_column` @@ -2678,7 +2730,7 @@ unpin_column(col_name: 'str') → SavedView --- - + ## class `Scorer` @@ -2693,7 +2745,7 @@ unpin_column(col_name: 'str') → SavedView #### property display_name - + ### classmethod `from_obj` @@ -2703,7 +2755,7 @@ from_obj(obj: WeaveObject) → Self --- - + ### method `model_post_init` @@ -2713,7 +2765,7 @@ model_post_init(context: Any) → None --- - + ### method `score` @@ -2723,7 +2775,7 @@ score(output: Any, **kwargs: Any) → Any --- - + ### method `summarize` @@ -2733,14 +2785,14 @@ summarize(score_rows: list) → dict | None --- - + ## class `Session` Deprecated alias of :class:`weave.Conversation`. Accepts the old ``session_id`` / ``session_name`` constructor fields and also exposes them as read/write properties that proxy to ``conversation_id`` / ``conversation_name``. The original ``Session`` had these as model fields, so old code that reads or assigns ``s.session_id`` keeps working. - + ### method `__init__` @@ -2773,11 +2825,21 @@ Deprecated alias of :attr:`conversation_name`. --- - + ## class `StringPrompt` +A prompt template for plain text prompts. + +Add variables in braces, then pass values for those variables to `format` to produce the final prompt text. + +**Example:** + prompt = StringPrompt("Hello {name}") prompt.format(name="Ada") 'Hello Ada' + +**Raises:** + + - `KeyError`: If you call `format` without a required template variable. - + ### method `__init__` @@ -2792,7 +2854,7 @@ __init__(content: str) - `ref`: `trace.refs.ObjectRef | None` - `content`: `` - + ### method `format` @@ -2802,7 +2864,7 @@ format(**kwargs: Any) → str --- - + ### classmethod `from_obj` @@ -2812,7 +2874,7 @@ from_obj(obj: WeaveObject) → Self --- - + ## class `SubAgent` A delegated agent invocation within a turn. @@ -2827,10 +2889,16 @@ Maps to a nested invoke_agent OTel span in the same trace. - `agent_description`: `` - `agent_version`: `` - `system_instructions`: `list[str]` +- `input_messages`: `list[conversation.types.Message]` +- `output_messages`: `list[conversation.types.Message]` +- `tool_name`: `` +- `tool_call_id`: `` +- `tool_call_arguments`: `` +- `tool_call_result`: `` - `started_at`: `datetime.datetime | None` - `ended_at`: `datetime.datetime | None` - + ### method `add_event` @@ -2854,7 +2922,7 @@ Must be called between span start and span end (inside ``with``). Outside that w --- - + ### method `end` @@ -2864,7 +2932,7 @@ end() → None --- - + ### method `llm` @@ -2876,13 +2944,11 @@ llm( ) → LLM ``` -Start an LLM call within this sub-agent. - -Sets the ``_current_llm`` contextvar so the LLM is visible via ``get_current_llm()`` regardless of whether a context manager is used. +Deprecated alias for :meth:`start_llm`. --- - + ### method `record` @@ -2891,6 +2957,12 @@ record( name: 'str | None' = None, model: 'str | None' = None, system_instructions: 'list[str] | None' = None, + input_messages: 'list[Message] | None' = None, + output_messages: 'list[Message] | None' = None, + tool_name: 'str | None' = None, + tool_call_id: 'str | None' = None, + tool_call_arguments: 'str | None' = None, + tool_call_result: 'str | None' = None, agent_id: 'str | None' = None, agent_description: 'str | None' = None, agent_version: 'str | None' = None @@ -2905,7 +2977,19 @@ Note: on the streaming (``with``) path the sub-agent span is named from ``name`` --- - + + +### method `record_error` + +```python +record_error(error: 'BaseException') → Self +``` + +Record a failure without ending the span; call ``end()`` when ready. + +--- + + ### method `set_attributes` @@ -2921,7 +3005,67 @@ Must be called between span start and span end — i.e. inside a ``with`` block. --- - + + +### method `start` + +```python +start(set_current: 'bool' = True) → Self +``` + +Start this sub-agent's span. ``__enter__`` without the ``with``. + +Pass ``set_current=False`` when sub-agents can be in flight concurrently. ``end()`` detaches via ``ContextVar.reset``, which silently corrupts the ambient context stack when overlapping spans end out of LIFO order — the surviving sibling stops being current, and the last detach restores an already-ended span. Children created through ``start_llm`` / ``start_tool`` / ``start_subagent`` nest under this span either way, because those factories thread an explicit parent context. + +--- + + + +### method `start_llm` + +```python +start_llm( + model: 'str' = '', + provider_name: 'str' = '', + system_instructions: 'list[str] | None' = None +) → LLM +``` + +Start an LLM call within this sub-agent. + +Sets the ``_current_llm`` contextvar so the LLM is visible via ``get_current_llm()`` regardless of whether a context manager is used. Pins the LLM's OTel parent to this SubAgent's span when the SubAgent has been entered. + +--- + + + +### method `start_subagent` + +```python +start_subagent(name: 'str', model: 'str' = '') → SubAgent +``` + +Start a nested sub-agent under this one. + +Pins the nested SubAgent's OTel parent to this SubAgent's span when this SubAgent has been entered. + +--- + + + +### method `start_tool` + +```python +start_tool(name: 'str', arguments: 'str' = '', tool_call_id: 'str' = '') → Tool +``` + +Start a tool execution within this sub-agent. + +Pins the Tool's OTel parent to this SubAgent's span when the SubAgent has been entered. + +--- + + ### method `tool` @@ -2929,15 +3073,15 @@ Must be called between span start and span end — i.e. inside a ``with`` block. tool(name: 'str', arguments: 'str' = '', tool_call_id: 'str' = '') → Tool ``` -Start a tool execution within this sub-agent. +Deprecated alias for :meth:`start_tool`. --- - + ## class `Table` - + ### method `__init__` @@ -2951,7 +3095,7 @@ __init__(rows: 'list[dict]') → None --- - + ### method `append` @@ -2963,7 +3107,7 @@ Add a row to the table. --- - + ### method `pop` @@ -2975,7 +3119,7 @@ Remove a row at the given index from the table. --- - + ## class `ContextAwareThread` A Thread that runs functions with the context of the caller. @@ -2995,7 +3139,7 @@ thread = threading.Thread(target=run_with_context(your_func, *args, **kwargs)) thread.start() ``` - + ### method `__init__` @@ -3039,7 +3183,7 @@ This is a non-negative integer. See the get_native_id() function. This represent --- - + ### method `run` @@ -3049,12 +3193,12 @@ run() → None --- - + ## class `ThreadContext` Context object providing access to current thread and turn information. - + ### method `__init__` @@ -3088,7 +3232,7 @@ Get the current turn_id from the active context. --- - + ## class `ContextAwareThreadPoolExecutor` A ThreadPoolExecutor that runs functions with the context of the caller. @@ -3107,7 +3251,7 @@ with concurrent.futures.ThreadPoolExecutor() as executor: executor.map(_wrapped_fn, vals) ``` - + ### method `__init__` @@ -3117,7 +3261,7 @@ __init__(*args: 'Any', **kwargs: 'Any') → None --- - + ### method `map` @@ -3132,7 +3276,7 @@ map( --- - + ### method `submit` @@ -3142,7 +3286,7 @@ submit(fn: 'Callable', *args: 'Any', **kwargs: 'Any') → Any --- - + ## class `Tool` One tool execution. Maps to an execute_tool OTel span. @@ -3162,7 +3306,7 @@ One tool execution. Maps to an execute_tool OTel span. - `started_at`: `datetime.datetime | None` - `ended_at`: `datetime.datetime | None` - + ### method `add_event` @@ -3186,7 +3330,7 @@ Must be called between span start and span end (inside ``with``). Outside that w --- - + ### method `end` @@ -3196,7 +3340,19 @@ end() → None --- - + + +### method `record_error` + +```python +record_error(error: 'BaseException') → Self +``` + +Record a failure without ending the span; call ``end()`` when ready. + +--- + + ### method `set_attributes` @@ -3212,7 +3368,7 @@ Must be called between span start and span end — i.e. inside a ``with`` block. --- - + ## class `Turn` One user-agent exchange. Maps to an invoke_agent OTel span. @@ -3228,12 +3384,13 @@ By default each turn starts its own OTel trace (``continue_parent_trace=False``) - `agent_version`: `` - `system_instructions`: `list[str]` - `messages`: `list[conversation.types.Message]` +- `output_messages`: `list[conversation.types.Message]` - `spans`: `list[conversation.conversation.LLM | conversation.conversation.Tool | conversation.conversation.SubAgent]` - `continue_parent_trace`: `` - `started_at`: `datetime.datetime | None` - `ended_at`: `datetime.datetime | None` - + ### method `add_event` @@ -3257,7 +3414,7 @@ Must be called between span start and span end (inside ``with``). Outside that w --- - + ### method `end` @@ -3267,7 +3424,7 @@ end() → None --- - + ### method `llm` @@ -3279,13 +3436,11 @@ llm( ) → LLM ``` -Start an LLM call (chat span, child of this turn). - -Sets the ``_current_llm`` contextvar so the LLM is visible via ``get_current_llm()`` regardless of whether a context manager is used. +Deprecated alias for :meth:`start_llm`. --- - + ### method `model_post_init` @@ -3295,13 +3450,14 @@ model_post_init(context: 'Any') → None --- - + ### method `record` ```python record( messages: 'list[Message] | None' = None, + output_messages: 'list[Message] | None' = None, system_instructions: 'list[str] | None' = None, agent_name: 'str | None' = None, model: 'str | None' = None, @@ -3313,13 +3469,25 @@ record( Set multiple turn fields in one call. -Collapses the per-field assignments a manually-instrumented agent otherwise makes on a turn (``system_instructions``, ``agent_id``, ...) into a single keyword call. Only fields explicitly passed (non-``None``) are applied — existing values are preserved. ``messages`` **replaces** the turn's existing messages (unlike ``Turn.user(...)``, which appends a single message). Returns ``self`` for chaining. Mirrors ``LLM.record``. +Collapses the per-field assignments a manually-instrumented agent otherwise makes on a turn (``system_instructions``, ``agent_id``, ...) into a single keyword call. Only fields explicitly passed (non-``None``) are applied — existing values are preserved. ``messages`` and ``output_messages`` independently replace the turn's existing input and output messages. This differs from ``Turn.user(...)``, which appends a single input message. Returns ``self`` for chaining. Mirrors ``LLM.record``. Note: on the streaming (``with``) path the turn span is named from ``agent_name`` at ``__enter__``, so set ``agent_name`` via ``start_turn`` rather than ``record`` if you need the span name to reflect it; ``record`` still updates the ``gen_ai.agent.name`` attribute. --- - + + +### method `record_error` + +```python +record_error(error: 'BaseException') → Self +``` + +Record a failure without ending the span; call ``end()`` when ready. + +--- + + ### method `set_attributes` @@ -3335,7 +3503,53 @@ Must be called between span start and span end — i.e. inside a ``with`` block. --- - + + +### method `start_llm` + +```python +start_llm( + model: 'str' = '', + provider_name: 'str' = '', + system_instructions: 'list[str] | None' = None +) → LLM +``` + +Start an LLM call (chat span, child of this turn). + +Sets the ``_current_llm`` contextvar so the LLM is visible via ``get_current_llm()`` regardless of whether a context manager is used. + +--- + + + +### method `start_subagent` + +```python +start_subagent( + name: 'str', + model: 'str' = '', + system_instructions: 'list[str] | None' = None +) → SubAgent +``` + +Start a sub-agent invocation (nested invoke_agent span, same trace). + +--- + + + +### method `start_tool` + +```python +start_tool(name: 'str', arguments: 'str' = '', tool_call_id: 'str' = '') → Tool +``` + +Start a tool execution (execute_tool span, child of this turn). + +--- + + ### method `subagent` @@ -3347,11 +3561,11 @@ subagent( ) → SubAgent ``` -Start a sub-agent invocation (nested invoke_agent span, same trace). +Deprecated alias for :meth:`start_subagent`. --- - + ### method `tool` @@ -3359,11 +3573,11 @@ Start a sub-agent invocation (nested invoke_agent span, same trace). tool(name: 'str', arguments: 'str' = '', tool_call_id: 'str' = '') → Tool ``` -Start a tool execution (execute_tool span, child of this turn). +Deprecated alias for :meth:`start_tool`. --- - + ### method `user` @@ -3375,7 +3589,7 @@ Append a user message mid-turn. --- - + ## class `Usage` Token usage for an LLM call. @@ -3390,7 +3604,7 @@ Token usage for an LLM call. --- - + ### function `add_tags` @@ -3405,7 +3619,7 @@ Add tags to an object version. --- - + ### function `as_op` @@ -3428,7 +3642,7 @@ Given a @weave.op decorated function, return its Op. --- - + ### function `attributes` @@ -3446,7 +3660,7 @@ with weave.attributes({'env': 'production'}): --- - + ### function `end_conversation` @@ -3458,7 +3672,7 @@ End the current conversation (from contextvar). --- - + ### function `end_llm` @@ -3470,7 +3684,7 @@ End the current LLM call (from contextvar). --- - + ### function `end_session` @@ -3482,7 +3696,7 @@ Deprecated alias of :func:`weave.end_conversation`. --- - + ### function `end_turn` @@ -3494,7 +3708,7 @@ End the current turn (from contextvar). --- - + ### function `finish` @@ -3508,7 +3722,7 @@ Following finish, calls of weave.op decorated functions will no longer be logged --- - + ### function `get` @@ -3538,7 +3752,7 @@ dataset2 = weave.get(ref) # same as dataset! --- - + ### function `get_aliases` @@ -3557,7 +3771,7 @@ Get aliases for an object version. --- - + ### function `get_client` @@ -3567,7 +3781,7 @@ get_client() → WeaveClient | None --- - + ### function `get_current_call` @@ -3586,7 +3800,7 @@ Get the Call object for the currently executing Op, within that Op. --- - + ### function `get_current_conversation` @@ -3598,7 +3812,7 @@ Return the active conversation from contextvar, or None. --- - + ### function `get_current_llm` @@ -3610,7 +3824,7 @@ Return the active LLM call from contextvar, or None. --- - + ### function `get_current_session` @@ -3622,7 +3836,7 @@ Deprecated alias of :func:`weave.get_current_conversation`. --- - + ### function `get_current_turn` @@ -3634,7 +3848,7 @@ Return the active turn from contextvar, or None. --- - + ### function `get_tags` @@ -3653,7 +3867,7 @@ Get tags for an object version. --- - + ### function `get_tags_and_aliases` @@ -3672,7 +3886,7 @@ Get both tags and aliases for an object version in a single call. --- - + ### function `init` @@ -3719,7 +3933,7 @@ NOTE: Client-level postprocessing runs after each op's own postprocessing. The o --- - + ### function `link_prompt_to_registry` @@ -3745,7 +3959,7 @@ Link a published prompt version into the registry. --- - + ### function `list_aliases` @@ -3760,7 +3974,7 @@ List all distinct aliases in the project. --- - + ### function `list_tags` @@ -3775,7 +3989,7 @@ List all distinct tags in the project. --- - + ### function `log_call` @@ -3862,7 +4076,7 @@ import weave --- - + ### function `log_conversation` @@ -3890,7 +4104,7 @@ Each Turn's ``.spans`` attribute provides its children. Auto-generates ``convers --- - + ### function `log_session` @@ -3913,7 +4127,7 @@ Deprecated alias of :func:`weave.log_conversation`. --- - + ### function `log_turn` @@ -3927,6 +4141,7 @@ log_turn( agent_description: 'str' = '', agent_version: 'str' = '', messages: 'list[Message] | None' = None, + output_messages: 'list[Message] | None' = None, system_instructions: 'list[str] | None' = None, spans: 'list[LLM | Tool | SubAgent] | None' = None, started_at: 'datetime | None' = None, @@ -3943,9 +4158,11 @@ Use when context managers aren't viable (stateless containers, callbacks, queue ``attributes`` are stamped on every emitted span; the streaming path reads these from the active conversation instead. Use custom, non-semconv keys: a key that collides with a span's own ``gen_ai.*`` / ``weave.*`` attribute is unsupported (which value wins is path-dependent). +``messages`` records the turn input and ``output_messages`` records the terminal agent response on the same ``invoke_agent`` span. + --- - + ### function `op` @@ -3973,7 +4190,7 @@ A decorator to weave op-ify a function or method. Works for both sync and async. --- - + ### function `otel_traces_endpoint` @@ -4000,7 +4217,7 @@ External callers (e.g. boot-time probes that want to verify the ingest endpoint --- - + ### function `publish` @@ -4030,7 +4247,7 @@ Weave creates a new version of the object if the object's name already exists an --- - + ### function `ref` @@ -4049,7 +4266,7 @@ Creates a Ref to an existing Weave object. This does not directly retrieve the o --- - + ### function `remove_aliases` @@ -4064,7 +4281,7 @@ Remove one or more aliases from an object. --- - + ### function `remove_tags` @@ -4081,7 +4298,7 @@ Remove tags from an object version. --- - + ### function `require_current_call` @@ -4132,7 +4349,7 @@ print(call.id) --- - + ### function `set_aliases` @@ -4147,7 +4364,7 @@ Set one or more aliases for an object version. --- - + ### function `set_view` @@ -4189,7 +4406,7 @@ Attach a custom view to the current call summary at `_weave.views.`. --- - + ### function `start_conversation` @@ -4211,7 +4428,7 @@ Create and activate a conversation. Sets the contextvar for cross-module access. --- - + ### function `start_llm` @@ -4231,7 +4448,7 @@ Pass ``provider_name`` explicitly. The SDK does not infer it from the model iden --- - + ### function `start_session` @@ -4253,7 +4470,7 @@ Deprecated alias of :func:`weave.start_conversation`. --- - + ### function `start_subagent` @@ -4271,7 +4488,7 @@ The SubAgent's OTel span automatically becomes a child of whatever span is curre --- - + ### function `start_tool` @@ -4285,7 +4502,7 @@ The Tool's OTel span automatically becomes a child of whatever span is current i --- - + ### function `start_turn` @@ -4304,13 +4521,13 @@ If no conversation is active, returns a disconnected Turn that is NOT set in the --- - + ### function `thread` ```python thread( - thread_id: 'str | object | None' = + thread_id: 'str | object | None' = ) → Iterator[ThreadContext] ``` @@ -4343,7 +4560,7 @@ with weave.thread(None) as t: --- - + ### function `wandb_init_hook` diff --git a/weave/reference/python-sdk/trace/feedback.mdx b/weave/reference/python-sdk/trace/feedback.mdx index fd4117f16c..aaea8b8880 100644 --- a/weave/reference/python-sdk/trace/feedback.mdx +++ b/weave/reference/python-sdk/trace/feedback.mdx @@ -10,12 +10,12 @@ import { SourceLink } from '/snippets/_includes/source-link.mdx'; --- - + ## class `FeedbackQuery` Lazy-loading object for fetching feedback from the server. - + ### method `__init__` @@ -32,7 +32,7 @@ __init__( --- - + ### method `execute` @@ -42,7 +42,7 @@ execute() → Feedbacks --- - + ### method `refresh` @@ -52,7 +52,7 @@ refresh() → Feedbacks --- - + ### method `refs` @@ -62,12 +62,12 @@ refs() → Refs --- - + ## class `Feedbacks` A collection of Feedback objects with utilities. - + ### method `__init__` @@ -80,7 +80,7 @@ __init__( --- - + ### method `refs` @@ -92,12 +92,12 @@ Return the unique refs associated with these feedbacks. --- - + ## class `RefFeedbackQuery` Object for interacting with feedback associated with a particular ref. - + ### method `__init__` @@ -107,7 +107,7 @@ __init__(ref: 'str') → None --- - + ### method `add` @@ -127,7 +127,7 @@ feedback_type: A string identifying the type of feedback. The "wandb." prefix is --- - + ### method `add_note` @@ -137,7 +137,7 @@ add_note(note: 'str', creator: 'str | None' = None) → str --- - + ### method `add_reaction` @@ -145,9 +145,11 @@ add_note(note: 'str', creator: 'str | None' = None) → str add_reaction(emoji: 'str', creator: 'str | None' = None) → str ``` +Add an emoji reaction, written as the type the target's UI renders. + --- - + ### method `execute` @@ -157,7 +159,7 @@ execute() → Feedbacks --- - + ### method `purge` @@ -167,7 +169,7 @@ purge(feedback_id: 'str') → None --- - + ### method `refresh` @@ -177,7 +179,7 @@ refresh() → Feedbacks --- - + ### method `refs` diff --git a/weave/reference/python-sdk/trace/op.mdx b/weave/reference/python-sdk/trace/op.mdx index e6f4f72aaa..014725a534 100644 --- a/weave/reference/python-sdk/trace/op.mdx +++ b/weave/reference/python-sdk/trace/op.mdx @@ -10,31 +10,31 @@ import { SourceLink } from '/snippets/_includes/source-link.mdx'; --- - + ## class `DisplayNameFuncError` --- - + ## class `OpCallError` --- - + ## class `OpKwargs` TypedDict for op() keyword arguments. --- - + ## class `Sentinel` Sentinel(package: 'str', path: 'str', name: 'str') - + ### method `__init__` @@ -44,13 +44,13 @@ __init__(package: 'str', path: 'str', name: 'str') → None --- - + ## class `WeaveKwargs` --- - + ### function `as_op` @@ -71,7 +71,7 @@ Given a @weave.op decorated function, return its Op. --- - + ### function `call` @@ -102,7 +102,7 @@ result, call = add.call(1, 2) --- - + ### function `calls` @@ -126,7 +126,7 @@ for call in calls: --- - + ### function `get_captured_code` @@ -142,7 +142,7 @@ ref = weave.publish(func) op = ref.get() captured_code = op.get_captured_code() --- - + ### function `is_op` @@ -154,7 +154,7 @@ Check if an object is an Op. --- - + ### function `is_placeholder_call` @@ -164,7 +164,7 @@ is_placeholder_call(call: 'Call') → TypeIs[NoOpCall] --- - + ### function `is_tracing_setting_disabled` @@ -174,7 +174,7 @@ is_tracing_setting_disabled() → bool --- - + ### function `maybe_bind_method` @@ -188,7 +188,7 @@ If self is None, return the function as is. --- - + ### function `maybe_unbind_method` @@ -204,7 +204,7 @@ For: --- - + ### function `op` @@ -232,7 +232,7 @@ A decorator to weave op-ify a function or method. Works for both sync and async. --- - + ### function `placeholder_call` @@ -242,7 +242,7 @@ placeholder_call() → Call --- - + ### function `setup_dunder_weave_dict` @@ -272,7 +272,7 @@ Sets up a __weave dict used to pass WeaveKwargs to ops. --- - + ### function `should_skip_tracing_for_op` diff --git a/weave/reference/python-sdk/trace/util.mdx b/weave/reference/python-sdk/trace/util.mdx index f526bfe3a4..2059428a5c 100644 --- a/weave/reference/python-sdk/trace/util.mdx +++ b/weave/reference/python-sdk/trace/util.mdx @@ -10,7 +10,7 @@ import { SourceLink } from '/snippets/_includes/source-link.mdx'; --- - + ## class `ContextAwareThread` A Thread that runs functions with the context of the caller. @@ -30,7 +30,7 @@ thread = threading.Thread(target=run_with_context(your_func, *args, **kwargs)) thread.start() ``` - + ### method `__init__` @@ -74,7 +74,7 @@ This is a non-negative integer. See the get_native_id() function. This represent --- - + ### method `run` @@ -84,7 +84,7 @@ run() → None --- - + ## class `ContextAwareThreadPoolExecutor` A ThreadPoolExecutor that runs functions with the context of the caller. @@ -103,7 +103,7 @@ with concurrent.futures.ThreadPoolExecutor() as executor: executor.map(_wrapped_fn, vals) ``` - + ### method `__init__` @@ -113,7 +113,7 @@ __init__(*args: 'Any', **kwargs: 'Any') → None --- - + ### method `map` @@ -128,7 +128,7 @@ map( --- - + ### method `submit` @@ -138,7 +138,7 @@ submit(fn: 'Callable', *args: 'Any', **kwargs: 'Any') → Any --- - + ### function `deprecated` @@ -150,7 +150,7 @@ Decorator to mark a function as deprecated and redirect users to `new_name`. --- - + ### function `is_colab` @@ -160,7 +160,7 @@ is_colab() --- - + ### function `is_notebook` @@ -170,7 +170,7 @@ is_notebook() → bool --- - + ### function `log_once` diff --git a/weave/reference/python-sdk/trace/weave_client.mdx b/weave/reference/python-sdk/trace/weave_client.mdx index a87bcfdde1..0eb54f660a 100644 --- a/weave/reference/python-sdk/trace/weave_client.mdx +++ b/weave/reference/python-sdk/trace/weave_client.mdx @@ -10,39 +10,39 @@ import { SourceLink } from '/snippets/_includes/source-link.mdx'; --- - + ## class `CrossProjectRefError` Raised when client-side digest computation encounters a ref to a different project that cannot be resolved to an internal ID. --- - + ## class `FlushStatus` Status information about the current flush operation. --- - + ## class `NoInternalProjectIDError` Raised when client-side digest computation cannot proceed because no internal project ID has been resolved yet. --- - + ## class `PendingJobCounts` Counts of pending jobs for each type. --- - + ## class `WeaveClient` - + ### method `__init__` @@ -77,7 +77,7 @@ This property can be used to check the progress of background tasks without bloc --- - + ### method `add_calls_to_annotation_queue` @@ -96,7 +96,7 @@ Add calls to an annotation queue. --- - + ### method `add_cost` @@ -108,7 +108,9 @@ add_cost( effective_date: 'datetime | None' = None, prompt_token_cost_unit: 'str | None' = 'USD', completion_token_cost_unit: 'str | None' = 'USD', - provider_id: 'str | None' = 'default' + provider_id: 'str | None' = 'default', + cache_read_input_token_cost: 'float' = 0, + cache_creation_input_token_cost: 'float' = 0 ) → CostCreateRes ``` @@ -133,12 +135,14 @@ client.add_cost(llm_id="my_expensive_custom_model", prompt_token_cost=500, compl - `provider_id`: The provider of the LLM. Defaults to "default". eg "openai" - `prompt_token_cost_unit`: The unit of the cost for the prompt tokens. Defaults to "USD". (Currently unused, will be used in the future to specify the currency type for the cost eg "tokens" or "time") - `completion_token_cost_unit`: The unit of the cost for the completion tokens. Defaults to "USD". (Currently unused, will be used in the future to specify the currency type for the cost eg "tokens" or "time") + - `cache_read_input_token_cost`: The cost per cache-read input token. Defaults to 0. + - `cache_creation_input_token_cost`: The cost per cache-creation input token. Defaults to 0. **Returns:** A CostCreateRes object. Which has one field called a list of tuples called ids. Each tuple contains the llm_id and the id of the created cost object. --- - + ### method `add_tags` @@ -153,7 +157,7 @@ Add tags to an object version. --- - + ### method `clear_wandb_run_context` @@ -178,7 +182,7 @@ client.clear_wandb_run_context() --- - + ### method `create_annotation_queue` @@ -203,7 +207,7 @@ Create an annotation queue for this project. --- - + ### method `create_call` @@ -237,7 +241,7 @@ Create, log, and push a call onto the runtime stack. --- - + ### method `delete_all_object_versions` @@ -256,7 +260,7 @@ Delete all versions of an object. --- - + ### method `delete_all_op_versions` @@ -275,7 +279,7 @@ Delete all versions of an op. --- - + ### method `delete_annotation_queue` @@ -287,7 +291,7 @@ Soft-delete an annotation queue. --- - + ### method `delete_call` @@ -297,7 +301,7 @@ delete_call(call: 'Call') → None --- - + ### method `delete_calls` @@ -314,7 +318,7 @@ Deleting a call will also delete all of its children. --- - + ### method `delete_object_version` @@ -324,7 +328,7 @@ delete_object_version(object: 'ObjectRef') → None --- - + ### method `delete_object_versions` @@ -345,7 +349,7 @@ Delete specific versions of an object. --- - + ### method `delete_op_version` @@ -355,7 +359,7 @@ delete_op_version(op: 'OpRef') → None --- - + ### method `fail_call` @@ -367,7 +371,7 @@ Fail a call with an exception. This is a convenience method for finish_call. --- - + ### method `finish` @@ -387,7 +391,7 @@ This method blocks until all currently enqueued jobs are processed, displaying a --- - + ### method `finish_call` @@ -407,7 +411,7 @@ Any values present in ``call.summary`` are deep-merged with computed summary sta --- - + ### method `flush` @@ -419,7 +423,7 @@ Flushes background asynchronous tasks, safe to call multiple times. --- - + ### method `get` @@ -429,7 +433,27 @@ get(ref: 'ObjectRef', objectify: 'bool' = True) → Any --- - + + +### method `get_agent_conversation_feedback` + +```python +get_agent_conversation_feedback(conversation_id: 'str') → RefFeedbackQuery +``` + +Feedback interface for an agent conversation (a session of turns). + + - `use_progress_bar`: Whether to display a progress bar during flush. Set to False for environments where a progress bar would not render well (e.g., CI environments). + - `callback`: Optional callback function that receives status updates. Overrides use_progress_bar. +**Examples:** +```python +fb = client.get_agent_conversation_feedback("") +fb.add_reaction("👍") +``` + +--- + + ### method `get_agent_custom_attributes` @@ -447,8 +471,6 @@ Discover typed custom-attribute keys on matching agent spans. Useful for populating filter/column pickers: returns the custom attribute keys (and their value types) seen on the selected spans. - - `use_progress_bar`: Whether to display a progress bar during flush. Set to False for environments where a progress bar would not render well (e.g., CI environments). - - `callback`: Optional callback function that receives status updates. Overrides use_progress_bar. **Args:** @@ -470,7 +492,26 @@ for attr in resp.attributes: --- - + + +### method `get_agent_span_feedback` + +```python +get_agent_span_feedback(span_id: 'str') → RefFeedbackQuery +``` + +Feedback interface for an agent span (one message in the Agent view). + +**Examples:** +```python +fb = client.get_agent_span_feedback("") +fb.add_reaction("👍") +fb.add_note("Great answer") +``` + +--- + + ### method `get_agent_span_stats` @@ -513,7 +554,7 @@ for row in resp.rows: --- - + ### method `get_agent_spans` @@ -553,7 +594,7 @@ for span in client.get_agent_spans(agent_name="my-agent"): --- - + ### method `get_agent_turn` @@ -586,7 +627,25 @@ for message in resp.messages: --- - + + +### method `get_agent_turn_feedback` + +```python +get_agent_turn_feedback(trace_id: 'str') → RefFeedbackQuery +``` + +Feedback interface for an agent turn (one user->agent exchange). + +**Examples:** +```python +fb = client.get_agent_turn_feedback("") +fb.add_reaction("👍") +``` + +--- + + ### method `get_agent_turns` @@ -624,7 +683,7 @@ for turn in resp.turns: --- - + ### method `get_agent_versions` @@ -662,7 +721,7 @@ for version in client.get_agent_versions(agent_name="my-agent"): --- - + ### method `get_agents` @@ -700,7 +759,7 @@ for agent in client.get_agents(limit=20): --- - + ### method `get_aliases` @@ -719,7 +778,7 @@ Get aliases for an object version. --- - + ### method `get_annotation_queue` @@ -731,7 +790,7 @@ Read a single annotation queue by ID. --- - + ### method `get_annotation_queue_stats` @@ -745,7 +804,7 @@ Get item completion stats for annotation queues. --- - + ### method `get_call` @@ -772,7 +831,7 @@ Get a single call by its ID. --- - + ### method `get_calls` @@ -835,7 +894,7 @@ for call in calls: --- - + ### method `get_evaluation` @@ -871,7 +930,7 @@ print(evaluation.name) --- - + ### method `get_evaluations` @@ -896,7 +955,7 @@ for eval in evaluations: --- - + ### method `get_feedback` @@ -950,7 +1009,7 @@ client.get_feedback(query=query) --- - + ### method `get_tags` @@ -969,7 +1028,7 @@ Get tags for an object version. --- - + ### method `get_tags_and_aliases` @@ -988,7 +1047,7 @@ Get both tags and aliases for an object version in a single call. --- - + ### method `link_prompt_to_registry` @@ -1014,7 +1073,7 @@ Link a published prompt version into the registry. --- - + ### method `list_aliases` @@ -1029,7 +1088,7 @@ List all distinct aliases in the project. --- - + ### method `list_annotation_queue_items` @@ -1048,7 +1107,7 @@ List calls assigned to an annotation queue. --- - + ### method `list_annotation_queues` @@ -1065,7 +1124,7 @@ List annotation queues for this project. --- - + ### method `list_tags` @@ -1080,7 +1139,7 @@ List all distinct tags in the project. --- - + ### method `purge_costs` @@ -1101,7 +1160,7 @@ client.purge_costs(ids) --- - + ### method `query_costs` @@ -1140,7 +1199,27 @@ client.query_costs(llm_ids=["gpt-4o-mini-2024-07-18"], limit=10) --- - + + +### method `register_custom_runtime` + +```python +register_custom_runtime( + name: 'str', + base_url: 'str', + runtime_ids: 'Iterable[str | CustomRuntimeID]', + api_key_secret: 'str | None' = None, + headers: 'Mapping[str, str] | None' = None +) → CustomRuntimeApplyRes +``` + +Register a custom runtime, replacing its configuration if it exists. + +Runtime IDs omitted from this call are removed. String IDs use the default maximum token count; pass ``CustomRuntimeID`` to set it explicitly. Inference may use a prior configuration for up to 60 seconds after an update. + +--- + + ### method `remove_aliases` @@ -1155,7 +1234,7 @@ Remove one or more aliases from an object. --- - + ### method `remove_tags` @@ -1172,7 +1251,7 @@ Remove tags from an object version. --- - + ### method `save` @@ -1195,7 +1274,7 @@ Do not call directly, use weave.publish() instead. --- - + ### method `search_agents` @@ -1236,7 +1315,7 @@ for conversation in resp.results: --- - + ### method `set_aliases` @@ -1251,7 +1330,7 @@ Set one or more aliases for an object version. --- - + ### method `set_wandb_run_context` @@ -1283,7 +1362,7 @@ client.set_wandb_run_context(run_id="my-run-id") --- - + ### method `update_annotation_queue` @@ -1300,7 +1379,7 @@ Update annotation queue metadata. --- - + ### function `get_obj_name` @@ -1310,7 +1389,7 @@ get_obj_name(val: 'Any') → str --- - + ### function `get_parallelism_settings` @@ -1320,7 +1399,7 @@ get_parallelism_settings() → tuple[int | None, int | None] --- - + ### function `map_to_refs` @@ -1330,7 +1409,7 @@ map_to_refs(obj: 'Any') → Any --- - + ### function `print_call_link` @@ -1340,7 +1419,7 @@ print_call_link(call: 'Call') → None --- - + ### function `redact_sensitive_keys` @@ -1350,7 +1429,7 @@ redact_sensitive_keys(obj: 'Any') → Any --- - + ### function `sanitize_object_name` diff --git a/weave/reference/python-sdk/trace_server/trace_server_interface.mdx b/weave/reference/python-sdk/trace_server/trace_server_interface.mdx index 3c4e1c4add..b3d53f9017 100644 --- a/weave/reference/python-sdk/trace_server/trace_server_interface.mdx +++ b/weave/reference/python-sdk/trace_server/trace_server_interface.mdx @@ -10,14 +10,14 @@ import { SourceLink } from '/snippets/_includes/source-link.mdx'; --- - + ## class `AggregationType` Aggregation functions supported by feedback and call stats metrics. --- - + ## class `AliasesListReq` @@ -28,7 +28,7 @@ Aggregation functions supported by feedback and call stats metrics. --- - + ## class `AliasesListRes` @@ -38,7 +38,7 @@ Aggregation functions supported by feedback and call stats metrics. --- - + ## class `AnnotationQueueAddCallsReq` Request to add calls to an annotation queue in batch. @@ -55,7 +55,7 @@ Extends AnnotationQueueAddCallsBody by adding queue_id for internal API usage. --- - + ## class `AnnotationQueueAddCallsRes` Response from adding calls to a queue. @@ -67,7 +67,7 @@ Response from adding calls to a queue. --- - + ## class `AnnotationQueueCreateReq` Request to create a new annotation queue. @@ -82,7 +82,7 @@ Request to create a new annotation queue. --- - + ## class `AnnotationQueueCreateRes` Response from creating an annotation queue. @@ -93,7 +93,7 @@ Response from creating an annotation queue. --- - + ## class `AnnotationQueueDeleteReq` Request to delete (soft-delete) an annotation queue. @@ -106,7 +106,7 @@ Request to delete (soft-delete) an annotation queue. --- - + ## class `AnnotationQueueDeleteRes` Response from deleting an annotation queue. @@ -117,7 +117,7 @@ Response from deleting an annotation queue. --- - + ## class `AnnotationQueueItemSchema` Schema for annotation queue item responses. @@ -144,7 +144,7 @@ Schema for annotation queue item responses. --- - + ## class `AnnotationQueueItemsQueryReq` Request to query items in an annotation queue. @@ -163,7 +163,7 @@ Extends AnnotationQueueItemsQueryBody by adding queue_id for internal API usage. --- - + ## class `AnnotationQueueItemsQueryRes` Response from querying annotation queue items. @@ -174,7 +174,7 @@ Response from querying annotation queue items. --- - + ## class `AnnotationQueueReadReq` Request to read a specific annotation queue. @@ -186,7 +186,7 @@ Request to read a specific annotation queue. --- - + ## class `AnnotationQueueReadRes` Response from reading an annotation queue. @@ -197,7 +197,7 @@ Response from reading an annotation queue. --- - + ## class `AnnotationQueueSchema` Schema for annotation queue responses. @@ -216,7 +216,7 @@ Schema for annotation queue responses. --- - + ## class `AnnotationQueueStatsSchema` Statistics for a single annotation queue. @@ -229,7 +229,7 @@ Statistics for a single annotation queue. --- - + ## class `AnnotationQueueUpdateReq` Request to update an annotation queue. @@ -247,7 +247,7 @@ All fields except project_id and queue_id are optional - only provided fields wi --- - + ## class `AnnotationQueueUpdateRes` Response from updating an annotation queue. @@ -258,7 +258,7 @@ Response from updating an annotation queue. --- - + ## class `AnnotationQueuesQueryReq` Request to query annotation queues for a project. @@ -273,7 +273,7 @@ Request to query annotation queues for a project. --- - + ## class `AnnotationQueuesQueryRes` Response from querying annotation queues. @@ -284,7 +284,7 @@ Response from querying annotation queues. --- - + ## class `AnnotationQueuesStatsReq` Request to get stats for multiple annotation queues. @@ -296,7 +296,7 @@ Request to get stats for multiple annotation queues. --- - + ## class `AnnotationQueuesStatsRes` Response with stats for multiple annotation queues. @@ -307,7 +307,7 @@ Response with stats for multiple annotation queues. --- - + ## class `AnnotatorQueueItemsProgressUpdateReq` Request to update the annotation state of a queue item for the current annotator. @@ -328,7 +328,7 @@ Valid state transitions: --- - + ## class `AnnotatorQueueItemsProgressUpdateRes` Response from updating annotation state. @@ -339,7 +339,7 @@ Response from updating annotation state. --- - + ## class `CallBatchEndMode` @@ -350,7 +350,7 @@ Response from updating annotation state. --- - + ## class `CallBatchStartMode` @@ -361,7 +361,7 @@ Response from updating annotation state. --- - + ## class `CallCreateBatchReq` @@ -371,7 +371,7 @@ Response from updating annotation state. --- - + ## class `CallCreateBatchRes` @@ -381,7 +381,7 @@ Response from updating annotation state. --- - + ## class `CallEndReq` @@ -391,13 +391,13 @@ Response from updating annotation state. --- - + ## class `CallEndRes` --- - + ## class `CallEndV2Req` Request for ending a single call via v2 API. @@ -408,14 +408,14 @@ Request for ending a single call via v2 API. --- - + ## class `CallEndV2Res` Response for ending a single call via v2 API. --- - + ## class `CallMetricSpec` Specification for a call-level metric to aggregate (not grouped by model). @@ -428,7 +428,7 @@ Specification for a call-level metric to aggregate (not grouped by model). --- - + ## class `CallReadReq` @@ -442,7 +442,7 @@ Specification for a call-level metric to aggregate (not grouped by model). --- - + ## class `CallReadRes` @@ -452,7 +452,7 @@ Specification for a call-level metric to aggregate (not grouped by model). --- - + ## class `CallSchema` @@ -483,7 +483,7 @@ Specification for a call-level metric to aggregate (not grouped by model). - `storage_size_bytes`: `int | None` - `total_storage_size_bytes`: `int | None` - + ### method `serialize_typed_dicts` @@ -493,7 +493,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `CallStartReq` @@ -503,7 +503,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `CallStartRes` @@ -514,7 +514,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `CallStartV2Req` Request for starting a single call via v2 API. @@ -525,7 +525,7 @@ Request for starting a single call via v2 API. --- - + ## class `CallStartV2Res` Response for starting a single call via v2 API. @@ -537,7 +537,7 @@ Response for starting a single call via v2 API. --- - + ## class `CallStatsReq` Request for aggregated call statistics over a time range. @@ -553,7 +553,7 @@ Request for aggregated call statistics over a time range. - `filter`: `CallsFilter | None` - `timezone`: `` - + ### method `validate_date_range` @@ -565,7 +565,7 @@ Ensure call stats requests are bounded to a safe date range. --- - + ## class `CallStatsRes` Response containing time-series call statistics. @@ -581,7 +581,7 @@ Response containing time-series call statistics. --- - + ## class `CallUpdateReq` @@ -594,13 +594,13 @@ Response containing time-series call statistics. --- - + ## class `CallUpdateRes` --- - + ## class `CallsDeleteReq` @@ -612,7 +612,7 @@ Response containing time-series call statistics. --- - + ## class `CallsDeleteRes` @@ -622,7 +622,7 @@ Response containing time-series call statistics. --- - + ## class `CallsFilter` @@ -642,7 +642,7 @@ Response containing time-series call statistics. --- - + ## class `CallsQueryReq` @@ -665,7 +665,7 @@ Response containing time-series call statistics. --- - + ## class `CallsQueryRes` @@ -675,7 +675,7 @@ Response containing time-series call statistics. --- - + ## class `CallsQueryStatsReq` @@ -690,7 +690,7 @@ Response containing time-series call statistics. --- - + ## class `CallsQueryStatsRes` @@ -702,7 +702,7 @@ Response containing time-series call statistics. --- - + ## class `CallsScoreReq` Request to enqueue scoring jobs for a list of calls. @@ -718,7 +718,7 @@ Scoring is performed asynchronously by the call_scoring_worker, which consumes m --- - + ## class `CallsScoreRes` Empty response for calls_score. @@ -727,7 +727,7 @@ Defined as a model (rather than returning None) to follow the convention used th --- - + ## class `CallsUpsertCompleteReq` Request for upserting a batch of completed calls. @@ -738,14 +738,14 @@ Request for upserting a batch of completed calls. --- - + ## class `CallsUpsertCompleteRes` Response for upserting a batch of completed calls. --- - + ## class `CallsUsageReq` Request to compute aggregated usage for multiple root calls. @@ -763,7 +763,7 @@ Note: All matching calls are loaded into memory for aggregation. For very large --- - + ## class `CallsUsageRes` Response with aggregated usage metrics per root call. @@ -775,7 +775,7 @@ Response with aggregated usage metrics per root call. --- - + ## class `CompletedCallSchemaForInsert` Schema for inserting a completed call directly. @@ -805,7 +805,7 @@ This represents a call that is already finished at insertion time, with both sta - `wb_run_step`: `int | None` - `wb_run_step_end`: `int | None` - + ### method `serialize_typed_dicts` @@ -815,7 +815,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `CompletionsCreateReq` @@ -833,7 +833,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `CompletionsCreateRequestInputs` @@ -861,6 +861,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] - `logprobs`: `bool | None` - `top_logprobs`: `int | None` - `parallel_tool_calls`: `bool | None` +- `reasoning_effort`: `str | None` - `extra_headers`: `dict | None` - `functions`: `list | None` - `function_call`: `str | None` @@ -871,7 +872,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `CompletionsCreateRes` @@ -885,7 +886,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `CostCreateInput` @@ -902,7 +903,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `CostCreateReq` @@ -914,7 +915,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `CostCreateRes` @@ -924,7 +925,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `CostPurgeReq` @@ -935,13 +936,13 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `CostPurgeRes` --- - + ## class `CostQueryOutput` @@ -951,6 +952,8 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] - `llm_id`: `str | None` - `prompt_token_cost`: `float | None` - `completion_token_cost`: `float | None` +- `cache_read_input_token_cost`: `float | None` +- `cache_creation_input_token_cost`: `float | None` - `prompt_token_cost_unit`: `str | None` - `completion_token_cost_unit`: `str | None` - `effective_date`: `datetime.datetime | None` @@ -958,7 +961,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `CostQueryReq` @@ -973,7 +976,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `CostQueryRes` @@ -983,7 +986,103 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + + +## class `CustomRuntimeApplyBody` + +**Pydantic Fields:** + +- `base_url`: `` +- `api_key_secret`: `str | None` +- `headers`: `dict[str, str]` +- `runtime_ids`: `list[CustomRuntimeID]` + + + +### classmethod `validate_unique_runtime_ids` + +```python +validate_unique_runtime_ids( + runtime_ids: list[CustomRuntimeID] +) → list[CustomRuntimeID] +``` + +--- + + + +## class `CustomRuntimeApplyReq` + +**Pydantic Fields:** + +- `base_url`: `` +- `api_key_secret`: `str | None` +- `headers`: `dict[str, str]` +- `runtime_ids`: `list[CustomRuntimeID]` +- `project_id`: `` +- `runtime_name`: `` +- `wb_user_id`: `str | None` + + + +### method `validate_storage_name_length` + +```python +validate_storage_name_length() → Self +``` + +--- + + + +### classmethod `validate_unique_runtime_ids` + +```python +validate_unique_runtime_ids( + runtime_ids: list[CustomRuntimeID] +) → list[CustomRuntimeID] +``` + +--- + + + +## class `CustomRuntimeApplyRes` + +**Pydantic Fields:** + +- `name`: `` +- `base_url`: `` +- `api_key_secret`: `str | None` +- `headers`: `dict[str, str]` +- `runtime_ids`: `list[CustomRuntimeIDRes]` + +--- + + + +## class `CustomRuntimeID` + +**Pydantic Fields:** + +- `id`: `` +- `max_tokens`: `` + +--- + + + +## class `CustomRuntimeIDRes` + +**Pydantic Fields:** + +- `id`: `` +- `max_tokens`: `` +- `playground_id`: `` + +--- + + ## class `DatasetCreateBody` @@ -995,7 +1094,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `DatasetCreateReq` @@ -1009,7 +1108,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `DatasetCreateRes` @@ -1021,7 +1120,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `DatasetDeleteReq` @@ -1034,7 +1133,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `DatasetDeleteRes` @@ -1044,7 +1143,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `DatasetListReq` @@ -1057,7 +1156,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `DatasetReadReq` @@ -1070,7 +1169,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `DatasetReadRes` @@ -1086,7 +1185,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `DatasetSourceLinkPayload` A single dataset row and the sources to link to it. @@ -1099,7 +1198,7 @@ A single dataset row and the sources to link to it. --- - + ## class `DatasetSourceLinkSchema` Schema for a single dataset source link row. @@ -1121,7 +1220,7 @@ Schema for a single dataset source link row. --- - + ## class `DatasetSourcesLinkDeleteReq` Request to soft-delete dataset source links by id. @@ -1134,7 +1233,7 @@ Request to soft-delete dataset source links by id. --- - + ## class `DatasetSourcesLinkDeleteRes` Response from deleting dataset source links. @@ -1145,7 +1244,7 @@ Response from deleting dataset source links. --- - + ## class `DatasetSourcesLinkDeleteResEntry` Result for a single link deletion. @@ -1157,7 +1256,7 @@ Result for a single link deletion. --- - + ## class `DatasetSourcesLinkReq` Request to link dataset rows to their provenance sources. @@ -1173,7 +1272,7 @@ Request to link dataset rows to their provenance sources. --- - + ## class `DatasetSourcesLinkRes` Response from linking dataset rows to sources. @@ -1186,7 +1285,7 @@ One entry per flattened (row_digest, source) tuple, in input order. --- - + ## class `DatasetSourcesLinkResEntry` Result for a single flattened (row_digest, source) link. @@ -1198,7 +1297,7 @@ Result for a single flattened (row_digest, source) link. --- - + ## class `DatasetSourcesQueryReq` Forward query: dataset -> sources. @@ -1216,7 +1315,7 @@ Forward query: dataset -> sources. --- - + ## class `DatasetSourcesQueryRes` Response from the forward dataset -> sources query. @@ -1227,7 +1326,19 @@ Response from the forward dataset -> sources query. --- - + + +## class `DeletedObjVersion` + +**Pydantic Fields:** + +- `digest`: `` +- `base_object_class`: `str | None` +- `leaf_object_class`: `str | None` + +--- + + ## class `EndedCallSchemaForInsert` @@ -1244,7 +1355,7 @@ Response from the forward dataset -> sources query. - `summary`: `` - `wb_run_step_end`: `int | None` - + ### method `serialize_typed_dicts` @@ -1254,7 +1365,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `EndedCallSchemaForInsertWithStartedAt` Deprecated alias. `started_at` now lives on the parent `EndedCallSchemaForInsert`; prefer that. Kept so external SDK pins on the `WithStartedAt` name keep importing. Remove once all in-tree callers migrate. @@ -1272,7 +1383,7 @@ Deprecated alias. `started_at` now lives on the parent `EndedCallSchemaForInsert - `summary`: `` - `wb_run_step_end`: `int | None` - + ### method `serialize_typed_dicts` @@ -1282,7 +1393,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `EvalResultsEvaluationSummary` @@ -1301,7 +1412,7 @@ serialize_typed_dicts(v: dict[str, Any]) → dict[str, Any] --- - + ## class `EvalResultsFilter` A filter scoped to an optional evaluation. @@ -1313,7 +1424,7 @@ A filter scoped to an optional evaluation. --- - + ## class `EvalResultsQueryBody` @@ -1335,7 +1446,7 @@ A filter scoped to an optional evaluation. - `limit`: `int | None` - `offset`: `` - + ### method `validate_identifiers` @@ -1347,7 +1458,7 @@ Validate that at least one evaluation identifier is provided. --- - + ## class `EvalResultsQueryReq` @@ -1370,7 +1481,7 @@ Validate that at least one evaluation identifier is provided. - `offset`: `` - `project_id`: `` - + ### method `validate_identifiers` @@ -1382,7 +1493,7 @@ Validate that at least one evaluation identifier is provided. --- - + ## class `EvalResultsQueryRes` @@ -1395,7 +1506,7 @@ Validate that at least one evaluation identifier is provided. --- - + ## class `EvalResultsRow` @@ -1407,7 +1518,7 @@ Validate that at least one evaluation identifier is provided. --- - + ## class `EvalResultsRowEvaluation` @@ -1418,7 +1529,7 @@ Validate that at least one evaluation identifier is provided. --- - + ## class `EvalResultsScorerStats` Stats for a single flattened score dimension (scorer_key or scorer_key.path.to.leaf). @@ -1438,7 +1549,7 @@ Stats for a single flattened score dimension (scorer_key or scorer_key.path.to.l --- - + ## class `EvalResultsSortBy` Sort specification for evaluation results, extending SortBy @@ -1452,7 +1563,7 @@ Sort specification for evaluation results, extending SortBy --- - + ## class `EvalResultsSummaryRes` @@ -1463,7 +1574,7 @@ Sort specification for evaluation results, extending SortBy --- - + ## class `EvalResultsTrial` @@ -1481,7 +1592,7 @@ Sort specification for evaluation results, extending SortBy --- - + ## class `EvaluateModelArgs` Arguments for a full evaluate-model job (loads model + runs predictions + scores). @@ -1499,7 +1610,7 @@ Moved from workers/evaluate_model_worker/evaluate_model_worker.py so both job ty --- - + ## class `EvaluateModelReq` @@ -1512,7 +1623,7 @@ Moved from workers/evaluate_model_worker/evaluate_model_worker.py so both job ty --- - + ## class `EvaluateModelRes` @@ -1522,7 +1633,7 @@ Moved from workers/evaluate_model_worker/evaluate_model_worker.py so both job ty --- - + ## class `EvaluationCreateBody` @@ -1538,7 +1649,7 @@ Moved from workers/evaluate_model_worker/evaluate_model_worker.py so both job ty --- - + ## class `EvaluationCreateReq` @@ -1556,7 +1667,7 @@ Moved from workers/evaluate_model_worker/evaluate_model_worker.py so both job ty --- - + ## class `EvaluationCreateRes` @@ -1569,7 +1680,7 @@ Moved from workers/evaluate_model_worker/evaluate_model_worker.py so both job ty --- - + ## class `EvaluationDeleteReq` @@ -1582,7 +1693,7 @@ Moved from workers/evaluate_model_worker/evaluate_model_worker.py so both job ty --- - + ## class `EvaluationDeleteRes` @@ -1592,7 +1703,7 @@ Moved from workers/evaluate_model_worker/evaluate_model_worker.py so both job ty --- - + ## class `EvaluationListReq` @@ -1605,7 +1716,7 @@ Moved from workers/evaluate_model_worker/evaluate_model_worker.py so both job ty --- - + ## class `EvaluationReadReq` @@ -1618,7 +1729,7 @@ Moved from workers/evaluate_model_worker/evaluate_model_worker.py so both job ty --- - + ## class `EvaluationReadRes` @@ -1640,7 +1751,7 @@ Moved from workers/evaluate_model_worker/evaluate_model_worker.py so both job ty --- - + ## class `EvaluationRunCreateBody` @@ -1652,7 +1763,7 @@ Moved from workers/evaluate_model_worker/evaluate_model_worker.py so both job ty --- - + ## class `EvaluationRunCreateReq` @@ -1666,7 +1777,7 @@ Moved from workers/evaluate_model_worker/evaluate_model_worker.py so both job ty --- - + ## class `EvaluationRunCreateRes` @@ -1676,7 +1787,7 @@ Moved from workers/evaluate_model_worker/evaluate_model_worker.py so both job ty --- - + ## class `EvaluationRunDeleteReq` @@ -1688,7 +1799,7 @@ Moved from workers/evaluate_model_worker/evaluate_model_worker.py so both job ty --- - + ## class `EvaluationRunDeleteRes` @@ -1698,7 +1809,7 @@ Moved from workers/evaluate_model_worker/evaluate_model_worker.py so both job ty --- - + ## class `EvaluationRunFilter` @@ -1710,7 +1821,7 @@ Moved from workers/evaluate_model_worker/evaluate_model_worker.py so both job ty --- - + ## class `EvaluationRunFinishBody` Request body for finishing an evaluation run via REST API. @@ -1723,7 +1834,7 @@ This model excludes project_id and evaluation_run_id since they come from the UR --- - + ## class `EvaluationRunFinishReq` @@ -1736,7 +1847,7 @@ This model excludes project_id and evaluation_run_id since they come from the UR --- - + ## class `EvaluationRunFinishRes` @@ -1746,7 +1857,7 @@ This model excludes project_id and evaluation_run_id since they come from the UR --- - + ## class `EvaluationRunListReq` @@ -1759,7 +1870,7 @@ This model excludes project_id and evaluation_run_id since they come from the UR --- - + ## class `EvaluationRunReadReq` @@ -1770,7 +1881,7 @@ This model excludes project_id and evaluation_run_id since they come from the UR --- - + ## class `EvaluationRunReadRes` @@ -1787,7 +1898,7 @@ This model excludes project_id and evaluation_run_id since they come from the UR --- - + ## class `EvaluationStatusComplete` @@ -1798,7 +1909,7 @@ This model excludes project_id and evaluation_run_id since they come from the UR --- - + ## class `EvaluationStatusFailed` @@ -1809,7 +1920,7 @@ This model excludes project_id and evaluation_run_id since they come from the UR --- - + ## class `EvaluationStatusNotFound` @@ -1819,7 +1930,7 @@ This model excludes project_id and evaluation_run_id since they come from the UR --- - + ## class `EvaluationStatusReq` @@ -1830,7 +1941,7 @@ This model excludes project_id and evaluation_run_id since they come from the UR --- - + ## class `EvaluationStatusRes` @@ -1840,7 +1951,7 @@ This model excludes project_id and evaluation_run_id since they come from the UR --- - + ## class `EvaluationStatusRunning` @@ -1852,7 +1963,68 @@ This model excludes project_id and evaluation_run_id since they come from the UR --- - + + +## class `ExportManifestEntry` + +**Pydantic Fields:** + +- `target`: `` +- `status`: `typing.Literal['running', 'done', 'error']` +- `rows`: `` +- `objects`: `list[str]` +- `urls`: `list[str]` +- `expires_at`: `str | None` +- `error`: `str | None` + +--- + + + +## class `ExportStartReq` + +**Pydantic Fields:** + +- `project_id`: `` +- `targets`: `list[str]` +- `wb_user_id`: `str | None` + +--- + + + +## class `ExportStartRes` + +**Pydantic Fields:** + +- `job_id`: `` + +--- + + + +## class `ExportStatusReq` + +**Pydantic Fields:** + +- `project_id`: `` +- `job_id`: `` +- `wb_user_id`: `str | None` + +--- + + + +## class `ExportStatusRes` + +**Pydantic Fields:** + +- `status`: `typing.Literal['running', 'done', 'error']` +- `manifest`: `list[ExportManifestEntry]` + +--- + + ## class `ExportTracePartialSuccess` @@ -1863,13 +2035,13 @@ This model excludes project_id and evaluation_run_id since they come from the UR --- - + ## class `ExtraKeysTypedDict` --- - + ## class `Feedback` @@ -1895,12 +2067,15 @@ This model excludes project_id and evaluation_run_id since they come from the UR - `span_agent_name`: `` - `span_agent_version`: `` - `span_status_code`: `` +- `span_conversation_id`: `` +- `span_trace_id`: `` +- `scorer_trace_id`: `` - `wb_user_id`: `str | None` - `created_at`: `` --- - + ## class `FeedbackAggregateBucket` One (time bucket, group) row of aggregated scorer feedback. @@ -1917,7 +2092,7 @@ One (time bucket, group) row of aggregated scorer feedback. --- - + ## class `FeedbackAggregateReq` Query for aggregate scores by time bucket and dimension. @@ -1940,7 +2115,7 @@ Query for aggregate scores by time bucket and dimension. --- - + ## class `FeedbackAggregateRes` Sparse time-series of aggregated scorer feedback (empty buckets omitted). @@ -1954,7 +2129,7 @@ Sparse time-series of aggregated scorer feedback (empty buckets omitted). --- - + ## class `FeedbackCreateBatchReq` @@ -1964,7 +2139,7 @@ Sparse time-series of aggregated scorer feedback (empty buckets omitted). --- - + ## class `FeedbackCreateBatchRes` @@ -1974,7 +2149,7 @@ Sparse time-series of aggregated scorer feedback (empty buckets omitted). --- - + ## class `FeedbackCreateReq` @@ -2000,11 +2175,14 @@ Sparse time-series of aggregated scorer feedback (empty buckets omitted). - `span_agent_name`: `` - `span_agent_version`: `` - `span_status_code`: `` +- `span_conversation_id`: `` +- `span_trace_id`: `` +- `scorer_trace_id`: `` - `wb_user_id`: `str | None` --- - + ## class `FeedbackCreateRes` @@ -2017,13 +2195,13 @@ Sparse time-series of aggregated scorer feedback (empty buckets omitted). --- - + ## class `FeedbackDict` --- - + ## class `FeedbackMetricSpec` Specification for a feedback payload metric to aggregate. @@ -2037,7 +2215,7 @@ Specification for a feedback payload metric to aggregate. --- - + ## class `FeedbackPayloadPath` Discovered path in feedback payload with inferred type. @@ -2049,7 +2227,7 @@ Discovered path in feedback payload with inferred type. --- - + ## class `FeedbackPayloadSchemaReq` Request for feedback payload schema discovery. @@ -2063,7 +2241,7 @@ Request for feedback payload schema discovery. - `trigger_ref`: `str | None` - `sample_limit`: `` - + ### method `validate_date_range` @@ -2075,7 +2253,7 @@ Ensure feedback requests are bounded to a safe date range. --- - + ## class `FeedbackPayloadSchemaRes` Response with discovered feedback payload paths and types. @@ -2086,7 +2264,7 @@ Response with discovered feedback payload paths and types. --- - + ## class `FeedbackPurgeReq` @@ -2097,13 +2275,13 @@ Response with discovered feedback payload paths and types. --- - + ## class `FeedbackPurgeRes` --- - + ## class `FeedbackQueryReq` @@ -2118,17 +2296,18 @@ Response with discovered feedback payload paths and types. --- - + ## class `FeedbackQueryRes` **Pydantic Fields:** - `result`: `list[dict[str, typing.Any]]` +- `total_count`: `` --- - + ## class `FeedbackReplaceReq` @@ -2154,12 +2333,15 @@ Response with discovered feedback payload paths and types. - `span_agent_name`: `` - `span_agent_version`: `` - `span_status_code`: `` +- `span_conversation_id`: `` +- `span_trace_id`: `` +- `scorer_trace_id`: `` - `wb_user_id`: `str | None` - `feedback_id`: `` --- - + ## class `FeedbackReplaceRes` @@ -2172,7 +2354,7 @@ Response with discovered feedback payload paths and types. --- - + ## class `FeedbackStatsReq` Request for aggregated feedback statistics over time buckets. @@ -2188,7 +2370,7 @@ Request for aggregated feedback statistics over time buckets. - `timezone`: `` - `metrics`: `list[FeedbackMetricSpec]` - + ### method `validate_date_range` @@ -2200,7 +2382,7 @@ Ensure feedback requests are bounded to a safe date range. --- - + ## class `FeedbackStatsRes` Response with time-series feedback statistics. @@ -2216,7 +2398,7 @@ Response with time-series feedback statistics. --- - + ## class `FileContentReadReq` @@ -2227,7 +2409,7 @@ Response with time-series feedback statistics. --- - + ## class `FileContentReadRes` @@ -2237,7 +2419,7 @@ Response with time-series feedback statistics. --- - + ## class `FileCreateReq` @@ -2250,7 +2432,7 @@ Response with time-series feedback statistics. --- - + ## class `FileCreateRes` @@ -2260,7 +2442,7 @@ Response with time-series feedback statistics. --- - + ## class `FilesStatsReq` @@ -2270,7 +2452,7 @@ Response with time-series feedback statistics. --- - + ## class `FilesStatsRes` @@ -2280,7 +2462,7 @@ Response with time-series feedback statistics. --- - + ## class `FullTraceServerInterface` Complete trace server interface supporting both V1 and Object APIs. @@ -2289,7 +2471,7 @@ This protocol represents a trace server implementation that supports the full se --- - + ### method `agent_agents_query` @@ -2299,7 +2481,7 @@ agent_agents_query(req: AgentsQueryReq) → AgentsQueryRes --- - + ### method `agent_conversation_chat` @@ -2311,7 +2493,7 @@ agent_conversation_chat( --- - + ### method `agent_conversation_spans` @@ -2323,7 +2505,7 @@ agent_conversation_spans( --- - + ### method `agent_custom_attrs_schema` @@ -2335,7 +2517,7 @@ agent_custom_attrs_schema( --- - + ### method `agent_search` @@ -2345,7 +2527,7 @@ agent_search(req: AgentSearchReq) → AgentSearchRes --- - + ### method `agent_spans_query` @@ -2355,7 +2537,7 @@ agent_spans_query(req: AgentSpansQueryReq) → AgentSpansQueryRes --- - + ### method `agent_spans_stats` @@ -2365,7 +2547,7 @@ agent_spans_stats(req: AgentSpanStatsReq) → AgentSpanStatsRes --- - + ### method `agent_traces_chat` @@ -2375,7 +2557,7 @@ agent_traces_chat(req: AgentTraceChatReq) → AgentTraceChatRes --- - + ### method `agent_versions_query` @@ -2385,7 +2567,7 @@ agent_versions_query(req: AgentVersionsQueryReq) → AgentVersionsQueryRes --- - + ### method `aliases_list` @@ -2395,7 +2577,7 @@ aliases_list(req: AliasesListReq) → AliasesListRes --- - + ### method `annotation_queue_add_calls` @@ -2407,7 +2589,7 @@ annotation_queue_add_calls( --- - + ### method `annotation_queue_create` @@ -2419,7 +2601,7 @@ annotation_queue_create( --- - + ### method `annotation_queue_delete` @@ -2431,7 +2613,7 @@ annotation_queue_delete( --- - + ### method `annotation_queue_items_query` @@ -2443,7 +2625,7 @@ annotation_queue_items_query( --- - + ### method `annotation_queue_read` @@ -2453,7 +2635,7 @@ annotation_queue_read(req: AnnotationQueueReadReq) → AnnotationQueueReadRes --- - + ### method `annotation_queue_update` @@ -2465,7 +2647,7 @@ annotation_queue_update( --- - + ### method `annotation_queues_query_stream` @@ -2477,7 +2659,7 @@ annotation_queues_query_stream( --- - + ### method `annotation_queues_stats` @@ -2489,7 +2671,7 @@ annotation_queues_stats( --- - + ### method `annotator_queue_items_progress_update` @@ -2501,7 +2683,7 @@ annotator_queue_items_progress_update( --- - + ### method `call_end` @@ -2511,7 +2693,7 @@ call_end(req: CallEndReq) → CallEndRes --- - + ### method `call_end_v2` @@ -2521,7 +2703,7 @@ call_end_v2(req: CallEndV2Req) → CallEndV2Res --- - + ### method `call_read` @@ -2531,7 +2713,7 @@ call_read(req: CallReadReq) → CallReadRes --- - + ### method `call_start` @@ -2541,7 +2723,7 @@ call_start(req: CallStartReq) → CallStartRes --- - + ### method `call_start_batch` @@ -2551,7 +2733,7 @@ call_start_batch(req: CallCreateBatchReq) → CallCreateBatchRes --- - + ### method `call_start_v2` @@ -2561,7 +2743,7 @@ call_start_v2(req: CallStartV2Req) → CallStartV2Res --- - + ### method `call_stats` @@ -2571,7 +2753,7 @@ call_stats(req: 'CallStatsReq') → CallStatsRes --- - + ### method `call_update` @@ -2581,7 +2763,7 @@ call_update(req: CallUpdateReq) → CallUpdateRes --- - + ### method `calls_complete` @@ -2591,7 +2773,7 @@ calls_complete(req: CallsUpsertCompleteReq) → CallsUpsertCompleteRes --- - + ### method `calls_delete` @@ -2601,7 +2783,7 @@ calls_delete(req: CallsDeleteReq) → CallsDeleteRes --- - + ### method `calls_query` @@ -2611,7 +2793,7 @@ calls_query(req: CallsQueryReq) → CallsQueryRes --- - + ### method `calls_query_stats` @@ -2621,7 +2803,7 @@ calls_query_stats(req: CallsQueryStatsReq) → CallsQueryStatsRes --- - + ### method `calls_query_stream` @@ -2631,7 +2813,7 @@ calls_query_stream(req: CallsQueryReq) → Iterator[CallSchema] --- - + ### method `calls_score` @@ -2641,7 +2823,7 @@ calls_score(req: CallsScoreReq) → CallsScoreRes --- - + ### method `calls_usage` @@ -2651,7 +2833,7 @@ calls_usage(req: 'CallsUsageReq') → CallsUsageRes --- - + ### method `completions_create` @@ -2661,7 +2843,7 @@ completions_create(req: CompletionsCreateReq) → CompletionsCreateRes --- - + ### method `completions_create_stream` @@ -2671,7 +2853,7 @@ completions_create_stream(req: CompletionsCreateReq) → Iterator[dict[str, Any] --- - + ### method `cost_create` @@ -2681,7 +2863,7 @@ cost_create(req: CostCreateReq) → CostCreateRes --- - + ### method `cost_purge` @@ -2691,7 +2873,7 @@ cost_purge(req: CostPurgeReq) → CostPurgeRes --- - + ### method `cost_query` @@ -2701,7 +2883,17 @@ cost_query(req: CostQueryReq) → CostQueryRes --- - + + +### method `custom_runtime_apply` + +```python +custom_runtime_apply(req: CustomRuntimeApplyReq) → CustomRuntimeApplyRes +``` + +--- + + ### method `dataset_create` @@ -2711,7 +2903,7 @@ dataset_create(req: DatasetCreateReq) → DatasetCreateRes --- - + ### method `dataset_delete` @@ -2721,7 +2913,7 @@ dataset_delete(req: DatasetDeleteReq) → DatasetDeleteRes --- - + ### method `dataset_list` @@ -2731,7 +2923,7 @@ dataset_list(req: DatasetListReq) → Iterator[DatasetReadRes] --- - + ### method `dataset_read` @@ -2741,7 +2933,7 @@ dataset_read(req: DatasetReadReq) → DatasetReadRes --- - + ### method `dataset_sources_link` @@ -2751,7 +2943,7 @@ dataset_sources_link(req: DatasetSourcesLinkReq) → DatasetSourcesLinkRes --- - + ### method `dataset_sources_link_delete` @@ -2763,7 +2955,7 @@ dataset_sources_link_delete( --- - + ### method `dataset_sources_query` @@ -2773,7 +2965,7 @@ dataset_sources_query(req: DatasetSourcesQueryReq) → DatasetSourcesQueryRes --- - + ### method `eval_results_query` @@ -2783,7 +2975,7 @@ eval_results_query(req: EvalResultsQueryReq) → EvalResultsQueryRes --- - + ### method `evaluate_model` @@ -2793,7 +2985,7 @@ evaluate_model(req: EvaluateModelReq) → EvaluateModelRes --- - + ### method `evaluation_create` @@ -2803,7 +2995,7 @@ evaluation_create(req: EvaluationCreateReq) → EvaluationCreateRes --- - + ### method `evaluation_delete` @@ -2813,7 +3005,7 @@ evaluation_delete(req: EvaluationDeleteReq) → EvaluationDeleteRes --- - + ### method `evaluation_list` @@ -2823,7 +3015,7 @@ evaluation_list(req: EvaluationListReq) → Iterator[EvaluationReadRes] --- - + ### method `evaluation_read` @@ -2833,7 +3025,7 @@ evaluation_read(req: EvaluationReadReq) → EvaluationReadRes --- - + ### method `evaluation_run_create` @@ -2843,7 +3035,7 @@ evaluation_run_create(req: EvaluationRunCreateReq) → EvaluationRunCreateRes --- - + ### method `evaluation_run_delete` @@ -2853,7 +3045,7 @@ evaluation_run_delete(req: EvaluationRunDeleteReq) → EvaluationRunDeleteRes --- - + ### method `evaluation_run_finish` @@ -2863,7 +3055,7 @@ evaluation_run_finish(req: EvaluationRunFinishReq) → EvaluationRunFinishRes --- - + ### method `evaluation_run_list` @@ -2873,7 +3065,7 @@ evaluation_run_list(req: EvaluationRunListReq) → Iterator[EvaluationRunReadRes --- - + ### method `evaluation_run_read` @@ -2883,7 +3075,7 @@ evaluation_run_read(req: EvaluationRunReadReq) → EvaluationRunReadRes --- - + ### method `evaluation_status` @@ -2893,7 +3085,27 @@ evaluation_status(req: EvaluationStatusReq) → EvaluationStatusRes --- - + + +### method `export_start` + +```python +export_start(req: ExportStartReq) → ExportStartRes +``` + +--- + + + +### method `export_status` + +```python +export_status(req: ExportStatusReq) → ExportStatusRes +``` + +--- + + ### method `feedback_aggregate` @@ -2903,7 +3115,7 @@ feedback_aggregate(req: FeedbackAggregateReq) → FeedbackAggregateRes --- - + ### method `feedback_create` @@ -2913,7 +3125,7 @@ feedback_create(req: FeedbackCreateReq) → FeedbackCreateRes --- - + ### method `feedback_create_batch` @@ -2923,7 +3135,7 @@ feedback_create_batch(req: FeedbackCreateBatchReq) → FeedbackCreateBatchRes --- - + ### method `feedback_payload_schema` @@ -2935,7 +3147,7 @@ feedback_payload_schema( --- - + ### method `feedback_purge` @@ -2945,7 +3157,7 @@ feedback_purge(req: FeedbackPurgeReq) → FeedbackPurgeRes --- - + ### method `feedback_query` @@ -2955,7 +3167,7 @@ feedback_query(req: FeedbackQueryReq) → FeedbackQueryRes --- - + ### method `feedback_replace` @@ -2965,7 +3177,7 @@ feedback_replace(req: FeedbackReplaceReq) → FeedbackReplaceRes --- - + ### method `feedback_stats` @@ -2975,7 +3187,7 @@ feedback_stats(req: FeedbackStatsReq) → FeedbackStatsRes --- - + ### method `file_content_read` @@ -2985,7 +3197,7 @@ file_content_read(req: FileContentReadReq) → FileContentReadRes --- - + ### method `file_create` @@ -2995,7 +3207,7 @@ file_create(req: FileCreateReq) → FileCreateRes --- - + ### method `files_stats` @@ -3005,7 +3217,7 @@ files_stats(req: FilesStatsReq) → FilesStatsRes --- - + ### method `genai_otel_export` @@ -3015,7 +3227,7 @@ genai_otel_export(req: GenAIOTelExportReq) → GenAIOTelExportRes --- - + ### method `image_create` @@ -3025,7 +3237,7 @@ image_create(req: ImageGenerationCreateReq) → ImageGenerationCreateRes --- - + ### method `model_create` @@ -3035,7 +3247,7 @@ model_create(req: ModelCreateReq) → ModelCreateRes --- - + ### method `model_delete` @@ -3045,7 +3257,7 @@ model_delete(req: ModelDeleteReq) → ModelDeleteRes --- - + ### method `model_list` @@ -3055,7 +3267,7 @@ model_list(req: ModelListReq) → Iterator[ModelReadRes] --- - + ### method `model_read` @@ -3065,7 +3277,7 @@ model_read(req: ModelReadReq) → ModelReadRes --- - + ### method `obj_add_tags` @@ -3075,7 +3287,7 @@ obj_add_tags(req: ObjAddTagsReq) → ObjAddTagsRes --- - + ### method `obj_create` @@ -3085,7 +3297,7 @@ obj_create(req: ObjCreateReq) → ObjCreateRes --- - + ### method `obj_delete` @@ -3095,7 +3307,7 @@ obj_delete(req: ObjDeleteReq) → ObjDeleteRes --- - + ### method `obj_read` @@ -3105,7 +3317,7 @@ obj_read(req: ObjReadReq) → ObjReadRes --- - + ### method `obj_remove_aliases` @@ -3115,7 +3327,7 @@ obj_remove_aliases(req: ObjRemoveAliasesReq) → ObjRemoveAliasesRes --- - + ### method `obj_remove_tags` @@ -3125,7 +3337,7 @@ obj_remove_tags(req: ObjRemoveTagsReq) → ObjRemoveTagsRes --- - + ### method `obj_set_aliases` @@ -3135,7 +3347,7 @@ obj_set_aliases(req: ObjSetAliasesReq) → ObjSetAliasesRes --- - + ### method `objs_query` @@ -3145,7 +3357,7 @@ objs_query(req: ObjQueryReq) → ObjQueryRes --- - + ### method `op_create` @@ -3155,7 +3367,7 @@ op_create(req: OpCreateReq) → OpCreateRes --- - + ### method `op_delete` @@ -3165,7 +3377,7 @@ op_delete(req: OpDeleteReq) → OpDeleteRes --- - + ### method `op_list` @@ -3175,7 +3387,7 @@ op_list(req: OpListReq) → Iterator[OpReadRes] --- - + ### method `op_read` @@ -3185,7 +3397,7 @@ op_read(req: OpReadReq) → OpReadRes --- - + ### method `otel_export` @@ -3195,7 +3407,7 @@ otel_export(req: OTelExportReq) → OTelExportRes --- - + ### method `prediction_create` @@ -3205,7 +3417,7 @@ prediction_create(req: PredictionCreateReq) → PredictionCreateRes --- - + ### method `prediction_delete` @@ -3215,7 +3427,7 @@ prediction_delete(req: PredictionDeleteReq) → PredictionDeleteRes --- - + ### method `prediction_finish` @@ -3225,7 +3437,7 @@ prediction_finish(req: PredictionFinishReq) → PredictionFinishRes --- - + ### method `prediction_list` @@ -3235,7 +3447,7 @@ prediction_list(req: PredictionListReq) → Iterator[PredictionReadRes] --- - + ### method `prediction_read` @@ -3245,7 +3457,7 @@ prediction_read(req: PredictionReadReq) → PredictionReadRes --- - + ### method `project_stats` @@ -3255,7 +3467,7 @@ project_stats(req: ProjectStatsReq) → ProjectStatsRes --- - + ### method `project_ttl_settings_read` @@ -3267,7 +3479,7 @@ project_ttl_settings_read( --- - + ### method `project_ttl_settings_update` @@ -3279,7 +3491,7 @@ project_ttl_settings_update( --- - + ### method `refs_read_batch` @@ -3289,7 +3501,7 @@ refs_read_batch(req: RefsReadBatchReq) → RefsReadBatchRes --- - + ### method `rescore` @@ -3299,7 +3511,7 @@ rescore(req: RescoreReq) → RescoreRes --- - + ### method `score_create` @@ -3309,7 +3521,7 @@ score_create(req: ScoreCreateReq) → ScoreCreateRes --- - + ### method `score_delete` @@ -3319,7 +3531,7 @@ score_delete(req: ScoreDeleteReq) → ScoreDeleteRes --- - + ### method `score_list` @@ -3329,7 +3541,7 @@ score_list(req: ScoreListReq) → Iterator[ScoreReadRes] --- - + ### method `score_read` @@ -3339,7 +3551,7 @@ score_read(req: ScoreReadReq) → ScoreReadRes --- - + ### method `scorer_create` @@ -3349,7 +3561,7 @@ scorer_create(req: ScorerCreateReq) → ScorerCreateRes --- - + ### method `scorer_delete` @@ -3359,7 +3571,7 @@ scorer_delete(req: ScorerDeleteReq) → ScorerDeleteRes --- - + ### method `scorer_list` @@ -3369,7 +3581,7 @@ scorer_list(req: ScorerListReq) → Iterator[ScorerReadRes] --- - + ### method `scorer_read` @@ -3379,7 +3591,7 @@ scorer_read(req: ScorerReadReq) → ScorerReadRes --- - + ### method `source_datasets_query` @@ -3389,7 +3601,7 @@ source_datasets_query(req: SourceDatasetsQueryReq) → SourceDatasetsQueryRes --- - + ### method `table_create` @@ -3399,7 +3611,7 @@ table_create(req: TableCreateReq) → TableCreateRes --- - + ### method `table_create_from_digests` @@ -3411,7 +3623,7 @@ table_create_from_digests( --- - + ### method `table_query` @@ -3421,7 +3633,7 @@ table_query(req: TableQueryReq) → TableQueryRes --- - + ### method `table_query_stats` @@ -3431,7 +3643,7 @@ table_query_stats(req: TableQueryStatsReq) → TableQueryStatsRes --- - + ### method `table_query_stats_batch` @@ -3441,7 +3653,7 @@ table_query_stats_batch(req: TableQueryStatsBatchReq) → TableQueryStatsBatchRe --- - + ### method `table_query_stream` @@ -3451,7 +3663,7 @@ table_query_stream(req: TableQueryReq) → Iterator[TableRowSchema] --- - + ### method `table_update` @@ -3461,7 +3673,7 @@ table_update(req: TableUpdateReq) → TableUpdateRes --- - + ### method `tags_list` @@ -3471,7 +3683,7 @@ tags_list(req: TagsListReq) → TagsListRes --- - + ### method `threads_query_stream` @@ -3481,7 +3693,7 @@ threads_query_stream(req: ThreadsQueryReq) → Iterator[ThreadSchema] --- - + ### method `trace_usage` @@ -3491,7 +3703,7 @@ trace_usage(req: 'TraceUsageReq') → TraceUsageRes --- - + ## class `GenAISpanRef` @@ -3502,7 +3714,7 @@ trace_usage(req: 'TraceUsageReq') → TraceUsageRes --- - + ## class `ImageGenerationCreateReq` @@ -3515,7 +3727,7 @@ trace_usage(req: 'TraceUsageReq') → TraceUsageRes --- - + ## class `ImageGenerationCreateRes` @@ -3526,7 +3738,7 @@ trace_usage(req: 'TraceUsageReq') → TraceUsageRes --- - + ## class `ImageGenerationRequestInputs` @@ -3538,7 +3750,7 @@ trace_usage(req: 'TraceUsageReq') → TraceUsageRes --- - + ## class `LLMAggregatedUsage` Aggregated usage metrics for a specific LLM. @@ -3558,19 +3770,19 @@ Aggregated usage metrics for a specific LLM. --- - + ## class `LLMCostSchema` --- - + ## class `LLMUsageSchema` --- - + ## class `ModelCreateBody` @@ -3583,7 +3795,7 @@ Aggregated usage metrics for a specific LLM. --- - + ## class `ModelCreateReq` @@ -3598,7 +3810,7 @@ Aggregated usage metrics for a specific LLM. --- - + ## class `ModelCreateRes` @@ -3611,7 +3823,7 @@ Aggregated usage metrics for a specific LLM. --- - + ## class `ModelDeleteReq` @@ -3624,7 +3836,7 @@ Aggregated usage metrics for a specific LLM. --- - + ## class `ModelDeleteRes` @@ -3634,7 +3846,7 @@ Aggregated usage metrics for a specific LLM. --- - + ## class `ModelListReq` @@ -3646,7 +3858,7 @@ Aggregated usage metrics for a specific LLM. --- - + ## class `ModelReadReq` @@ -3658,7 +3870,7 @@ Aggregated usage metrics for a specific LLM. --- - + ## class `ModelReadRes` @@ -3675,7 +3887,7 @@ Aggregated usage metrics for a specific LLM. --- - + ## class `OTelExportReq` @@ -3687,7 +3899,7 @@ Aggregated usage metrics for a specific LLM. --- - + ## class `OTelExportRes` @@ -3697,7 +3909,7 @@ Aggregated usage metrics for a specific LLM. --- - + ## class `ObjAddTagsReq` @@ -3709,7 +3921,7 @@ Aggregated usage metrics for a specific LLM. - `tags`: `list[str]` - `wb_user_id`: `str | None` - + ### method `validate_tags` @@ -3719,13 +3931,13 @@ validate_tags() → ObjAddTagsReq --- - + ## class `ObjAddTagsRes` --- - + ## class `ObjCreateReq` @@ -3735,7 +3947,7 @@ validate_tags() → ObjAddTagsReq --- - + ## class `ObjCreateRes` @@ -3746,7 +3958,7 @@ validate_tags() → ObjAddTagsReq --- - + ## class `ObjDeleteReq` @@ -3758,17 +3970,18 @@ validate_tags() → ObjAddTagsReq --- - + ## class `ObjDeleteRes` **Pydantic Fields:** - `num_deleted`: `` +- `deleted_versions`: `list[DeletedObjVersion] | None` --- - + ## class `ObjQueryReq` @@ -3785,7 +3998,7 @@ validate_tags() → ObjAddTagsReq --- - + ## class `ObjQueryRes` @@ -3795,7 +4008,7 @@ validate_tags() → ObjAddTagsReq --- - + ## class `ObjReadReq` @@ -3809,7 +4022,7 @@ validate_tags() → ObjAddTagsReq --- - + ## class `ObjReadRes` @@ -3819,7 +4032,7 @@ validate_tags() → ObjAddTagsReq --- - + ## class `ObjRemoveAliasesReq` @@ -3830,7 +4043,7 @@ validate_tags() → ObjAddTagsReq - `aliases`: `list[str]` - `wb_user_id`: `str | None` - + ### method `validate_aliases` @@ -3840,13 +4053,13 @@ validate_aliases() → ObjRemoveAliasesReq --- - + ## class `ObjRemoveAliasesRes` --- - + ## class `ObjRemoveTagsReq` @@ -3860,13 +4073,13 @@ validate_aliases() → ObjRemoveAliasesReq --- - + ## class `ObjRemoveTagsRes` --- - + ## class `ObjSchema` @@ -3890,7 +4103,7 @@ validate_aliases() → ObjRemoveAliasesReq --- - + ## class `ObjSchemaForInsert` @@ -3904,7 +4117,7 @@ validate_aliases() → ObjRemoveAliasesReq - `expected_digest`: `str | None` - `wb_user_id`: `str | None` - + ### method `model_post_init` @@ -3914,7 +4127,7 @@ model_post_init(context: Any) → None --- - + ## class `ObjSetAliasesReq` @@ -3926,7 +4139,7 @@ model_post_init(context: Any) → None - `aliases`: `list[str]` - `wb_user_id`: `str | None` - + ### method `validate_aliases` @@ -3936,13 +4149,13 @@ validate_aliases() → ObjSetAliasesReq --- - + ## class `ObjSetAliasesRes` --- - + ## class `ObjectInterface` Object API endpoints for Trace Server. @@ -3951,7 +4164,7 @@ This protocol contains object management APIs that provide cleaner, more RESTful --- - + ### method `call_end_v2` @@ -3961,7 +4174,7 @@ call_end_v2(req: CallEndV2Req) → CallEndV2Res --- - + ### method `call_start_v2` @@ -3971,7 +4184,7 @@ call_start_v2(req: CallStartV2Req) → CallStartV2Res --- - + ### method `calls_complete` @@ -3981,7 +4194,17 @@ calls_complete(req: CallsUpsertCompleteReq) → CallsUpsertCompleteRes --- - + + +### method `custom_runtime_apply` + +```python +custom_runtime_apply(req: CustomRuntimeApplyReq) → CustomRuntimeApplyRes +``` + +--- + + ### method `dataset_create` @@ -3991,7 +4214,7 @@ dataset_create(req: DatasetCreateReq) → DatasetCreateRes --- - + ### method `dataset_delete` @@ -4001,7 +4224,7 @@ dataset_delete(req: DatasetDeleteReq) → DatasetDeleteRes --- - + ### method `dataset_list` @@ -4011,7 +4234,7 @@ dataset_list(req: DatasetListReq) → Iterator[DatasetReadRes] --- - + ### method `dataset_read` @@ -4021,7 +4244,7 @@ dataset_read(req: DatasetReadReq) → DatasetReadRes --- - + ### method `eval_results_query` @@ -4031,7 +4254,7 @@ eval_results_query(req: EvalResultsQueryReq) → EvalResultsQueryRes --- - + ### method `evaluation_create` @@ -4041,7 +4264,7 @@ evaluation_create(req: EvaluationCreateReq) → EvaluationCreateRes --- - + ### method `evaluation_delete` @@ -4051,7 +4274,7 @@ evaluation_delete(req: EvaluationDeleteReq) → EvaluationDeleteRes --- - + ### method `evaluation_list` @@ -4061,7 +4284,7 @@ evaluation_list(req: EvaluationListReq) → Iterator[EvaluationReadRes] --- - + ### method `evaluation_read` @@ -4071,7 +4294,7 @@ evaluation_read(req: EvaluationReadReq) → EvaluationReadRes --- - + ### method `evaluation_run_create` @@ -4081,7 +4304,7 @@ evaluation_run_create(req: EvaluationRunCreateReq) → EvaluationRunCreateRes --- - + ### method `evaluation_run_delete` @@ -4091,7 +4314,7 @@ evaluation_run_delete(req: EvaluationRunDeleteReq) → EvaluationRunDeleteRes --- - + ### method `evaluation_run_finish` @@ -4101,7 +4324,7 @@ evaluation_run_finish(req: EvaluationRunFinishReq) → EvaluationRunFinishRes --- - + ### method `evaluation_run_list` @@ -4111,7 +4334,7 @@ evaluation_run_list(req: EvaluationRunListReq) → Iterator[EvaluationRunReadRes --- - + ### method `evaluation_run_read` @@ -4121,7 +4344,7 @@ evaluation_run_read(req: EvaluationRunReadReq) → EvaluationRunReadRes --- - + ### method `model_create` @@ -4131,7 +4354,7 @@ model_create(req: ModelCreateReq) → ModelCreateRes --- - + ### method `model_delete` @@ -4141,7 +4364,7 @@ model_delete(req: ModelDeleteReq) → ModelDeleteRes --- - + ### method `model_list` @@ -4151,7 +4374,7 @@ model_list(req: ModelListReq) → Iterator[ModelReadRes] --- - + ### method `model_read` @@ -4161,7 +4384,7 @@ model_read(req: ModelReadReq) → ModelReadRes --- - + ### method `op_create` @@ -4171,7 +4394,7 @@ op_create(req: OpCreateReq) → OpCreateRes --- - + ### method `op_delete` @@ -4181,7 +4404,7 @@ op_delete(req: OpDeleteReq) → OpDeleteRes --- - + ### method `op_list` @@ -4191,7 +4414,7 @@ op_list(req: OpListReq) → Iterator[OpReadRes] --- - + ### method `op_read` @@ -4201,7 +4424,7 @@ op_read(req: OpReadReq) → OpReadRes --- - + ### method `prediction_create` @@ -4211,7 +4434,7 @@ prediction_create(req: PredictionCreateReq) → PredictionCreateRes --- - + ### method `prediction_delete` @@ -4221,7 +4444,7 @@ prediction_delete(req: PredictionDeleteReq) → PredictionDeleteRes --- - + ### method `prediction_finish` @@ -4231,7 +4454,7 @@ prediction_finish(req: PredictionFinishReq) → PredictionFinishRes --- - + ### method `prediction_list` @@ -4241,7 +4464,7 @@ prediction_list(req: PredictionListReq) → Iterator[PredictionReadRes] --- - + ### method `prediction_read` @@ -4251,7 +4474,7 @@ prediction_read(req: PredictionReadReq) → PredictionReadRes --- - + ### method `score_create` @@ -4261,7 +4484,7 @@ score_create(req: ScoreCreateReq) → ScoreCreateRes --- - + ### method `score_delete` @@ -4271,7 +4494,7 @@ score_delete(req: ScoreDeleteReq) → ScoreDeleteRes --- - + ### method `score_list` @@ -4281,7 +4504,7 @@ score_list(req: ScoreListReq) → Iterator[ScoreReadRes] --- - + ### method `score_read` @@ -4291,7 +4514,7 @@ score_read(req: ScoreReadReq) → ScoreReadRes --- - + ### method `scorer_create` @@ -4301,7 +4524,7 @@ scorer_create(req: ScorerCreateReq) → ScorerCreateRes --- - + ### method `scorer_delete` @@ -4311,7 +4534,7 @@ scorer_delete(req: ScorerDeleteReq) → ScorerDeleteRes --- - + ### method `scorer_list` @@ -4321,7 +4544,7 @@ scorer_list(req: ScorerListReq) → Iterator[ScorerReadRes] --- - + ### method `scorer_read` @@ -4331,7 +4554,7 @@ scorer_read(req: ScorerReadReq) → ScorerReadRes --- - + ## class `ObjectVersionFilter` @@ -4348,7 +4571,7 @@ scorer_read(req: ScorerReadReq) → ScorerReadRes --- - + ## class `OpCreateBody` Request body for creating an Op object via REST API. @@ -4362,7 +4585,7 @@ This model excludes project_id since it comes from the URL path in RESTful endpo --- - + ## class `OpCreateReq` Request model for creating an Op object. @@ -4378,7 +4601,7 @@ Extends OpCreateBody by adding project_id for internal API usage. --- - + ## class `OpCreateRes` Response model for creating an Op object. @@ -4391,7 +4614,7 @@ Response model for creating an Op object. --- - + ## class `OpDeleteReq` @@ -4404,7 +4627,7 @@ Response model for creating an Op object. --- - + ## class `OpDeleteRes` @@ -4414,7 +4637,7 @@ Response model for creating an Op object. --- - + ## class `OpListReq` @@ -4427,7 +4650,7 @@ Response model for creating an Op object. --- - + ## class `OpReadReq` @@ -4440,7 +4663,7 @@ Response model for creating an Op object. --- - + ## class `OpReadRes` Response model for reading an Op object. @@ -4457,7 +4680,7 @@ The code field contains the actual source code of the op. --- - + ## class `PredictionCreateBody` Request body for creating a Prediction via REST API. @@ -4474,7 +4697,7 @@ This model excludes project_id since it comes from the URL path in RESTful endpo --- - + ## class `PredictionCreateReq` Request model for creating a Prediction. @@ -4493,7 +4716,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `PredictionCreateRes` @@ -4503,7 +4726,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `PredictionDeleteReq` @@ -4515,7 +4738,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `PredictionDeleteRes` @@ -4525,7 +4748,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `PredictionFinishReq` @@ -4537,7 +4760,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `PredictionFinishRes` @@ -4547,7 +4770,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `PredictionListReq` @@ -4561,7 +4784,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `PredictionListRes` @@ -4571,7 +4794,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `PredictionReadReq` @@ -4583,7 +4806,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `PredictionReadRes` @@ -4598,7 +4821,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `ProcessedResourceSpans` @@ -4611,7 +4834,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `ProjectStatsReq` @@ -4625,7 +4848,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `ProjectStatsRes` @@ -4638,7 +4861,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `ProjectTTLSettingsReadReq` @@ -4648,7 +4871,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `ProjectTTLSettingsReadRes` @@ -4658,7 +4881,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `ProjectTTLSettingsUpdateReq` @@ -4670,7 +4893,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `ProjectTTLSettingsUpdateRes` @@ -4680,7 +4903,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `RefsReadBatchReq` @@ -4690,7 +4913,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `RefsReadBatchRes` @@ -4700,7 +4923,7 @@ Extends PredictionCreateBody by adding project_id for internal API usage. --- - + ## class `RescoreBody` Request body for rescoring via REST API (excludes server-set fields). @@ -4712,7 +4935,7 @@ Request body for rescoring via REST API (excludes server-set fields). --- - + ## class `RescoreReq` Full rescore request including server-set fields. @@ -4726,7 +4949,7 @@ Full rescore request including server-set fields. --- - + ## class `RescoreRes` Response for a rescore request. @@ -4738,7 +4961,7 @@ Response for a rescore request. --- - + ## class `RescoringArgs` Arguments for a rescore job dispatched to the evaluate-model worker. @@ -4756,7 +4979,7 @@ Differs from EvaluateModelArgs: no model is loaded, no predictions are run. Only --- - + ## class `ScoreCreateBody` Request body for creating a Score via REST API. @@ -4772,7 +4995,7 @@ This model excludes project_id since it comes from the URL path in RESTful endpo --- - + ## class `ScoreCreateReq` Request model for creating a Score. @@ -4790,7 +5013,7 @@ Extends ScoreCreateBody by adding project_id for internal API usage. --- - + ## class `ScoreCreateRes` @@ -4800,7 +5023,7 @@ Extends ScoreCreateBody by adding project_id for internal API usage. --- - + ## class `ScoreDeleteReq` @@ -4812,7 +5035,7 @@ Extends ScoreCreateBody by adding project_id for internal API usage. --- - + ## class `ScoreDeleteRes` @@ -4822,7 +5045,7 @@ Extends ScoreCreateBody by adding project_id for internal API usage. --- - + ## class `ScoreListReq` @@ -4836,7 +5059,7 @@ Extends ScoreCreateBody by adding project_id for internal API usage. --- - + ## class `ScoreReadReq` @@ -4848,7 +5071,7 @@ Extends ScoreCreateBody by adding project_id for internal API usage. --- - + ## class `ScoreReadRes` @@ -4862,7 +5085,7 @@ Extends ScoreCreateBody by adding project_id for internal API usage. --- - + ## class `ScorerCreateBody` @@ -4874,7 +5097,7 @@ Extends ScoreCreateBody by adding project_id for internal API usage. --- - + ## class `ScorerCreateReq` @@ -4888,7 +5111,7 @@ Extends ScoreCreateBody by adding project_id for internal API usage. --- - + ## class `ScorerCreateRes` @@ -4901,7 +5124,7 @@ Extends ScoreCreateBody by adding project_id for internal API usage. --- - + ## class `ScorerDeleteReq` @@ -4914,7 +5137,7 @@ Extends ScoreCreateBody by adding project_id for internal API usage. --- - + ## class `ScorerDeleteRes` @@ -4924,7 +5147,7 @@ Extends ScoreCreateBody by adding project_id for internal API usage. --- - + ## class `ScorerListReq` @@ -4937,7 +5160,7 @@ Extends ScoreCreateBody by adding project_id for internal API usage. --- - + ## class `ScorerReadReq` @@ -4950,7 +5173,7 @@ Extends ScoreCreateBody by adding project_id for internal API usage. --- - + ## class `ScorerReadRes` @@ -4966,7 +5189,7 @@ Extends ScoreCreateBody by adding project_id for internal API usage. --- - + ## class `SourceDatasetMembership` Membership of a single (source, dataset) pair in the reverse query. @@ -4984,7 +5207,7 @@ Membership of a single (source, dataset) pair in the reverse query. --- - + ## class `SourceDatasetsQueryReq` Reverse query: sources -> datasets. @@ -4998,7 +5221,7 @@ Reverse query: sources -> datasets. --- - + ## class `SourceDatasetsQueryRes` Response from the reverse sources -> datasets query. @@ -5009,13 +5232,13 @@ Response from the reverse sources -> datasets query. --- - + ## class `SourceKind` --- - + ## class `SourceRef` Reference to a provenance source (a call, an agent span, or a conversation). @@ -5028,7 +5251,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `StartedCallSchemaForInsert` @@ -5052,19 +5275,19 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `SummaryInsertMap` --- - + ## class `SummaryMap` --- - + ## class `TableAppendSpec` @@ -5074,7 +5297,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableAppendSpecPayload` @@ -5084,7 +5307,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableCreateFromDigestsReq` @@ -5096,7 +5319,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableCreateFromDigestsRes` @@ -5106,7 +5329,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableCreateReq` @@ -5116,7 +5339,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableCreateRes` @@ -5127,7 +5350,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableInsertSpec` @@ -5137,7 +5360,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableInsertSpecPayload` @@ -5148,7 +5371,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TablePopSpec` @@ -5158,7 +5381,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TablePopSpecPayload` @@ -5168,7 +5391,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableQueryReq` @@ -5183,7 +5406,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableQueryRes` @@ -5193,7 +5416,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableQueryStatsBatchReq` @@ -5205,7 +5428,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableQueryStatsBatchRes` @@ -5215,7 +5438,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableQueryStatsReq` @@ -5226,7 +5449,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableQueryStatsRes` @@ -5236,7 +5459,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableRowFilter` @@ -5246,7 +5469,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableRowSchema` @@ -5258,7 +5481,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableSchemaForInsert` @@ -5270,7 +5493,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableStatsRow` @@ -5282,7 +5505,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableUpdateReq` @@ -5294,7 +5517,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TableUpdateRes` @@ -5305,7 +5528,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TagsListReq` @@ -5316,7 +5539,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `TagsListRes` @@ -5326,7 +5549,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `ThreadSchema` @@ -5343,7 +5566,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `ThreadsQueryFilter` @@ -5355,7 +5578,7 @@ Reference to a provenance source (a call, an agent span, or a conversation). --- - + ## class `ThreadsQueryReq` Query threads with aggregated statistics based on turn calls only. @@ -5372,13 +5595,13 @@ Turn calls are the immediate children of thread contexts (where call.id == turn_ --- - + ## class `TraceServerInterface` --- - + ### method `agent_agents_query` @@ -5388,7 +5611,7 @@ agent_agents_query(req: AgentsQueryReq) → AgentsQueryRes --- - + ### method `agent_conversation_chat` @@ -5400,7 +5623,7 @@ agent_conversation_chat( --- - + ### method `agent_conversation_spans` @@ -5412,7 +5635,7 @@ agent_conversation_spans( --- - + ### method `agent_custom_attrs_schema` @@ -5424,7 +5647,7 @@ agent_custom_attrs_schema( --- - + ### method `agent_search` @@ -5434,7 +5657,7 @@ agent_search(req: AgentSearchReq) → AgentSearchRes --- - + ### method `agent_spans_query` @@ -5444,7 +5667,7 @@ agent_spans_query(req: AgentSpansQueryReq) → AgentSpansQueryRes --- - + ### method `agent_spans_stats` @@ -5454,7 +5677,7 @@ agent_spans_stats(req: AgentSpanStatsReq) → AgentSpanStatsRes --- - + ### method `agent_traces_chat` @@ -5464,7 +5687,7 @@ agent_traces_chat(req: AgentTraceChatReq) → AgentTraceChatRes --- - + ### method `agent_versions_query` @@ -5474,7 +5697,7 @@ agent_versions_query(req: AgentVersionsQueryReq) → AgentVersionsQueryRes --- - + ### method `aliases_list` @@ -5484,7 +5707,7 @@ aliases_list(req: AliasesListReq) → AliasesListRes --- - + ### method `annotation_queue_add_calls` @@ -5496,7 +5719,7 @@ annotation_queue_add_calls( --- - + ### method `annotation_queue_create` @@ -5508,7 +5731,7 @@ annotation_queue_create( --- - + ### method `annotation_queue_delete` @@ -5520,7 +5743,7 @@ annotation_queue_delete( --- - + ### method `annotation_queue_items_query` @@ -5532,7 +5755,7 @@ annotation_queue_items_query( --- - + ### method `annotation_queue_read` @@ -5542,7 +5765,7 @@ annotation_queue_read(req: AnnotationQueueReadReq) → AnnotationQueueReadRes --- - + ### method `annotation_queue_update` @@ -5554,7 +5777,7 @@ annotation_queue_update( --- - + ### method `annotation_queues_query_stream` @@ -5566,7 +5789,7 @@ annotation_queues_query_stream( --- - + ### method `annotation_queues_stats` @@ -5578,7 +5801,7 @@ annotation_queues_stats( --- - + ### method `annotator_queue_items_progress_update` @@ -5590,7 +5813,7 @@ annotator_queue_items_progress_update( --- - + ### method `call_end` @@ -5600,7 +5823,7 @@ call_end(req: CallEndReq) → CallEndRes --- - + ### method `call_read` @@ -5610,7 +5833,7 @@ call_read(req: CallReadReq) → CallReadRes --- - + ### method `call_start` @@ -5620,7 +5843,7 @@ call_start(req: CallStartReq) → CallStartRes --- - + ### method `call_start_batch` @@ -5630,7 +5853,7 @@ call_start_batch(req: CallCreateBatchReq) → CallCreateBatchRes --- - + ### method `call_stats` @@ -5640,7 +5863,7 @@ call_stats(req: 'CallStatsReq') → CallStatsRes --- - + ### method `call_update` @@ -5650,7 +5873,7 @@ call_update(req: CallUpdateReq) → CallUpdateRes --- - + ### method `calls_delete` @@ -5660,7 +5883,7 @@ calls_delete(req: CallsDeleteReq) → CallsDeleteRes --- - + ### method `calls_query` @@ -5670,7 +5893,7 @@ calls_query(req: CallsQueryReq) → CallsQueryRes --- - + ### method `calls_query_stats` @@ -5680,7 +5903,7 @@ calls_query_stats(req: CallsQueryStatsReq) → CallsQueryStatsRes --- - + ### method `calls_query_stream` @@ -5690,7 +5913,7 @@ calls_query_stream(req: CallsQueryReq) → Iterator[CallSchema] --- - + ### method `calls_score` @@ -5700,7 +5923,7 @@ calls_score(req: CallsScoreReq) → CallsScoreRes --- - + ### method `calls_usage` @@ -5710,7 +5933,7 @@ calls_usage(req: 'CallsUsageReq') → CallsUsageRes --- - + ### method `completions_create` @@ -5720,7 +5943,7 @@ completions_create(req: CompletionsCreateReq) → CompletionsCreateRes --- - + ### method `completions_create_stream` @@ -5730,7 +5953,7 @@ completions_create_stream(req: CompletionsCreateReq) → Iterator[dict[str, Any] --- - + ### method `cost_create` @@ -5740,7 +5963,7 @@ cost_create(req: CostCreateReq) → CostCreateRes --- - + ### method `cost_purge` @@ -5750,7 +5973,7 @@ cost_purge(req: CostPurgeReq) → CostPurgeRes --- - + ### method `cost_query` @@ -5760,7 +5983,7 @@ cost_query(req: CostQueryReq) → CostQueryRes --- - + ### method `dataset_sources_link` @@ -5770,7 +5993,7 @@ dataset_sources_link(req: DatasetSourcesLinkReq) → DatasetSourcesLinkRes --- - + ### method `dataset_sources_link_delete` @@ -5782,7 +6005,7 @@ dataset_sources_link_delete( --- - + ### method `dataset_sources_query` @@ -5792,7 +6015,7 @@ dataset_sources_query(req: DatasetSourcesQueryReq) → DatasetSourcesQueryRes --- - + ### method `evaluate_model` @@ -5802,7 +6025,7 @@ evaluate_model(req: EvaluateModelReq) → EvaluateModelRes --- - + ### method `evaluation_status` @@ -5812,7 +6035,27 @@ evaluation_status(req: EvaluationStatusReq) → EvaluationStatusRes --- - + + +### method `export_start` + +```python +export_start(req: ExportStartReq) → ExportStartRes +``` + +--- + + + +### method `export_status` + +```python +export_status(req: ExportStatusReq) → ExportStatusRes +``` + +--- + + ### method `feedback_aggregate` @@ -5822,7 +6065,7 @@ feedback_aggregate(req: FeedbackAggregateReq) → FeedbackAggregateRes --- - + ### method `feedback_create` @@ -5832,7 +6075,7 @@ feedback_create(req: FeedbackCreateReq) → FeedbackCreateRes --- - + ### method `feedback_create_batch` @@ -5842,7 +6085,7 @@ feedback_create_batch(req: FeedbackCreateBatchReq) → FeedbackCreateBatchRes --- - + ### method `feedback_payload_schema` @@ -5854,7 +6097,7 @@ feedback_payload_schema( --- - + ### method `feedback_purge` @@ -5864,7 +6107,7 @@ feedback_purge(req: FeedbackPurgeReq) → FeedbackPurgeRes --- - + ### method `feedback_query` @@ -5874,7 +6117,7 @@ feedback_query(req: FeedbackQueryReq) → FeedbackQueryRes --- - + ### method `feedback_replace` @@ -5884,7 +6127,7 @@ feedback_replace(req: FeedbackReplaceReq) → FeedbackReplaceRes --- - + ### method `feedback_stats` @@ -5894,7 +6137,7 @@ feedback_stats(req: FeedbackStatsReq) → FeedbackStatsRes --- - + ### method `file_content_read` @@ -5904,7 +6147,7 @@ file_content_read(req: FileContentReadReq) → FileContentReadRes --- - + ### method `file_create` @@ -5914,7 +6157,7 @@ file_create(req: FileCreateReq) → FileCreateRes --- - + ### method `files_stats` @@ -5924,7 +6167,7 @@ files_stats(req: FilesStatsReq) → FilesStatsRes --- - + ### method `genai_otel_export` @@ -5934,7 +6177,7 @@ genai_otel_export(req: GenAIOTelExportReq) → GenAIOTelExportRes --- - + ### method `image_create` @@ -5944,7 +6187,7 @@ image_create(req: ImageGenerationCreateReq) → ImageGenerationCreateRes --- - + ### method `obj_add_tags` @@ -5954,7 +6197,7 @@ obj_add_tags(req: ObjAddTagsReq) → ObjAddTagsRes --- - + ### method `obj_create` @@ -5964,7 +6207,7 @@ obj_create(req: ObjCreateReq) → ObjCreateRes --- - + ### method `obj_delete` @@ -5974,7 +6217,7 @@ obj_delete(req: ObjDeleteReq) → ObjDeleteRes --- - + ### method `obj_read` @@ -5984,7 +6227,7 @@ obj_read(req: ObjReadReq) → ObjReadRes --- - + ### method `obj_remove_aliases` @@ -5994,7 +6237,7 @@ obj_remove_aliases(req: ObjRemoveAliasesReq) → ObjRemoveAliasesRes --- - + ### method `obj_remove_tags` @@ -6004,7 +6247,7 @@ obj_remove_tags(req: ObjRemoveTagsReq) → ObjRemoveTagsRes --- - + ### method `obj_set_aliases` @@ -6014,7 +6257,7 @@ obj_set_aliases(req: ObjSetAliasesReq) → ObjSetAliasesRes --- - + ### method `objs_query` @@ -6024,7 +6267,7 @@ objs_query(req: ObjQueryReq) → ObjQueryRes --- - + ### method `otel_export` @@ -6034,7 +6277,7 @@ otel_export(req: OTelExportReq) → OTelExportRes --- - + ### method `project_stats` @@ -6044,7 +6287,7 @@ project_stats(req: ProjectStatsReq) → ProjectStatsRes --- - + ### method `project_ttl_settings_read` @@ -6056,7 +6299,7 @@ project_ttl_settings_read( --- - + ### method `project_ttl_settings_update` @@ -6068,7 +6311,7 @@ project_ttl_settings_update( --- - + ### method `refs_read_batch` @@ -6078,7 +6321,7 @@ refs_read_batch(req: RefsReadBatchReq) → RefsReadBatchRes --- - + ### method `rescore` @@ -6088,7 +6331,7 @@ rescore(req: RescoreReq) → RescoreRes --- - + ### method `source_datasets_query` @@ -6098,7 +6341,7 @@ source_datasets_query(req: SourceDatasetsQueryReq) → SourceDatasetsQueryRes --- - + ### method `table_create` @@ -6108,7 +6351,7 @@ table_create(req: TableCreateReq) → TableCreateRes --- - + ### method `table_create_from_digests` @@ -6120,7 +6363,7 @@ table_create_from_digests( --- - + ### method `table_query` @@ -6130,7 +6373,7 @@ table_query(req: TableQueryReq) → TableQueryRes --- - + ### method `table_query_stats` @@ -6140,7 +6383,7 @@ table_query_stats(req: TableQueryStatsReq) → TableQueryStatsRes --- - + ### method `table_query_stats_batch` @@ -6150,7 +6393,7 @@ table_query_stats_batch(req: TableQueryStatsBatchReq) → TableQueryStatsBatchRe --- - + ### method `table_query_stream` @@ -6160,7 +6403,7 @@ table_query_stream(req: TableQueryReq) → Iterator[TableRowSchema] --- - + ### method `table_update` @@ -6170,7 +6413,7 @@ table_update(req: TableUpdateReq) → TableUpdateRes --- - + ### method `tags_list` @@ -6180,7 +6423,7 @@ tags_list(req: TagsListReq) → TagsListRes --- - + ### method `threads_query_stream` @@ -6190,7 +6433,7 @@ threads_query_stream(req: ThreadsQueryReq) → Iterator[ThreadSchema] --- - + ### method `trace_usage` @@ -6200,13 +6443,13 @@ trace_usage(req: 'TraceUsageReq') → TraceUsageRes --- - + ## class `TraceStatus` --- - + ## class `TraceUsageReq` Request to compute per-call usage for a trace, with descendant rollup. @@ -6225,7 +6468,7 @@ Note: All matching calls are loaded into memory for aggregation. For very large --- - + ## class `TraceUsageRes` Response with per-call usage metrics (each includes descendant contributions). @@ -6237,7 +6480,7 @@ Response with per-call usage metrics (each includes descendant contributions). --- - + ## class `UsageMetricSpec` Specification for a usage metric to aggregate (grouped by model). @@ -6250,7 +6493,7 @@ Specification for a usage metric to aggregate (grouped by model). --- - + ## class `WeaveSummarySchema` diff --git a/weave/reference/python-sdk/trace_server_bindings/remote_http_trace_server.mdx b/weave/reference/python-sdk/trace_server_bindings/remote_http_trace_server.mdx index b0d0d50863..e88fad21c7 100644 --- a/weave/reference/python-sdk/trace_server_bindings/remote_http_trace_server.mdx +++ b/weave/reference/python-sdk/trace_server_bindings/remote_http_trace_server.mdx @@ -10,11 +10,11 @@ import { SourceLink } from '/snippets/_includes/source-link.mdx'; --- - + ## class `RemoteHTTPTraceServer` - + ### method `__init__` @@ -30,7 +30,7 @@ __init__( --- - + ### method `agent_agents_query` @@ -40,7 +40,7 @@ agent_agents_query(req: AgentsQueryReq) → AgentsQueryRes --- - + ### method `agent_conversation_chat` @@ -52,7 +52,7 @@ agent_conversation_chat( --- - + ### method `agent_custom_attrs_schema` @@ -64,7 +64,7 @@ agent_custom_attrs_schema( --- - + ### method `agent_search` @@ -74,7 +74,7 @@ agent_search(req: AgentSearchReq) → AgentSearchRes --- - + ### method `agent_spans_query` @@ -84,7 +84,7 @@ agent_spans_query(req: AgentSpansQueryReq) → AgentSpansQueryRes --- - + ### method `agent_spans_stats` @@ -94,7 +94,7 @@ agent_spans_stats(req: AgentSpanStatsReq) → AgentSpanStatsRes --- - + ### method `agent_traces_chat` @@ -104,7 +104,7 @@ agent_traces_chat(req: AgentTraceChatReq) → AgentTraceChatRes --- - + ### method `agent_versions_query` @@ -114,7 +114,7 @@ agent_versions_query(req: AgentVersionsQueryReq) → AgentVersionsQueryRes --- - + ### method `aliases_list` @@ -124,7 +124,7 @@ aliases_list(req: AliasesListReq) → AliasesListRes --- - + ### method `annotation_queue_add_calls` @@ -136,7 +136,7 @@ annotation_queue_add_calls( --- - + ### method `annotation_queue_create` @@ -148,7 +148,7 @@ annotation_queue_create( --- - + ### method `annotation_queue_delete` @@ -160,7 +160,7 @@ annotation_queue_delete( --- - + ### method `annotation_queue_items_query` @@ -172,7 +172,7 @@ annotation_queue_items_query( --- - + ### method `annotation_queue_read` @@ -182,7 +182,7 @@ annotation_queue_read(req: AnnotationQueueReadReq) → AnnotationQueueReadRes --- - + ### method `annotation_queue_update` @@ -194,7 +194,7 @@ annotation_queue_update( --- - + ### method `annotation_queues_query_stream` @@ -206,7 +206,7 @@ annotation_queues_query_stream( --- - + ### method `annotation_queues_stats` @@ -218,7 +218,7 @@ annotation_queues_stats( --- - + ### method `annotator_queue_items_progress_update` @@ -230,7 +230,7 @@ annotator_queue_items_progress_update( --- - + ### method `call_end` @@ -240,7 +240,7 @@ call_end(req: CallEndReq) → CallEndRes --- - + ### method `call_end_v2` @@ -254,7 +254,7 @@ This endpoint is used for eager ops that need their end sent separately. --- - + ### method `call_read` @@ -264,7 +264,7 @@ call_read(req: CallReadReq) → CallReadRes --- - + ### method `call_start` @@ -274,7 +274,7 @@ call_start(req: CallStartReq) → CallStartRes --- - + ### method `call_start_batch` @@ -284,7 +284,7 @@ call_start_batch(req: CallCreateBatchReq) → CallCreateBatchRes --- - + ### method `call_start_v2` @@ -298,7 +298,7 @@ This endpoint is used for eager ops that need their start visible immediately. --- - + ### method `call_update` @@ -308,7 +308,7 @@ call_update(req: CallUpdateReq) → CallUpdateRes --- - + ### method `calls_complete` @@ -322,7 +322,7 @@ This endpoint is used when use_calls_complete is enabled to send complete calls --- - + ### method `calls_delete` @@ -332,7 +332,7 @@ calls_delete(req: CallsDeleteReq) → CallsDeleteRes --- - + ### method `calls_query` @@ -342,7 +342,7 @@ calls_query(req: CallsQueryReq) → CallsQueryRes --- - + ### method `calls_query_stats` @@ -352,7 +352,7 @@ calls_query_stats(req: CallsQueryStatsReq) → CallsQueryStatsRes --- - + ### method `calls_query_stream` @@ -362,7 +362,7 @@ calls_query_stream(req: CallsQueryReq) → Iterator[CallSchema] --- - + ### method `calls_score` @@ -372,7 +372,7 @@ calls_score(req: CallsScoreReq) → CallsScoreRes --- - + ### method `calls_usage` @@ -382,7 +382,7 @@ calls_usage(req: CallsUsageReq) → CallsUsageRes --- - + ### method `completions_create` @@ -392,7 +392,7 @@ completions_create(req: CompletionsCreateReq) → CompletionsCreateRes --- - + ### method `completions_create_stream` @@ -402,7 +402,7 @@ completions_create_stream(req: CompletionsCreateReq) → Iterator[dict[str, Any] --- - + ### method `cost_create` @@ -412,7 +412,7 @@ cost_create(req: CostCreateReq) → CostCreateRes --- - + ### method `cost_purge` @@ -422,7 +422,7 @@ cost_purge(req: CostPurgeReq) → CostPurgeRes --- - + ### method `cost_query` @@ -432,7 +432,17 @@ cost_query(req: CostQueryReq) → CostQueryRes --- - + + +### method `custom_runtime_apply` + +```python +custom_runtime_apply(req: CustomRuntimeApplyReq) → CustomRuntimeApplyRes +``` + +--- + + ### method `dataset_create` @@ -442,7 +452,7 @@ dataset_create(req: DatasetCreateReq) → DatasetCreateRes --- - + ### method `dataset_delete` @@ -452,7 +462,7 @@ dataset_delete(req: DatasetDeleteReq) → DatasetDeleteRes --- - + ### method `dataset_list` @@ -462,7 +472,7 @@ dataset_list(req: DatasetListReq) → Iterator[DatasetReadRes] --- - + ### method `dataset_read` @@ -472,7 +482,7 @@ dataset_read(req: DatasetReadReq) → DatasetReadRes --- - + ### method `dataset_sources_link` @@ -482,7 +492,7 @@ dataset_sources_link(req: DatasetSourcesLinkReq) → DatasetSourcesLinkRes --- - + ### method `dataset_sources_link_delete` @@ -494,7 +504,7 @@ dataset_sources_link_delete( --- - + ### method `dataset_sources_query` @@ -504,7 +514,7 @@ dataset_sources_query(req: DatasetSourcesQueryReq) → DatasetSourcesQueryRes --- - + ### method `delete` @@ -514,7 +524,7 @@ delete(url: str, *args: Any, **kwargs: Any) → Response --- - + ### method `ensure_project_exists` @@ -524,7 +534,7 @@ ensure_project_exists(entity: str, project: str) → EnsureProjectExistsRes --- - + ### method `evaluate_model` @@ -534,7 +544,7 @@ evaluate_model(req: EvaluateModelReq) → EvaluateModelRes --- - + ### method `evaluation_create` @@ -544,7 +554,7 @@ evaluation_create(req: EvaluationCreateReq) → EvaluationCreateRes --- - + ### method `evaluation_delete` @@ -554,7 +564,7 @@ evaluation_delete(req: EvaluationDeleteReq) → EvaluationDeleteRes --- - + ### method `evaluation_list` @@ -564,7 +574,7 @@ evaluation_list(req: EvaluationListReq) → Iterator[EvaluationReadRes] --- - + ### method `evaluation_read` @@ -574,7 +584,7 @@ evaluation_read(req: EvaluationReadReq) → EvaluationReadRes --- - + ### method `evaluation_run_create` @@ -584,7 +594,7 @@ evaluation_run_create(req: EvaluationRunCreateReq) → EvaluationRunCreateRes --- - + ### method `evaluation_run_delete` @@ -594,7 +604,7 @@ evaluation_run_delete(req: EvaluationRunDeleteReq) → EvaluationRunDeleteRes --- - + ### method `evaluation_run_finish` @@ -604,7 +614,7 @@ evaluation_run_finish(req: EvaluationRunFinishReq) → EvaluationRunFinishRes --- - + ### method `evaluation_run_list` @@ -614,7 +624,7 @@ evaluation_run_list(req: EvaluationRunListReq) → Iterator[EvaluationRunReadRes --- - + ### method `evaluation_run_read` @@ -624,7 +634,7 @@ evaluation_run_read(req: EvaluationRunReadReq) → EvaluationRunReadRes --- - + ### method `evaluation_status` @@ -634,7 +644,7 @@ evaluation_status(req: EvaluationStatusReq) → EvaluationStatusRes --- - + ### method `feedback_aggregate` @@ -646,7 +656,7 @@ Query the feedback table for aggregate scores over time. --- - + ### method `feedback_create` @@ -656,7 +666,7 @@ feedback_create(req: FeedbackCreateReq) → FeedbackCreateRes --- - + ### method `feedback_create_batch` @@ -666,7 +676,7 @@ feedback_create_batch(req: FeedbackCreateBatchReq) → FeedbackCreateBatchRes --- - + ### method `feedback_payload_schema` @@ -678,7 +688,7 @@ feedback_payload_schema( --- - + ### method `feedback_purge` @@ -688,7 +698,7 @@ feedback_purge(req: FeedbackPurgeReq) → FeedbackPurgeRes --- - + ### method `feedback_query` @@ -698,7 +708,7 @@ feedback_query(req: FeedbackQueryReq) → FeedbackQueryRes --- - + ### method `feedback_replace` @@ -708,7 +718,7 @@ feedback_replace(req: FeedbackReplaceReq) → FeedbackReplaceRes --- - + ### method `feedback_stats` @@ -718,7 +728,7 @@ feedback_stats(req: FeedbackStatsReq) → FeedbackStatsRes --- - + ### method `file_content_read` @@ -728,7 +738,7 @@ file_content_read(req: FileContentReadReq) → FileContentReadRes --- - + ### method `file_create` @@ -738,7 +748,7 @@ file_create(req: FileCreateReq) → FileCreateRes --- - + ### method `files_stats` @@ -748,7 +758,7 @@ files_stats(req: FilesStatsReq) → FilesStatsRes --- - + ### classmethod `from_env` @@ -758,7 +768,7 @@ from_env(should_batch: bool = False) → Self --- - + ### method `get` @@ -768,7 +778,7 @@ get(url: str, *args: Any, **kwargs: Any) → Response --- - + ### method `get_call_processor` @@ -780,7 +790,7 @@ Custom method not defined on the formal TraceServerInterface to expose the under --- - + ### method `get_feedback_processor` @@ -792,7 +802,7 @@ Custom method not defined on the formal TraceServerInterface to expose the under --- - + ### method `image_create` @@ -802,7 +812,7 @@ image_create(req: ImageGenerationCreateReq) → ImageGenerationCreateRes --- - + ### method `model_create` @@ -812,7 +822,7 @@ model_create(req: ModelCreateReq) → ModelCreateRes --- - + ### method `model_delete` @@ -822,7 +832,7 @@ model_delete(req: ModelDeleteReq) → ModelDeleteRes --- - + ### method `model_list` @@ -832,7 +842,7 @@ model_list(req: ModelListReq) → Iterator[ModelReadRes] --- - + ### method `model_read` @@ -842,7 +852,7 @@ model_read(req: ModelReadReq) → ModelReadRes --- - + ### method `obj_add_tags` @@ -852,7 +862,7 @@ obj_add_tags(req: ObjAddTagsReq) → ObjAddTagsRes --- - + ### method `obj_create` @@ -862,7 +872,7 @@ obj_create(req: ObjCreateReq) → ObjCreateRes --- - + ### method `obj_delete` @@ -872,7 +882,7 @@ obj_delete(req: ObjDeleteReq) → ObjDeleteRes --- - + ### method `obj_read` @@ -882,7 +892,7 @@ obj_read(req: ObjReadReq) → ObjReadRes --- - + ### method `obj_remove_aliases` @@ -892,7 +902,7 @@ obj_remove_aliases(req: ObjRemoveAliasesReq) → ObjRemoveAliasesRes --- - + ### method `obj_remove_tags` @@ -902,7 +912,7 @@ obj_remove_tags(req: ObjRemoveTagsReq) → ObjRemoveTagsRes --- - + ### method `obj_set_aliases` @@ -912,7 +922,7 @@ obj_set_aliases(req: ObjSetAliasesReq) → ObjSetAliasesRes --- - + ### method `objs_query` @@ -922,7 +932,7 @@ objs_query(req: ObjQueryReq) → ObjQueryRes --- - + ### method `op_create` @@ -932,7 +942,7 @@ op_create(req: OpCreateReq) → OpCreateRes --- - + ### method `op_delete` @@ -942,7 +952,7 @@ op_delete(req: OpDeleteReq) → OpDeleteRes --- - + ### method `op_list` @@ -952,7 +962,7 @@ op_list(req: OpListReq) → Iterator[OpReadRes] --- - + ### method `op_read` @@ -962,7 +972,7 @@ op_read(req: OpReadReq) → OpReadRes --- - + ### method `otel_export` @@ -972,7 +982,7 @@ otel_export(req: OTelExportReq) → OTelExportRes --- - + ### method `post` @@ -987,7 +997,7 @@ post( --- - + ### method `prediction_create` @@ -997,7 +1007,7 @@ prediction_create(req: PredictionCreateReq) → PredictionCreateRes --- - + ### method `prediction_delete` @@ -1007,7 +1017,7 @@ prediction_delete(req: PredictionDeleteReq) → PredictionDeleteRes --- - + ### method `prediction_finish` @@ -1017,7 +1027,7 @@ prediction_finish(req: PredictionFinishReq) → PredictionFinishRes --- - + ### method `prediction_list` @@ -1027,7 +1037,7 @@ prediction_list(req: PredictionListReq) → Iterator[PredictionReadRes] --- - + ### method `prediction_read` @@ -1037,7 +1047,7 @@ prediction_read(req: PredictionReadReq) → PredictionReadRes --- - + ### method `project_stats` @@ -1047,7 +1057,7 @@ project_stats(req: ProjectStatsReq) → ProjectStatsRes --- - + ### method `project_ttl_settings_read` @@ -1059,7 +1069,7 @@ project_ttl_settings_read( --- - + ### method `project_ttl_settings_update` @@ -1071,7 +1081,7 @@ project_ttl_settings_update( --- - + ### method `projects_info` @@ -1081,7 +1091,7 @@ projects_info(req: ProjectsInfoReq) → list[ProjectsInfoRes] --- - + ### method `put` @@ -1091,7 +1101,7 @@ put(url: str, *args: Any, **kwargs: Any) → Response --- - + ### method `refs_read_batch` @@ -1101,7 +1111,7 @@ refs_read_batch(req: RefsReadBatchReq) → RefsReadBatchRes --- - + ### method `rescore` @@ -1111,7 +1121,7 @@ rescore(req: RescoreReq) → RescoreRes --- - + ### method `score_create` @@ -1121,7 +1131,7 @@ score_create(req: ScoreCreateReq) → ScoreCreateRes --- - + ### method `score_delete` @@ -1131,7 +1141,7 @@ score_delete(req: ScoreDeleteReq) → ScoreDeleteRes --- - + ### method `score_list` @@ -1141,7 +1151,7 @@ score_list(req: ScoreListReq) → Iterator[ScoreReadRes] --- - + ### method `score_read` @@ -1151,7 +1161,7 @@ score_read(req: ScoreReadReq) → ScoreReadRes --- - + ### method `scorer_create` @@ -1161,7 +1171,7 @@ scorer_create(req: ScorerCreateReq) → ScorerCreateRes --- - + ### method `scorer_delete` @@ -1171,7 +1181,7 @@ scorer_delete(req: ScorerDeleteReq) → ScorerDeleteRes --- - + ### method `scorer_list` @@ -1181,7 +1191,7 @@ scorer_list(req: ScorerListReq) → Iterator[ScorerReadRes] --- - + ### method `scorer_read` @@ -1191,7 +1201,7 @@ scorer_read(req: ScorerReadReq) → ScorerReadRes --- - + ### method `server_info` @@ -1201,7 +1211,7 @@ server_info() → ServerInfoRes --- - + ### method `set_auth` @@ -1211,7 +1221,7 @@ set_auth(auth: tuple[str, str]) → None --- - + ### method `source_datasets_query` @@ -1221,7 +1231,7 @@ source_datasets_query(req: SourceDatasetsQueryReq) → SourceDatasetsQueryRes --- - + ### method `table_create` @@ -1231,7 +1241,7 @@ table_create(req: TableCreateReq) → TableCreateRes --- - + ### method `table_create_from_digests` @@ -1245,7 +1255,7 @@ Create a table by specifying row digests instead of actual rows. --- - + ### method `table_query` @@ -1255,7 +1265,7 @@ table_query(req: TableQueryReq) → TableQueryRes --- - + ### method `table_query_stats` @@ -1265,7 +1275,7 @@ table_query_stats(req: TableQueryStatsReq) → TableQueryStatsRes --- - + ### method `table_query_stats_batch` @@ -1275,7 +1285,7 @@ table_query_stats_batch(req: TableQueryStatsReq) → TableQueryStatsRes --- - + ### method `table_query_stream` @@ -1285,7 +1295,7 @@ table_query_stream(req: TableQueryReq) → Iterator[TableRowSchema] --- - + ### method `table_update` @@ -1297,7 +1307,7 @@ Similar to `calls/batch_upsert`, we can dynamically adjust the payload size due --- - + ### method `tags_list` @@ -1307,7 +1317,7 @@ tags_list(req: TagsListReq) → TagsListRes --- - + ### method `threads_query_stream` @@ -1317,7 +1327,7 @@ threads_query_stream(req: ThreadsQueryReq) → Iterator[ThreadSchema] --- - + ### method `trace_usage` diff --git a/weave/reference/service-api.mdx b/weave/reference/service-api.mdx index bb3b07a6fd..4cf16f2a30 100644 --- a/weave/reference/service-api.mdx +++ b/weave/reference/service-api.mdx @@ -141,6 +141,10 @@ curl -H "Authorization: Bearer YOUR_API_KEY" https://trace.wandb.ai/... - **[POST `/annotation_queues/{queue_id}/items/query`](https://docs.wandb.ai/weave/reference/service-api/annotation-queues/annotation-queue-items-query)** - Annotation Queue Items Query - **[POST `/annotation_queues/{queue_id}/items/{item_id}/progress`](https://docs.wandb.ai/weave/reference/service-api/annotation-queues/annotation-queue-item-progress-update)** - Annotation Queue Item Progress Update +### Custom Runtimes + +- **[PUT `/v2/{entity}/{project}/runtimes/{runtime_name}`](https://docs.wandb.ai/weave/reference/service-api/custom-runtimes/custom-runtime-apply)** - Custom Runtime Apply + ### Datasets - **[GET `/v2/{entity}/{project}/datasets`](https://docs.wandb.ai/weave/reference/service-api/datasets/dataset-list)** - Dataset List diff --git a/weave/reference/service-api/openapi.json b/weave/reference/service-api/openapi.json index 7c3b277b4f..0e53e3e2bf 100644 --- a/weave/reference/service-api/openapi.json +++ b/weave/reference/service-api/openapi.json @@ -2509,10 +2509,12 @@ }, "responses": { "200": { - "description": "Successful Response", + "description": "Stream of data in JSONL format", "content": { - "application/json": { - "schema": {} + "application/x-ndjson": { + "schema": { + "$ref": "#/components/schemas/ThreadSchema" + } } } }, @@ -3450,10 +3452,12 @@ ], "responses": { "200": { - "description": "Successful Response", + "description": "Stream of data in JSONL format", "content": { - "application/json": { - "schema": {} + "application/x-ndjson": { + "schema": { + "$ref": "#/components/schemas/OpReadRes" + } } } }, @@ -3760,10 +3764,12 @@ ], "responses": { "200": { - "description": "Successful Response", + "description": "Stream of data in JSONL format", "content": { - "application/json": { - "schema": {} + "application/x-ndjson": { + "schema": { + "$ref": "#/components/schemas/DatasetReadRes" + } } } }, @@ -3932,6 +3938,82 @@ } } }, + "/v2/{entity}/{project}/runtimes/{runtime_name}": { + "put": { + "tags": [ + "Custom Runtimes" + ], + "summary": "Custom Runtime Apply", + "description": "Create or replace a custom runtime configuration.", + "operationId": "custom_runtime_apply_v2__entity___project__runtimes__runtime_name__put", + "parameters": [ + { + "name": "entity", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Entity" + } + }, + { + "name": "project", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Project" + } + }, + { + "name": "runtime_name", + "in": "path", + "required": true, + "schema": { + "type": "string", + "minLength": 1, + "maxLength": 128, + "pattern": "^[^\\s:]*(?::[^\\s:]+)*:?$", + "description": "Stable name of the custom runtime to create or replace", + "title": "Runtime Name" + }, + "description": "Stable name of the custom runtime to create or replace" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomRuntimeApplyBody" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomRuntimeApplyRes" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, "/v2/{entity}/{project}/scorers": { "post": { "tags": [ @@ -4018,14 +4100,52 @@ "type": "string", "title": "Project" } + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Maximum number of scorers to return", + "title": "Limit" + }, + "description": "Maximum number of scorers to return" + }, + { + "name": "offset", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of scorers to skip", + "title": "Offset" + }, + "description": "Number of scorers to skip" } ], "responses": { "200": { - "description": "Successful Response", + "description": "Stream of data in JSONL format", "content": { - "application/json": { - "schema": {} + "application/x-ndjson": { + "schema": { + "$ref": "#/components/schemas/ScorerReadRes" + } } } }, @@ -4280,14 +4400,52 @@ "type": "string", "title": "Project" } + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Maximum number of evaluations to return", + "title": "Limit" + }, + "description": "Maximum number of evaluations to return" + }, + { + "name": "offset", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of evaluations to skip", + "title": "Offset" + }, + "description": "Number of evaluations to skip" } ], "responses": { "200": { - "description": "Successful Response", + "description": "Stream of data in JSONL format", "content": { - "application/json": { - "schema": {} + "application/x-ndjson": { + "schema": { + "$ref": "#/components/schemas/EvaluationReadRes" + } } } }, @@ -4582,10 +4740,12 @@ ], "responses": { "200": { - "description": "Successful Response", + "description": "Stream of data in JSONL format", "content": { - "application/json": { - "schema": {} + "application/x-ndjson": { + "schema": { + "$ref": "#/components/schemas/ModelReadRes" + } } } }, @@ -4947,10 +5107,7 @@ "content": { "application/jsonl": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EvaluationRunReadRes" - } + "$ref": "#/components/schemas/EvaluationRunReadRes" } } } @@ -5312,10 +5469,7 @@ "content": { "application/jsonl": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PredictionReadRes" - } + "$ref": "#/components/schemas/PredictionReadRes" } } } @@ -5667,10 +5821,7 @@ "content": { "application/jsonl": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ScoreReadRes" - } + "$ref": "#/components/schemas/ScoreReadRes" } } } @@ -5937,6 +6088,12 @@ } }, "type": "object", + "required": [ + "model", + "system_instructions", + "tool_definitions", + "status" + ], "title": "AgentChatAgentStart", "description": "Payload for an agent lifecycle boundary." }, @@ -6071,7 +6228,18 @@ }, "type": "object", "required": [ - "text" + "text", + "model", + "reasoning_content", + "reasoning_tokens", + "input_tokens", + "output_tokens", + "input_cost_usd", + "output_cost_usd", + "total_cost_usd", + "duration_ms", + "status", + "content_refs" ], "title": "AgentChatAssistantMessage", "description": "Payload for assistant text emitted by an agent or LLM span." @@ -6113,24 +6281,34 @@ } }, "type": "object", + "required": [ + "compaction_summary", + "compaction_items_before", + "compaction_items_after" + ], "title": "AgentChatContextCompacted", "description": "Payload for a context-window compaction event." }, - "AgentChatMessage": { + "AgentChatFeedback": { "properties": { - "type": { + "id": { "type": "string", - "enum": [ - "user_message", - "assistant_message", - "tool_call", - "agent_handoff", - "agent_start", - "context_compacted" - ], - "title": "Type" + "title": "Id" }, - "span_id": { + "feedback_type": { + "type": "string", + "title": "Feedback Type" + }, + "weave_ref": { + "type": "string", + "title": "Weave Ref" + }, + "payload": { + "additionalProperties": true, + "type": "object", + "title": "Payload" + }, + "creator": { "anyOf": [ { "type": "string" @@ -6139,20 +6317,21 @@ "type": "null" } ], - "title": "Span Id" + "title": "Creator" }, - "agent_name": { + "created_at": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Agent Name" + "title": "Created At" }, - "agent_version": { + "wb_user_id": { "anyOf": [ { "type": "string" @@ -6161,57 +6340,214 @@ "type": "null" } ], - "title": "Agent Version" + "title": "Wb User Id" }, - "status_code": { + "runnable_ref": { "anyOf": [ { - "type": "string", - "enum": [ - "UNSET", - "OK", - "ERROR" - ] + "type": "string" }, { "type": "null" } ], - "title": "Status Code" + "title": "Runnable Ref" }, - "started_at": { + "call_ref": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Started At" + "title": "Call Ref" }, - "user_message": { + "trigger_ref": { "anyOf": [ { - "$ref": "#/components/schemas/AgentChatUserMessage" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Trigger Ref" }, - "assistant_message": { + "annotation_ref": { "anyOf": [ { - "$ref": "#/components/schemas/AgentChatAssistantMessage" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Annotation Ref" }, - "tool_call": { + "scorer_tags": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Scorer Tags" + }, + "scorer_tag_reasons": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "title": "Scorer Tag Reasons" + }, + "scorer_tag_confidences": { + "additionalProperties": { + "type": "number" + }, + "type": "object", + "title": "Scorer Tag Confidences" + }, + "scorer_ratings": { + "additionalProperties": { + "type": "number" + }, + "type": "object", + "title": "Scorer Ratings" + }, + "scorer_rating_reasons": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "title": "Scorer Rating Reasons" + }, + "scorer_rating_confidences": { + "additionalProperties": { + "type": "number" + }, + "type": "object", + "title": "Scorer Rating Confidences" + } + }, + "type": "object", + "required": [ + "id", + "feedback_type", + "weave_ref", + "payload", + "creator", + "created_at", + "wb_user_id", + "runnable_ref", + "call_ref", + "trigger_ref", + "annotation_ref", + "scorer_tags", + "scorer_tag_reasons", + "scorer_tag_confidences", + "scorer_ratings", + "scorer_rating_reasons", + "scorer_rating_confidences" + ], + "title": "AgentChatFeedback", + "description": "Feedback row from the agent chat `include_feedback` projection.\n\nField names match FEEDBACK_QUERY_FIELDS. This is not the feedback\ntable row and not FeedbackCreateReq: project_id and span_* are not\nselected." + }, + "AgentChatMessage": { + "properties": { + "type": { + "type": "string", + "enum": [ + "user_message", + "assistant_message", + "tool_call", + "agent_handoff", + "agent_start", + "context_compacted" + ], + "title": "Type" + }, + "span_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Span Id" + }, + "agent_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Agent Name" + }, + "agent_version": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Agent Version" + }, + "status_code": { + "anyOf": [ + { + "type": "string", + "enum": [ + "UNSET", + "OK", + "ERROR" + ] + }, + { + "type": "null" + } + ], + "title": "Status Code" + }, + "started_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Started At" + }, + "user_message": { + "anyOf": [ + { + "$ref": "#/components/schemas/AgentChatUserMessage" + }, + { + "type": "null" + } + ] + }, + "assistant_message": { + "anyOf": [ + { + "$ref": "#/components/schemas/AgentChatAssistantMessage" + }, + { + "type": "null" + } + ] + }, + "tool_call": { "anyOf": [ { "$ref": "#/components/schemas/AgentChatToolCall" @@ -6255,8 +6591,7 @@ "anyOf": [ { "items": { - "additionalProperties": true, - "type": "object" + "$ref": "#/components/schemas/AgentChatFeedback" }, "type": "array" }, @@ -6269,7 +6604,19 @@ }, "type": "object", "required": [ - "type" + "type", + "span_id", + "agent_name", + "agent_version", + "status_code", + "started_at", + "user_message", + "assistant_message", + "tool_call", + "agent_start", + "agent_handoff", + "context_compacted", + "feedback" ], "title": "AgentChatMessage", "description": "A single element in the structured agent trajectory / chat view.\n\nCommon event fields live at the top level. Type-specific fields are\ngrouped under the payload matching `type`, and exactly one payload must be\nset. This keeps subtype nullability explicit while preserving a single\nordered timeline model for callers." @@ -6345,6 +6692,14 @@ } }, "type": "object", + "required": [ + "tool_name", + "tool_arguments", + "tool_result", + "duration_ms", + "status", + "content_refs" + ], "title": "AgentChatToolCall", "description": "Payload for a tool call timeline event." }, @@ -6364,7 +6719,8 @@ }, "type": "object", "required": [ - "text" + "text", + "content_refs" ], "title": "AgentChatUserMessage", "description": "Payload for a user prompt in the chat timeline." @@ -6456,8 +6812,7 @@ "anyOf": [ { "items": { - "additionalProperties": true, - "type": "object" + "$ref": "#/components/schemas/AgentChatFeedback" }, "type": "array" }, @@ -6470,7 +6825,14 @@ }, "type": "object", "required": [ - "conversation_id" + "conversation_id", + "turns", + "total_turns", + "has_more", + "limit", + "offset", + "total_cost_usd", + "feedback" ], "title": "AgentConversationChatRes", "description": "Multi-turn chat view: an ordered list of per-turn chat responses.\n\nEach entry in `turns` corresponds to one trace_id, which Weave treats as\none conversation turn. This is not necessarily one `invoke_agent` span:\na turn can contain zero, one, or many agent invocations. The frontend can\nrender turn-number dividers between entries and still reuse\n`AgentTraceChatRes` rendering for each individual turn." @@ -6479,8 +6841,11 @@ "properties": { "role": { "type": "string", - "title": "Role", - "default": "" + "enum": [ + "user_message", + "assistant_message" + ], + "title": "Role" }, "text": { "type": "string", @@ -6489,6 +6854,10 @@ } }, "type": "object", + "required": [ + "role", + "text" + ], "title": "AgentConversationMessagePreview", "description": "A truncated first/last message snippet for a grouped conversation row.\n\n`role` is the chat-timeline message type (e.g. \"user_message\",\n\"assistant_message\") so clients can style it consistently with the full\nchat view; `text` is the trimmed, length-capped preview content." }, @@ -6579,7 +6948,9 @@ "type": "object", "required": [ "trace_id", - "feedback_type" + "feedback_type", + "tags", + "ratings" ], "title": "AgentConversationSpanFeedback", "description": "Tags and ratings applied to a conversation's turn (or the conversation).\n\nPositioned client-side by matching `trace_id` (turn) against the spans;\n`trace_id` is None for conversation-level feedback." @@ -6620,7 +6991,9 @@ "type": "object", "required": [ "name", - "value" + "value", + "reason", + "confidence" ], "title": "AgentConversationSpanRating", "description": "One numeric rating (a scorer score) applied to a turn or conversation." @@ -6648,7 +7021,9 @@ }, "type": "object", "required": [ - "conversation_id" + "conversation_id", + "spans", + "spans_feedback" ], "title": "AgentConversationSpans", "description": "One conversation's span sequence and its feedback markers." @@ -6710,6 +7085,9 @@ } }, "type": "object", + "required": [ + "conversations" + ], "title": "AgentConversationSpansRes", "description": "Span sequences + feedback markers, one entry per requested conversation." }, @@ -6841,6 +7219,12 @@ } }, "type": "object", + "required": [ + "attributes", + "limit", + "offset", + "has_more" + ], "title": "AgentCustomAttrsSchemaRes", "description": "Typed custom attribute keys available for spans query/group/stats APIs." }, @@ -6963,7 +7347,8 @@ "total_duration_ms", "error_count", "first_seen", - "last_seen" + "last_seen", + "total_cost_usd" ], "title": "AgentSchema", "description": "Aggregated per-agent stats from the agents table." @@ -7017,15 +7402,22 @@ "title": "Trace Id" }, "role": { - "type": "string", - "enum": [ - "", - "user", - "assistant", - "system", - "tool", - "tool_call", - "tool_result" + "anyOf": [ + { + "type": "string", + "enum": [ + "", + "user", + "assistant", + "system", + "tool", + "tool_call", + "tool_result" + ] + }, + { + "type": "string" + } ], "title": "Role" }, @@ -7211,11 +7603,32 @@ }, "type": "object", "required": [ - "results" + "results", + "total_conversations" ], "title": "AgentSearchRes", "description": "Response from a full-text search across agent messages." }, + "AgentSignalFilter": { + "properties": { + "tags": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Tags" + }, + "ratings": { + "items": { + "$ref": "#/components/schemas/RatingCondition" + }, + "type": "array", + "title": "Ratings" + } + }, + "type": "object", + "title": "AgentSignalFilter" + }, "AgentSortBy": { "properties": { "field": { @@ -7338,7 +7751,13 @@ "alias", "source", "key", - "value_type" + "value_type", + "total_count", + "present_count", + "missing_count", + "other_count", + "bins", + "values" ], "title": "AgentSpanGroupDistributionItem", "description": "Distribution data for one span-group/custom-attribute pair." @@ -7668,6 +8087,33 @@ } }, "type": "object", + "required": [ + "group_keys", + "span_count", + "invocation_count", + "conversation_count", + "total_input_tokens", + "total_cache_creation_input_tokens", + "total_cache_read_input_tokens", + "total_output_tokens", + "total_reasoning_tokens", + "total_duration_ms", + "error_count", + "total_cost_usd", + "total_input_cost_usd", + "total_output_cost_usd", + "agent_names", + "agent_versions", + "provider_names", + "request_models", + "conversation_names", + "first_seen", + "last_seen", + "first_message", + "last_message", + "metrics", + "distributions" + ], "title": "AgentSpanGroupRow", "description": "A single row in a grouped spans query response.\n\n`group_keys` maps each group_by ref's alias to its value for this row.\nThe remaining fields are a fixed aggregate bundle computed per group." }, @@ -7910,6 +8356,105 @@ ], "title": "Agent Version" }, + "eval_run_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Eval Run Id" + }, + "eval_predict_and_score_call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Eval Predict And Score Call Id" + }, + "eval_kind": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Eval Kind" + }, + "eval_row_digest": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Eval Row Digest" + }, + "eval_example_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Eval Example Id" + }, + "eval_trial_index": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Eval Trial Index" + }, + "eval_evaluation_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Eval Evaluation Name" + }, + "parent_call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Parent Call Id" + }, + "parent_call_trace_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Parent Call Trace Id" + }, "request_model": { "anyOf": [ { @@ -8461,7 +9006,83 @@ "required": [ "project_id", "trace_id", - "span_id" + "span_id", + "parent_span_id", + "span_name", + "span_kind", + "started_at", + "ended_at", + "status_code", + "status_message", + "operation_name", + "provider_name", + "agent_name", + "agent_id", + "agent_description", + "agent_version", + "eval_run_id", + "eval_predict_and_score_call_id", + "eval_kind", + "eval_row_digest", + "eval_example_id", + "eval_trial_index", + "eval_evaluation_name", + "parent_call_id", + "parent_call_trace_id", + "request_model", + "response_model", + "response_id", + "input_tokens", + "output_tokens", + "reasoning_tokens", + "cache_creation_input_tokens", + "cache_read_input_tokens", + "input_cost_usd", + "output_cost_usd", + "cache_read_cost_usd", + "cache_creation_cost_usd", + "total_cost_usd", + "reasoning_content", + "conversation_id", + "conversation_name", + "tool_name", + "tool_type", + "tool_call_id", + "tool_description", + "tool_definitions", + "finish_reasons", + "error_type", + "request_temperature", + "request_max_tokens", + "request_top_p", + "request_frequency_penalty", + "request_presence_penalty", + "request_seed", + "request_stop_sequences", + "request_choice_count", + "output_type", + "input_messages", + "output_messages", + "system_instructions", + "tool_call_arguments", + "tool_call_result", + "compaction_summary", + "compaction_items_before", + "compaction_items_after", + "content_refs", + "artifact_refs", + "object_refs", + "custom_attrs_string", + "custom_attrs_int", + "custom_attrs_float", + "custom_attrs_bool", + "server_address", + "server_port", + "wb_user_id", + "wb_run_id", + "wb_run_step", + "wb_run_step_end", + "raw_span_dump" ], "title": "AgentSpanSchema", "description": "A normalized agent span returned by query APIs." @@ -8519,7 +9140,9 @@ "required": [ "name", "role", - "value_type" + "value_type", + "metric", + "aggregation" ], "title": "AgentSpanStatsColumn", "description": "Metadata describing one column in an agent span stats result row." @@ -8755,6 +9378,16 @@ }, "type": "array", "title": "Group Filters" + }, + "signal_filters": { + "anyOf": [ + { + "$ref": "#/components/schemas/AgentSignalFilter" + }, + { + "type": "null" + } + ] } }, "type": "object", @@ -8843,7 +9476,11 @@ "required": [ "start", "end", - "timezone" + "granularity", + "timezone", + "bucket_type", + "columns", + "rows" ], "title": "AgentSpanStatsRes", "description": "Response containing chart-ready agent span stats rows." @@ -8996,17 +9633,27 @@ ], "title": "Started After" }, - "started_before": { + "started_before": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Started Before" + }, + "signal_filters": { "anyOf": [ { - "type": "string", - "format": "date-time" + "$ref": "#/components/schemas/AgentSignalFilter" }, { "type": "null" } - ], - "title": "Started Before" + ] } }, "type": "object", @@ -9039,6 +9686,11 @@ } }, "type": "object", + "required": [ + "spans", + "groups", + "total_count" + ], "title": "AgentSpansQueryRes", "description": "Response from a spans query.\n\nExactly one of `spans` or `groups` will be populated, based on\nwhether the request specified `group_by`." }, @@ -9132,6 +9784,41 @@ ], "title": "Provider" }, + "started_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Started At" + }, + "ended_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Ended At" + }, + "wb_user_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Wb User Id" + }, "total_duration_ms": { "anyOf": [ { @@ -9155,6 +9842,31 @@ ], "title": "Total Cost Usd" }, + "total_input_tokens": { + "type": "integer", + "title": "Total Input Tokens", + "default": 0 + }, + "total_output_tokens": { + "type": "integer", + "title": "Total Output Tokens", + "default": 0 + }, + "total_reasoning_tokens": { + "type": "integer", + "title": "Total Reasoning Tokens", + "default": 0 + }, + "total_cache_creation_input_tokens": { + "type": "integer", + "title": "Total Cache Creation Input Tokens", + "default": 0 + }, + "total_cache_read_input_tokens": { + "type": "integer", + "title": "Total Cache Read Input Tokens", + "default": 0 + }, "messages": { "items": { "$ref": "#/components/schemas/AgentChatMessage" @@ -9166,8 +9878,7 @@ "anyOf": [ { "items": { - "additionalProperties": true, - "type": "object" + "$ref": "#/components/schemas/AgentChatFeedback" }, "type": "array" }, @@ -9180,7 +9891,24 @@ }, "type": "object", "required": [ - "trace_id" + "trace_id", + "root_span_name", + "agent_name", + "agent_version", + "status_code", + "provider", + "started_at", + "ended_at", + "wb_user_id", + "total_duration_ms", + "total_cost_usd", + "total_input_tokens", + "total_output_tokens", + "total_reasoning_tokens", + "total_cache_creation_input_tokens", + "total_cache_read_input_tokens", + "messages", + "feedback" ], "title": "AgentTraceChatRes", "description": "Structured chat view: a linear sequence of messages representing\nthe agent trajectory for a single trace." @@ -9271,6 +9999,7 @@ "error_count", "first_seen", "last_seen", + "total_cost_usd", "agent_version" ], "title": "AgentVersionSchema", @@ -9344,7 +10073,8 @@ }, "type": "object", "required": [ - "versions" + "versions", + "total_count" ], "title": "AgentVersionsQueryRes", "description": "Response containing agent version stats." @@ -9440,7 +10170,8 @@ }, "type": "object", "required": [ - "agents" + "agents", + "total_count" ], "title": "AgentsQueryRes", "description": "Response containing aggregated agent stats." @@ -9489,6 +10220,9 @@ { "$ref": "#/components/schemas/ConvertOperation" }, + { + "$ref": "#/components/schemas/SizeOperation" + }, { "$ref": "#/components/schemas/AndOperation" }, @@ -9570,7 +10304,6 @@ ] } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -9649,7 +10382,6 @@ "description": "Do not set directly. Server will automatically populate this field." } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -9706,7 +10438,6 @@ ] } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -10017,7 +10748,6 @@ "default": false } }, - "additionalProperties": false, "type": "object", "required": [ "project_id" @@ -10209,7 +10939,6 @@ ] } }, - "additionalProperties": false, "type": "object", "required": [ "project_id" @@ -10298,7 +11027,6 @@ ] } }, - "additionalProperties": false, "type": "object", "required": [ "project_id" @@ -10330,7 +11058,6 @@ ] } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -10377,7 +11104,7 @@ }, "file": { "type": "string", - "format": "binary", + "contentMediaType": "application/octet-stream", "title": "File" }, "expected_digest": { @@ -10485,7 +11212,6 @@ "$ref": "#/components/schemas/EndedCallSchemaForInsert" } }, - "additionalProperties": false, "type": "object", "required": [ "end" @@ -10530,7 +11256,6 @@ "default": [] } }, - "additionalProperties": false, "type": "object", "required": [ "metric" @@ -10585,7 +11310,6 @@ "default": false } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -10846,7 +11570,6 @@ "$ref": "#/components/schemas/StartedCallSchemaForInsert" } }, - "additionalProperties": false, "type": "object", "required": [ "start" @@ -10955,7 +11678,6 @@ "default": "UTC" } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -11053,7 +11775,6 @@ "description": "Do not set directly. Server will automatically populate this field." } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -11092,7 +11813,6 @@ "description": "Do not set directly. Server will automatically populate this field." } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -11268,7 +11988,6 @@ "title": "Wb Run Ids" } }, - "additionalProperties": false, "type": "object", "title": "CallsFilter" }, @@ -11448,7 +12167,6 @@ "default": true } }, - "additionalProperties": false, "type": "object", "required": [ "project_id" @@ -11526,7 +12244,6 @@ ] } }, - "additionalProperties": false, "type": "object", "required": [ "project_id" @@ -11597,7 +12314,6 @@ "description": "Do not set directly. Server will automatically populate this field." } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -11663,7 +12379,6 @@ "default": 10000 } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -11916,6 +12631,9 @@ { "$ref": "#/components/schemas/ConvertOperation" }, + { + "$ref": "#/components/schemas/SizeOperation" + }, { "$ref": "#/components/schemas/AndOperation" }, @@ -11960,6 +12678,9 @@ { "$ref": "#/components/schemas/ConvertOperation" }, + { + "$ref": "#/components/schemas/SizeOperation" + }, { "$ref": "#/components/schemas/AndOperation" }, @@ -12040,6 +12761,9 @@ { "$ref": "#/components/schemas/ConvertOperation" }, + { + "$ref": "#/components/schemas/SizeOperation" + }, { "$ref": "#/components/schemas/AndOperation" }, @@ -12246,7 +12970,6 @@ "description": "The provider of the LLM, e.g. 'openai' or 'mistral'. If not provided, the provider_id will be set to 'default'" } }, - "additionalProperties": false, "type": "object", "required": [ "prompt_token_cost", @@ -12283,7 +13006,6 @@ "description": "Do not set directly. Server will automatically populate this field." } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -12330,7 +13052,6 @@ "$ref": "#/components/schemas/Query" } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -12401,6 +13122,34 @@ 1.0 ] }, + "cache_read_input_token_cost": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Cache Read Input Token Cost", + "examples": [ + 1.0 + ] + }, + "cache_creation_input_token_cost": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Cache Creation Input Token Cost", + "examples": [ + 1.0 + ] + }, "prompt_token_cost_unit": { "anyOf": [ { @@ -12550,7 +13299,6 @@ ] } }, - "additionalProperties": false, "type": "object", "required": [ "project_id" @@ -12642,6 +13390,147 @@ "type": "object", "title": "CreateAndLinkWeaveAssetRes" }, + "CustomRuntimeApplyBody": { + "properties": { + "base_url": { + "type": "string", + "title": "Base Url", + "description": "Public OpenAI-compatible endpoint base URL" + }, + "api_key_secret": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Api Key Secret", + "description": "Team secret name used as the endpoint API key; never the secret value" + }, + "headers": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "title": "Headers", + "description": "Literal headers forwarded to the endpoint" + }, + "runtime_ids": { + "items": { + "$ref": "#/components/schemas/CustomRuntimeID" + }, + "type": "array", + "title": "Runtime Ids", + "description": "Complete desired list of IDs exposed by the endpoint" + } + }, + "type": "object", + "required": [ + "base_url", + "runtime_ids" + ], + "title": "CustomRuntimeApplyBody" + }, + "CustomRuntimeApplyRes": { + "properties": { + "name": { + "type": "string", + "title": "Name", + "description": "Stable custom runtime name" + }, + "base_url": { + "type": "string", + "title": "Base Url" + }, + "api_key_secret": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Api Key Secret" + }, + "headers": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "title": "Headers" + }, + "runtime_ids": { + "items": { + "$ref": "#/components/schemas/CustomRuntimeIDRes" + }, + "type": "array", + "title": "Runtime Ids" + } + }, + "type": "object", + "required": [ + "name", + "base_url", + "api_key_secret", + "headers", + "runtime_ids" + ], + "title": "CustomRuntimeApplyRes" + }, + "CustomRuntimeID": { + "properties": { + "id": { + "type": "string", + "minLength": 1, + "pattern": "^\\S+$", + "title": "Id", + "description": "Value sent in the OpenAI-compatible request model field" + }, + "max_tokens": { + "type": "integer", + "exclusiveMinimum": 0.0, + "title": "Max Tokens", + "description": "Maximum tokens supported by this runtime ID", + "default": 4096 + } + }, + "type": "object", + "required": [ + "id" + ], + "title": "CustomRuntimeID" + }, + "CustomRuntimeIDRes": { + "properties": { + "id": { + "type": "string", + "minLength": 1, + "pattern": "^\\S+$", + "title": "Id", + "description": "Value sent in the OpenAI-compatible request model field" + }, + "max_tokens": { + "type": "integer", + "exclusiveMinimum": 0.0, + "title": "Max Tokens", + "description": "Maximum tokens supported by this runtime ID", + "default": 4096 + }, + "playground_id": { + "type": "string", + "title": "Playground Id" + } + }, + "type": "object", + "required": [ + "id", + "playground_id" + ], + "title": "CustomRuntimeIDRes" + }, "Datacenter": { "properties": { "country_code": { @@ -12792,7 +13681,42 @@ "name", "rows" ], - "title": "DatasetReadRes" + "title": "DatasetReadRes" + }, + "DeletedObjVersion": { + "properties": { + "digest": { + "type": "string", + "title": "Digest" + }, + "base_object_class": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Base Object Class" + }, + "leaf_object_class": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Leaf Object Class" + } + }, + "type": "object", + "required": [ + "digest" + ], + "title": "DeletedObjVersion" }, "EndedCallSchemaForInsert": { "properties": { @@ -12902,6 +13826,9 @@ { "$ref": "#/components/schemas/ConvertOperation" }, + { + "$ref": "#/components/schemas/SizeOperation" + }, { "$ref": "#/components/schemas/AndOperation" }, @@ -12945,6 +13872,9 @@ { "$ref": "#/components/schemas/ConvertOperation" }, + { + "$ref": "#/components/schemas/SizeOperation" + }, { "$ref": "#/components/schemas/AndOperation" }, @@ -13114,7 +14044,6 @@ "description": "Filter expression. Supported field prefixes: scores., inputs., outputs.." } }, - "additionalProperties": false, "type": "object", "required": [ "query" @@ -13205,7 +14134,7 @@ "include_costs": { "type": "boolean", "title": "Include Costs", - "description": "When true, enrich the predict-and-score child calls with cost so the summary can report predict-only `predict_total_cost`. Opt-in: other callers skip the cost computation.", + "description": "When true, price each trial's predict call so rows and summary report predict-only cost (`total_cost` / `predict_total_cost`); scorer costs are excluded. Opt-in: other callers skip the cost computation.", "default": false }, "sort_by": { @@ -13267,7 +14196,6 @@ "default": 0 } }, - "additionalProperties": false, "type": "object", "title": "EvalResultsQueryBody" }, @@ -13492,7 +14420,6 @@ "default": "value" } }, - "additionalProperties": false, "type": "object", "required": [ "field", @@ -13638,7 +14565,6 @@ "description": "Do not set directly. Server will automatically populate this field." } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -14101,7 +15027,6 @@ "title": "Output" } }, - "additionalProperties": false, "type": "object", "required": [ "output" @@ -14128,7 +15053,6 @@ "title": "Error" } }, - "additionalProperties": false, "type": "object", "title": "EvaluationStatusFailed" }, @@ -14141,7 +15065,6 @@ "default": "not_found" } }, - "additionalProperties": false, "type": "object", "title": "EvaluationStatusNotFound" }, @@ -14156,7 +15079,6 @@ "title": "Call Id" } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -14207,7 +15129,6 @@ "title": "Total Rows" } }, - "additionalProperties": false, "type": "object", "required": [ "completed_rows", @@ -14409,7 +15330,6 @@ "description": "Allowed: ['scorer_id', 'span_agent_name', 'span_agent_version', 'span_status_code']." } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -14469,7 +15389,6 @@ "title": "Batch" } }, - "additionalProperties": false, "type": "object", "required": [ "batch" @@ -14728,9 +15647,27 @@ "description": "Status of the scored turn (from spans.status_code)", "default": "UNSET", "examples": [ - "SUCCESS" + "OK" ] }, + "span_conversation_id": { + "type": "string", + "title": "Span Conversation Id", + "description": "Conversation the feedback belongs to (from spans.conversation_id)", + "default": "" + }, + "span_trace_id": { + "type": "string", + "title": "Span Trace Id", + "description": "Turn the feedback belongs to (from spans.trace_id)", + "default": "" + }, + "scorer_trace_id": { + "type": "string", + "title": "Scorer Trace Id", + "description": "Trace of the scorer (judge) invocation that produced this feedback (spans.trace_id of the judge call). Distinct from span_trace_id, which is the scored turn. Lets signals price the invocation off the judge span without joining the calls model.", + "default": "" + }, "wb_user_id": { "anyOf": [ { @@ -14744,7 +15681,6 @@ "description": "Do not set directly. Server will automatically populate this field." } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -14819,7 +15755,6 @@ "description": "Percentile values to compute (0\u2013100), e.g. [5, 50, 95]. Only applicable for numeric value_type fields; ignored for boolean/categorical." } }, - "additionalProperties": false, "type": "object", "required": [ "json_path" @@ -14846,7 +15781,6 @@ "default": "numeric" } }, - "additionalProperties": false, "type": "object", "required": [ "json_path" @@ -14912,7 +15846,6 @@ "default": 2000 } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -14949,7 +15882,6 @@ "$ref": "#/components/schemas/Query" } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -15045,7 +15977,6 @@ ] } }, - "additionalProperties": false, "type": "object", "required": [ "project_id" @@ -15061,11 +15992,17 @@ }, "type": "array", "title": "Result" + }, + "total_count": { + "type": "integer", + "minimum": 0.0, + "title": "Total Count" } }, "type": "object", "required": [ - "result" + "result", + "total_count" ], "title": "FeedbackQueryRes" }, @@ -15305,9 +16242,27 @@ "description": "Status of the scored turn (from spans.status_code)", "default": "UNSET", "examples": [ - "SUCCESS" + "OK" ] }, + "span_conversation_id": { + "type": "string", + "title": "Span Conversation Id", + "description": "Conversation the feedback belongs to (from spans.conversation_id)", + "default": "" + }, + "span_trace_id": { + "type": "string", + "title": "Span Trace Id", + "description": "Turn the feedback belongs to (from spans.trace_id)", + "default": "" + }, + "scorer_trace_id": { + "type": "string", + "title": "Scorer Trace Id", + "description": "Trace of the scorer (judge) invocation that produced this feedback (spans.trace_id of the judge call). Distinct from span_trace_id, which is the scored turn. Lets signals price the invocation off the judge span without joining the calls model.", + "default": "" + }, "wb_user_id": { "anyOf": [ { @@ -15325,7 +16280,6 @@ "title": "Feedback Id" } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -15442,7 +16396,6 @@ "description": "Metrics to aggregate from payload_dump." } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -15531,7 +16484,6 @@ "title": "Digest" } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -15559,7 +16511,6 @@ "title": "Project Id" } }, - "additionalProperties": false, "type": "object", "required": [ "project_id" @@ -15713,6 +16664,9 @@ { "$ref": "#/components/schemas/ConvertOperation" }, + { + "$ref": "#/components/schemas/SizeOperation" + }, { "$ref": "#/components/schemas/AndOperation" }, @@ -15756,6 +16710,9 @@ { "$ref": "#/components/schemas/ConvertOperation" }, + { + "$ref": "#/components/schemas/SizeOperation" + }, { "$ref": "#/components/schemas/AndOperation" }, @@ -15817,6 +16774,9 @@ { "$ref": "#/components/schemas/ConvertOperation" }, + { + "$ref": "#/components/schemas/SizeOperation" + }, { "$ref": "#/components/schemas/AndOperation" }, @@ -15860,6 +16820,9 @@ { "$ref": "#/components/schemas/ConvertOperation" }, + { + "$ref": "#/components/schemas/SizeOperation" + }, { "$ref": "#/components/schemas/AndOperation" }, @@ -16030,6 +16993,9 @@ { "$ref": "#/components/schemas/ConvertOperation" }, + { + "$ref": "#/components/schemas/SizeOperation" + }, { "$ref": "#/components/schemas/AndOperation" }, @@ -16074,6 +17040,9 @@ { "$ref": "#/components/schemas/ConvertOperation" }, + { + "$ref": "#/components/schemas/SizeOperation" + }, { "$ref": "#/components/schemas/AndOperation" }, @@ -16248,6 +17217,10 @@ "type": "string", "title": "Labelopenrouter" }, + "openRouterPermaslug": { + "type": "string", + "title": "Openrouterpermaslug" + }, "status": { "type": "string", "title": "Status" @@ -16313,6 +17286,37 @@ "type": "boolean", "title": "Featuretrainableserverlessrl" }, + "reasoningSupport": { + "type": "string", + "enum": [ + "unsupported", + "default-off", + "adaptive", + "default-on", + "always-on" + ], + "title": "Reasoningsupport" + }, + "reasoningEfforts": { + "items": { + "type": "string", + "enum": [ + "none", + "minimal", + "low", + "medium", + "high", + "xhigh", + "max" + ] + }, + "type": "array", + "title": "Reasoningefforts" + }, + "reasoningArgument": { + "type": "string", + "title": "Reasoningargument" + }, "parameterCountTotal": { "type": "integer", "title": "Parametercounttotal" @@ -16618,6 +17622,9 @@ { "$ref": "#/components/schemas/ConvertOperation" }, + { + "$ref": "#/components/schemas/SizeOperation" + }, { "$ref": "#/components/schemas/AndOperation" }, @@ -16661,6 +17668,9 @@ { "$ref": "#/components/schemas/ConvertOperation" }, + { + "$ref": "#/components/schemas/SizeOperation" + }, { "$ref": "#/components/schemas/AndOperation" }, @@ -16722,6 +17732,9 @@ { "$ref": "#/components/schemas/ConvertOperation" }, + { + "$ref": "#/components/schemas/SizeOperation" + }, { "$ref": "#/components/schemas/AndOperation" }, @@ -16765,6 +17778,9 @@ { "$ref": "#/components/schemas/ConvertOperation" }, + { + "$ref": "#/components/schemas/SizeOperation" + }, { "$ref": "#/components/schemas/AndOperation" }, @@ -17275,10 +18291,12 @@ }, "type": "object", "required": [ - "content" + "role", + "content", + "finish_reason" ], "title": "NormalizedMessage", - "description": "A single message normalized from any provider format.\n\nMaps to ClickHouse ``Tuple(role String, content String, finish_reason String)``.\n\n- role: message role (user, assistant, tool, system)\n- content: plain text for simple messages, or JSON-serialized parts\n array for multimodal/structured messages\n- finish_reason: per-message finish reason (output messages only)" + "description": "A single message normalized from any provider format.\n\nMaps to ClickHouse ``Tuple(role String, content String, finish_reason String)``.\n\n- role: message role (user, assistant, tool, system)\n- content: plain text for simple messages, or JSON-serialized parts\n array for multimodal/structured messages\n- finish_reason: per-message finish reason (output messages only)\n\nSerialization JSON Schema marks defaulted fields required. In the public\nOpenAPI document this class appears only as an AgentSpanSchema message\nelement. Ingest validation is unchanged." }, "NotOperation": { "properties": { @@ -17295,6 +18313,9 @@ { "$ref": "#/components/schemas/ConvertOperation" }, + { + "$ref": "#/components/schemas/SizeOperation" + }, { "$ref": "#/components/schemas/AndOperation" }, @@ -17427,7 +18448,6 @@ "$ref": "#/components/schemas/ObjSchemaForInsert" } }, - "additionalProperties": false, "type": "object", "required": [ "obj" @@ -17484,7 +18504,6 @@ "description": "List of digests to delete. If not provided, all digests for the object will be deleted." } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -17497,6 +18516,21 @@ "num_deleted": { "type": "integer", "title": "Num Deleted" + }, + "deleted_versions": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/DeletedObjVersion" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Deleted Versions", + "description": "Metadata for each deleted object version, with digest aliases resolved to content digests. None when the backing server does not report it." } }, "type": "object", @@ -17627,7 +18661,6 @@ "default": false } }, - "additionalProperties": false, "type": "object", "required": [ "project_id" @@ -17691,7 +18724,6 @@ "default": false } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -17734,7 +18766,6 @@ ] } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -17986,7 +19017,6 @@ ] } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -18024,7 +19054,6 @@ ] } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -18190,7 +19219,6 @@ "description": "Filter objects that have any of the specified aliases" } }, - "additionalProperties": false, "type": "object", "title": "ObjectVersionFilter" }, @@ -18320,6 +19348,9 @@ { "$ref": "#/components/schemas/ConvertOperation" }, + { + "$ref": "#/components/schemas/SizeOperation" + }, { "$ref": "#/components/schemas/AndOperation" }, @@ -18566,7 +19597,6 @@ ] } }, - "additionalProperties": false, "type": "object", "required": [ "project_ids" @@ -18638,6 +19668,36 @@ ], "title": "Query" }, + "RatingCondition": { + "properties": { + "scorer_key": { + "type": "string", + "title": "Scorer Key" + }, + "op": { + "type": "string", + "enum": [ + "gte", + "gt", + "lte", + "lt", + "eq" + ], + "title": "Op" + }, + "value": { + "type": "number", + "title": "Value" + } + }, + "type": "object", + "required": [ + "scorer_key", + "op", + "value" + ], + "title": "RatingCondition" + }, "ReasoningBudgetTokens": { "properties": { "type": { @@ -18739,7 +19799,6 @@ "title": "Refs" } }, - "additionalProperties": false, "type": "object", "required": [ "refs" @@ -19233,6 +20292,63 @@ ], "title": "ServerInfoRes" }, + "SizeOperation": { + "properties": { + "$size": { + "anyOf": [ + { + "$ref": "#/components/schemas/LiteralOperation" + }, + { + "$ref": "#/components/schemas/GetFieldOperator" + }, + { + "$ref": "#/components/schemas/ConvertOperation" + }, + { + "$ref": "#/components/schemas/SizeOperation" + }, + { + "$ref": "#/components/schemas/AndOperation" + }, + { + "$ref": "#/components/schemas/OrOperation" + }, + { + "$ref": "#/components/schemas/NotOperation" + }, + { + "$ref": "#/components/schemas/EqOperation" + }, + { + "$ref": "#/components/schemas/GtOperation" + }, + { + "$ref": "#/components/schemas/LtOperation" + }, + { + "$ref": "#/components/schemas/GteOperation" + }, + { + "$ref": "#/components/schemas/LteOperation" + }, + { + "$ref": "#/components/schemas/InOperation" + }, + { + "$ref": "#/components/schemas/ContainsOperation" + } + ], + "title": "$Size" + } + }, + "type": "object", + "required": [ + "$size" + ], + "title": "SizeOperation", + "description": "Return the number of elements in a collection or characters in a string.\n\nExample:\n ```\n {\"$size\": {\"$getField\": \"scorer_tags\"}}\n ```" + }, "SortBy": { "properties": { "field": { @@ -19248,7 +20364,6 @@ "title": "Direction" } }, - "additionalProperties": false, "type": "object", "required": [ "field", @@ -19480,7 +20595,6 @@ "description": "Client-computed table digest for server-side validation." } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -19507,7 +20621,6 @@ "$ref": "#/components/schemas/TableSchemaForInsert" } }, - "additionalProperties": false, "type": "object", "required": [ "table" @@ -19682,7 +20795,6 @@ ] } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -19750,7 +20862,6 @@ "default": false } }, - "additionalProperties": false, "type": "object", "required": [ "project_id" @@ -19789,7 +20900,6 @@ "description": "The digest of the table to query" } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -19834,7 +20944,6 @@ ] } }, - "additionalProperties": false, "type": "object", "title": "TableRowFilter" }, @@ -19957,7 +21066,6 @@ "title": "Updates" } }, - "additionalProperties": false, "type": "object", "required": [ "project_id", @@ -20003,6 +21111,91 @@ ], "title": "TagsListRes" }, + "ThreadSchema": { + "properties": { + "thread_id": { + "type": "string", + "title": "Thread Id" + }, + "turn_count": { + "type": "integer", + "title": "Turn Count", + "description": "Number of turn calls in this thread" + }, + "start_time": { + "type": "string", + "format": "date-time", + "title": "Start Time", + "description": "Earliest start time of turn calls in this thread" + }, + "last_updated": { + "type": "string", + "format": "date-time", + "title": "Last Updated", + "description": "Latest end time of turn calls in this thread" + }, + "first_turn_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "First Turn Id", + "description": "Turn ID of the first turn in this thread (earliest start_time)" + }, + "last_turn_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Last Turn Id", + "description": "Turn ID of the latest turn in this thread (latest end_time)" + }, + "p50_turn_duration_ms": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "P50 Turn Duration Ms", + "description": "50th percentile (median) of turn durations in milliseconds within this thread" + }, + "p99_turn_duration_ms": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "P99 Turn Duration Ms", + "description": "99th percentile of turn durations in milliseconds within this thread" + } + }, + "type": "object", + "required": [ + "thread_id", + "turn_count", + "start_time", + "last_updated", + "first_turn_id", + "last_turn_id", + "p50_turn_duration_ms", + "p99_turn_duration_ms" + ], + "title": "ThreadSchema" + }, "ThreadsQueryFilter": { "properties": { "after_datetime": { @@ -20060,7 +21253,6 @@ ] } }, - "additionalProperties": false, "type": "object", "title": "ThreadsQueryFilter" }, @@ -20133,7 +21325,6 @@ ] } }, - "additionalProperties": false, "type": "object", "required": [ "project_id" @@ -20192,7 +21383,6 @@ "default": 10000 } }, - "additionalProperties": false, "type": "object", "required": [ "project_id" @@ -20262,7 +21452,6 @@ "default": [] } }, - "additionalProperties": false, "type": "object", "required": [ "metric" @@ -20293,6 +21482,13 @@ "type": { "type": "string", "title": "Error Type" + }, + "input": { + "title": "Input" + }, + "ctx": { + "type": "object", + "title": "Context" } }, "type": "object", diff --git a/weave/reference/typescript-sdk.mdx b/weave/reference/typescript-sdk.mdx index 816a1d18d7..3abd6b46ba 100644 --- a/weave/reference/typescript-sdk.mdx +++ b/weave/reference/typescript-sdk.mdx @@ -65,6 +65,7 @@ description: "TypeScript SDK reference" - [Response](./typescript-sdk/type-aliases/response) - [Role](./typescript-sdk/type-aliases/role) - [~~Session~~](./typescript-sdk/type-aliases/session) +- [~~Session-1~~](./typescript-sdk/type-aliases/session-1) - [~~SessionInit~~](./typescript-sdk/type-aliases/sessioninit) - [Settings](./typescript-sdk/type-aliases/settings) diff --git a/weave/reference/typescript-sdk/type-aliases/session-1.mdx b/weave/reference/typescript-sdk/type-aliases/session-1.mdx new file mode 100644 index 0000000000..d5d9b27313 --- /dev/null +++ b/weave/reference/typescript-sdk/type-aliases/session-1.mdx @@ -0,0 +1,13 @@ +--- +title: "Session-1" +description: "TypeScript SDK reference" +--- + + + + **Deprecated.** Use [Conversation](../interfaces/conversation) instead. + + +> **Session** = [`Conversation`](../interfaces/conversation) + +Defined in: [src/genai/conversation.ts:191](https://github.com/wandb/weave/blob/8c5f077eb11c42b84000726ff20504abc728d3fb/sdks/node/src/genai/conversation.ts#L191) \ No newline at end of file