OpenAI Swift 客户端项目教程

OpenAI Swift 客户端项目教程

OpenAI A Swift client for the OpenAI API. 项目地址: https://gitcode.com/gh_mirrors/opena/OpenAI

1. 项目目录结构及介绍

OpenAI
├── README.md
├── LICENSE
├── Package.swift
├── Package.resolved
├── .gitignore
├── Sources
│   └── OpenAI
│       └── Client.swift
├── Tests
│   └── OpenAITests
│       └── ClientTests.swift
└── playground
    └── OpenAI.playground

目录结构说明

• README.md: 项目介绍和使用说明。
• LICENSE: 项目许可证文件。
• Package.swift: Swift Package Manager 配置文件。
• Package.resolved: 依赖解析文件。
• .gitignore: Git 忽略文件配置。
• Sources/OpenAI: 项目源代码目录，包含主要的 Swift 文件。
• Tests/OpenAITests: 测试代码目录，包含测试用例。
• playground/OpenAI.playground: 用于快速测试和演示的 Playground 文件。

2. 项目启动文件介绍

启动文件

项目的启动文件位于 Sources/OpenAI/Client.swift。该文件定义了 Client 类，用于与 OpenAI API 进行交互。

主要功能

• 初始化: 通过 Client(apiKey: String) 初始化客户端。
• API 调用: 提供了多种 API 调用方法，如 completions、search、classify 和 answer。

示例代码

import OpenAI

let apiKey = "your-api-key"
let client = Client(apiKey: apiKey)

let prompt = "Once upon a time"
client.completions(engine: "davinci", prompt: prompt, numberOfTokens: 5, numberOfCompletions: 1) { result in
    guard case .success(let completions) = result else { return }
    print(completions.first?.choices.first?.text ?? "")
}

3. 项目配置文件介绍

Package.swift

Package.swift 是 Swift Package Manager 的配置文件，定义了项目的依赖和目标。

// swift-tools-version:5.3
import PackageDescription

let package = Package(
    name: "OpenAI",
    platforms: [
        .macOS(.v10_15),
        .iOS(.v13),
        .tvOS(.v13),
        .watchOS(.v6)
    ],
    products: [
        .library(name: "OpenAI", targets: ["OpenAI"])
    ],
    dependencies: [],
    targets: [
        .target(name: "OpenAI", dependencies: []),
        .testTarget(name: "OpenAITests", dependencies: ["OpenAI"])
    ]
)

配置说明

• name: 项目名称。
• platforms: 支持的平台。
• products: 定义了可用的库。
• dependencies: 项目依赖。
• targets: 定义了目标模块和测试模块。

.gitignore

.gitignore 文件用于指定 Git 忽略的文件和目录。

# Xcode
build/
*.xcodeproj
*.xcworkspace

# Swift Package Manager
.build/
Package.resolved

# Playground
playground/

配置说明

• Xcode: 忽略 Xcode 生成的文件和目录。
• Swift Package Manager: 忽略 SPM 生成的文件和目录。
• Playground: 忽略 Playground 文件。

通过以上配置，项目可以更好地管理和维护代码库。

OpenAI A Swift client for the OpenAI API. 项目地址: https://gitcode.com/gh_mirrors/opena/OpenAI