Flutter OpenAI接口集成插件openai_sdk的使用

openai_sdk (EXPERIMENTAL)

APIs for sampling from and fine-tuning language models

这个Dart包是由OpenAPI Generator项目自动生成的：

• API版本: 1.2.0
• 构建包: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

• Dart 2.15.0+ 或 Flutter 2.8.0+
• Dio 5.0.0+ (https://pub.dev/packages/dio)

Installation & Usage

pub.dev

要从pub.dev使用该包，请在pubspec.yaml中添加以下内容：

dependencies:
  openai_sdk: 0.0.1

Github

如果此Dart包发布到Github，请在pubspec.yaml中添加以下内容：

dependencies:
  openai_sdk:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local Development

要在本地驱动器上使用该包，请在pubspec.yaml中添加以下内容：

dependencies:
  openai_sdk:
    path: /path/to/openai_sdk

Getting Started

请按照安装步骤操作，然后运行以下代码：

import 'package:openai_sdk/openai_sdk.dart';

void main() async {
  // 初始化OpenAI API
  final api = OpenaiSdk().getOpenAIApi();

  // 示例：创建一个文本补全请求
  final CreateCompletionRequest request = CreateCompletionRequest(
    model: "text-davinci-002", // 模型名称
    prompt: "你好，世界！", // 输入提示
    maxTokens: 50, // 最大生成长度
  );

  try {
    // 调用API并获取响应
    final response = await api.createCompletion(request);
    print("生成结果: ${response.choices.first.text}");
  } catch (e) {
    print("调用API时出错: $e");
  }
}

Documentation for API Endpoints

所有URI均相对于https://api.openai.com/v1

Documentation For Models

• ChatCompletionRequestMessage
• ChatCompletionResponseMessage
• CreateAnswerRequest
• CreateAnswerRequestStop
• CreateAnswerResponse
• CreateAnswerResponseSelectedDocumentsInner
• CreateChatCompletionRequest
• CreateChatCompletionRequestStop
• CreateChatCompletionResponse
• CreateChatCompletionResponseChoicesInner
• CreateClassificationRequest
• CreateClassificationResponse
• CreateClassificationResponseSelectedExamplesInner
• CreateCompletionRequest
• CreateCompletionRequestPrompt
• CreateCompletionRequestStop
• CreateCompletionResponse
• CreateCompletionResponseChoicesInner
• CreateCompletionResponseChoicesInnerLogprobs
• CreateCompletionResponseUsage
• CreateEditRequest
• CreateEditResponse
• CreateEmbeddingRequest
• CreateEmbeddingRequestInput
• CreateEmbeddingResponse
• CreateEmbeddingResponseDataInner
• CreateEmbeddingResponseUsage
• CreateFineTuneRequest
• CreateImageRequest
• CreateModerationRequest
• CreateModerationRequestInput
• CreateModerationResponse
• CreateModerationResponseResultsInner
• CreateModerationResponseResultsInnerCategories
• CreateModerationResponseResultsInnerCategoryScores
• CreateSearchRequest
• CreateSearchResponse
• CreateSearchResponseDataInner
• CreateTranscriptionResponse
• CreateTranslationResponse
• DeleteFileResponse
• DeleteModelResponse
• Engine
• FineTune
• FineTuneEvent
• ImagesResponse
• ImagesResponseDataInner
• ListEnginesResponse
• ListFilesResponse
• ListFineTuneEventsResponse
• ListFineTunesResponse
• ListModelsResponse
• Model
• OpenAIFile

Documentation For Authorization

所有端点都不需要授权。

示例代码

以下是一个完整的示例代码，展示如何使用openai_sdk创建文本补全任务：

import 'package:flutter/material.dart';
import 'package:openai_sdk/openai_sdk.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('OpenAI SDK 示例')),
        body: Center(child: TextButton(
          onPressed: () async {
            // 初始化OpenAI API
            final api = OpenaiSdk().getOpenAIApi();

            // 创建补全请求
            final CreateCompletionRequest request = CreateCompletionRequest(
              model: "text-davinci-002",
              prompt: "你好，世界！",
              maxTokens: 50,
            );

            try {
              // 调用API并获取响应
              final response = await api.createCompletion(request);
              print("生成结果: ${response.choices.first.text}");
            } catch (e) {
              print("调用API时出错: $e");
            }
          },
          child: Text('调用OpenAI API'),
        )),
      ),
    );
  }
}