Additional documentation for Feedback #129
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nqn
reviewed
Apr 10, 2024
| - `type`: Usually set to "object" to indicate that the feedback data should be a JSON object. | ||
| - `properties`: An object that defines the individual fields of the feedback, including their types (e.g., integer, string), possible values, and descriptions. | ||
| - `required`: An array listing the names of required properties. | ||
|
|
There was a problem hiding this comment.
Suggested change
| For a full list of supported JSON schema properties, see [JSON Schema](https://json-schema.org/understanding-json-schema/reference/). | |
nqn
reviewed
Apr 10, 2024
|
|
||
| - `task_id`: The ID of the feedback task this feedback is for. | ||
| - `values`: A dictionary where keys correspond to the properties defined in the feedback task's schema, and values are the feedback given for those properties. | ||
| - `completion_tags_selector`: A list of tags associated with the feedback. |
There was a problem hiding this comment.
Suggested change
| - `completion_tags_selector`: A list of tags associated with the feedback. | |
| - `completion_tags_selector`: A list of tags which is used to map this feedback item to a set of logs. See [matching-semantics](https://docs.log10.io/feedback/log_matching#matching-semantics) for more details |
nqn
approved these changes
Apr 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This one is focused on improving the developer experience. Compiled from my notes, but edit/reformat as needed.