Skip to content

Commit cec7631

Browse files
jitokimtzolov
authored andcommitted
Update documentation for property override precedence in ChatModel and EmbeddingModel configurations.
Signed-off-by: jitokim <[email protected]>
1 parent bc50d28 commit cec7631

File tree

7 files changed

+14
-11
lines changed

7 files changed

+14
-11
lines changed

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chat/qianfan-chat.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ Exporting an environment variable is one way to set that configuration property:
1313

1414
[source,shell]
1515
----
16-
export SPRING_AI_QIANFAN_API_KEY=<INSERT KEY HERE>
16+
export SPRING_AI_QIANFAN_API_KEY=<INSERT API KEY HERE>
17+
export SPRING_AI_QIANFAN_SECRET_KEY=<INSERT SECRET KEY HERE>
1718
----
1819

1920
=== Add Repositories and BOM
@@ -102,7 +103,7 @@ The prefix `spring.ai.qianfan.chat` is the property prefix that lets you configu
102103
| spring.ai.qianfan.chat.options.stop | The model will stop generating characters specified by stop, and currently only supports a single stop word in the format of ["stop_word1"] | -
103104
|====
104105

105-
NOTE: You can override the common `spring.ai.qianfan.base-url`, `spring.ai.qianfan.chat.api-key` and `spring.ai.qianfan.chat.secret-key` for the `ChatClient` implementations.
106+
NOTE: You can override the common `spring.ai.qianfan.base-url`, `spring.ai.qianfan.api-key` and `spring.ai.qianfan.secret-key` for the `ChatClient` implementations.
106107
The `spring.ai.qianfan.chat.base-url`, `spring.ai.qianfan.chat.api-key` and `spring.ai.qianfan.chat.secret-key` properties if set take precedence over the common properties.
107108
This is useful if you want to use different QianFan accounts for different models and different model endpoints.
108109

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/minimax-embeddings.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ The prefix `spring.ai.minimax.embedding` is property prefix that configures the
9595

9696
NOTE: You can override the common `spring.ai.minimax.base-url` and `spring.ai.minimax.api-key` for the `ChatModel` and `EmbeddingModel` implementations.
9797
The `spring.ai.minimax.embedding.base-url` and `spring.ai.minimax.embedding.api-key` properties if set take precedence over the common properties.
98-
Similarly, the `spring.ai.minimax.embedding.base-url` and `spring.ai.minimax.embedding.api-key` properties if set take precedence over the common properties.
98+
Similarly, the `spring.ai.minimax.chat.base-url` and `spring.ai.minimax.chat.api-key` properties if set take precedence over the common properties.
9999
This is useful if you want to use different MiniMax accounts for different models and different model endpoints.
100100

101101
TIP: All properties prefixed with `spring.ai.minimax.embedding.options` can be overridden at runtime by adding a request specific <<embedding-options>> to the `EmbeddingRequest` call.

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/mistralai-embeddings.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ The prefix `spring.ai.mistralai.embedding` is property prefix that configures th
9696

9797
NOTE: You can override the common `spring.ai.mistralai.base-url` and `spring.ai.mistralai.api-key` for the `ChatModel` and `EmbeddingModel` implementations.
9898
The `spring.ai.mistralai.embedding.base-url` and `spring.ai.mistralai.embedding.api-key` properties if set take precedence over the common properties.
99-
Similarly, the `spring.ai.mistralai.embedding.base-url` and `spring.ai.mistralai.embedding.api-key` properties if set take precedence over the common properties.
99+
Similarly, the `spring.ai.mistralai.chat.base-url` and `spring.ai.mistralai.chat.api-key` properties if set take precedence over the common properties.
100100
This is useful if you want to use different MistralAI accounts for different models and different model endpoints.
101101

