README

安装指南 | 文档 | 贡献 | 许可证

描述

本项目为Laravel提供了OpenAI、Claude、Cohere和Mistral API的统一封装。目标是简化在不同AI模型和API之间的切换，使其尽可能无缝。

观看如何在5分钟内完成设置的简短视频。

特性

• Open AI, Mistral, Claude & Cohere
  • 对话 => 快速原型/构建聊天机器人（通过数据库记录历史）
  • 完成 => 完成或响应给定的提示
• Open AI, Mistral（仅限）
  • 嵌入 => 从文本创建向量表示
• Open AI（仅限）
  • 音频 => 从文本提示创建音频文件
  • 图片 => 从文本提示创建图片
  • 审查 => 审查文本并标记不受欢迎的内容（非常适合审查评论）
  • 转录 => 转录音频文件
• 快速工具（所有模型都支持）
  • 总结 => 总结给定的输入
  • extractKeywords => 从给定的输入中提取关键词
  • translateText => 将给定的输入翻译成另一种语言
  • generateContent => 从给定的主题中生成内容想法

安装指南

在您的laravel应用中安装该包的最简单方法是在项目目录中运行以下命令

    composer require paparascaldev/sidekick

配置.env

一旦Sidekick安装完成，您需要更新.env文件，添加您的访问令牌。

您只需要指定您将要使用的提供者令牌。

SIDEKICK_OPENAI_TOKEN={API_KEY_HERE} (Recommended)
SIDEKICK_MISTRAL_TOKEN={API_KEY_HERE} (Optional)
SIDEKICK_CLAUDE_TOKEN={API_KEY_HERE} (Optional)
SIDEKICK_COHERE_TOKEN={API_KEY_HERE} (Optional)

我在哪里可以获得API密钥？

如果您尚未注册任何AI提供商，以下是一些帮助链接

• https://platform.openai.com（Open Ai）
• https://console.anthropic.com（Claude）
• https://console.mistral.ai（Mistral）
• https://dashboard.cohere.com（Cohere）

运行迁移

使用以下命令运行您的迁移

    php artisan migrate

在更新.env后，您可以开始测试插件。

Sidekick游乐场

为了查看Sidekick的一些实际应用示例，我创建了一个游乐场。默认情况下，此功能不可用，因为有些人可能不想使用它。

如果您想使用它，请运行以下Artisan命令来安装游乐场

  php artisan sidekick:install

这将安装路由和视图到您的应用程序中。

安装后，您可以在以下位置访问游乐场

/sidekick

文档

请参阅以下位置可找到的wiki文档： 文档

参与方式

要了解如何参与，请查看 CONTRIBUTING.md 或在此处阅读我的帖子： https://ashleyjohnson.co.uk/journal/calling-all-laravel-devs-lets-collaborate-on-sidekick

此外，如果您认为它有用，请为我的仓库加星。

模型支持

我已经使用以下模型测试了此包

Open Ai

gpt-3.5-turbo, gpt-4, tts-1, tts-1-hd, dall-e-2, dall-e-3, whisper-1, text-embedding-3-small, text-embedding-3-large, text-embedding-ada-002, text-moderation-latest, text-moderation-stable, text-moderation-007

Mistral AI

mistral-small-latest, mistral-medium-latest, mistral-large-latest, open-mistral-7b, mistral-embed

Claude AI

claude-3-opus-20240229, claude-3-sonnet-20240229, claude-3-haiku-20240307

Cohere AI

command-r-08-2024 command-r-plus-08-2024

Starred Users

向那些为仓库加星的人致敬！