Flutter私有GPT API集成插件private_gpt_api的使用

开发背景

本插件为Flutter开发者提供了一种方便的方式，通过private_gpt_api插件调用私有的GPT API。该插件由Dart语言编写，并通过OpenAPI Generator生成。

使用说明

1. 安装插件

方法一：从GitHub安装

如果插件已发布到GitHub仓库，请在pubspec.yaml文件中添加以下依赖：

dependencies:
  private_gpt_api:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

方法二：本地安装

如果插件存储在本地路径，请将以下内容添加到pubspec.yaml文件中：

dependencies:
  private_gpt_api:
    path: /path/to/private_gpt_api

2. 配置环境

确保你的开发环境满足以下条件：

• Dart SDK版本为2.12或更高。

快速开始

初始化插件

首先，导入插件并初始化API实例：

import 'package:private_gpt_api/api.dart';

// 初始化API实例
final api_instance = ContextChunksApi();

// 创建请求体对象
final chunksBody = ChunksBody();

调用API方法

接下来，调用插件提供的API方法。例如，调用chunksRetrievalV1ChunksPost方法：

try {
  // 执行API调用
  final result = api_instance.chunksRetrievalV1ChunksPost(chunksBody);

  // 打印返回结果
  print(result);
} catch (e) {
  // 捕获异常并打印错误信息
  print('Exception when calling ContextChunksApi->chunksRetrievalV1ChunksPost: $e\n');
}

API文档

以下是所有可用的API端点及其描述：

模型文档

以下是插件中使用的模型类列表：

• ChatBody
• ChatBodyContextFilter
• Chunk
• ChunksBody
• ChunksResponse
• CompletionsBody
• Content
• ContextFilter
• DocMetadata
• DocsIds
• Embedding
• EmbeddingsBody
• EmbeddingsResponse
• FinishReason
• HTTPValidationError
• HealthResponse
• IngestResponse
• IngestTextBody
• IngestedDoc
• Input
• NextTexts
• OpenAIChoice
• OpenAIChoiceDelta
• OpenAIChoiceMessage
• OpenAICompletion
• OpenAIDelta
• OpenAIMessage
• PreviousTexts
• Sources
• SystemPrompt
• ValidationError
• ValidationErrorLocInner

授权说明

所有API端点均无需授权即可调用。

示例代码

以下是一个完整的示例代码，展示如何使用插件调用chunksRetrievalV1ChunksPost方法：

import 'package:private_gpt_api/api.dart';

void main() async {
  try {
    // 初始化API实例
    final api_instance = ContextChunksApi();

    // 创建请求体对象
    final chunksBody = ChunksBody();

    // 调用API方法
    final result = await api_instance.chunksRetrievalV1ChunksPost(chunksBody);

    // 打印返回结果
    print('Result: $result');
  } catch (e) {
    // 捕获异常并打印错误信息
    print('Exception: $e');
  }
}