README

此包用于通过 OpenAI API 简单地管理文件和批次。流程描述 在此。

安装

您可以通过 composer 安装此包

composer require moontechs/filamentphp-openai-management

您需要使用以下命令发布和运行迁移

php artisan vendor:publish --tag="filamentphp-openai-management-migrations"
php artisan migrate

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag="filamentphp-openai-management-config"

这是已发布配置文件的内容

return [
    'disk' => 'local', // you can customize used disk and upload/download folders
    'directory' => 'openai-files',
    'download-disk' => 'local',
    'download-directory' => 'openai-files-downloads',

    'select-options' => [
        'file-purpose' => [
            'batch' => 'batch',
            'assistants' => 'assistants',
            'fine-tune' => 'fine-tune',
        ],
        'batch-endpoint' => [
            '/v1/chat/completions' => '/v1/chat/completions',
            '/v1/embeddings' => '/v1/embeddings',
            '/v1/completions' => '/v1/completions',
        ],
    ],
];

用法

将插件添加到您的面板提供者

use Moontechs\OpenAIManagement\OpenAIManagementPlugin;

->plugins([
    new OpenAIManagementPlugin,
])

作业

计划以下 CLI 命令

• php artisan openai-management:files:update - 上传新文件到 OpenAI 存储并更新已上传文件的状态
• php artisan openai-management:batches:update - 发送文件批量处理请求并更新旧请求的状态。如果没有正在进行的批次，它将发送下一个批量处理请求。
• php artisan openai-management:batches:download-processed-files - 下载已处理的批次（文件）

UI（步骤流程）

1. 添加项目
   • 请参考 OpenAI 文档以创建新项目或获取现有项目的 ID 和 密钥。
   • 注意：OpenAI 密钥将被加密。不要重新生成 Laravel 的 APP_KEY。

1. 上传文件
   • 请参阅 文档了解文件结构。
   • 支持多文件上传。
   • 标签仅用于内部使用，不影响 API 调用。

1. 请求批量处理
   • 如果文件处于 processed 状态，您可以请求批量处理。

1. 检查批次状态
   • 批量处理可能需要长达 24 小时。您可以检查批次状态。

1. 下载处理过的文件
   • 当批次完成时，后台作业将文件下载到服务器。然后您可以本地下载它们（将出现下载按钮）。

致谢

• Moontechs
• 所有贡献者

许可证

AGPL-3.0 许可证。请参阅 许可证文件获取更多信息。