Skip to content

Update property precedence in documentation #1641

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

Merged
merged 1 commit into from
Nov 3, 2024
Merged

Update property precedence in documentation #1641

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chat/qianfan-chat.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ Exporting an environment variable is one way to set that configuration property:

[source,shell]
----
export SPRING_AI_QIANFAN_API_KEY=<INSERT KEY HERE>
export SPRING_AI_QIANFAN_API_KEY=<INSERT API KEY HERE>
export SPRING_AI_QIANFAN_SECRET_KEY=<INSERT SECRET KEY HERE>
----

=== Add Repositories and BOM
Expand Down Expand Up @@ -102,7 +103,7 @@ The prefix `spring.ai.qianfan.chat` is the property prefix that lets you configu
| 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"] | -
|====

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.
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.
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.
This is useful if you want to use different QianFan accounts for different models and different model endpoints.

Expand Down
2 changes: 1 addition & 1 deletion ...-docs/src/main/antora/modules/ROOT/pages/api/embeddings/minimax-embeddings.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ The prefix `spring.ai.minimax.embedding` is property prefix that configures the

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

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.
Expand Down
2 changes: 1 addition & 1 deletion ...ocs/src/main/antora/modules/ROOT/pages/api/embeddings/mistralai-embeddings.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ The prefix `spring.ai.mistralai.embedding` is property prefix that configures th

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

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.
Expand Down
2 changes: 1 addition & 1 deletion ...i-docs/src/main/antora/modules/ROOT/pages/api/embeddings/openai-embeddings.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ The prefix `spring.ai.openai.embedding` is property prefix that configures the `

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

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.
Expand Down
9 changes: 5 additions & 4 deletions ...-docs/src/main/antora/modules/ROOT/pages/api/embeddings/qianfan-embeddings.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ Exporting an environment variable is one way to set that configuration property:

[source,shell]
----
export SPRING_AI_QIANFAN_API_KEY=<INSERT KEY HERE>
export SPRING_AI_QIANFAN_API_KEY=<INSERT API KEY HERE>
export SPRING_AI_QIANFAN_SECRET_KEY=<INSERT SECRET KEY HERE>
----

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

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.
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.
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.
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.
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.
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.
This is useful if you want to use different QianFan accounts for different models and different model endpoints.

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.
Expand Down
2 changes: 1 addition & 1 deletion ...-docs/src/main/antora/modules/ROOT/pages/api/embeddings/zhipuai-embeddings.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ The prefix `spring.ai.zhipuai.embedding` is property prefix that configures the

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

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.
Expand Down
3 changes: 2 additions & 1 deletion spring-ai-docs/src/main/antora/modules/ROOT/pages/api/image/qianfan-image.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ Exporting an environment variable is one way to set that configuration property:

[source,shell]
----
export SPRING_AI_QIANFAN_API_KEY=<INSERT KEY HERE>
export SPRING_AI_QIANFAN_API_KEY=<INSERT API KEY HERE>
export SPRING_AI_QIANFAN_SECRET_KEY=<INSERT SECRET KEY HERE>
----
=== Add Repositories and BOM

Expand Down