[Enhancement] - Add requestMetadata to Bedrock converse request

  - Derive requestMetadata from user metadata

Signed-off-by: Stuart Loxton <[email protected]>
Signed-off-by: Stuart Loxton <[email protected]>

Author: Stuart Loxton

models/spring-ai-bedrock-converse/src/main/java/org/springframework/ai/bedrock/converse/BedrockChatOptions.java

@@ -54,6 +54,9 @@ public class BedrockChatOptions implements ToolCallingChatOptions {
 	@JsonProperty("presencePenalty")
 	private Double presencePenalty;
 
+	@JsonIgnore
+	private Map<String, String> requestParameters = new HashMap<>();
+
 	@JsonProperty("stopSequences")
 	private List<String> stopSequences;
 
@@ -88,6 +91,7 @@ public static BedrockChatOptions fromOptions(BedrockChatOptions fromOptions) {
 			.frequencyPenalty(fromOptions.getFrequencyPenalty())
 			.maxTokens(fromOptions.getMaxTokens())
 			.presencePenalty(fromOptions.getPresencePenalty())
+			.requestParameters(new HashMap<>(fromOptions.getRequestParameters()))
 			.stopSequences(
 					fromOptions.getStopSequences() != null ? new ArrayList<>(fromOptions.getStopSequences()) : null)
 			.temperature(fromOptions.getTemperature())
@@ -127,6 +131,14 @@ public void setMaxTokens(Integer maxTokens) {
 		this.maxTokens = maxTokens;
 	}
 
+	public Map<String, String> getRequestParameters() {
+		return this.requestParameters;
+	}
+
+	public void setRequestParameters(Map<String, String> requestParameters) {
+		this.requestParameters = requestParameters;
+	}
+
 	@Override
 	public Double getPresencePenalty() {
 		return this.presencePenalty;
@@ -242,6 +254,7 @@ public boolean equals(Object o) {
 		return Objects.equals(this.model, that.model) && Objects.equals(this.frequencyPenalty, that.frequencyPenalty)
 				&& Objects.equals(this.maxTokens, that.maxTokens)
 				&& Objects.equals(this.presencePenalty, that.presencePenalty)
+				&& Objects.equals(this.requestParameters, that.requestParameters)
 				&& Objects.equals(this.stopSequences, that.stopSequences)
 				&& Objects.equals(this.temperature, that.temperature) && Objects.equals(this.topK, that.topK)
 				&& Objects.equals(this.topP, that.topP) && Objects.equals(this.toolCallbacks, that.toolCallbacks)
@@ -251,9 +264,9 @@ public boolean equals(Object o) {
 
 	@Override
 	public int hashCode() {
-		return Objects.hash(this.model, this.frequencyPenalty, this.maxTokens, this.presencePenalty, this.stopSequences,
-				this.temperature, this.topK, this.topP, this.toolCallbacks, this.toolNames, this.toolContext,
-				this.internalToolExecutionEnabled);
+		return Objects.hash(this.model, this.frequencyPenalty, this.maxTokens, this.presencePenalty,
+				this.requestParameters, this.stopSequences, this.temperature, this.topK, this.topP, this.toolCallbacks,
+				this.toolNames, this.toolContext, this.internalToolExecutionEnabled);
 	}
 
 	public static class Builder {
@@ -280,6 +293,11 @@ public Builder presencePenalty(Double presencePenalty) {
 			return this;
 		}
 
+		public Builder requestParameters(Map<String, String> requestParameters) {
+			this.options.requestParameters = requestParameters;
+			return this;
+		}
+
 		public Builder stopSequences(List<String> stopSequences) {
 			this.options.stopSequences = stopSequences;
 			return this;

models/spring-ai-bedrock-converse/src/main/java/org/springframework/ai/bedrock/converse/BedrockProxyChatModel.java

@@ -429,13 +429,17 @@ else if (message.getMessageType() == MessageType.TOOL) {
 		Document additionalModelRequestFields = ConverseApiUtils
 			.getChatOptionsAdditionalModelRequestFields(this.defaultOptions, prompt.getOptions());
 
+		Map<String, String> requestMetadata = ConverseApiUtils
+			.getRequestMetadata(prompt.getUserMessage().getMetadata());
+
 		return ConverseRequest.builder()
 			.modelId(updatedRuntimeOptions.getModel())
 			.inferenceConfig(inferenceConfiguration)
 			.messages(instructionMessages)
 			.system(systemMessages)
 			.additionalModelRequestFields(additionalModelRequestFields)
 			.toolConfig(toolConfiguration)
+			.requestMetadata(requestMetadata)
 			.build();
 	}
 

models/spring-ai-bedrock-converse/src/main/java/org/springframework/ai/bedrock/converse/api/ConverseApiUtils.java

@@ -384,6 +384,26 @@ else if (value instanceof Map mapValue) {
 		}
 	}
 
+	@SuppressWarnings("unchecked")
+	public static Map<String, String> getRequestMetadata(Map<String, Object> metadata) {
+
+		if (metadata.isEmpty()) {
+			return Map.of();
+		}
+
+		Map<String, String> result = new HashMap<>();
+		for (Map.Entry<String, Object> entry : metadata.entrySet()) {
+			String key = entry.getKey();
+			Object value = entry.getValue();
+
+			if (key != null && value != null) {
+				result.put(key, value.toString());
+			}
+		}
+
+		return result;
+	}
+
 	private static Document convertMapToDocument(Map<String, Object> value) {
 		Map<String, Document> attr = value.entrySet()
 			.stream()

models/spring-ai-bedrock-converse/src/test/java/org/springframework/ai/bedrock/converse/BedrockChatOptionsTests.java

@@ -37,16 +37,18 @@ void testBuilderWithAllFields() {
 			.frequencyPenalty(0.0)
 			.maxTokens(100)
 			.presencePenalty(0.0)
+			.requestParameters(Map.of("requestId", "1234"))
 			.stopSequences(List.of("stop1", "stop2"))
 			.temperature(0.7)
 			.topP(0.8)
 			.topK(50)
 			.build();
 
 		assertThat(options)
-			.extracting("model", "frequencyPenalty", "maxTokens", "presencePenalty", "stopSequences", "temperature",
-					"topP", "topK")
-			.containsExactly("test-model", 0.0, 100, 0.0, List.of("stop1", "stop2"), 0.7, 0.8, 50);
+			.extracting("model", "frequencyPenalty", "maxTokens", "presencePenalty", "requestParameters",
+					"stopSequences", "temperature", "topP", "topK")
+			.containsExactly("test-model", 0.0, 100, 0.0, Map.of("requestId", "1234"), List.of("stop1", "stop2"), 0.7,
+					0.8, 50);
 	}
 
 	@Test

models/spring-ai-bedrock-converse/src/test/java/org/springframework/ai/bedrock/converse/BedrockConverseChatClientIT.java

@@ -70,7 +70,9 @@ void call() {
 				.system(s -> s.text(this.systemTextResource)
 						.param("name", "Bob")
 						.param("voice", "pirate"))
-				.user("Tell me about 3 famous pirates from the Golden Age of Piracy and what they did")
+				.user(u -> u.text("Tell me about 3 famous pirates from the Golden Age of Piracy and what they did")
+						.metadata("requestId", "12345")
+				)
 				.call()
 				.chatResponse();
 		// @formatter:on