Skip to content

Commit

Permalink
Clarified ref creation
Browse files Browse the repository at this point in the history
  • Loading branch information
cjmalloy committed Jul 25, 2023
1 parent bba29fe commit 3446cf1
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/main/java/jasper/component/delta/Ai.java
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,10 @@ public void run(Ref ref) throws JsonProcessingException {
```
Also include any other entities (refs, exts) in your response and they will be created.
However, the first Ref should be considered your response and is the only required response.
When asked to create a Ref, do not use the first Ref to fulfil the request. Always use the first
Ref to reply to the request, acknowledging it and providing links so the user can find what you have created.
The second, third, and so on Refs can be the Refs the user has asked you to create.
When linking to Refs you have created, prefix the URL with /ref/ so that it takes the user to the Ref, and not to an external website.
For example, in response to:
```json
{"url":"comment:2","title":"Chat with AI","comment":"Can you create an Ref pointing to the wikipedia article for weightlifting and tag it #cool?","tags":["public","+user/chris","plugin/inbox/ai"]}
Expand Down

0 comments on commit 3446cf1

Please sign in to comment.