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

Improve naming in technical files to help AI to produce cheaper and better answers #1106

Open
igorbeslic opened this issue May 24, 2024 · 0 comments
Assignees
Labels
backend Concerning any and all backend issues task Task to do

Comments

@igorbeslic
Copy link
Collaborator

igorbeslic commented May 24, 2024

We have doubt should we rename technical names for task structure elements.
When inside workflow definition YAML/JSON we found out cognitive pressure to properly relate:

  • meaning of element task.label - should it be title as it would show up in UI as task title? (label is universal abstract notion used for peace of text attached to something while title is much more it is the text that would be emphasised for the purpose of distinguishment
  • meaning of task.parameters - definetely those are task.properties - in the case of task of type bash/v1/execute script is not parameter of bash/v1/execute component, contrary it is component's property for which flow designer provides parameter for. In interaction with AI we spotted this issue. AI had figured out wrong how to assemble task.
  • task.name - OK - this one is hard... is name good or key or reference should be used? It is important to understand that defined name value is used later in subsequent tasks to access particular task output. So should it be key, reference, accessorReference, accessName, referenceName? All comments welcome.
@ivicac ivicac self-assigned this May 27, 2024
@ivicac ivicac added task Task to do backend Concerning any and all backend issues labels May 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Concerning any and all backend issues task Task to do
Projects
Status: 🔖 Ready
Development

No branches or pull requests

2 participants