🪨 feat: AWS Bedrock support (#3935)

* feat: Add BedrockIcon component to SVG library

* feat: EModelEndpoint.bedrock

* feat: first pass, bedrock chat. note: AgentClient is returning `agents` as conversation.endpoint

* fix: declare endpoint in initialization step

* chore: Update @librechat/agents dependency to version 1.4.5

* feat: backend content aggregation for agents/bedrock

* feat: abort agent requests

* feat: AWS Bedrock icons

* WIP: agent provider schema parsing

* chore: Update EditIcon props type

* refactor(useGenerationsByLatest): make agents and bedrock editable

* refactor: non-assistant message content, parts

* fix: Bedrock response `sender`

* fix: use endpointOption.model_parameters not endpointOption.modelOptions

* fix: types for step handler

* refactor: Update Agents.ToolCallDelta type

* refactor: Remove unnecessary assignment of parentMessageId in AskController

* refactor: remove unnecessary assignment of parentMessageId (agent request handler)

* fix(bedrock/agents): message regeneration

* refactor: dynamic form elements using react-hook-form Controllers

* fix: agent icons/labels for messages

* fix: agent actions

* fix: use of new dynamic tags causing application crash

* refactor: dynamic settings touch-ups

* refactor: update Slider component to allow custom track class name

* refactor: update DynamicSlider component styles

* refactor: use Constants value for GLOBAL_PROJECT_NAME (enum)

* feat: agent share global methods/controllers

* fix: agents query

* fix: `getResponseModel`

* fix: share prompt a11y issue

* refactor: update SharePrompt dialog theme styles

* refactor: explicit typing for SharePrompt

* feat: add agent roles/permissions

* chore: update @librechat/agents dependency to version 1.4.7 for tool_call_ids edge case

* fix(Anthropic): messages.X.content.Y.tool_use.input: Input should be a valid dictionary

* fix: handle text parts with tool_call_ids and empty text

* fix: role initialization

* refactor: don't make instructions required

* refactor: improve typing of Text part

* fix: setShowStopButton for agents route

* chore: remove params for now

* fix: add streamBuffer and streamRate to help prevent 'Overloaded' errors from Anthropic API

* refactor: remove console.log statement in ContentRender component

* chore: typing, rename Context to Delete Button

* chore(DeleteButton): logging

* refactor(Action): make accessible

* style(Action): improve a11y again

* refactor: remove use/mention of mongoose sessions

* feat: first pass, sharing agents

* feat: visual indicator for global agent, remove author when serving to non-author

* wip: params

* chore: fix typing issues

* fix(schemas): typing

* refactor: improve accessibility of ListCard component and fix console React warning

* wip: reset templates for non-legacy new convos

* Revert "wip: params"

This reverts commit f8067e91d4.

* Revert "refactor: dynamic form elements using react-hook-form Controllers"

This reverts commit 2150c4815d.

* fix(Parameters): types and parameter effect update to only update local state to parameters

* refactor: optimize useDebouncedInput hook for better performance

* feat: first pass, anthropic bedrock params

* chore: paramEndpoints check for endpointType too

* fix: maxTokens to use coerceNumber.optional(),

* feat: extra chat model params

* chore: reduce code repetition

* refactor: improve preset title handling in SaveAsPresetDialog component

* refactor: improve preset handling in HeaderOptions component

* chore: improve typing, replace legacy dialog for SaveAsPresetDialog

* feat: save as preset from parameters panel

* fix: multi-search in select dropdown when using Option type

* refactor: update default showDefault value to false in Dynamic components

* feat: Bedrock presets settings

* chore: config, fix agents schema, update config version

* refactor: update AWS region variable name in bedrock options endpoint to BEDROCK_AWS_DEFAULT_REGION

* refactor: update baseEndpointSchema in config.ts to include baseURL property

* refactor: update createRun function to include req parameter and set streamRate based on provider

* feat: availableRegions via config

* refactor: remove unused demo agent controller file

* WIP: title

* Update @librechat/agents to version 1.5.0

* chore: addTitle.js to handle empty responseText

* feat: support images and titles

* feat: context token updates

* Refactor BaseClient test to use expect.objectContaining

* refactor: add model select, remove header options params, move side panel params below prompts

* chore: update models list, catch title error

* feat: model service for bedrock models (env)

* chore: Remove verbose debug log in AgentClient class following stream

* feat(bedrock): track token spend; fix: token rates, value key mapping for AWS models

* refactor: handle streamRate in `handleLLMNewToken` callback

* chore: AWS Bedrock example config in `.env.example`

* refactor: Rename bedrockMeta to bedrockGeneral in settings.ts and use for AI21 and Amazon Bedrock providers

* refactor: Update `.env.example` with AWS Bedrock model IDs URL and additional notes

* feat: titleModel support for bedrock

* refactor: Update `.env.example` with additional notes for AWS Bedrock model IDs

api/server/services/Endpoints/agents/build.js

@@ -2,7 +2,7 @@ const { getAgent } = require('~/models/Agent');
 const { logger } = require('~/config');
 
 const buildOptions = (req, endpoint, parsedBody) => {
-  const { agent_id, instructions, spec, ...rest } = parsedBody;
+  const { agent_id, instructions, spec, ...model_parameters } = parsedBody;
 
   const agentPromise = getAgent({
     id: agent_id,
@@ -19,9 +19,7 @@ const buildOptions = (req, endpoint, parsedBody) => {
     agent_id,
     instructions,
     spec,
-    modelOptions: {
-      ...rest,
-    },
+    model_parameters,
   };
 
   return endpointOption;

api/server/services/Endpoints/agents/initialize.js

@@ -11,7 +11,12 @@
 
 const { z } = require('zod');
 const { tool } = require('@langchain/core/tools');
-const { EModelEndpoint, providerEndpointMap } = require('librechat-data-provider');
+const { createContentAggregator } = require('@librechat/agents');
+const {
+  EModelEndpoint,
+  providerEndpointMap,
+  getResponseSender,
+} = require('librechat-data-provider');
 const { getDefaultHandlers } = require('~/server/controllers/agents/callbacks');
 // for testing purposes
 // const createTavilySearchTool = require('~/app/clients/tools/structured/TavilySearch');
@@ -53,7 +58,8 @@ const initializeClient = async ({ req, res, endpointOption }) => {
   }
 
   // TODO: use endpointOption to determine options/modelOptions
-  const eventHandlers = getDefaultHandlers({ res });
+  const { contentParts, aggregateContent } = createContentAggregator();
+  const eventHandlers = getDefaultHandlers({ res, aggregateContent });
 
   // const tools = [createTavilySearchTool()];
   // const tools = [_getWeather];
@@ -90,7 +96,7 @@ const initializeClient = async ({ req, res, endpointOption }) => {
   }
 
   // TODO: pass-in override settings that are specific to current run
-  endpointOption.modelOptions.model = agent.model;
+  endpointOption.model_parameters.model = agent.model;
   const options = await getOptions({
     req,
     res,
@@ -101,13 +107,21 @@ const initializeClient = async ({ req, res, endpointOption }) => {
   });
   modelOptions = Object.assign(modelOptions, options.llmConfig);
 
+  const sender = getResponseSender({
+    ...endpointOption,
+    model: endpointOption.model_parameters.model,
+  });
+
   const client = new AgentClient({
     req,
     agent,
     tools,
+    sender,
     toolMap,
+    contentParts,
     modelOptions,
     eventHandlers,
+    endpoint: EModelEndpoint.agents,
     configOptions: options.configOptions,
     maxContextTokens:
       agent.max_context_tokens ??

api/server/services/Endpoints/anthropic/addTitle.js

@@ -23,7 +23,7 @@ const addTitle = async (req, { text, response, client }) => {
 
   const title = await client.titleConvo({
     text,
-    responseText: response?.text,
+    responseText: response?.text ?? '',
     conversationId: response.conversationId,
   });
   await titleCache.set(key, title, 120000);

api/server/services/Endpoints/bedrock/build.js

@@ -0,0 +1,44 @@
+const { removeNullishValues, bedrockInputParser } = require('librechat-data-provider');
+const generateArtifactsPrompt = require('~/app/clients/prompts/artifacts');
+const { logger } = require('~/config');
+
+const buildOptions = (endpoint, parsedBody) => {
+  const {
+    modelLabel: name,
+    promptPrefix,
+    maxContextTokens,
+    resendFiles = true,
+    imageDetail,
+    iconURL,
+    greeting,
+    spec,
+    artifacts,
+    ...model_parameters
+  } = parsedBody;
+  let parsedParams = model_parameters;
+  try {
+    parsedParams = bedrockInputParser.parse(model_parameters);
+  } catch (error) {
+    logger.warn('Failed to parse bedrock input', error);
+  }
+  const endpointOption = removeNullishValues({
+    endpoint,
+    name,
+    resendFiles,
+    imageDetail,
+    iconURL,
+    greeting,
+    spec,
+    promptPrefix,
+    maxContextTokens,
+    model_parameters: parsedParams,
+  });
+
+  if (typeof artifacts === 'string') {
+    endpointOption.artifactsPrompt = generateArtifactsPrompt({ endpoint, artifacts });
+  }
+
+  return endpointOption;
+};
+
+module.exports = { buildOptions };

api/server/services/Endpoints/bedrock/index.js

@@ -0,0 +1,7 @@
+const build = require('./build');
+const initialize = require('./initialize');
+
+module.exports = {
+  ...build,
+  ...initialize,
+};

api/server/services/Endpoints/bedrock/initialize.js

@@ -0,0 +1,72 @@
+const { createContentAggregator } = require('@librechat/agents');
+const {
+  EModelEndpoint,
+  providerEndpointMap,
+  getResponseSender,
+} = require('librechat-data-provider');
+const { getDefaultHandlers } = require('~/server/controllers/agents/callbacks');
+// const { loadAgentTools } = require('~/server/services/ToolService');
+const getOptions = require('~/server/services/Endpoints/bedrock/options');
+const AgentClient = require('~/server/controllers/agents/client');
+const { getModelMaxTokens } = require('~/utils');
+
+const initializeClient = async ({ req, res, endpointOption }) => {
+  if (!endpointOption) {
+    throw new Error('Endpoint option not provided');
+  }
+
+  /** @type {Array<UsageMetadata>} */
+  const collectedUsage = [];
+  const { contentParts, aggregateContent } = createContentAggregator();
+  const eventHandlers = getDefaultHandlers({ res, aggregateContent, collectedUsage });
+
+  // const tools = [createTavilySearchTool()];
+
+  /** @type {Agent} */
+  const agent = {
+    id: EModelEndpoint.bedrock,
+    name: endpointOption.name,
+    instructions: endpointOption.promptPrefix,
+    provider: EModelEndpoint.bedrock,
+    model: endpointOption.model_parameters.model,
+    model_parameters: endpointOption.model_parameters,
+  };
+
+  let modelOptions = { model: agent.model };
+
+  // TODO: pass-in override settings that are specific to current run
+  const options = await getOptions({
+    req,
+    res,
+    endpointOption,
+  });
+
+  modelOptions = Object.assign(modelOptions, options.llmConfig);
+  const maxContextTokens =
+    agent.max_context_tokens ??
+    getModelMaxTokens(modelOptions.model, providerEndpointMap[agent.provider]);
+
+  const sender = getResponseSender({
+    ...endpointOption,
+    model: endpointOption.model_parameters.model,
+  });
+
+  const client = new AgentClient({
+    req,
+    agent,
+    sender,
+    // tools,
+    // toolMap,
+    modelOptions,
+    contentParts,
+    eventHandlers,
+    collectedUsage,
+    maxContextTokens,
+    endpoint: EModelEndpoint.bedrock,
+    configOptions: options.configOptions,
+    attachments: endpointOption.attachments,
+  });
+  return { client };
+};
+
+module.exports = { initializeClient };

api/server/services/Endpoints/bedrock/options.js

@@ -0,0 +1,90 @@
+const { HttpsProxyAgent } = require('https-proxy-agent');
+const {
+  EModelEndpoint,
+  Constants,
+  AuthType,
+  removeNullishValues,
+} = require('librechat-data-provider');
+const { getUserKey, checkUserKeyExpiry } = require('~/server/services/UserService');
+const { sleep } = require('~/server/utils');
+
+const getOptions = async ({ req, endpointOption }) => {
+  const {
+    BEDROCK_AWS_SECRET_ACCESS_KEY,
+    BEDROCK_AWS_ACCESS_KEY_ID,
+    BEDROCK_REVERSE_PROXY,
+    BEDROCK_AWS_DEFAULT_REGION,
+    PROXY,
+  } = process.env;
+  const expiresAt = req.body.key;
+  const isUserProvided = BEDROCK_AWS_SECRET_ACCESS_KEY === AuthType.USER_PROVIDED;
+
+  const credentials = isUserProvided
+    ? await getUserKey({ userId: req.user.id, name: EModelEndpoint.bedrock })
+    : {
+      accessKeyId: BEDROCK_AWS_ACCESS_KEY_ID,
+      secretAccessKey: BEDROCK_AWS_SECRET_ACCESS_KEY,
+    };
+
+  if (!credentials) {
+    throw new Error('Bedrock credentials not provided. Please provide them again.');
+  }
+
+  if (expiresAt && isUserProvided) {
+    checkUserKeyExpiry(expiresAt, EModelEndpoint.bedrock);
+  }
+
+  /** @type {number} */
+  let streamRate = Constants.DEFAULT_STREAM_RATE;
+
+  /** @type {undefined | TBaseEndpoint} */
+  const bedrockConfig = req.app.locals[EModelEndpoint.bedrock];
+
+  if (bedrockConfig && bedrockConfig.streamRate) {
+    streamRate = bedrockConfig.streamRate;
+  }
+
+  /** @type {undefined | TBaseEndpoint} */
+  const allConfig = req.app.locals.all;
+  if (allConfig && allConfig.streamRate) {
+    streamRate = allConfig.streamRate;
+  }
+
+  /** @type {import('@librechat/agents').BedrockConverseClientOptions} */
+  const requestOptions = Object.assign(
+    {
+      credentials,
+      model: endpointOption.model,
+      region: BEDROCK_AWS_DEFAULT_REGION,
+      streaming: true,
+      streamUsage: true,
+      callbacks: [
+        {
+          handleLLMNewToken: async () => {
+            if (!streamRate) {
+              return;
+            }
+            await sleep(streamRate);
+          },
+        },
+      ],
+    },
+    endpointOption.model_parameters,
+  );
+
+  const configOptions = {};
+  if (PROXY) {
+    configOptions.httpAgent = new HttpsProxyAgent(PROXY);
+  }
+
+  if (BEDROCK_REVERSE_PROXY) {
+    configOptions.endpointHost = BEDROCK_REVERSE_PROXY;
+  }
+
+  return {
+    llmConfig: removeNullishValues(requestOptions),
+    configOptions,
+  };
+};
+
+module.exports = getOptions;

api/server/services/Endpoints/bedrock/title.js

@@ -0,0 +1,40 @@
+const { CacheKeys } = require('librechat-data-provider');
+const getLogStores = require('~/cache/getLogStores');
+const { isEnabled } = require('~/server/utils');
+const { saveConvo } = require('~/models');
+
+const addTitle = async (req, { text, response, client }) => {
+  const { TITLE_CONVO = true } = process.env ?? {};
+  if (!isEnabled(TITLE_CONVO)) {
+    return;
+  }
+
+  if (client.options.titleConvo === false) {
+    return;
+  }
+
+  // If the request was aborted, don't generate the title.
+  if (client.abortController.signal.aborted) {
+    return;
+  }
+
+  const titleCache = getLogStores(CacheKeys.GEN_TITLE);
+  const key = `${req.user.id}-${response.conversationId}`;
+
+  const title = await client.titleConvo({
+    text,
+    responseText: response?.text ?? '',
+    conversationId: response.conversationId,
+  });
+  await titleCache.set(key, title, 120000);
+  await saveConvo(
+    req,
+    {
+      conversationId: response.conversationId,
+      title,
+    },
+    { context: 'api/server/services/Endpoints/bedrock/title.js' },
+  );
+};
+
+module.exports = addTitle;

api/server/services/Endpoints/google/addTitle.js

@@ -49,7 +49,7 @@ const addTitle = async (req, { text, response, client }) => {
 
   const title = await titleClient.titleConvo({
     text,
-    responseText: response?.text,
+    responseText: response?.text ?? '',
     conversationId: response.conversationId,
   });
   await titleCache.set(key, title, 120000);

api/server/services/Endpoints/openAI/addTitle.js

@@ -23,7 +23,7 @@ const addTitle = async (req, { text, response, client }) => {
 
   const title = await client.titleConvo({
     text,
-    responseText: response?.text,
+    responseText: response?.text ?? '',
     conversationId: response.conversationId,
   });
   await titleCache.set(key, title, 120000);