sharpapi laravel client
v1.2.2
在 SharpAPI.com 网站上查看更多信息 »
PHP >= 8.1
Laravel >= 9.0
如果您不使用 Laravel，那么您可以在这里找到通用 SharpAPI PHP 客户端 »
按照以下步骤安装和设置 SharpAPI Laravel 客户端包。
通过composer安装包：
作曲家需要 Sharpapi/sharpapi-laravel-client
在 SharpAPI.com 注册并获取 API 密钥。
在.env中设置 API 密钥
SHARP_API_KEY=密钥
[可选]发布配置文件sharpapi-client.php 。
注意：您不再需要发布配置文件即可使用此包。默认情况下，该包将使用合理的默认值。如果您想自定义配置，只需发布配置即可。
php artisan 供应商：发布 --tag=sharpapi-laravel-client
？电子商务
快速生成引人入胜的产品介绍以吸引客户。
自动创建个性化的感谢电子邮件以增强客户体验。
简化产品分类，形成组织良好的目录。
情绪分析：了解和分析产品评论中的情绪，以进行数据驱动的决策。
️内容和营销自动化
为全球受众轻松翻译文本。
释义和校对任何文本（包括语法检查）
垃圾邮件内容检测：有效识别并过滤掉垃圾邮件内容。
联系信息提取：从非标准格式中提取电话号码和电子邮件地址，以简化通信。
生成简洁的摘要和独特的关键字/标签以改善内容消耗。
根据内容自动生成 META 标签，促进 SEO 工作。
人力资源技术
轻松生成复杂的职位描述，节省招聘过程中的时间。
技能和职位洞察：确定相关的工作职位和技能以简化招聘。
自动简历解析：有效地解析和提取简历文件中的信息，以便于处理。
旅行、旅游与酒店业
分析旅行评论中的情绪以改善服务。
简化旅游、活动和酒店产品的分类。
请参考官方：
API文档
多语言支持：每个内容或数据分析 API 端点支持 80 种语言。检查这里的列表。
易于使用的 RESTful 格式：具有标准化的端点集 - 通过分析端点获得有价值的见解，涵盖产品类别、技能和职位，并提供相关分数。
始终相同、干净的数据格式：所有返回的数据都具有一致、可预测的 JSON 格式，请放心。无需担心人工智能数据模糊。
技术支持：由开发人员为开发人员精心打造，我们在您的整个旅程中提供持续的帮助。
您可以注入SharpApiService类或使用外观SharpApiService单例。
我们建议您使用 Laravel 队列系统来优化调度作业和检查结果的过程，特别是当您处理较大批量的数据时。
典型用例需要以下步骤：
调度可用的 AI 处理方法之一（这将返回作业处理状态 URL）
运行fetchResults($statusUrl)方法，该方法在轮询模式下运行，每 10 秒发送一次底层请求，持续 180 秒（这些值可以自定义）。
将返回SharpApiJob对象。
对于以success返回状态完成的作业，您可以使用其中一种方法获取结果，例如$jobResultJson = $jobResult->getResultJson() 。
每个调度的作业通常需要几秒钟到一分钟的时间。
在此期限之后，返回的作业通常会具有success状态，并且其结果可用于进一步处理。每个API方法返回不同的返回格式。请参阅下面的 API 方法/端点列表了解详细信息»
我们的 API 保证每次都返回正确的格式。 SharpAPI 在极少数情况下使用的人工智能引擎容易出现行为异常、超时或返回错误数据的情况。在这些情况下，作业的返回status将是failed 。在这种情况下，您可以重新运行完全相同的作业请求。
只要我们的引擎仍在处理作业，它就会继续返回pending状态。
<?phpnamespace AppHttpControllers;use GuzzleHttpExceptionGuzzleException;use SharpAPISharpApiServiceSharpApiService;类 SharpTest 扩展控制器{public function __construct(public SharpApiService $sharpApiService)
{
}/** * @throws GuzzleException */public function detector_phones(): void{$statusUrl = $this->sharpApiService->detectPhones('在哪里可以找到我们？致电销售技术顾问：致电：1800-394-7486或我们的新加坡办事处 +65 8888 8888'）； $result = $this->sharpApiService->fetchResults($statusUrl); dd($result->getResultJson());/* 返回: [ { "Detected_number": "1800-394-7486", "parsed_number": "+18003947486" }, { "Detected_number": "+65 8888 8888" , "parsed_number": "+6588888888" } ] */}
}底层 HTTP 请求由 Laravel HTTP Client/Guzzle 提供便利，因此建议您熟悉常见的 Guzzle 异常。
use GuzzleHttpExceptionClientException;// 第 1 步：使用其中一种方法将作业分派到 API，例如：try {$statusUrl = SharpApiService::summarizeText($text, 'German', // 可选语言500, // 可选长度'中性语音' // 可选语音
);// $statusUrl 示例值： 'http://sharpapi.com/api/v1/job/status/75acb6dc-a975-4969-9ef1-c62cebc511cb'} catch (ClientException $e) { $e->getResponse( ）
}// 第 2 步：请求以轮询模式检查作业状态并等待结果$jobResult = SharpApiService::fetchResults($statusUrl);// 第 3 步：获取已调度 API 作业的结果，这里返回作业结果作为漂亮的 JSON$jobResultJson = $jobResult->getResultJson();// ..or PHP 数组:$jobResultArray = $jobResult->getResultArray();// ..or PHP stdClass:$jobResultObject = $jobResult->getResultObject();因此，您可以使用.env设置覆盖这些值：
SHARP_API_KEY=XXX_key_XXXSHARP_API_JOB_STATUS_POLLING_WAIT=200SHARP_API_JOB_STATUS_USE_POLLING_INTERVAL=trueSHARP_API_JOB_STATUS_POLLING_INTERVAL=5SHARP_API_BASE_URL=MOCK_SERVER
每个方法总是返回SharpApiJob对象，其中getResultJson / getResultArray / getResultObject方法将返回不同的数据结构。请参考 SharpAPI.com 提供的详细示例
对于具有language参数的方法，您还可以使用SharpApiLanguages枚举值来使代码更具可读性。
解析多种格式（PDF/DOC/DOCX/TXT/RTF）的简历（CV）文件并返回广泛的数据点对象。
还可以提供可选的输出语言参数（默认设置为English值）。
$statusUrl = SharpApiService::parseResume('/test/resume.pdf', '英语');基于广泛的参数列表，该端点以响应格式提供简洁的工作详细信息，包括简短描述、工作要求和工作职责。唯一的强制参数是name 。
此功能利用名为JobDescriptionParameters的专用DTO类（ Data Transfer Object ）参数来帮助验证输入参数。此DTO的构造函数中只有name参数是必需的。
您可以通过提供 voice_tone 参数来设置您喜欢的书写风格。它可以是形容词，如funny或joyous ，甚至可以是一位著名作家的名字。
此 API 方法还提供了一个可选的上下文参数，可用于为内容处理提供额外的灵活指令。
$jobDescriptionParameters = 新的 JobDescriptionParameters(
姓名：“PHP高级工程师”，
Company_name: "ACME LTD", // 可选的最低工作经验: "5 年", // 可选的最低教育: "学士学位", // 可选的就业类型: "全职", // 可选的必需技能: ['PHP8', 'Laravel'], //可选的可选_技能：['AWS'，'Redis']，//可选的国家/地区：“英国”，//可选的远程： true, // 可选visa_spoke: true, // 可选voice_tone: 'Professional and Geeky', // 可选语音语气context: null, // 可选上下文，附加AI处理指令 language: null // 可选输出语言
);$statusUrl = SharpApiService::generateJobDescription($jobDescriptionParameters);生成相关技能的列表，其权重为浮点值 (1.0-10.0)，其中 10 等于 100%，即最高相关性分数。
仅需要第一个参数（ name ）。
您可以使用max_quantity参数限制输出。
$statusUrl = SharpApiService::latedSkills('MySQL', 'English', // 可选语言10 // 可选数量
）；生成相关职位的列表，其权重为浮点值 (1.0-10.0)，其中 10 等于 100%，即最高相关性分数。
仅需要第一个参数（ name ）。
您可以使用max_quantity参数限制输出。
$statusUrl = SharpApiService::latedJobPositions('高级PHP工程师', '英语', // 可选语言10 // 可选数量
）；解析客户的产品评论并提供其情绪（正面/负面/中性），分数介于 0-100% 之间。非常适合任何在线商店的情绪报告处理。
$statusUrl = SharpApiService::productReviewSentiment('客户评论内容');生成产品的合适类别列表，相关权重为浮点值 (1.0-10.0)，其中 10 等于 100%，即最高相关性得分。提供产品名称及其参数，以获得尽可能最佳的类别匹配。可以方便地填充产品目录数据和批量产品处理。
您可以使用max_quantity参数限制输出。
您可以通过提供voice_tone参数来设置您喜欢的书写风格。它可以是形容词，如funny或joyous ，甚至可以是一位著名作家的名字。
在附加的可选参数上下文中，您可以提供映射过程中将考虑的其他类别列表（例如您当前的电子商务类别）。
$statusUrl = SharpApiService::productCategories('Sony Playstation 5', 'English', // 可选语言5, // 可选数量 'Tech-savvy', // 可选语音提示 'Game Console, PS5 Console' // 可选上下文,当前要匹配的类别
）；生成产品描述的较短版本。提供尽可能多的产品细节和参数，以获得最佳的营销介绍。可以方便地填充产品目录数据和批量产品处理。
您可以使用max_length参数限制输出。请记住， max_length作为语言模型的强烈建议，而不是严格的要求，以保持结果的一般意义。
您可以通过提供voice_tone参数来设置您喜欢的书写风格。它可以是形容词，如funny或joyous ，甚至可以是一位著名作家的名字。
$statusUrl = SharpApiService::generateProductIntro('Sony Playstation 5', SharpApiLanguages::ENGLISH, // 可选语言300, // 可选长度 'Funny' // 可选语音
）；购买后向客户生成个性化的感谢电子邮件。回复内容末尾不包含标题、问候语或发件人信息，因此您可以轻松个性化电子邮件的其余部分。
您可以使用 max_length 参数限制输出。请记住， max_length作为语言模型的强烈建议，而不是严格的要求，以保持结果的一般意义。
您可以通过提供voice_tone参数来设置您喜欢的书写风格。它可以是形容词，如有趣或欢乐，甚至是著名作家的名字。
此 API 方法还提供了一个可选的上下文参数，可用于为内容处理提供额外的灵活指令。
$statusUrl = SharpApiService::generateThankYouEmail('Sony Playstation 5', SharpApiLanguages::ENGLISH, // 可选语言250, // 可选长度'Neutral', // 可选语音提示'必须邀请客户在假期前再次访问' // 可选语境
）；将提供的文本翻译为选定的语言。支持 80 种语言。请检查包含的SharpApiLanguages枚举类以了解详细信息。
您可以通过提供voice_tone参数来设置您喜欢的书写风格。它可以是形容词，如有趣或欢乐，甚至是著名作家的名字。
还可以使用可选的context参数。它可用于为翻译文本提供更多上下文，例如用例示例或一些附加解释。
$statusUrl = SharpApiService::translate('turn', SharpApiLanguages::FRENCH, // 可选语言 'neutral', // 可选语音 '翻页' // 可选上下文
);// 将导致 :// {"content": "tourner", "to_language": "French", "from_language": "English"}生成所提供文本的释义版本。仅需要content参数。您可以定义输出语言、最大字符长度和语气。
可以在上下文参数中提供有关如何处理文本的附加说明。请记住， max_length作为语言模型的强烈建议，而不是严格的要求，以保持结果的一般意义。
您可以通过提供可选的voice_tone参数来设置您喜欢的书写风格。它可以是形容词，如funny或joyous ，甚至可以是一位著名作家的名字。
此 API 方法还提供了一个可选的context参数，可用于为内容处理提供额外的灵活指令。
$statusUrl = SharpApiService::paraphrase($text, SharpApiLanguages::FRENCH, // 可选 language500, // 可选长度 'neutral', // 可选语气 'avoid using abbreviations' // 可选上下文
）；校对（并检查语法）提供的文本。
$statusUrl = SharpApiService::proofread($text);
检查提供的内容是否通过垃圾邮件过滤测试。提供百分比置信度分数以及是否被视为垃圾邮件的解释。此信息对于主持人做出最终决定很有用。
$statusUrl = SharpApiService::detectSpam($text);
解析提供的文本中的任何电话号码，并返回检测到的原始版本及其 E.164 格式。如果您想在不应该出现的地方检测电话号码，那么在根据电话号码或 fe 处理和验证大量数据的情况下可能会派上用场。
$statusUrl = SharpApiService::DetectPhones($text);
解析提供的文本以查找任何可能的电子邮件。如果您想在不应该出现的地方检测电子邮件，那么在根据电子邮件地址处理和验证大量数据时可能会派上用场。
$statusUrl = SharpApiService::detectEmails($text);
根据提供的内容生成唯一关键字/标签的列表。
您可以使用max_quantity参数限制输出。
您可以通过提供voice_tone参数来设置您喜欢的书写风格。
$statusUrl = SharpApiService::generateKeywords($text, 'English', // 可选 language5, // 可选长度 'Freaky & Curious', // 可选语音 'add emojis!' // 可选用于内容处理的额外上下文指令 ）；
生成所提供内容的摘要版本。非常适合生成较长文本的营销介绍。
您可以使用max_length参数限制输出。请记住， max_length作为语言模型的强烈建议，而不是严格的要求，以保持结果的一般意义。
您可以通过提供voice_ton e 参数来设置您喜欢的书写风格。它可以是形容词，如funny或joyous ，甚至可以是一位著名作家的名字。
$statusUrl = SharpApiService::summarizeText($text, 'English', // 可选语言 'David Attenborough', // 可选语音 'add emojis!' // 可选用于内容处理的额外上下文指令 ）；
根据提供的内容生成所有最重要的 META 标签。确保包含网站链接和图片 URL，以填充尽可能多的标签。
您可以通过提供voice_ton e 参数来设置您喜欢的书写风格。它可以是形容词，如funny或joyous ，甚至可以是一位著名作家的名字。
$statusUrl = SharpApiService::generateSeoTags($text, 'English', // 可选语言 'David Attenborough' // 可选语音 ）；
解析旅行/酒店产品评论并提供其情绪（正面/负面/中性），分数介于 0-100% 之间。非常适合任何在线商店的情绪报告处理。
$statusUrl = SharpApiService::travelReviewSentiment($text);
生成旅游和活动产品的合适类别列表，相关权重为浮点值 (1.0-10.0)，其中 10 等于 100%，即最高相关性得分。提供产品名称及其参数，以获得尽可能最佳的类别匹配。可以方便地填充产品目录数据和批量产品处理。仅需要第一个参数productName 。
您可以使用max_quantity参数限制输出。
您可以通过提供voice_tone参数来设置您喜欢的书写风格。它可以是形容词，如funny或joyous ，甚至可以是一位著名作家的名字。
在附加的可选参数context中，您可以提供映射过程中将考虑的其他类别列表（例如您当前的电子商务类别）。
$statusUrl = SharpApiService::toursAndActivitiesProductCategories('海湾绿洲''下龙', // 可选城市'越南', // 可选国家'英语', // 可选语言10, // 可选数量'Adventurous', //可选语音提示'Bay Hotels, Ha Long Hotels' // 可选上下文，当前要匹配的类别
）；生成酒店类型产品的合适类别列表，相关权重为浮点值 (1.0-10.0)，其中 10 等于 100%，即最高相关性得分。提供产品名称及其参数，以获得尽可能最佳的类别匹配。可以方便地填充产品目录数据和批量产品处理。仅需要第一个参数productName 。
您可以使用max_quantity参数限制输出。
您可以通过提供voice_tone参数来设置您喜欢的书写风格。它可以是形容词，如funny或joyous ，甚至可以是一位著名作家的名字。
在附加的可选参数context中，您可以提供映射过程中将考虑的其他类别列表（例如您当前的电子商务类别）。
$statusUrl = SharpApiService::hospitalityProductCategories('Hotel Crystal 大人専用''Tokyo', // 可选城市 'Japan', // 可选国家 'English', // 可选 language10, // 可选数量 'Adventurous', // 可选语音提示 'Tokyo Hotels, Crystal Hotels' // 可选上下文，当前要匹配的类别
）；用于检查当前订阅周期详细信息的端点
$statusUrl = SharpApiService::quota();
将导致：
{“时间戳”：“2024-03-19T12：49：41.445736Z”，“on_Trial”：假，“Trial_ends”：“2024-03-17T07：57：46.000000Z”，“订阅”：true，“current_subscription_start” ： “2024-03-18T12：37：39.000000Z”，“current_subscription_end”：“2024-04-18T12：37：39.000000Z”，“subscription_words_quota”：100000，“subscription_words_used”：9608，“subscription_words_used_percentage”： 0.1} subscription_words_used_percentage是当前每月配额使用量的百分比，可以作为信用耗尽的用户警报。如果价值高于 80%，建议在 https://sharpapi.com/dashboard/credits 订阅更多积分，以避免服务中断。
这些值也可以在仪表板中找到：https://sharpapi.com/dashboard
简单的 PING 端点，用于检查 API 及其内部 timze 区域（时间戳）的可用性。
$statusUrl = SharpApiService::ping();
将导致：
{“ping”：“pong”，“时间戳”：“2024-03-12T08：50：11.188308Z”}请通过 GitHub 告知我们 »
或加入我们的电报群 »
请参阅变更日志以了解有关最近更改内容的更多信息。
A2Z网络有限公司
大卫·马考斯基
提升您的 Laravel AI 能力！
麻省理工学院许可证 (MIT)。请参阅许可证文件以获取更多信息。
如需最新消息、教程和案例研究，请不要忘记关注我们：
SharpAPI X（以前的 Twitter）
夏普API YouTube
夏普API Vimeo
SharpAPI 领英
夏普API脸书