102102
TIP: All properties prefixed with `spring.ai.mistralai.embedding.options` can be overridden at runtime by adding a request specific <<embedding-options>> to the `EmbeddingRequest` call.

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/openai-embeddings.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ The prefix `spring.ai.openai.embedding` is property prefix that configures the `
107107

108108
NOTE: You can override the common `spring.ai.openai.base-url` and `spring.ai.openai.api-key` for the `ChatModel` and `EmbeddingModel` implementations.
109109
The `spring.ai.openai.embedding.base-url` and `spring.ai.openai.embedding.api-key` properties if set take precedence over the common properties.
110-
Similarly, the `spring.ai.openai.embedding.base-url` and `spring.ai.openai.embedding.api-key` properties if set take precedence over the common properties.
110+
Similarly, the `spring.ai.openai.chat.base-url` and `spring.ai.openai.chat.api-key` properties if set take precedence over the common properties.
111111
This is useful if you want to use different OpenAI accounts for different models and different model endpoints.
112112

113113
TIP: All properties prefixed with `spring.ai.openai.embedding.options` can be overridden at runtime by adding a request specific <<embedding-options>> to the `EmbeddingRequest` call.

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/qianfan-embeddings.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ Exporting an environment variable is one way to set that configuration property:
1313

1414
[source,shell]
1515
----
16-
export SPRING_AI_QIANFAN_API_KEY=<INSERT KEY HERE>
16+
export SPRING_AI_QIANFAN_API_KEY=<INSERT API KEY HERE>
17+
export SPRING_AI_QIANFAN_SECRET_KEY=<INSERT SECRET KEY HERE>
1718
----
1819

1920
=== Add Repositories and BOM
@@ -96,9 +97,9 @@ The prefix `spring.ai.qianfan.embedding` is property prefix that configures the
9697
| spring.ai.qianfan.embedding.options.model | The model to use | bge_large_zh
9798
|====
9899

99-
NOTE: You can override the common `spring.ai.qianfan.base-url`, `spring.ai.qianfan.embedding.api-key` and `spring.ai.qianfan.embedding.secret-key` for the `ChatClient` and `EmbeddingClient` implementations.
100-
The `spring.ai.qianfan.embedding.base-url`, `spring.ai.qianfan.embedding.api-key` and `spring.ai.qianfan.embedding.secret-key` properties if set take precedence over the common properties.
101-
Similarly, the `spring.ai.qianfan.embedding.base-url`, `spring.ai.qianfan.embedding.api-key` and `spring.ai.qianfan.embedding.secret-key` properties if set take precedence over the common properties.
100+
NOTE: You can override the common `spring.ai.qianfan.base-url`, `spring.ai.qianfan.api-key` and `spring.ai.qianfan.secret-key` for the `ChatModel` and `EmbeddingModel` implementations.
101+
The `spring.ai.qianfan.chat.base-url`, `spring.ai.qianfan.chat.api-key` and `spring.ai.qianfan.chat.secret-key` properties if set take precedence over the common properties.
102+
Similarly, the `spring.ai.qianfan.chat.base-url`, `spring.ai.qianfan.chat.api-key` and `spring.ai.qianfan.chat.secret-key` properties if set take precedence over the common properties.
102103
This is useful if you want to use different QianFan accounts for different models and different model endpoints.
103104

104105
TIP: All properties prefixed with `spring.ai.qianfan.embedding.options` can be overridden at runtime by adding a request specific <<embedding-options>> to the `EmbeddingRequest` call.

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/zhipuai-embeddings.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ The prefix `spring.ai.zhipuai.embedding` is property prefix that configures the
9595

9696
NOTE: You can override the common `spring.ai.zhipuai.base-url` and `spring.ai.zhipuai.api-key` for the `ChatModel` and `EmbeddingModel` implementations.
9797
The `spring.ai.zhipuai.embedding.base-url` and `spring.ai.zhipuai.embedding.api-key` properties if set take precedence over the common properties.
98-
Similarly, the `spring.ai.zhipuai.embedding.base-url` and `spring.ai.zhipuai.embedding.api-key` properties if set take precedence over the common properties.
98+
Similarly, the `spring.ai.zhipuai.chat.base-url` and `spring.ai.zhipuai.chat.api-key` properties if set take precedence over the common properties.
9999
This is useful if you want to use different ZhiPuAI accounts for different models and different model endpoints.
100100

101101
TIP: All properties prefixed with `spring.ai.zhipuai.embedding.options` can be overridden at runtime by adding a request specific <<embedding-options>> to the `EmbeddingRequest` call.

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/image/qianfan-image.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Exporting an environment variable is one way to set that configuration property:
1414

1515
[source,shell]
1616
----
17-
export SPRING_AI_QIANFAN_API_KEY=<INSERT KEY HERE>
17+
export SPRING_AI_QIANFAN_API_KEY=<INSERT API KEY HERE>
18+
export SPRING_AI_QIANFAN_SECRET_KEY=<INSERT SECRET KEY HERE>
1819
----
1920
=== Add Repositories and BOM
2021

0 commit comments

Comments
 (0)