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 是一个开源项目，旨在为不同的聊天完成和嵌入模型、助手和应用提供一个统一的API。该项目使用 Java 17 作为主要的编程语言，并且构建在 Eclipse Vert.x 框架之上。

2. 关键技术和框架

• Java 17: 项目的主要开发语言。
• Eclipse Vert.x: 用于构建响应式应用程序的框架。
• JClouds: 云服务集成库，用于与云存储服务交互。
• Helm: Kubernetes 的包管理工具，用于部署应用。

3. 安装和配置准备工作

在开始安装之前，请确保您的环境中已安装以下工具：

• Java Development Kit (JDK) 17: 用于编译和运行 Java 应用程序。
• Gradle: 构建工具，用于自动化项目的构建。
• Git: 版本控制系统，用于克隆和操作项目代码。
• Maven: 用于管理项目的依赖项。
• Kubernetes (可选): 如果需要使用 Helm 部署，则需要 Kubernetes 集群。

安装步骤

步骤 1：克隆项目

首先，您需要从 GitHub 克隆项目到本地环境：

git clone https://github.com/epam/ai-dial-core.git
cd ai-dial-core

步骤 2：设置环境变量

项目依赖 JClouds 包，这需要通过 GitHub Packages 进行访问。您需要设置环境变量以提供访问权限：

export GPR_USERNAME=your_github_username
export GPR_PASSWORD=your_github_personal_access_token

确保您已经生成了具有 read:packages 权限的 GitHub 个人访问令牌。

步骤 3：构建项目

使用 Gradle 构建 AI DIAL Core 项目：

./gradlew build

步骤 4：运行项目

构建完成后，您可以使用 Gradle 运行项目：

./gradlew :server:run

或者，您也可以从您喜欢的集成开发环境（IDE）中运行 com.epam.aidial.core.AIDial 类。

步骤 5：配置项目

项目的配置文件通常位于 src/main/resources/aidial.settings.json。您需要根据您的需求修改这个文件。以下是一些重要的配置项：

• config.files: 动态设置的文件路径列表。
• config.reload: 配置重新加载间隔（毫秒）。
• identityProviders: 身份提供者的配置，至少需要配置一个。
• storage.provider: 指定存储提供者，如 filesystem、s3 等。

确保所有配置项都是正确的，否则项目可能无法正常运行。

完成以上步骤后，您应该能够成功安装并运行 AI DIAL Core 项目。如果有任何问题，请参考项目的 README.md 文件或查看 GitHub 上的项目文档。

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