Notebook.add_measurement¶
Add a measurement annotation to this notebook.
Signature¶
add_measurement(name: str, **kwargs: Any) -> dict[str, Any]
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
name |
str |
yes | - |
**kwargs |
Any |
no | - |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
notebook_id |
path |
string |
yes | - |
Fields¶
Schema: NotebookMeasurementCreateSchema
| Field |
|---|
name |
**kwargs |
Return shape¶
HTTP 201 — Created
Schema: NotebookMeasurementSchema
| Field | Type | Required |
|---|---|---|
config |
object |
no |
created_at |
string |
no |
id |
string |
yes |
is_visible |
boolean |
no |
label |
string |
no |
measurement_type |
string |
yes |
order |
integer |
no |
trace_ref_id |
string |
no |
updated_at |
string |
no |
Permission¶
Required permission: notebook:update
HTTP¶
POST /api/notebooks/{id}/measurements/ (createNotebookMeasurement)
Usage¶
notebook.add_measurement(name)