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.

Sign up for GitHub

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

update bedrock documentation to include support for doc handling #4795

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+7 −3
Open

update bedrock documentation to include support for doc handling #4795

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
abf9f16
update bedrock documentation to include support for doc handling
DenovVasil Dec 19, 2024
0b72df8
TW edits
mesellings Dec 20, 2024
b7ab5af
Fix document link
mesellings Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/components/connectors/out-of-the-box-connectors/amazon-bedrock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,14 +111,15 @@ 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` this is a list of documents that will be part of your **new message**. To work with documents it is necessary
to upload them first, one of the possible ways is to use REST api, more information [here](https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/upload-document-alpha/).
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[all.hrefProduction] Improper link format: 'here'. Please use relative URLs.

Then the result of the endpoint must be assigned to a variable in **Start Process Instance**. So we 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:

- `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.
The **Response** is a list of consecutive messages of the user and the assistant. 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.
Loading