From d0da90c0db48bc8b504aa5ee7ef8bfa50a6b01ec Mon Sep 17 00:00:00 2001 From: YuLuo Date: Fri, 5 Jul 2024 11:03:37 +0800 Subject: [PATCH] feat: update rag example and readme files (#3774) Signed-off-by: yuluo-yx --- .../spring-cloud-ai-rag-example/README-en.md | 13 +++++++++---- .../spring-cloud-ai-rag-example/README.md | 9 +++++++-- .../src/main/resources/application.yml | 13 +++++++++---- .../cloud/ai/tongyi/TongYiConnectionProperties.java | 4 ++-- 4 files changed, 27 insertions(+), 12 deletions(-) diff --git a/spring-cloud-alibaba-examples/ai-example/spring-cloud-ai-rag-example/README-en.md b/spring-cloud-alibaba-examples/ai-example/spring-cloud-ai-rag-example/README-en.md index 19e7b1684..051df6e9c 100644 --- a/spring-cloud-alibaba-examples/ai-example/spring-cloud-ai-rag-example/README-en.md +++ b/spring-cloud-alibaba-examples/ai-example/spring-cloud-ai-rag-example/README-en.md @@ -40,22 +40,27 @@ You need to introduce the following dependencies in the POM. XML: org.springframework.ai - spring-ai-redis-spring-boot-starter + spring-ai-redis-store-spring-boot-starter ${spring.ai.version} ``` ## 3. Configuration -Configure the following information in the application. Yml: +Configure the following information in application.yml: > Note: It is recommended that you configure apiKey via an environment variable for apiKey security. + +> Note: It is recommended to configure the apiKey via environment variables for apiKey security. +> Reference: https://github.com/alibaba/spring-cloud-alibaba/tree/2023.x/spring-cloud-alibaba-examples/ai-example/spring-cloud-ai-example#% E6%8E%A5%E5%85%A5-spring-cloud-starter-alibaba-ai: ```yaml spring: ai: vectorstore: redis: + # Configure Redis connection URI, default value is redis://127.0.0.1:6379 + # uri: redis://127.0.0.1:6379 index: peer - prefix: peer + Prefix: peer ``` ## 4. Write the code @@ -120,7 +125,7 @@ You can start the SprigBoot main class and then use a browser to access: ```shell # request params is prompt，the default value：What ber pairs well with smoked meats?" -http://localhost:8080/rag/chat +http://localhost:8081/rag/chat ``` To experience the RAG application. diff --git a/spring-cloud-alibaba-examples/ai-example/spring-cloud-ai-rag-example/README.md b/spring-cloud-alibaba-examples/ai-example/spring-cloud-ai-rag-example/README.md index b5e45d4a8..2264625cb 100644 --- a/spring-cloud-alibaba-examples/ai-example/spring-cloud-ai-rag-example/README.md +++ b/spring-cloud-alibaba-examples/ai-example/spring-cloud-ai-rag-example/README.md @@ -40,7 +40,7 @@ services: org.springframework.ai - spring-ai-redis-spring-boot-starter + spring-ai-redis-store-spring-boot-starter ${spring.ai.version} ``` @@ -49,11 +49,16 @@ services: 在 application.yml 中配置如下信息： +> 注意：为了保证 apiKey 安全，建议通过环境变量的方式配置 apiKey。 +> 参考：https://github.com/alibaba/spring-cloud-alibaba/tree/2023.x/spring-cloud-alibaba-examples/ai-example/spring-cloud-ai-example#%E6%8E%A5%E5%85%A5-spring-cloud-starter-alibaba-ai: + ```yaml spring: ai: vectorstore: redis: + # Configure the Redis connection URI, default value is redis://127.0.0.1:6379 + # uri: redis://127.0.0.1:6379 index: peer prefix: peer ``` @@ -120,7 +125,7 @@ private Message getSystemMessage(List similarDocuments) { ```shell # 参数为 prompt，默认值为：What ber pairs well with smoked meats?" -http://localhost:8080/rag/chat +http://localhost:8081/rag/chat ``` 来体验 RAG 应用。 diff --git a/spring-cloud-alibaba-examples/ai-example/spring-cloud-ai-rag-example/src/main/resources/application.yml b/spring-cloud-alibaba-examples/ai-example/spring-cloud-ai-rag-example/src/main/resources/application.yml index 982253987..9110af6d9 100644 --- a/spring-cloud-alibaba-examples/ai-example/spring-cloud-ai-rag-example/src/main/resources/application.yml +++ b/spring-cloud-alibaba-examples/ai-example/spring-cloud-ai-rag-example/src/main/resources/application.yml @@ -21,12 +21,17 @@ spring: application: name: sca-ai-rag-example cloud: - ai: - tongyi: - api-key: sk-xxxxxx + # We recommend configuring the api-key via an environment variable. + # Please see https://github.com/alibaba/spring-cloud-alibaba/tree/2023.x/spring-cloud-alibaba-examples/ai-example/spring-cloud-ai-example#%E6%8E%A5%E5%85%A5-spring-cloud-starter-alibaba-ai: + # ai: + # tongyi: + # connection: + # api-key: sk-xxxxxx + ai: vectorstore: redis: - uri: your redis addr # eg：redis://127.0.0.1:6379 + # Configure the Redis connection URI, default value is redis://127.0.0.1:6379 + # uri: redis://127.0.0.1:6379 index: peer prefix: peer diff --git a/spring-cloud-alibaba-starters/spring-cloud-starter-alibaba-ai/src/main/java/com/alibaba/cloud/ai/tongyi/TongYiConnectionProperties.java b/spring-cloud-alibaba-starters/spring-cloud-starter-alibaba-ai/src/main/java/com/alibaba/cloud/ai/tongyi/TongYiConnectionProperties.java index 74141bd22..db15e7367 100644 --- a/spring-cloud-alibaba-starters/spring-cloud-starter-alibaba-ai/src/main/java/com/alibaba/cloud/ai/tongyi/TongYiConnectionProperties.java +++ b/spring-cloud-alibaba-starters/spring-cloud-starter-alibaba-ai/src/main/java/com/alibaba/cloud/ai/tongyi/TongYiConnectionProperties.java @@ -32,9 +32,9 @@ import static com.alibaba.cloud.ai.tongyi.common.constants.TongYiConstants.SCA_A public class TongYiConnectionProperties { /** - * Spring Cloud Alibaba AI connection configuration Prefix. + * Spring Cloud Alibaba AI connection configuration prefix. */ - public static final String CONFIG_PREFIX = SCA_AI_CONFIGURATION + "tongyi"; + public static final String CONFIG_PREFIX = SCA_AI_CONFIGURATION + "connection"; /** * TongYi LLM API key.