模块化JS+OpenAI 手搓数据分析项目

睡个好jo
VIP.1 初学乍练
2,464 阅读7分钟

现如今，AI时代来临，我们正步入一个前所未有的智能时代。本文旨在通过一个实战项目，探讨如何利用JavaScript的模块化特性以及OpenAI的API，来构建一个能够智能分析销售数据的应用。这个项目不仅展示了AI在简化数据分析过程中的力量，也强调了现代编程范式的灵活性和效率。

项目背景与目标

在当前的商业环境中，快速准确地从大量数据中提取有价值的信息是至关重要的。本项目的目标是设计一个简单的数据分析系统，它能够接收销售数据，并根据用户的自然语言查询，自动生成相应的报告。我们将利用OpenAI的API来处理这些查询，模拟一个“专业数据分析师”的角色，从而降低人工分析的负担，提高工作效率。

技术栈简介

  • JavaScript模块化: ES6模块（.mjs文件）为JavaScript提供了原生的模块系统，支持import和export语句，使得代码组织更加清晰，复用性更强。
  • OpenAI API: 通过调用OpenAI提供的API，尤其是GPT系列模型，我们可以利用大型语言模型（LLM）的能力来理解和生成复杂的文本，这在处理数据分析查询时尤其有用。
  • Node.js: 作为后端运行环境，Node.js为JavaScript提供了服务器端的执行能力，支持我们轻松地集成各种API和处理数据。

实战项目：模块化数据分析应用

项目结构

  1. main.mjs: 主入口文件，负责初始化OpenAI客户端，定义数据集，并发起查询请求。
  2. common.mjs: 包含辅助函数，如数据处理逻辑和OpenAI调用封装。

关键步骤

  1. 环境搭建与依赖管理: 使用npm初始化项目，安装openai库作为与OpenAI API交互的桥梁。
  2. 模块定义: 在common.mjs中，我们定义了getSaleReport函数，它接受OpenAI客户端实例、原始数据和查询字符串作为参数，构造一个适合模型理解的prompt，并通过OpenAI API获取分析结果。
   // common.mjs
  export const getSaleReport = async (client, data, query) => {
    const prompt = `
        You are a professional data analyst.
        Here is the sale data \n ${data} \n \n
        Please generate a report to answer
        the following question:\n
        ${query}
    `
    // openai 的接口很简单
    // AIGC -> AGI  OPENAI completions生成（完成）
    let response = await client.completions.create({
        // chat gpt-3.5-turbo
        model: 'gpt-3.5-turbo-instruct',
        prompt,
        // LLM 的自由度 数据分析要严格
        temperature: 0,
        n: 1,
        // 控制花销的 openai 账单 靠token
        max_tokens: 1000,
    })
    return response.choices[0].text
}

这段代码是一个JavaScript模块（.mjs文件），用于通过AI生成销售报告。它导出了一个名为getSaleReport的异步函数，该函数接收三个参数：client（一个用于与AI服务交互的客户端实例，假设是OpenAI API客户端）、data（销售数据）和query（需要解答的问题）。下面是该函数的详细解析：

  • 定义Prompt: 函数内部首先构建了一个字符串prompt，这个字符串作为与AI模型交互的指令。它设定了一个场景，让AI扮演一个专业的数据分析师，并提供了销售数据以及需要回答的具体问题。这里使用了模板字符串（反引号包围的字符串）来插入变量data和query的值。

  • 调用AI服务: 接下来，通过client.completions.create方法调用了AI服务（假设是OpenAI API），传递了一系列配置选项：

    • model: 指定了使用的AI模型为gpt-3.5-turbo-instruct，这是OpenAI的一个模型，适合于指令型任务。
    • prompt: 刚刚构建的指令字符串，作为AI生成文本的基础。
    • temperature: 设置为0，意味着希望AI生成的结果尽可能确定性、遵循逻辑，而不是富有创造性或随机性。
    • n: 设定为1，表示只需要生成一个答案。
    • max_tokens: 限制了生成文本的最大长度为1000个token，有助于控制成本和确保回答的简洁性。

  • 处理并返回结果: 函数从AI服务的响应中提取第一个选择（response.choices[0].text），这通常是生成的报告文本，并将其直接返回。

  1. 主逻辑实现: 在main.mjs中，我们实例化OpenAI客户端，定义了示例销售数据，并向getSaleReport函数发起调用，询问关于产品总收入的对比问题。
 // main.mjs
 import OpenAI from 'openai';
 import { getSaleReport } from './common.mjs';

 const client = new OpenAI({
     apiKey: 'YOUR_API_KEY',
     baseURL: 'https://api.openai.com/v1',
 });

 const saleData = `
     日期，产品，销量，单价，总收入
     2023-01-01,iPhone 13,100,6000,600000
     ... // 其他数据行
 `;

 const query = "根据上述销售数据，哪个产品的总收入更高，高多少？";
 const res = await getSaleReport(client, saleData, query);
 console.log(res);

