Class FeedbackProjectLogsItem
-
- All Implemented Interfaces:
public final class FeedbackProjectLogsItem
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFeedbackProjectLogsItem.BuilderA builder for FeedbackProjectLogsItem.
public final classFeedbackProjectLogsItem.MetadataA 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.public final classFeedbackProjectLogsItem.ScoresA dictionary of numeric values (between 0 and 1) to log. These scores will be merged into the existing scores for the project logs event
public final classFeedbackProjectLogsItem.SourceThe source of the feedback. Must be one of "external" (default), "app", or "api"
-
Method Summary
Modifier and Type Method Description final Stringid()The id of the project logs event to log feedback for. final Optional<String>comment()An optional comment string to log about the project logs event final JsonValue_expected()The ground truth value (an arbitrary, JSON serializable object) that you'd compare to outputto determine if youroutputvalue is correct or notfinal Optional<FeedbackProjectLogsItem.Metadata>metadata()A dictionary with additional data about the feedback. final Optional<FeedbackProjectLogsItem.Scores>scores()A dictionary of numeric values (between 0 and 1) to log. final Optional<FeedbackProjectLogsItem.Source>source()The source of the feedback. final Optional<List<String>>tags()A list of tags to log final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<String>_comment()Returns the raw JSON value of comment. final JsonField<FeedbackProjectLogsItem.Metadata>_metadata()Returns the raw JSON value of metadata. final JsonField<FeedbackProjectLogsItem.Scores>_scores()Returns the raw JSON value of scores. final JsonField<FeedbackProjectLogsItem.Source>_source()Returns the raw JSON value of source. final JsonField<List<String>>_tags()Returns the raw JSON value of tags. final Map<String, JsonValue>_additionalProperties()final FeedbackProjectLogsItem.BuildertoBuilder()final FeedbackProjectLogsItemvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static FeedbackProjectLogsItem.Builderbuilder()Returns a mutable builder for constructing an instance of FeedbackProjectLogsItem. -
-
Method Detail
-
id
final String id()
The id of the project logs event to log feedback for. This is the row
idreturned byPOST /v1/project_logs/{project_id}/insert
-
comment
final Optional<String> comment()
An optional comment string to log about the project logs event
-
_expected
final JsonValue _expected()
The ground truth value (an arbitrary, JSON serializable object) that you'd compare to
outputto determine if youroutputvalue is correct or not
-
metadata
final Optional<FeedbackProjectLogsItem.Metadata> metadata()
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.
-
scores
final Optional<FeedbackProjectLogsItem.Scores> scores()
A dictionary of numeric values (between 0 and 1) to log. These scores will be merged into the existing scores for the project logs event
-
source
final Optional<FeedbackProjectLogsItem.Source> source()
The source of the feedback. Must be one of "external" (default), "app", or "api"
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_comment
final JsonField<String> _comment()
Returns the raw JSON value of comment.
Unlike comment, this method doesn't throw if the JSON field has an unexpected type.
-
_metadata
final JsonField<FeedbackProjectLogsItem.Metadata> _metadata()
Returns the raw JSON value of metadata.
Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.
-
_scores
final JsonField<FeedbackProjectLogsItem.Scores> _scores()
Returns the raw JSON value of scores.
Unlike scores, this method doesn't throw if the JSON field has an unexpected type.
-
_source
final JsonField<FeedbackProjectLogsItem.Source> _source()
Returns the raw JSON value of source.
Unlike source, this method doesn't throw if the JSON field has an unexpected type.
-
_tags
final JsonField<List<String>> _tags()
Returns the raw JSON value of tags.
Unlike tags, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final FeedbackProjectLogsItem.Builder toBuilder()
-
validate
final FeedbackProjectLogsItem validate()
-
builder
final static FeedbackProjectLogsItem.Builder builder()
Returns a mutable builder for constructing an instance of FeedbackProjectLogsItem.
The following fields are required:
.id()
-
-
-
-