sharpapi php client
v1.2.0 release
Voir plus sur le site Web de Sharpapi.com »
Veuillez vous référer au fonctionnaire:
composer require sharpapi/sharpapi-php-clientInscrivez-vous sur Sharpapi.com et obtenez la clé API.
C'est ça!
$ 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 ());Le cas d'utilisation typique nécessite ces étapes:
fetchResults($statusUrl) qui fonctionne en mode d'interrogation, en envoyant sous les demandes toutes les 10 secondes pendant 180 secondes (ces valeurs peuvent être personnalisées, vérifiez le code source SharpApiService ).SharpApiJob sera retourné.success vous pouvez obtenir les résultats avec l'une des méthodes, par exemple $jobResultJson = $jobResult->getResultJson() .Chaque travail expédié prend généralement quelque part entre quelques secondes à une minute.
Après cette période, un travail retourné aura généralement un statut success et ses résultats seront disponibles pour un traitement ultérieur. Chaque méthode API renvoie un format de retour différent. Accédez à la liste des méthodes API / points de terminaison ci-dessous pour plus de détails »
Notre API garantit de retourner le format correct à chaque fois. Les moteurs IA que SharpAPI utilisent dans de rares cas ont tendance à mal se comporter et à délai ou à renvoyer des données incorrectes. Dans ces cas, le status retourné pour le travail sera failed . Vous pouvez relancer la même demande d'emploi exacte dans ce cas.
Tant que le travail est toujours traité par notre moteur, il continuera de retourner l'état pending .
Les demandes HTTP sous-jacentes sont alimentées avec Guzzle, c'est donc une bonne idée de vérifier les exceptions typiques de 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"
}
]
*/
}
} Chaque méthode renvoie toujours l'objet SharpApiJob , où ses méthodes getResultJson / getResultArray / getResultObject renverront différentes structures de données. Veuillez vous référer aux exemples détaillés fournis sur Sharpapi.com.
SharpApiLanguages pour rendre votre code plus lisible.Analyse un fichier de CV (CV) à partir de plusieurs formats (PDF / DOC / DOCX / TXT / RTF) et renvoie un vaste objet de points de données.
Un paramètre de langue de sortie facultatif peut également être fourni (la valeur English est définie par défaut).
$ statusUrl = SharpApiService:: parseResume ( ' /test/resume.pdf ' , ' English ' ); Sur la base de la liste des paramètres étendus, ce point final fournit des détails concis au format de réponse, y compris la description courte, les exigences du travail et les responsabilités professionnelles. Le seul paramètre obligatoire est name .
Cette fonctionnalité utilise un paramètre spécialisé de classe DTO ( Data Transfer Object ) nommé JobDescriptionParameters pour aider à la validation des paramètres d'entrée. Seul le paramètre name dans le constructeur de ce DTO est obligatoire.
Vous pouvez définir votre style d'écriture préféré en fournissant un paramètre Voice_tone. Il peut s'agir d'adjectifs comme funny ou joyous , ou même le nom d'un écrivain célèbre.
Cette méthode API fournit également un paramètre de contexte facultatif, qui peut être utilisé pour fournir des instructions flexibles supplémentaires pour le traitement du contenu.
$ 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 );Génère une liste de compétences connexes avec leurs poids en tant que valeur flottante (1.0-10.0) où 10 équivaut à 100%, le score le plus pertinent.
Seul le premier paramètre ( name ) est requis.
Vous pouvez limiter la sortie avec le paramètre max_quantity .
$ statusUrl = SharpApiService:: relatedSkills (
' MySQL ' ,
' English ' , // optional language
10 // optional quantity
);Génère une liste de postes de postes connexes avec leurs poids en tant que valeur flottante (1.0-10.0) où 10 équivaut à 100%, le score le plus pertinent.
Seul le premier paramètre ( name ) est requis.
Vous pouvez limiter la sortie avec le paramètre max_quantity .
$ statusUrl = SharpApiService:: relatedJobPositions (
' Senior PHP Engineer ' ,
' English ' , // optional language
10 // optional quantity
);Analyse l'examen des produits du client et fournit son sentiment (positif / négatif / neutre) avec un score entre 0 et 100%. Idéal pour le traitement des rapports de sentiment pour toute boutique en ligne.
$ statusUrl = SharpApiService:: productReviewSentiment ( ' customer review contents ' );Génère une liste de catégories appropriées pour le produit avec des poids de pertinence en tant que valeur flottante (1,0-10,0) où 10 équivaut à 100%, le score de pertinence le plus élevé. Fournissez le nom du produit et ses paramètres pour obtenir les meilleures correspondances de catégorie possibles. Est utile avec le remplissage des données du catalogue de produits et le traitement des produits en vrac.
Vous pouvez limiter la sortie avec le paramètre max_quantity .
Vous pouvez définir votre style d'écriture préféré en fournissant un paramètre voice_tone . Il peut s'agir d'adjectifs comme funny ou joyous , ou même le nom d'un écrivain célèbre.
Dans un contexte de paramètre facultatif supplémentaire, vous pouvez fournir une liste d'autres catégories qui seront prises en considération pendant le processus de cartographie (par exemple vos catégories de commerce électronique actuelles).
$ 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
);Génère une version plus courte de la description du produit. Fournissez autant de détails et de paramètres du produit pour obtenir la meilleure introduction marketing possible. Est utile avec le remplissage des données du catalogue de produits et le traitement des produits en vrac.
Vous pouvez limiter la sortie avec le paramètre max_length . Veuillez garder à l'esprit que max_length sert de suggestion forte pour le modèle de langue, plutôt que comme une exigence stricte, pour maintenir le sens général du résultat.
Vous pouvez définir votre style d'écriture préféré en fournissant un paramètre voice_tone . Il peut s'agir d'adjectifs comme funny ou joyous , ou même le nom d'un écrivain célèbre.
$ statusUrl = SharpApiService:: generateProductIntro (
' Sony Playstation 5 ' ,
SharpApiLanguages:: ENGLISH , // optional language
300 , // optional length
' Funny ' // optional voice tone
);Génère un e-mail de remerciement personnalisé au client après l'achat. Le contenu de réponse ne contient pas le titre, la salutation ou les informations de l'expéditeur à la fin, vous pouvez donc personnaliser facilement le reste de l'e-mail.
Vous pouvez limiter la sortie avec le paramètre max_length. Veuillez garder à l'esprit que max_length sert de suggestion forte pour le modèle de langue, plutôt que comme une exigence stricte, pour maintenir le sens général du résultat.
Vous pouvez définir votre style d'écriture préféré en fournissant un paramètre voice_tone . Il peut s'agir d'adjectifs comme drôle ou joyeux, ou même le nom d'un écrivain célèbre.
Cette méthode API fournit également un paramètre de contexte facultatif, qui peut être utilisé pour fournir des instructions flexibles supplémentaires pour le traitement du contenu.
$ 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
); Traduit du texte fourni à la langue sélectionnée. 80 langues sont prises en charge. Veuillez vérifier la classe Enumanguages SharpApiLanguages pour plus de détails.
Vous pouvez définir votre style d'écriture préféré en fournissant un paramètre voice_tone . Il peut s'agir d'adjectifs comme drôle ou joyeux, ou même le nom d'un écrivain célèbre.
Un paramètre context facultatif est également disponible. Il peut être utilisé pour fournir plus de contexte au texte traduit, comme l'exemple de cas d'utilisation ou quelques explications supplémentaires.
$ 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"} Génère une version paraphrasée du texte fourni. Seul le paramètre content est requis. Vous pouvez définir le langage de sortie, la longueur maximale du caractère et le ton de la voix.
Des instructions supplémentaires sur la façon de traiter le texte peuvent être fournies dans le paramètre de contexte. Veuillez garder à l'esprit que max_length sert de suggestion forte pour le modèle de langue, plutôt que comme une exigence stricte, pour maintenir le sens général du résultat.
Vous pouvez définir votre style d'écriture préféré en fournissant un paramètre voice_tone en option. Il peut s'agir d'adjectifs comme funny ou joyous , ou même le nom d'un écrivain célèbre.
Cette méthode API fournit également un paramètre context facultatif, qui peut être utilisé pour fournir des instructions flexibles supplémentaires pour le traitement du contenu.
$ statusUrl = SharpApiService:: paraphrase (
$ text ,
SharpApiLanguages:: FRENCH , // optional language
500 , // optional length
' neutral ' , // optional voice tone
' avoid using abbreviations ' // optional context
);Relies (et vérifie la grammaire) un texte fourni.
$ statusUrl = SharpApiService:: proofread ( $ text );Vérifie si le contenu fourni passe un test de filtration de spam. Fournit un score de confiance en pourcentage et une explication pour savoir s'il est considéré comme un spam ou non. Ces informations sont utiles pour que les modérateurs prennent une décision finale.
$ statusUrl = SharpApiService:: detectSpam ( $ text );Analyse le texte fourni pour tous les numéros de téléphone et renvoie la version détectée originale et son format E.164. Pourrait être utile dans le cas du traitement et de la validation des gros morceaux de données contre les numéros de téléphone ou FE si vous souhaitez détecter les numéros de téléphone dans des endroits où ils ne sont pas censés être.
$ statusUrl = SharpApiService:: detectPhones ( $ text );Analyse le texte fourni pour tout e-mail possible. Pourrait être utile en cas de traitement et de validation de gros morceaux de données contre les adresses e-mail ou FE si vous souhaitez détecter des e-mails dans des endroits où ils ne sont pas censés être.
$ statusUrl = SharpApiService:: detectEmails ( $ text );Génère une liste de mots clés / balises uniques basés sur le contenu fourni.
Vous pouvez limiter la sortie avec le paramètre max_quantity .
Vous pouvez définir votre style d'écriture préféré en fournissant un paramètre 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
);Génère une version résumée du contenu fourni. Parfait pour générer des introductions marketing de textes plus longs.
Vous pouvez limiter la sortie avec le paramètre max_length . Veuillez garder à l'esprit que max_length sert de suggestion forte pour le modèle de langue, plutôt que comme une exigence stricte, pour maintenir le sens général du résultat.
Vous pouvez définir votre style d'écriture préféré en fournissant un paramètre voice_ton E. Il peut s'agir d'adjectifs comme funny ou joyous , ou même le nom d'un écrivain célèbre.
$ statusUrl = SharpApiService:: summarizeText (
$ text ,
' English ' , // optional language
' David Attenborough ' , // optional voice tone
' add emojis! ' // optional extra context instructions for content processing
);Génère toutes les balises de méta les plus importantes en fonction du contenu fourni. Assurez-vous d'inclure un lien vers le site Web et l'URL des images pour obtenir autant de balises peuplées que possible.
Vous pouvez définir votre style d'écriture préféré en fournissant un paramètre voice_ton E. Il peut s'agir d'adjectifs comme funny ou joyous , ou même le nom d'un écrivain célèbre.
$ statusUrl = SharpApiService:: generateSeoTags (
$ text ,
' English ' , // optional language
' David Attenborough ' // optional voice tone
);Analyse l'examen des produits de voyage / hospitalité et fournit son sentiment (positif / négatif / neutre) avec un score entre 0 et 100%. Idéal pour le traitement des rapports de sentiment pour toute boutique en ligne.
$ statusUrl = SharpApiService:: travelReviewSentiment ( $ text ); Génère une liste de catégories appropriées pour le produit Tours & Activities avec des poids de pertinence en tant que valeur flottante (1.0-10.0) où 10 équivaut à 100%, le score de pertinence le plus élevé. Fournissez le nom du produit et ses paramètres pour obtenir les meilleures correspondances de catégorie possibles. Est utile avec le remplissage des données du catalogue de produits et le traitement des produits en vrac. Seul le premier paramètre productName est requis.
Vous pouvez limiter la sortie avec le paramètre max_quantity .
Vous pouvez définir votre style d'écriture préféré en fournissant un paramètre voice_tone . Il peut s'agir d'adjectifs comme funny ou joyous , ou même le nom d'un écrivain célèbre.
Dans un context de paramètre facultatif supplémentaire, vous pouvez fournir une liste d'autres catégories qui seront prises en considération pendant le processus de cartographie (par exemple vos catégories de commerce électronique actuelles).
$ 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
); Génère une liste de catégories appropriées pour le produit de type hospitalité avec des poids de pertinence en tant que valeur flottante (1,0-10,0) où 10 équivaut à 100%, le score de pertinence le plus élevé. Fournissez le nom du produit et ses paramètres pour obtenir les meilleures correspondances de catégorie possibles. Est utile avec les données de remplissage des produits de produits et le traitement des produits en vrac. Seul le premier paramètre productName est requis.
Vous pouvez limiter la sortie avec le paramètre max_quantity .
Vous pouvez définir votre style d'écriture préféré en fournissant un paramètre voice_tone . Il peut s'agir d'adjectifs comme funny ou joyous , ou même le nom d'un écrivain célèbre.
Dans un context de paramètre facultatif supplémentaire, vous pouvez fournir une liste d'autres catégories qui seront prises en considération pendant le processus de cartographie (par exemple vos catégories de commerce électronique actuelles).
$ 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
);Point de terminaison pour vérifier les détails concernant la période actuelle de l'abonnement
$ statusUrl = SharpApiService:: quota ();entraînera:
{
"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 est un pourcentage de l'utilisation du quota mensuelle actuelle et pourrait servir d'alerte à l'utilisateur des crédits épuisés. Avec une valeur supérieure à 80%, il est conseillé de souscrire à plus de crédits à https://sharpapi.com/dashboard/credits pour éviter les perturbations du service.
Ces valeurs sont également disponibles dans le tableau de bord à https://sharpapi.com/dashboard
Ping de ping simple pour vérifier la disponibilité de l'API et sa zone Timze interne (horodatage).
$ statusUrl = SharpApiService:: ping ();entraînera:
{
"ping" : " pong " ,
"timestamp" : " 2024-03-12T08:50:11.188308Z "
}Veuillez nous faire savoir "
Veuillez consulter Changelog pour plus d'informations sur ce qui a changé récemment.
La licence MIT (MIT). Veuillez consulter le fichier de licence pour plus d'informations.