这段代码位于一个名为main.mjs的JavaScript模块文件中，其主要功能是使用OpenAI API通过AI生成销售报告来回答特定的查询问题。以下是代码的详细解析：

  • 导入依赖: 首先，它导入了OpenAI客户端模块，用于与OpenAI API进行交互，以及从common.mjs模块中导入了getSaleReport函数，该函数用于获取销售报告。

  • 初始化OpenAI客户端: 创建了一个新的OpenAI客户端实例，设置API密钥和基础URL。

  • 定义销售数据: 定义了一个名为saleData的多行字符串，其中包含了模拟的销售数据，包括日期、产品、销量、单价和总收入等列。实际应用中，这些数据可能从数据库或CSV文件等来源获取。

  • 定义查询问题: 定义了一个字符串query，提出了一个具体的分析请求，即找出总收入最高的产品及其相比其他产品的高收入额度。

  • 调用函数并打印结果: 使用await关键字调用从common.mjs导入的getSaleReport函数，传入了OpenAI客户端实例、销售数据和查询问题作为参数。函数的返回值（即AI生成的销售报告文本）被赋给了变量res，并通过console.log(res)输出到控制台。

输出结果：

image.png

项目亮点

  1. 模块化编程: 通过导入(import)语句，代码体现了模块化设计原则。这样做的好处是提高了代码的可重用性、可维护性和可读性。OpenAI客户端作为一个模块被导入，而具体的数据处理逻辑放在了单独的common.mjs模块中的getSaleReport函数里。

  2. 异步编程: 使用await关键字调用异步函数，这表明代码采用了现代JavaScript的异步编程模型，能够处理非阻塞操作，如网络请求，从而提高程序运行效率和响应性。这对于与外部API（如OpenAI API）交互至关重要，因为这类操作往往需要时间且不应阻塞其他任务执行。

  3. API集成: 整合了OpenAI API，展示了如何在实际项目中利用先进的AI技术来增强应用功能。这种集成方式打开了利用人工智能处理复杂数据、生成分析报告等任务的大门，是技术与业务融合的一个实例。

  4. 明确的业务逻辑分离: 通过定义清晰的查询(query)和调用专门的函数(getSaleReport)来处理这一查询，代码保持了良好的分离关注点原则。这意味着业务逻辑（提出问题）与数据处理逻辑（如何获取答案）被恰当地分隔开，便于未来的扩展和维护。

  5. 使用现代JavaScript语法: 文件扩展名.mjs表明这是ES模块格式的JavaScript代码，利用了ECMAScript最新标准的特性，比如顶级await，这简化了异步代码的编写，使得代码更加简洁和直观。

结论

本实战项目成功展示了如何将JavaScript的模块化特性与OpenAI的API相结合，打造出一个能够智能分析销售数据的应用。通过模块化的编程实践，我们不仅实现了代码的解耦和重用，还确保了系统的可扩展性和维护性。整合OpenAI的先进AI技术，特别是其强大的语言模型，使应用程序能够在理解自然语言查询的基础上，自动化生成详细的销售分析报告，极大地提高了数据分析的效率与准确性。

avatar
文章
阅读
粉丝