AI DIAL Core 开源项目使用教程

AI DIAL Core 开源项目使用教程

ai-dial-core The main component of AI DIAL, which provides unified API to different chat completion and embedding models, assistants, and applications 项目地址: https://gitcode.com/gh_mirrors/ai/ai-dial-core

1. 项目目录结构及介绍

AI DIAL Core 的目录结构如下：

ai-dial-core/
├── .github/
├── .gradle/
├── build.gradle
├── gradlew
├── gradlew.bat
├── settings.gradle
├── src/
│   ├── main/
│   │   ├── java/
│   │   ├── resources/
│   │   ├── webapp/
│   │   └── Dockerfile
│   └── test/
│       ├── java/
│       └── resources/
├── Dockerfile
├── LICENSE
├── README.md
├── SECURITY.md
└── trivy.yaml

• .github/：包含与 GitHub 仓库操作相关的文件，例如代码审查和自动化工作流程的配置文件。
• .gradle/：包含 Gradle 的本地缓存和配置文件。
• build.gradle：Gradle 的构建脚本，用于编译、测试和打包项目。
• gradlew 和 gradlew.bat：Gradle Wrapper 脚本，允许用户在没有安装 Gradle 的情况下构建项目。
• settings.gradle：Gradle 的设置文件，用于配置项目的多模块构建。
• src/：源代码目录，包含主要的 Java 源文件、资源文件、测试代码和 Dockerfile。
• Dockerfile：用于创建项目 Docker 容器的 Dockerfile 文件。
• LICENSE：项目的 Apache-2.0 许可证文件。
• README.md：项目的基本介绍和说明。
• SECURITY.md：安全相关的信息和指南。
• trivy.yaml：用于容器镜像安全扫描的 Trivy 配置文件。

2. 项目的启动文件介绍

AI DIAL Core 的启动可以通过 Gradle 进行，主要的启动文件是位于 src/main/java 目录下的 AIDial.java 类。以下是启动项目的基本命令：

./gradlew :server:run

这条命令会启动服务器，默认情况下会监听配置的端口。如果你想在 IDE 中运行，可以运行 AIDial 类的 main 方法。

3. 项目的配置文件介绍

AI DIAL Core 使用 JSON 格式的配置文件来配置应用程序的设置。配置文件通常位于 src/main/resources/ 目录下，默认的配置文件是 aidial.settings.json。

以下是一些重要的配置项：

• config.files：指定动态配置文件的路径列表。
• config.reload：配置文件重新加载的间隔时间，单位为毫秒。
• identityProviders：配置身份提供者，包括 JWT 验证和用户信息获取的设置。
• storage.provider：指定存储提供者，例如 filesystem、s3、aws-s3 等。
• storage.endpoint：对于兼容 S3 的存储，指定端点 URL。
• storage.identity 和 storage.credential：存储的访问密钥和秘密密钥。
• storage.bucket：存储桶的名称。
• storage.createBucket：指示是否在启动时创建存储桶。

配置文件中的设置可以通过环境变量覆盖，环境变量需要带有 aidial. 前缀。例如，要覆盖 server.port，可以使用环境变量 aidial.server.port。

ai-dial-core The main component of AI DIAL, which provides unified API to different chat completion and embedding models, assistants, and applications 项目地址: https://gitcode.com/gh_mirrors/ai/ai-dial-core