Skip to content

Commit bd123ed

Browse files
committed
task(logger): align param docs to include note about pydantic
1 parent 3f35ff6 commit bd123ed

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

py/src/braintrust/logger.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3891,7 +3891,7 @@ def log_feedback(
38913891
:param expected: (Optional) the ground truth value (an arbitrary, JSON serializable object) that you'd compare to `output` to determine if your `output` value is correct or not.
38923892
:param tags: (Optional) a list of strings that you can use to filter and group records later.
38933893
:param comment: (Optional) an optional comment string to log about the event.
3894-
:param metadata: (Optional) a dictionary, or an object that serializes to a dictionary, with additional data about the feedback. If you have a `user_id`, you can log it here and access it in the Braintrust UI. Note, this metadata does not correspond to the main event itself, but rather the audit log attached to the event. The values in `metadata` can be any JSON-serializable type, but its keys must be strings.
3894+
:param metadata: (Optional) a dictionary, or an object that serializes to a dictionary (such as a Pydantic model), with additional data about the feedback. If you have a `user_id`, you can log it here and access it in the Braintrust UI. Note, this metadata does not correspond to the main event itself, but rather the audit log attached to the event. The values in `metadata` can be any JSON-serializable type, but its keys must be strings.
38953895
:param source: (Optional) the source of the feedback. Must be one of "external" (default), "app", or "api".
38963896
"""
38973897
return _log_feedback_impl(
@@ -5323,7 +5323,7 @@ def log_feedback(
53235323
:param expected: (Optional) the ground truth value (an arbitrary, JSON serializable object) that you'd compare to `output` to determine if your `output` value is correct or not.
53245324
:param tags: (Optional) a list of strings that you can use to filter and group records later.
53255325
:param comment: (Optional) an optional comment string to log about the event.
5326-
:param metadata: (Optional) a dictionary, or an object that serializes to a dictionary, with additional data about the feedback. If you have a `user_id`, you can log it here and access it in the Braintrust UI. Note, this metadata does not correspond to the main event itself, but rather the audit log attached to the event. The values in `metadata` can be any JSON-serializable type, but its keys must be strings.
5326+
:param metadata: (Optional) a dictionary, or an object that serializes to a dictionary (such as a Pydantic model), with additional data about the feedback. If you have a `user_id`, you can log it here and access it in the Braintrust UI. Note, this metadata does not correspond to the main event itself, but rather the audit log attached to the event. The values in `metadata` can be any JSON-serializable type, but its keys must be strings.
53275327
:param source: (Optional) the source of the feedback. Must be one of "external" (default), "app", or "api".
53285328
"""
53295329
return _log_feedback_impl(

0 commit comments

Comments
 (0)