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

Developer doc #57

Merged
merged 10 commits into from
Apr 5, 2024
Merged

Developer doc #57

merged 10 commits into from
Apr 5, 2024

Conversation

julien-nc
Copy link
Member

  • add developer doc in /docs
  • write and generate OpenAPI specs
  • make sure frontend helper functions are not broken, call new ones in the old ones
  • harmonize STT scheduling logic with the rest (properly schedule, factorize frontend code, return task in the API etc...)

Signed-off-by: Julien Veyssier <julien-nc@posteo.net>
Signed-off-by: Julien Veyssier <julien-nc@posteo.net>
Signed-off-by: Julien Veyssier <julien-nc@posteo.net>
Signed-off-by: provokateurin <kate@provokateurin.de>
Signed-off-by: provokateurin <kate@provokateurin.de>
Signed-off-by: provokateurin <kate@provokateurin.de>
Signed-off-by: Julien Veyssier <julien-nc@posteo.net>
Signed-off-by: Julien Veyssier <julien-nc@posteo.net>
Signed-off-by: Julien Veyssier <julien-nc@posteo.net>
Signed-off-by: Julien Veyssier <julien-nc@posteo.net>
@julien-nc julien-nc requested a review from provokateurin April 3, 2024 09:38
appId: 'my_app_id',
identifier: 'my custom identifier',
taskType: 'OCP\\TextProcessing\\FreePromptTaskType',
input: 'count to 3',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can be changed to inputs ig. Will allow for much more flexibility. But maybe not something for this PR.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes it will be done soon, thx.


If you get a task with the `/ocs/v2.php/apps/assistant/api/v1/task/TASK_ID` or `/ocs/v2.php/apps/assistant/api/v1/tasks` OCS endpoint,
you can display it in the assistant UI by using the `OCA.Assistant.openAssistantTask` helper function.
This function takes the task object as parameter. Calling it will open the assistant and load the task values
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can have a link here for the task object to point to the below section? And mention it explicitly there?

Copy link
Contributor

@kyteinsky kyteinsky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@julien-nc julien-nc merged commit 723bcd1 into main Apr 5, 2024
5 checks passed
@delete-merged-branch delete-merged-branch bot deleted the enh/add-dev-doc branch April 5, 2024 08:15
@julien-nc julien-nc mentioned this pull request Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants