Skip to content

Commit

Permalink
update bedrock documentation to include support for doc handling (#4795)
Browse files Browse the repository at this point in the history
* update bedrock documentation to include support for doc handling

* TW edits

* Fix document link

---------

Co-authored-by: mesellings <[email protected]>
  • Loading branch information
DenovVasil and mesellings authored Jan 7, 2025
1 parent 09bd942 commit 7ed27cd
Showing 1 changed file with 7 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -111,14 +111,18 @@ Ensure the model is available in your region, that your model can invoke the `Co
:::

- `New Message` is either the first message (to start a conversation) or is the next message from an already started conversation.
- `Documents` is a list of documents to include as part of your **new message**.
- To work with documents you must upload them first, [using the REST API](/apis-tools/camunda-api-rest/specifications/create-document.api.mdx) for example.
- The result of the endpoint must then be assigned to a variable in **Start Process Instance** so you can use the list of these variables in the **Documents** field.
- `Message History` is the history of the conversation that should always be passed. If not set, this will be a new conversation.

1. Use **Result Variable** to store the response in a process variable. For example, `myResultVariable`.
2. Use **Result Expression** to map fields from the response into process variables.

The response contains two elements:
The **Response** is a list of consecutive messages of the user and the assistant.

- `messageHistory` is the full history of the previous message, from user and assistant, including the latest message written by the assistant.
- `newMessage` is the latest message written by the assistant.
:::info important
The current implementation supports the assistant's responses only in text format.
:::

Ideally, the message's history must transit within the process and be the input of this `Converse` task with the new message.

0 comments on commit 7ed27cd

Please sign in to comment.