Class FeedbackDatasetItem
-
- All Implemented Interfaces:
public final class FeedbackDatasetItem
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFeedbackDatasetItem.BuilderA builder for FeedbackDatasetItem.
public final classFeedbackDatasetItem.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 classFeedbackDatasetItem.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 dataset event to log feedback for. final Optional<String>comment()An optional comment string to log about the dataset event final Optional<FeedbackDatasetItem.Metadata>metadata()A dictionary with additional data about the feedback. final Optional<FeedbackDatasetItem.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<FeedbackDatasetItem.Metadata>_metadata()Returns the raw JSON value of metadata. final JsonField<FeedbackDatasetItem.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 FeedbackDatasetItem.BuildertoBuilder()final FeedbackDatasetItemvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static FeedbackDatasetItem.Builderbuilder()Returns a mutable builder for constructing an instance of FeedbackDatasetItem. -
-
Method Detail
-
id
final String id()
The id of the dataset event to log feedback for. This is the row
idreturned byPOST /v1/dataset/{dataset_id}/insert
-
metadata
final Optional<FeedbackDatasetItem.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.
-
source
final Optional<FeedbackDatasetItem.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<FeedbackDatasetItem.Metadata> _metadata()
Returns the raw JSON value of metadata.
Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.
-
_source
final JsonField<FeedbackDatasetItem.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 FeedbackDatasetItem.Builder toBuilder()
-
validate
final FeedbackDatasetItem validate()
-
builder
final static FeedbackDatasetItem.Builder builder()
Returns a mutable builder for constructing an instance of FeedbackDatasetItem.
The following fields are required:
.id()
-
-
-
-