Skip to content

Fix wrong configuration key #4624

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

Closed
wants to merge 1 commit into from
Closed

Fix wrong configuration key #4624

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
14 changes: 7 additions & 7 deletions ...-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 @@ -10,13 +10,13 @@ You will need to create an API with ZhiPuAI to access ZhiPu AI language models.

Create an account at https://open.bigmodel.cn/login[ZhiPu AI registration page] and generate the token on the https://open.bigmodel.cn/usercenter/apikeys[API Keys page].

The Spring AI project defines a configuration property named `spring.ai.zhipu.api-key` that you should set to the value of the `API Key` obtained from the API Keys page.
The Spring AI project defines a configuration property named `spring.ai.zhipuai.api-key` that you should set to the value of the `API Key` obtained from the API Keys page.

You can set this configuration property in your `application.properties` file:

[source,properties]
----
spring.ai.zhipu.api-key=<your-zhipu-api-key>
spring.ai.zhipuai.api-key=<your-zhipuai-api-key>
----

For enhanced security when handling sensitive information like API keys, you can use Spring Expression Language (SpEL) to reference an environment variable:
Expand All @@ -26,22 +26,22 @@ For enhanced security when handling sensitive information like API keys, you can
# In application.yml
spring:
ai:
zhipu:
api-key: ${ZHIPU_API_KEY}
zhipuai:
api-key: ${ZHIPUAI_API_KEY}
----

[source,bash]
----
# In your environment or .env file
export ZHIPU_API_KEY=<your-zhipu-api-key>
export ZHIPUAI_API_KEY=<your-zhipuai-api-key>
----

You can also set this configuration programmatically in your application code:

[source,java]
----
// Retrieve API key from a secure source or environment variable
String apiKey = System.getenv("ZHIPU_API_KEY");
String apiKey = System.getenv("ZHIPUAI_API_KEY");
----

=== Add Repositories and BOM
Expand Down Expand Up @@ -228,7 +228,7 @@ Next, create an `ZhiPuAiEmbeddingModel` instance and use it to compute the simil

[source,java]
----
var zhiPuAiApi = new ZhiPuAiApi(System.getenv("ZHIPU_AI_API_KEY"));
var zhiPuAiApi = new ZhiPuAiApi(System.getenv("ZHIPUAI_API_KEY"));

var embeddingModel = new ZhiPuAiEmbeddingModel(api, MetadataMode.EMBED,
ZhiPuAiEmbeddingOptions.builder()
Expand Down