sharpapi php client
v1.2.0 release
Смотрите больше на веб -сайте Sharpapi.com »
Пожалуйста, обратитесь к чиновнику:
composer require sharpapi/sharpapi-php-clientЗарегистрируйтесь на Sharpapi.com и получите ключ API.
Вот и все!
$ sharpApi = new SharpAPI SharpApiService SharpApiService ( SHARP_API_KEY );
$ statusUrl = $ sharpApi -> productCategories (
' Lenovo Chromebook Laptop (2023), 14" FHD Touchscreen Slim 3,
8-Core MediaTek Kompanio 520 CPU, 4GB RAM, 128GB Storage ' ,
' German ' , // optional language
400 , // optional quantity
' optional neutral voice tone ' , // optional voice tone
' optional current e-store categories ' // optional context, current categories to match
);
$ resultSharpApiJob = $ sharpApi -> fetchResults ( $ statusUrl );
var_dump ( $ resultSharpApiJob -> getResultJson ());Типичный вариант использования требует этих шагов:
fetchResults($statusUrl) , который работает в режиме опроса, отправляя под запросы каждые 10 секунд в течение 180 секунд (эти значения можно настроить, проверьте исходный код SharpApiService ).SharpApiJob будет возвращен.success вы можете получить результаты с одним из методов, например, $jobResultJson = $jobResult->getResultJson() .Каждая отправленная работа обычно занимает от пары секунд до минуты.
После этого периода возвращаемая работа обычно имеет статус success , и ее результаты будут доступны для дальнейшей обработки. Каждый метод API возвращает различный формат возврата. Перейдите в список методов API/конечных точек ниже для получения подробной информации »
Наш API гарантирует возвращать правильный формат каждый раз. Двигатели искусственного интеллекта, которые используют Sharpapi в редких случаях, имеют тенденцию неправильно вести себя и возвращать неверные данные. В этих случаях возвращенный status для работы потерпит failed . В этом случае вы можете повторить тот же запрос на работу.
Пока работа все еще обрабатывается нашим двигателем, она будет продолжать pending статус.
Базовые HTTP -запросы оснащены Guzzle, так что рекомендуется проверить типичные исключения для Guzzle:
use GuzzleHttp Exception ClientException ;
// Step 1: dispatch the job to the API with one of the methods, for example:
try {
$ statusUrl = SharpApiService:: summarizeText (
$ text ,
' German ' // optional language
500 , // optional length
' neutral ' // optional voice tone
);
// $statusUrl example value: 'https://sharpapi.com/api/v1/job/status/75acb6dc-a975-4969-9ef1-c62cebc511cb'
} catch ( ClientException $ e ) {
$ e -> getResponse ()
}
// Step 2: request to check job status in polling mode and wait for the result
$ jobResult = SharpApiService:: fetchResults ( $ statusUrl );
// Step 3: get results of dispatched API job, f.e. this returns job result as a prettied JSON
$ jobResultJson = $ jobResult -> getResultJson ();
// ..or PHP array:
$ jobResultArray = $ jobResult -> getResultArray ();
// ..or PHP stdClass:
$ jobResultObject = $ jobResult -> getResultObject (); <?php
namespace App Http Controllers ;
use GuzzleHttp Exception GuzzleException ;
use SharpAPI SharpApiService SharpApiService ;
class SharpTest extends Controller
{
public function __construct ( public SharpApiService $ sharpApiService )
{
}
/**
* @throws GuzzleException
*/
public function detect_phones (): void
{
$ statusUrl = $ this -> sharpApiService -> detectPhones (
' Where to find us? Call with a sales tech advisor:
Call: 1800-394-7486 or our Singapore office +65 8888 8888 '
);
$ result = $ this -> sharpApiService -> fetchResults ( $ statusUrl );
dd ( $ result -> getResultJson ());
/* returned:
[
{
"detected_number": "1800-394-7486",
"parsed_number": "+18003947486"
},
{
"detected_number": "+65 8888 8888",
"parsed_number": "+6588888888"
}
]
*/
}
} Каждый метод всегда возвращает объект SharpApiJob , где его методы getResultJson / getResultArray / getResultObject возвращают различную структуру данных. Пожалуйста, обратитесь к подробным примерам, представленным на Sharpapi.com.
SharpApiLanguages , чтобы сделать ваш код более читабельным.Подготовки файл резюме (CV) из нескольких форматов (PDF/DOC/DOCX/TXT/RTF) и возвращает обширный объект точек данных.
Необходимый параметр языка вывода также может быть предоставлен (значение English установлено в качестве по умолчанию).
$ statusUrl = SharpApiService:: parseResume ( ' /test/resume.pdf ' , ' English ' ); На основании списка обширных параметров эта конечная точка содержит краткие данные о работе в формате ответа, включая краткое описание, требования к работе и обязанности по работе. Единственный обязательный параметр - это name .
Эта функциональность использует параметр специализированного класса DTO ( Data Transfer Object ) с именем JobDescriptionParameters для помощи в проверке входных параметров. Только параметр name в конструкторе этого DTO является обязательным.
Вы можете установить свой предпочтительный стиль письма, предоставив параметр Voice_tone. Это могут быть прилагательные, такие как funny или joyous , или даже имя известного писателя.
Этот метод API также предоставляет дополнительный параметр контекста, который можно использовать для предоставления дополнительных гибких инструкций для обработки контента.
$ jobDescriptionParameters = new JobDescriptionParameters (
name: " PHP Senior Engineer " ,
company_name: " ACME LTD " , // optional
minimum_work_experience: " 5 years " , // optional
minimum_education: " Bachelor Degree " , // optional
employment_type: " full time " , // optional
required_skills: [ ' PHP8 ' , ' Laravel ' ], // optional
optional_skills: [ ' AWS ' , ' Redis ' ], // optional
country: " United Kingdom " , // optional
remote: true , // optional
visa_sponsored: true , // optional
voice_tone: ' Professional and Geeky ' , // optional voice tone
context: null , // optional context, additional AI processing instructions
language: null // optional output language
);
$ statusUrl = SharpApiService:: generateJobDescription ( $ jobDescriptionParameters );Генерирует список связанных навыков с их весами в качестве значения поплавки (1,0-10,0), где 10 равны 100%, что является наивысшей оценкой актуальности.
Требуется только первый параметр ( name ).
Вы можете ограничить вывод параметром max_quantity .
$ statusUrl = SharpApiService:: relatedSkills (
' MySQL ' ,
' English ' , // optional language
10 // optional quantity
);Генерирует список связанных рабочих мест с их весами в качестве значения поплавки (1,0-10,0), где 10 равны 100%, что является наивысшей оценкой актуальности.
Требуется только первый параметр ( name ).
Вы можете ограничить вывод параметром max_quantity .
$ statusUrl = SharpApiService:: relatedJobPositions (
' Senior PHP Engineer ' ,
' English ' , // optional language
10 // optional quantity
);Подготовки к обзору продукта клиента и обеспечивают его настроение (положительное/отрицательное/нейтральное) со счетом между 0-100%. Отлично подходит для обработки отчетов настроений для любого интернет -магазина.
$ statusUrl = SharpApiService:: productReviewSentiment ( ' customer review contents ' );Генерирует список подходящих категорий для продукта с весами релевантности в качестве плавающего значения (1,0-10,0), где 10 равны 100%, что является наивысшей оценкой актуальности. Предоставьте название продукта и его параметры, чтобы получить наилучшие категории. Пригодится с помощью данных каталога продуктов и обработки объемных продуктов.
Вы можете ограничить вывод параметром max_quantity .
Вы можете установить свой предпочтительный стиль письма, предоставив параметр voice_tone . Это могут быть прилагательные, такие как funny или joyous , или даже имя известного писателя.
В дополнительном дополнительном контексте параметров вы можете предоставить список других категорий, которые будут учитываться в процессе отображения (например, ваши текущие категории электронной коммерции).
$ statusUrl = SharpApiService:: productCategories (
' Sony Playstation 5 ' ,
' English ' , // optional language
5 , // optional quantity
' Tech-savvy ' , // optional voice tone
' Game Console, PS5 Console ' // optional context, current categories to match
);Генерирует более короткую версию описания продукта. Предоставьте как можно больше деталей и параметров продукта, чтобы получить наилучшее введение маркетинга. Пригодится с помощью данных по каталогу заполненных продуктов и обработки объемных продуктов.
Вы можете ограничить выходной сигнал параметром max_length . Пожалуйста, имейте в виду, что max_length служит сильным предложением для языковой модели, а не строгого требования, поддерживать общее чувство результата.
Вы можете установить свой предпочтительный стиль письма, предоставив параметр voice_tone . Это могут быть прилагательные, такие как funny или joyous , или даже имя известного писателя.
$ statusUrl = SharpApiService:: generateProductIntro (
' Sony Playstation 5 ' ,
SharpApiLanguages:: ENGLISH , // optional language
300 , // optional length
' Funny ' // optional voice tone
);Генерирует персонализированное благодарственное письмо клиенту после покупки. Содержимое ответа не содержит заголовок, приветствия или информации отправителя в конце, поэтому вы можете легко персонализировать остальную часть электронной почты.
Вы можете ограничить выходной сигнал параметром MAX_LENGHT. Пожалуйста, имейте в виду, что max_length служит сильным предложением для языковой модели, а не строгого требования, поддерживать общее чувство результата.
Вы можете установить свой предпочтительный стиль письма, предоставив параметр voice_tone . Это могут быть прилагательные, такие как смешные или радостные, или даже имя известного писателя.
Этот метод API также предоставляет дополнительный параметр контекста, который можно использовать для предоставления дополнительных гибких инструкций для обработки контента.
$ statusUrl = SharpApiService:: generateThankYouEmail (
' Sony Playstation 5 ' ,
SharpApiLanguages:: ENGLISH , // optional language
250 , // optional length
' Neutral ' , // optional voice tone
' Must invite customer to visit again before Holidays ' // optional context
); Переводит предоставленный текст на выбранную формулировку. 80 языков поддерживаются. Пожалуйста, проверьте включены класс SharpApiLanguages Enum для получения подробной информации.
Вы можете установить свой предпочтительный стиль письма, предоставив параметр voice_tone . Это могут быть прилагательные, такие как смешные или радостные, или даже имя известного писателя.
Необязательный параметр context также доступен. Он может быть использован для обеспечения большего контекста для переведенного текста, например, пример варианта использования или некоторые дополнительные объяснения.
$ statusUrl = SharpApiService:: translate (
' turn ' ,
SharpApiLanguages:: FRENCH , // optional language
' neutral ' , // optional voice tone
' to turn a page ' // optional context
);
// will result in :
// {"content": "tourner", "to_language": "French", "from_language": "English"} Генерирует перефразированную версию предоставленного текста. Требуется только параметр content . Вы можете определить язык вывода, максимальную длину символа и тон голоса.
Дополнительные инструкции о том, как обработать текст, могут быть предоставлены в параметре контекста. Пожалуйста, имейте в виду, что max_length служит сильным предложением для языковой модели, а не строгого требования, поддерживать общее чувство результата.
Вы можете установить свой предпочтительный стиль письма, предоставив дополнительный параметр voice_tone . Это могут быть прилагательные, такие как funny или joyous , или даже имя известного писателя.
Этот метод API также предоставляет дополнительный параметр context , который можно использовать для предоставления дополнительных гибких инструкций для обработки контента.
$ statusUrl = SharpApiService:: paraphrase (
$ text ,
SharpApiLanguages:: FRENCH , // optional language
500 , // optional length
' neutral ' , // optional voice tone
' avoid using abbreviations ' // optional context
);Корретат (и проверяет грамматику) предоставленный текст.
$ statusUrl = SharpApiService:: proofread ( $ text );Проверки, если предоставлено содержание, проходит тест на спам -фильтрационный тест. Обеспечивает процентный показатель доверия и объяснение того, считается ли он спамом или нет. Эта информация полезна для модераторов, чтобы принять окончательное решение.
$ statusUrl = SharpApiService:: detectSpam ( $ text );Диаграммы предоставленный текст для любых телефонов и возвращает исходную обнаруженную версию и его формат E.164. Может пригодиться в случае обработки и проверки больших кусков данных против телефонов или Fe, если вы хотите обнаружить номера телефонов в местах, где они не должны быть.
$ statusUrl = SharpApiService:: detectPhones ( $ text );Подготовки предоставленный текст для любых возможных электронных писем. Может пригодиться в случае обработки и проверки больших кусков данных по адресам электронной почты или Fe, если вы хотите обнаружить электронные письма в местах, где они не должны быть.
$ statusUrl = SharpApiService:: detectEmails ( $ text );Генерирует список уникальных ключевых слов/тегов на основе предоставленного контента.
Вы можете ограничить вывод параметром max_quantity .
Вы можете установить свой предпочтительный стиль письма, предоставив параметр voice_tone .
$ statusUrl = SharpApiService:: generateKeywords (
$ text ,
' English ' , // optional language
5 , // optional length
' Freaky & Curious ' , // optional voice tone
' add emojis! ' // optional extra context instructions for content processing
);Генерирует суммированную версию предоставленного контента. Идеально подходит для создания маркетинговых внедрений более длинных текстов.
Вы можете ограничить выходной сигнал параметром max_length . Пожалуйста, имейте в виду, что max_length служит сильным предложением для языковой модели, а не строгого требования, поддерживать общее чувство результата.
Вы можете установить свой предпочтительный стиль письма, предоставив параметр voice_ton E. Это могут быть прилагательные, такие как funny или joyous , или даже имя известного писателя.
$ statusUrl = SharpApiService:: summarizeText (
$ text ,
' English ' , // optional language
' David Attenborough ' , // optional voice tone
' add emojis! ' // optional extra context instructions for content processing
);Генерирует все наиболее важные метатеги на основе предоставленного контента. Обязательно включите ссылку на URL -адрес веб -сайта и картинки, чтобы получить как можно больше тегов.
Вы можете установить свой предпочтительный стиль письма, предоставив параметр voice_ton E. Это могут быть прилагательные, такие как funny или joyous , или даже имя известного писателя.
$ statusUrl = SharpApiService:: generateSeoTags (
$ text ,
' English ' , // optional language
' David Attenborough ' // optional voice tone
);Подготовки к обзору продукта Travel/Hospitality и обеспечивают свои настроения (положительный/отрицательный/нейтральный) с оценкой от 0 до 1,00%. Отлично подходит для обработки отчетов настроений для любого интернет -магазина.
$ statusUrl = SharpApiService:: travelReviewSentiment ( $ text ); Генерирует список подходящих категорий для продукта туров и мероприятий с весами с релевантностью как значение для поплавки (1,0-10,0), где 10 равны 100%, что является наивысшей оценкой актуальности. Предоставьте название продукта и его параметры, чтобы получить наилучшие категории. Пригодится с помощью данных каталога продуктов и обработки продуктов. Требуется только productName первого параметра.
Вы можете ограничить вывод параметром max_quantity .
Вы можете установить свой предпочтительный стиль письма, предоставив параметр voice_tone . Это могут быть прилагательные, такие как funny или joyous , или даже имя известного писателя.
В дополнительном дополнительном context параметров вы можете предоставить список других категорий, которые будут учитываться в процессе отображения (например, ваши текущие категории электронной коммерции).
$ statusUrl = SharpApiService:: toursAndActivitiesProductCategories (
' Oasis of the Bay '
'Ha Long', // optional city
' Vietnam ' , // optional country
' English ' , // optional language
10 , // optional quantity
' Adventurous ' , // optional voice tone
' Bay Hotels, Ha Long Hotels ' // optional context, current categories to match
); Генерирует список подходящих категорий для продукта типа гостеприимства с весами релевантности как значение поплавки (1,0-10,0), где 10 равны 100%, что является наивысшей оценкой релевантности. Предоставьте название продукта и его параметры, чтобы получить наилучшие категории. Пригодится в каталогах заполняющих продуктов и обработки объемных продуктов. Требуется только productName первого параметра.
Вы можете ограничить вывод параметром max_quantity .
Вы можете установить свой предпочтительный стиль письма, предоставив параметр voice_tone . Это могут быть прилагательные, такие как funny или joyous , или даже имя известного писателя.
В дополнительном дополнительном context параметров вы можете предоставить список других категорий, которые будут учитываться в процессе отображения (например, ваши текущие категории электронной коммерции).
$ statusUrl = SharpApiService:: hospitalityProductCategories (
' Hotel Crystal 大人専用'
'Tokyo', // optional city
' Japan ' , // optional country
' English ' , // optional language
10 , // optional quantity
' Adventurous ' , // optional voice tone
' Tokyo Hotels, Crystal Hotels ' // optional context, current categories to match
);Конечная точка, чтобы проверить подробности о текущем периоде подписки
$ 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 и внутренней зоны TIMZE (TimeStamp).
$ statusUrl = SharpApiService:: ping ();приведет к:
{
"ping" : " pong " ,
"timestamp" : " 2024-03-12T08:50:11.188308Z "
}Пожалуйста, дайте нам знать »
Пожалуйста, смотрите ChangeLog для получения дополнительной информации о том, что изменилось в последнее время.
Лицензия MIT (MIT). Пожалуйста, смотрите файл лицензии для получения дополнительной информации.
