sharpapi laravel client
v1.2.2
Дополнительную информацию можно найти на веб-сайте SharpAPI.com »
PHP >= 8.1
Ларавел >= 9.0
Если вы не используете Laravel, вы можете найти общий PHP-клиент SharpAPI здесь »
Выполните следующие действия, чтобы установить и настроить пакет клиента SharpAPI Laravel.
Установите пакет через composer :
композитору требуется Sharpapi/sharpapi-laravel-client
Зарегистрируйтесь на SharpAPI.com и получите ключ API.
Установите ключ API внутри .env
SHARP_API_KEY=ключ
[НЕОБЯЗАТЕЛЬНО] Опубликуйте файл конфигурации sharpapi-client.php .
Примечание. Чтобы использовать этот пакет, вам больше не нужно публиковать файл конфигурации. По умолчанию пакет будет использовать разумные значения по умолчанию. Вам нужно опубликовать конфигурацию только в том случае, если вы хотите ее настроить.
поставщик php artisan:publish --tag=sharpapi-laravel-client
? Электронная коммерция
Быстро создавайте привлекательные презентации продуктов для привлечения клиентов.
Автоматически создавайте персонализированные письма с благодарностью для повышения качества обслуживания клиентов.
Оптимизируйте категоризацию продуктов для хорошо организованного каталога.
Анализ настроений: Понимайте и анализируйте настроения в обзорах продуктов для принятия решений на основе данных.
️ Автоматизация контента и маркетинга
Легко переводите текст для глобальной аудитории.
Перефразируйте и вычитайте любой текст (включая проверку грамматики)
Обнаружение спам-контента: эффективно выявляйте и фильтруйте спам-контент.
Извлечение контактной информации: Извлекайте номера телефонов и адреса электронной почты из нестандартных форматов для оптимизации общения.
Создавайте краткие сводки и уникальные ключевые слова/теги для улучшения потребления контента.
Увеличьте усилия по SEO, автоматически генерируя МЕТА-теги на основе контента.
HR-технологии
Легко создавайте сложные описания вакансий, экономя время в процессе найма.
Навыки и информация о позициях: определите соответствующие должности и навыки для оптимизации набора персонала.
Автоматический анализ резюме: эффективно анализируйте и извлекайте информацию из файлов резюме для упрощения обработки.
Путешествия, туризм и гостиничный бизнес
Анализируйте настроения в обзорах путешествий, чтобы улучшить услуги.
Оптимизируйте категоризацию туров, мероприятий и продуктов гостеприимства.
Пожалуйста, обратитесь к официальному:
API-документация
Многоязычная поддержка : поддержка 80 языков для каждой конечной точки API анализа контента или данных. Проверьте список здесь.
Простой в использовании формат 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; используйте GuzzleHttpExceptionGuzzleException; используйте SharpAPISharpApiServiceSharpApiService; класс SharpTest расширяет контроллер {public function __construct (public SharpApiService $sharpApiService)
{
}/** * @throws GuzzleException */public functionDetect_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-запросы выполняются с помощью HTTP-клиента/Guzzle Laravel, поэтому рекомендуется ознакомиться с распространенными исключениями Guzzle.
используйте GuzzleHttpExceptionClientException;// Шаг 1: отправьте задание в API одним из методов, например: попробуйте {$statusUrl = SharpApiService::summarizeText($text, 'Немецкий', // необязательный язык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();// ..или массив PHP:$jobResultArray = $jobResult->getResultArray();// ..или 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 Enum, чтобы сделать ваш код более читабельным.
Анализирует файл резюме (CV) из нескольких форматов (PDF/DOC/DOCX/TXT/RTF) и возвращает обширный объект точек данных.
Также может быть предоставлен дополнительный параметр языка вывода (по умолчанию установлено English значение).
$statusUrl = SharpApiService::parseResume('/test/resume.pdf', 'Английский'); На основе списка расширенных параметров эта конечная точка предоставляет краткие сведения о задании в формате ответа, включая краткое описание, требования к должности и должностные обязанности. Единственный обязательный параметр — name .
Эта функция использует специализированный параметр класса DTO ( Data Transfer Object ) с именем JobDescriptionParameters , который помогает проверять входные параметры. Обязательным является только параметр name в конструкторе этого DTO .
Вы можете установить предпочитаемый стиль письма, указав параметр voice_tone. Это могут быть прилагательные типа funny или joyous , или даже имя известного писателя.
Этот метод API также предоставляет дополнительный параметр контекста, который можно использовать для предоставления дополнительных гибких инструкций по обработке контента.
$jobDescriptionParameters = новые JobDescriptionParameters(
имя: «Старший инженер PHP»,
название компании: "ACME LTD", // необязательный минимальный_опыт_работы: "5 лет", // необязательное минимальное_образование: "Степень бакалавра", // необязательный тип_работы: "полный рабочий день", // необязательные_навыки: ['PHP8', 'Laravel'], // optionoptional_skills: ['AWS', 'Redis'], // optioncountry: "Великобритания", // optionremote: true, // optionvisa_sponsored: true, // optionvoice_tone: 'Professional and Geeky', // необязательный голосовой тонcontext: null, // необязательный контекст, дополнительные инструкции по обработке AIlanguage: null // необязательный язык вывода
);$statusUrl = SharpApiService::generateJobDescription($jobDescriptionParameters);Создает список связанных навыков с их весами в виде плавающего значения (1,0–10,0), где 10 соответствует 100 %, наивысшему показателю релевантности.
Требуется только первый параметр ( name ).
Вы можете ограничить вывод с помощью параметра max_quantity .
$statusUrl = SharpApiService::relatedSkills('MySQL', 'English', // необязательный язык10 // необязательное количество
);Создает список связанных должностей с их весами в виде плавающего значения (1,0–10,0), где 10 соответствует 100 %, наивысшему показателю релевантности.
Требуется только первый параметр ( name ).
Вы можете ограничить вывод с помощью параметра max_quantity .
$statusUrl = SharpApiService::relatedJobPositions('Старший 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', // необязательный голосовой тон 'Игровая консоль, консоль PS5' // необязательный контекст, текущие категории для соответствия
);Создает сокращенную версию описания продукта. Предоставьте как можно больше деталей и параметров продукта, чтобы обеспечить наилучшее маркетинговое представление. Удобен при заполнении данных каталога продукции и обработке оптовых партий продукции.
Вы можете ограничить вывод с помощью параметра 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, // необязательная длина "Нейтральный", // необязательный голосовой тон "Необходимо пригласить клиента посетить еще раз перед праздниками" // необязательно контекст
); Переводит предоставленный текст на выбранный язык. Поддерживается 80 языков. Пожалуйста, проверьте включенный класс SharpApiLanguages Enum для получения подробной информации.
Вы можете установить предпочитаемый стиль письма, указав параметр voice_tone . Это могут быть прилагательные типа смешной или радостный, или даже имя известного писателя.
Также доступен необязательный параметр context . Его можно использовать для предоставления большего контекста переведенному тексту, например примера использования или некоторых дополнительных пояснений.
$statusUrl = SharpApiService::translate('turn', SharpApiLanguages::FRENCH, // необязательный язык 'нейтральный', // необязательный голосовой тон 'чтобы перевернуть страницу' // необязательный контекст
);// приведет к результату :// {"content": "tourner", "to_language": "French", "from_language": "English"} Создает перефразированную версию предоставленного текста. Обязателен только параметр content . Вы можете определить язык вывода, максимальную длину символов и тон голоса.
Дополнительные инструкции по обработке текста можно указать в параметре context. Имейте в виду, что max_length служит сильным предложением для языковой модели, а не строгим требованием для сохранения общего смысла результата.
Вы можете установить предпочитаемый стиль письма, указав дополнительный параметр voice_tone . Это могут быть прилагательные типа funny или joyous , или даже имя известного писателя.
Этот метод API также предоставляет дополнительный параметр context , который можно использовать для предоставления дополнительных гибких инструкций по обработке контента.
$statusUrl = SharpApiService::paraphrase($text, SharpApiLanguages::FRENCH, // необязательный язык500, // необязательная длина «нейтральный», // необязательный голосовой тон «избегать использования сокращений» // необязательный контекст
);Корректирует (и проверяет грамматику) предоставленный текст.
$statusUrl = SharpApiService::proofread($text);
Проверяет, проходит ли предоставленный контент тест на фильтрацию спама. Предоставляет процентную оценку достоверности и объяснение того, считается ли сообщение спамом или нет. Эта информация полезна модераторам для принятия окончательного решения.
$statusUrl = SharpApiService::detectSpam($text);
Анализирует предоставленный текст на предмет любых телефонных номеров и возвращает исходную обнаруженную версию и ее формат E.164. Может пригодиться в случае обработки и проверки больших объемов данных по телефонным номерам или, например, если вы хотите обнаружить телефонные номера в местах, где их не должно быть.
$statusUrl = SharpApiService::detectPhones($text);
Анализирует предоставленный текст на наличие возможных писем. Может пригодиться в случае обработки и проверки больших объемов данных по адресам электронной почты или, например, если вы хотите обнаруживать электронные письма там, где их не должно быть.
$statusUrl = SharpApiService::detectEmails($text);
Создает список уникальных ключевых слов/тегов на основе предоставленного контента.
Вы можете ограничить вывод с помощью параметра max_quantity .
Вы можете установить предпочитаемый стиль письма, указав параметр voice_tone .
$statusUrl = SharpApiService::generateKeywords($text, 'English', // необязательный язык5, // необязательная длина 'Freaky & Curious', // необязательный голосовой тон 'добавить смайлы!' // необязательные дополнительные контекстные инструкции для обработки контента );
Создает обобщенную версию предоставленного контента. Идеально подходит для создания маркетинговых вступлений к более длинным текстам.
Вы можете ограничить вывод с помощью параметра max_length . Имейте в виду, что max_length служит сильным предложением для языковой модели, а не строгим требованием для сохранения общего смысла результата.
Вы можете установить предпочитаемый стиль письма, указав параметр voice_ton e. Это могут быть прилагательные типа funny или joyous , или даже имя известного писателя.
$statusUrl = SharpApiService::summarizeText($text, 'English', // необязательный язык'Дэвид Аттенборо', // необязательный голосовой тон 'добавить смайлы!' // необязательные дополнительные контекстные инструкции для обработки контента );
Генерирует все наиболее важные МЕТА-теги на основе предоставленного контента. Обязательно укажите ссылку на веб-сайт и 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 大人専用''Токио', // необязательный город'Япония', // необязательная страна'Английский', // необязательный язык10, // необязательное количество'Adventurous', // необязательно голосовой тон 'Tokyo Hotels, Crystal Hotels' // необязательный контекст, текущие категории для соответствия
);Конечная точка для проверки сведений о текущем периоде подписки.
$statusUrl = SharpApiService::quota();
приведет к:
{"timestamp": "2024-03-19T12:49:41.445736Z","on_trial": false,"trial_ends": "2024-03-17T07:57:46.000000Z","subscribed": 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 и его внутренней временной зоны (временной метки).
$statusUrl = SharpApiService::ping();
приведет к:
{ "ping": "pong", "timestamp": "2024-03-12T08:50:11.188308Z"}Пожалуйста, сообщите нам об этом через GitHub »
или присоединяйтесь к нашей группе в Telegram »
Пожалуйста, посетите CHANGELOG для получения дополнительной информации о том, что изменилось за последнее время.
А2З ВЕБ, ООО
Давид Маковски
Расширьте свои возможности искусственного интеллекта в Laravel!
Лицензия MIT (MIT). Дополнительную информацию см. в файле лицензии.
Чтобы быть в курсе последних новостей, учебных пособий и тематических исследований, не забудьте подписаться на нас:
SharpAPI X (ранее Twitter)
SharpAPI YouTube
SharpAPI Вимео
SharpAPI LinkedIn
SharpAPI Facebook
