sharpapi php client
v1.2.0 release
Veja mais no site de Sharpapi.com »
Por favor, consulte o funcionário:
composer require sharpapi/sharpapi-php-clientRegistre -se em SharpApi.com e obtenha a chave da API.
É isso!
$ 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 ());O caso de uso típico requer estas etapas:
fetchResults($statusUrl) que opera no modo de votação, enviando solicitações abaixo de 10 segundos por 180 segundos (esses valores podem ser personalizados, verifique o código -fonte SharpApiService ).SharpApiJob será devolvido.success você pode obter os resultados com um dos métodos, por exemplo $jobResultJson = $jobResult->getResultJson() .Cada trabalho despachado geralmente leva entre alguns segundos a um minuto.
Após esse período, um trabalho devolvido geralmente terá status success e seus resultados estarão disponíveis para processamento adicional. Cada método da API retorna diferentes formatos de retorno. Vá para a lista de métodos/pontos de extremidade da API abaixo para obter detalhes »
Nossa API garante retornar o formato correto todas as vezes. Os motores da IA que o uso de SharpApi em casos raros tendem a se comportar mal e no tempo limite ou retornar dados incorretos. Nesses casos, o status retornado do trabalho será failed . Você pode executar novamente a mesma solicitação de emprego nesse caso.
Enquanto o trabalho ainda estiver sendo processado pelo nosso mecanismo, ele continuará retornando o status pending .
As solicitações HTTP subjacentes são alimentadas com o Buzzle, por isso é uma boa ideia verificar as exceções típicas do 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"
}
]
*/
}
} Cada método sempre retorna o objeto SharpApiJob , onde seus métodos getResultJson / getResultArray / getResultObject retornarão diferentes estrutura de dados. Consulte os exemplos detalhados fornecidos em SharpApi.com.
SharpApiLanguages para tornar seu código mais legível.Paresia um arquivo de currículo (CV) de vários formatos (pdf/doc/docx/txt/rtf) e retorna um extenso objeto de pontos de dados.
Um parâmetro opcional de linguagem de saída também pode ser fornecido (o valor English é definido como o padrão).
$ statusUrl = SharpApiService:: parseResume ( ' /test/resume.pdf ' , ' English ' ); Com base na lista de parâmetros extensos, esse terminal fornece detalhes concisos no formato de resposta, incluindo a descrição curta, os requisitos do trabalho e as responsabilidades do trabalho. O único parâmetro obrigatório é name .
Essa funcionalidade utiliza um parâmetro especializado em classe DTO ( Data Transfer Object ) nomeado JobDescriptionParameters para ajudar na validação dos parâmetros de entrada. Somente o parâmetro name no construtor deste DTO é obrigatório.
Você pode definir seu estilo de escrita preferido, fornecendo um parâmetro voz_tone. Pode ser adjetivos como funny ou joyous , ou mesmo o nome de um escritor famoso.
Esse método da API também fornece um parâmetro de contexto opcional, que pode ser usado para fornecer instruções flexíveis adicionais para o processamento de conteúdo.
$ 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 );Gera uma lista de habilidades relacionadas com seus pesos como um valor de flutuação (1,0-10.0), onde 10 é igual a 100%, a maior pontuação de relevância.
Somente o primeiro parâmetro ( name ) é necessário.
Você pode limitar a saída com o parâmetro max_quantity .
$ statusUrl = SharpApiService:: relatedSkills (
' MySQL ' ,
' English ' , // optional language
10 // optional quantity
);Gera uma lista de posições de trabalho relacionadas com seus pesos como valor de flutuação (1,0-10.0), onde 10 é igual a 100%, a maior pontuação de relevância.
Somente o primeiro parâmetro ( name ) é necessário.
Você pode limitar a saída com o parâmetro max_quantity .
$ statusUrl = SharpApiService:: relatedJobPositions (
' Senior PHP Engineer ' ,
' English ' , // optional language
10 // optional quantity
);Analisa a revisão do produto do cliente e fornece seu sentimento (positivo/negativo/neutro) com uma pontuação entre 0-100%. Ótimo para processamento de relatórios de sentimentos para qualquer loja on -line.
$ statusUrl = SharpApiService:: productReviewSentiment ( ' customer review contents ' );Gera uma lista de categorias adequadas para o produto com pesos relevantes como um valor de flutuação (1,0-10.0), onde 10 é igual a 100%, a maior pontuação de relevância. Forneça o nome do produto e seus parâmetros para obter as melhores correspondências de categoria possíveis. É útil com a população de dados de catálogo de produtos e processamento de produtos em massa.
Você pode limitar a saída com o parâmetro max_quantity .
Você pode definir seu estilo de escrita preferido, fornecendo um parâmetro voice_tone . Pode ser adjetivos como funny ou joyous , ou mesmo o nome de um escritor famoso.
Dentro de um contexto de parâmetro opcional adicional, você pode fornecer uma lista de outras categorias que serão levadas em consideração durante o processo de mapeamento (por exemplo, suas categorias atuais de comércio eletrônico).
$ 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
);Gera uma versão mais curta da descrição do produto. Forneça tantos detalhes e parâmetros do produto para obter a melhor introdução de marketing possível. É útil com a população de dados do catálogo de produtos e processamento de produtos a granel.
Você pode limitar a saída com o parâmetro max_length . Lembre -se de que max_length serve como uma forte sugestão para o modelo de idioma, em vez de um requisito rigoroso, para manter o sentido geral do resultado.
Você pode definir seu estilo de escrita preferido, fornecendo um parâmetro voice_tone . Pode ser adjetivos como funny ou joyous , ou mesmo o nome de um escritor famoso.
$ statusUrl = SharpApiService:: generateProductIntro (
' Sony Playstation 5 ' ,
SharpApiLanguages:: ENGLISH , // optional language
300 , // optional length
' Funny ' // optional voice tone
);Gera um e-mail de agradecimento personalizado para o cliente após a compra. O conteúdo da resposta não contém o título, a saudação ou as informações do remetente no final, para que você possa personalizar o restante do email facilmente.
Você pode limitar a saída com o parâmetro max_length. Lembre -se de que max_length serve como uma forte sugestão para o modelo de idioma, em vez de um requisito rigoroso, para manter o sentido geral do resultado.
Você pode definir seu estilo de escrita preferido, fornecendo um parâmetro voice_tone . Pode ser adjetivos como engraçado ou alegre, ou mesmo o nome de um escritor famoso.
Esse método da API também fornece um parâmetro de contexto opcional, que pode ser usado para fornecer instruções flexíveis adicionais para o processamento de conteúdo.
$ 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
); Traduz texto fornecido para o idioma selecionado. 80 idiomas são suportados. Verifique a aula de enum SharpApiLanguages incluído para obter detalhes.
Você pode definir seu estilo de escrita preferido, fornecendo um parâmetro voice_tone . Pode ser adjetivos como engraçado ou alegre, ou mesmo o nome de um escritor famoso.
Um parâmetro context opcional também está disponível. Ele pode ser usado para fornecer mais contexto ao texto traduzido, como o exemplo de caso de uso ou algumas explicações adicionais.
$ 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"} Gera uma versão parafraseada do texto fornecido. Somente o parâmetro content é necessário. Você pode definir o idioma de saída, o comprimento máximo do caractere e o tom da voz.
Instruções adicionais sobre como processar o texto pode ser fornecido no parâmetro de contexto. Lembre -se de que max_length serve como uma forte sugestão para o modelo de idioma, em vez de um requisito rigoroso, para manter o sentido geral do resultado.
Você pode definir seu estilo de escrita preferido, fornecendo um parâmetro opcional voice_tone . Pode ser adjetivos como funny ou joyous , ou mesmo o nome de um escritor famoso.
Esse método da API também fornece um parâmetro context opcional, que pode ser usado para fornecer instruções flexíveis adicionais para o processamento de conteúdo.
$ statusUrl = SharpApiService:: paraphrase (
$ text ,
SharpApiLanguages:: FRENCH , // optional language
500 , // optional length
' neutral ' , // optional voice tone
' avoid using abbreviations ' // optional context
);Revisões (e verifica a gramática) um texto fornecido.
$ statusUrl = SharpApiService:: proofread ( $ text );Verifica se o conteúdo fornecido passa um teste de filtragem de spam. Fornece uma pontuação percentual de confiança e uma explicação para se é considerada spam ou não. Esta informação é útil para os moderadores tomarem uma decisão final.
$ statusUrl = SharpApiService:: detectSpam ( $ text );Analisa o texto fornecido para qualquer número de telefone e retorna a versão detectada original e seu formato E.164. Pode ser útil no caso de processamento e validação de grandes pedaços de dados contra números de telefone ou Fe, se você deseja detectar números de telefone em locais onde não deveriam estar.
$ statusUrl = SharpApiService:: detectPhones ( $ text );Analisa o texto fornecido para possíveis e -mails. Pode ser útil em caso de processamento e validação de grandes pedaços de dados contra endereços de email ou Fe, se você quiser detectar e -mails em locais onde não deveriam estar.
$ statusUrl = SharpApiService:: detectEmails ( $ text );Gera uma lista de palavras -chave/tags exclusivas com base no conteúdo fornecido.
Você pode limitar a saída com o parâmetro max_quantity .
Você pode definir seu estilo de escrita preferido, fornecendo um parâmetro 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
);Gera uma versão resumida do conteúdo fornecido. Perfeito para gerar introduções de marketing de textos mais longos.
Você pode limitar a saída com o parâmetro max_length . Lembre -se de que max_length serve como uma forte sugestão para o modelo de idioma, em vez de um requisito rigoroso, para manter o sentido geral do resultado.
Você pode definir seu estilo de escrita preferido, fornecendo um parâmetro voice_ton E. Pode ser adjetivos como funny ou joyous , ou mesmo o nome de um escritor famoso.
$ statusUrl = SharpApiService:: summarizeText (
$ text ,
' English ' , // optional language
' David Attenborough ' , // optional voice tone
' add emojis! ' // optional extra context instructions for content processing
);Gera todas as metatags mais importantes com base no conteúdo fornecido. Certifique -se de incluir o link para o URL do site e fotos para obter o maior número possível de tags.
Você pode definir seu estilo de escrita preferido, fornecendo um parâmetro voice_ton E. Pode ser adjetivos como funny ou joyous , ou mesmo o nome de um escritor famoso.
$ statusUrl = SharpApiService:: generateSeoTags (
$ text ,
' English ' , // optional language
' David Attenborough ' // optional voice tone
);Paresi a revisão de produtos de viagem/hospitalidade e fornece seu sentimento (positivo/negativo/neutro) com uma pontuação entre 0-100%. Ótimo para processamento de relatórios de sentimentos para qualquer loja on -line.
$ statusUrl = SharpApiService:: travelReviewSentiment ( $ text ); Gera uma lista de categorias adequadas para o produto Tours & Activities com pesos relevantes como valor de flutuação (1,0-10.0), onde 10 é igual a 100%, a maior pontuação de relevância. Forneça o nome do produto e seus parâmetros para obter as melhores correspondências de categoria possíveis. É útil com os dados do catálogo de produtos preenchidos e o processamento de produtos a granel. Somente productName do primeiro parâmetro é necessário.
Você pode limitar a saída com o parâmetro max_quantity .
Você pode definir seu estilo de escrita preferido, fornecendo um parâmetro voice_tone . Pode ser adjetivos como funny ou joyous , ou mesmo o nome de um escritor famoso.
Dentro de um context de parâmetro opcional adicional, você pode fornecer uma lista de outras categorias que serão levadas em consideração durante o processo de mapeamento (por exemplo, suas categorias atuais de comércio eletrônico).
$ 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
); Gera uma lista de categorias adequadas para o produto do tipo hospitalidade com pesos de relevância como valor de flutuação (1,0-10.0), onde 10 é igual a 100%, a maior pontuação de relevância. Forneça o nome do produto e seus parâmetros para obter as melhores correspondências de categoria possíveis. É útil com os produtos de população catalogos de dados e processamento de produtos a granel. Somente productName do primeiro parâmetro é necessário.
Você pode limitar a saída com o parâmetro max_quantity .
Você pode definir seu estilo de escrita preferido, fornecendo um parâmetro voice_tone . Pode ser adjetivos como funny ou joyous , ou mesmo o nome de um escritor famoso.
Dentro de um context de parâmetro opcional adicional, você pode fornecer uma lista de outras categorias que serão levadas em consideração durante o processo de mapeamento (por exemplo, suas categorias atuais de comércio eletrônico).
$ 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
);Endpoint para verificar os detalhes sobre o período atual da assinatura
$ statusUrl = SharpApiService:: quota ();resultará em:
{
"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 é uma porcentagem do uso mensal atual da cota e pode servir como um alerta ao usuário dos créditos esgotados. Com um valor acima de 80%, é aconselhável assinar mais créditos em https://sharpapi.com/dashboard/credits para evitar a interrupção do serviço.
Esses valores também estão disponíveis no painel em https://sharpapi.com/dashboard
Endpoint simples de ping para verificar a disponibilidade da API e sua zona de Timze interna (registro de data e hora).
$ statusUrl = SharpApiService:: ping ();resultará em:
{
"ping" : " pong " ,
"timestamp" : " 2024-03-12T08:50:11.188308Z "
}Por favor, informe -nos »
Consulte Changelog para obter mais informações sobre o que mudou recentemente.
A licença do MIT (MIT). Consulte o arquivo de licença para obter mais informações.
