Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Output and errors standardization #13

Open
RobotSail opened this issue Mar 9, 2022 · 2 comments
Open

Output and errors standardization #13

RobotSail opened this issue Mar 9, 2022 · 2 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@RobotSail
Copy link
Collaborator

Errors for copilot-ops should be well-defined and explicit so that the user does not receive unambiguous responses.

For example, if copilot-ops exceeds the maximum response length for a request, the user should know that this was the cause of error.

@RobotSail RobotSail added enhancement New feature or request help wanted Extra attention is needed labels Mar 9, 2022
@guymguym guymguym self-assigned this Apr 25, 2022
@guymguym
Copy link
Contributor

The plan is:

  • errors.go - add ErrorToUser/WarningToUser functions which will keep a list of those errs and warnings, also log it and return an error interface for the caller to return back.
  • call these functions in the other packages cmd/filemap/opensai/etc when we identify it and make sure the message provides a usable info for the end user (not the bot framework, but the user providing the input itself).
  • patch.go we need a finally case so that it will output the errors and warnings collected.

@guymguym guymguym removed the help wanted Extra attention is needed label Apr 27, 2022
@guymguym guymguym modified the milestones: TBD, 0.2 May 25, 2022
@guymguym guymguym changed the title Error Standardization Output and errors standardization Aug 1, 2022
@guymguym
Copy link
Contributor

guymguym commented Aug 8, 2022

We have output type flag supporting json vs plain.
We have Filemap.EncodeToInputTextFullPaths(outputType).
We want to pull up the output type handling so it covers both output and errors.
We want that for the bot to have a machine readable output both for errors and generated/edit content.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants