add `additionalProperties` across clients #836

devcrocod · 2025-09-21T18:17:28Z

KG-313 Ability to pass (really) custom LLM params

Motivation and Context

Passing properties to the LLM client that are not supported in requests

Breaking Changes

No

Type of the changes

New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation update
Tests improvement
Refactoring

Checklist

The pull request has a description of the proposed change
I read the Contributing Guidelines before opening the pull request
The pull request uses develop as the base branch
Tests for the changes have been added
All new and existing tests passed

Additional steps for pull requests adding a new feature

An issue describing the proposed change exists
The pull request includes a link to the issue
The change was discussed and approved in the issue
Docs have been added / updated

Copilot

Pull Request Overview

This PR adds support for additionalProperties across all LLM clients, enabling developers to pass custom parameters that are not explicitly supported in the request models. The feature allows custom properties to be seamlessly merged into the final JSON request while preserving the ability to deserialize them back during response processing.

Key Changes

Added additionalProperties field to core LLMParams class with helper functions for type conversion
Implemented AdditionalPropertiesSerializer for handling JSON serialization/deserialization
Updated all client implementations to support and pass through additional properties

Reviewed Changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
LLMParams.kt	Added `additionalProperties` field and utility functions for JSON element conversion
AdditionalPropertiesSerializer.kt	Core serializer implementing flattening/collecting logic for additional properties
Various client request models	Added `additionalProperties` field to all request DTOs
Various client implementations	Updated to use custom serializers and pass additional properties
Test files	Comprehensive serialization tests for all clients verifying round-trip behavior

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

prompt/prompt-model/src/commonMain/kotlin/ai/koog/prompt/params/LLMParams.kt

...client/src/commonMain/kotlin/ai/koog/prompt/executor/clients/anthropic/AnthropicLLMClient.kt

...-client/src/jvmTest/kotlin/ai/koog/prompt/executor/clients/google/GoogleSerializationTest.kt

.../jvmTest/kotlin/ai/koog/prompt/executor/clients/deepseek/models/DeepSeekSerializationTest.kt

github-actions · 2025-09-21T18:45:28Z

Qodana for JVM

846 new problems were found

Inspection name	Severity	Problems
`Check Kotlin and Java source code coverage`	🔶 Warning	809
`Vulnerable imported dependency`	🔶 Warning	21
`Missing KDoc for public API declaration`	🔶 Warning	16

@@ Code coverage @@
+ 69% total lines covered
12337 lines analyzed, 8592 lines covered
# Calculated according to the filters of your coverage tool

☁️ View the detailed Qodana report

Contact Qodana team

Contact us at qodana-support@jetbrains.com

Or via our issue tracker: https://jb.gg/qodana-issue
Or share your feedback: https://jb.gg/qodana-discussions

kpavlov

Thank you, @devcrocod
I like the design approach, but some more testing is needed: AdditionalParams got lost during the copy operation

kpavlov · 2025-09-22T09:01:40Z

prompt/prompt-model/src/commonMain/kotlin/ai/koog/prompt/params/LLMParams.kt

+ * @param pairs A variable number of key-value pairs, where the keys are strings and the values are any type.
+ * @return A map with the provided keys associated with their corresponding JsonElement representations as values.
+ */
+public fun additionalPropertiesOf(vararg pairs: Pair<String, Any>): Map<String, JsonElement> =


Maybe it make sense to define the type/typealias for Map<String, JsonElement>. I am introducing the utils module, where this type and it's serializer may live.

prompt/prompt-model/src/commonMain/kotlin/ai/koog/prompt/params/LLMParams.kt

...nMain/kotlin/ai/koog/prompt/executor/clients/serialization/AdditionalPropertiesSerializer.kt

…oss clients

- Introduced a unit test to validate that the `copy()` function on `LLMParams` retains all property values without changes.

…latteningSerializer`

…nd deserialization strategies, update dependencies, and improve Anthropic client tests with JSON assertion using Kotest.

…geRequest` - Annotated `maxTokens` and `stream` with `@EncodeDefault` for consistent serialization defaults. - Introduced `@SerialName` for the `max_tokens` and `tool_choice` properties.

kpavlov

Thank you, @devcrocod

…zation` and inline JSON strings for improved readability and consistency.

kpavlov · 2025-09-26T06:47:45Z

Need more tests...

…urrentLinkedQueue` for logs, and enable parallel test execution in JUnit; update dependencies.

[KG-313](https://youtrack.jetbrains.com/issue/KG-313) Ability to pass (really) custom LLM params ## Motivation and Context Passing properties to the LLM client that are not supported in requests --- Co-authored-by: Konstantin Pavlov <1517853+kpavlov@users.noreply.github.com>

devcrocod requested review from EugeneTheDev, Ololoshechkin, aozherelyeva and Copilot September 21, 2025 18:17

Copilot AI reviewed Sep 21, 2025

View reviewed changes

kpavlov requested changes Sep 22, 2025

View reviewed changes

devcrocod requested a review from kpavlov September 24, 2025 08:13

aozherelyeva requested a review from sdubov September 24, 2025 12:40

devcrocod and others added 6 commits September 25, 2025 11:44

Refactor serialization handling to support additionalProperties acr…

69aac3b

…oss clients

Add test for LLMParams copy behavior

9d04f66

- Introduced a unit test to validate that the `copy()` function on `LLMParams` retains all property values without changes.

Rename serializer with additionalProperties to `AdditionalPropertiesF…

9fb7865

…latteningSerializer`

Add support for additionalProperties in LLMParams

c312913

Add additional properties to specific provider params

be9ef04

remove unused imports

1a7ec71

devcrocod force-pushed the devcrocod/KG-313-custom-LLM-params branch from b0b8784 to 1a7ec71 Compare September 25, 2025 09:48

kpavlov and others added 3 commits September 25, 2025 14:44

Enhance verifyDeserialization utility with explicit serialization a…

88803d7

…nd deserialization strategies, update dependencies, and improve Anthropic client tests with JSON assertion using Kotest.

Add @EncodeDefault and @SerialName annotations to `AnthropicMessa…

19ab8bd

…geRequest` - Annotated `maxTokens` and `stream` with `@EncodeDefault` for consistent serialization defaults. - Introduced `@SerialName` for the `max_tokens` and `tool_choice` properties.

remove debug statements and unused imports

31bea49

kpavlov approved these changes Sep 25, 2025

View reviewed changes

kpavlov added 2 commits September 25, 2025 23:03

Refactor Anthropic JSON deserialization tests to use `verifyDeseriali…

8931659

…zation` and inline JSON strings for improved readability and consistency.

Merge branch 'develop' into devcrocod/KG-313-custom-LLM-params

49c2660

kpavlov self-requested a review September 26, 2025 06:47

Add support for additionalProperties in LLMParams and related tests

51277df

kpavlov added enhancement New feature or request tests Add new tests or modify existing labels Sep 26, 2025

kpavlov added 3 commits September 26, 2025 09:26

Remove unused import in LLMParamsTest

95acd63

Remove unused imports

f482d4e

Enhance test reliability with Awaitility, switch to thread-safe `Conc…

d42b539

…urrentLinkedQueue` for logs, and enable parallel test execution in JUnit; update dependencies.

kpavlov approved these changes Sep 26, 2025

View reviewed changes

devcrocod merged commit 1c57548 into develop Sep 26, 2025
11 checks passed

devcrocod deleted the devcrocod/KG-313-custom-LLM-params branch September 26, 2025 10:21

add additionalProperties across clients #836

add additionalProperties across clients #836

Uh oh!

Conversation

devcrocod commented Sep 21, 2025 • edited by kpavlov Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation and Context

Breaking Changes

Type of the changes

Checklist

Additional steps for pull requests adding a new feature

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key Changes

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Sep 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Qodana for JVM

Uh oh!

kpavlov left a comment

Choose a reason for hiding this comment

Uh oh!

kpavlov Sep 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kpavlov left a comment

Choose a reason for hiding this comment

Uh oh!

kpavlov commented Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

add `additionalProperties` across clients #836

add `additionalProperties` across clients #836

devcrocod commented Sep 21, 2025 •

edited by kpavlov

Loading

github-actions bot commented Sep 21, 2025 •

edited

Loading

kpavlov commented Sep 26, 2025 •

edited

Loading