OpenAI-DotNet 入门指南

1. 项目目录结构及介绍

OpenAI-DotNet 是一个.NET库，用于与OpenAI API进行交互。以下是项目的基本目录结构及其作用：

OpenAI-DotNet/
├── src/               # 主要代码源文件
│   ├── OpenAI/        # 库的核心实现
│   └── Tests/         # 测试用例
├── samples/           # 示例应用程序
└── README.md          # 项目说明文档

• src/OpenAI: 包含了与OpenAI API交互的主要类和接口。
• src/Tests: 存放测试代码，用于验证库的功能正确性。
• samples: 提供简单示例应用，展示如何在实际项目中使用该库。

2. 项目的启动文件介绍

由于OpenAI-DotNet是一个库而非独立的应用程序，因此没有传统的"启动文件"。但是，在samples目录下，你可以找到一些.NET项目文件（如.csproj），这些是演示库用法的示例应用。例如，一个简单的控制台应用可能有一个名为Program.cs的文件，其中包含了调用OpenAI API的方法。

以下是一个简单的Program.cs示例片段：

using System;
using OpenAI;

namespace SampleApp
{
    class Program
    {
        static void Main(string[] args)
        {
            // 初始化OpenAIClient
            var apiKey = "your_api_key";
            var client = new OpenAIClient(apiKey);

            // 使用客户端进行API请求
            var response = client.TextCompletion("你好，世界!");

            Console.WriteLine(response.choices[0].text);
        }
    }
}

此代码展示了如何初始化OpenAIClient并执行一个文本完成任务。

3. 项目的配置文件介绍

OpenAI-DotNet库本身并不直接使用配置文件，而是通过构造函数参数或设置对象来传递API密钥和其他相关配置。通常，为了安全地管理API密钥，建议在你的应用中使用环境变量或者本地配置文件。

使用环境变量

将API密钥存储在环境变量OPENAI_API_KEY中，然后在代码中使用如下方式：

var apiKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY");
var client = new OpenAIClient(apiKey);

使用配置文件

如果你在一个.NET框架的应用中，可以利用appsettings.json或其他自定义配置文件来存储API密钥，然后在代码中加载：

// appsettings.json
{
  "OpenAI": {
    "ApiKey": "your_api_key"
  }
}

using Microsoft.Extensions.Configuration;

// 加载配置
var builder = new ConfigurationBuilder()
    .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);
var configuration = builder.Build();

// 获取API Key
var apiKey = configuration["OpenAI:ApiKey"];
var client = new OpenAIClient(apiKey);

这样，你就可以安全地在应用中使用OpenAI-DotNet库，而无需在代码中直接硬编码API密钥。