sharpapi laravel client
v1.2.2
Pour en savoir plus, visitez le site Web SharpAPI.com »
PHP >= 8.1
Laravel >= 9.0
Si vous n'utilisez pas Laravel, vous pouvez trouver le client PHP générique SharpAPI ici »
Suivez ces étapes pour installer et configurer le package client SharpAPI Laravel.
Installez le package via composer :
le compositeur nécessite Sharpapi/sharpapi-laravel-client
Inscrivez-vous sur SharpAPI.com et obtenez la clé API.
Définir la clé API dans .env
SHARP_API_KEY=clé
[OPTIONNEL] Publiez le fichier de configuration sharpapi-client.php .
Remarque : Vous n'avez plus besoin de publier le fichier de configuration pour utiliser ce package. Par défaut, le package utilisera des valeurs par défaut raisonnables. Il vous suffit de publier la configuration si vous souhaitez la personnaliser.
fournisseur artisanal php :publish --tag=sharpapi-laravel-client
? Commerce électronique
Générez rapidement des présentations de produits attrayantes pour attirer les clients.
Créez automatiquement des e-mails de remerciement personnalisés pour une expérience client améliorée.
Rationalisez la catégorisation des produits pour un catalogue bien organisé.
Analyse des sentiments : comprenez et analysez les sentiments dans les avis sur les produits pour une prise de décision basée sur les données.
️ Automatisation du contenu et du marketing
Traduisez facilement du texte pour un public mondial.
Paraphraser et relire n’importe quel texte (y compris la vérification grammaticale)
Détection du contenu spam : identifiez et filtrez efficacement le contenu spam.
Extraction des informations de contact : extrayez les numéros de téléphone et les adresses e-mail à partir de formats non standard pour une communication rationalisée.
Générez des résumés concis et des mots-clés/balises uniques pour une meilleure consommation de contenu.
Boostez vos efforts de référencement en générant automatiquement des balises META basées sur le contenu.
Technologie RH
Générez facilement des descriptions de poste complexes, gagnant ainsi du temps dans le processus de recrutement.
Compétences et informations sur les postes : identifiez les postes et les compétences connexes pour rationaliser le recrutement.
Analyse automatisée des CV : analysez et extrayez efficacement les informations des fichiers de CV pour un traitement facile.
Voyages, tourisme et hôtellerie
Analysez les sentiments dans les avis de voyage pour améliorer les services.
Rationalisez la catégorisation des visites, des activités et des produits d’accueil.
Veuillez vous référer au responsable :
Documentation API
Prise en charge multilingue : prise en charge de 80 langues pour chaque point de terminaison de l'API d'analyse de contenu ou de données. Consultez la liste ici.
Format RESTful facile à utiliser : avec un ensemble standardisé de points de terminaison - obtenez des informations précieuses grâce aux points de terminaison d'analyse, couvrant les catégories de produits, les compétences et les postes, en fournissant des scores pertinents.
Formats de données toujours identiques et propres : soyez assuré d'un format JSON cohérent et prévisible pour toutes les données renvoyées. Pas besoin de vous soucier des données floues de l'IA.
Support technique : conçu par des développeurs pour des développeurs, nous vous fournissons une assistance continue tout au long de votre parcours.
Vous pouvez injecter la classe SharpApiService ou utiliser le singleton de façade SharpApiService .
Nous vous recommandons d'utiliser le système de file d'attente Laravel pour optimiser les tâches distribuées et le processus de vérification des résultats, surtout si vous traitez de plus gros lots de données.
Un cas d'utilisation typique nécessite ces étapes :
Envoyez l'une des méthodes de traitement de l'IA disponibles (cela renverra l'URL de l'état de traitement du travail)
Exécutez la méthode fetchResults($statusUrl) qui fonctionne en mode d'interrogation, envoyant des requêtes ci-dessous toutes les 10 secondes pendant 180 secondes (ces valeurs peuvent être personnalisées).
L'objet SharpApiJob sera renvoyé.
Pour un travail terminé avec un statut de retour success , vous pouvez obtenir les résultats avec l'une des méthodes, par exemple $jobResultJson = $jobResult->getResultJson() .
Chaque tâche envoyée prend généralement entre quelques secondes et une minute.
Après cette période, une tâche renvoyée aura généralement le 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/points de terminaison API ci-dessous pour plus de détails »
Notre API garantit de renvoyer le format correct à chaque fois. Les moteurs d'IA que SharpAPI utilise dans de rares cas ont tendance à se comporter mal et à expirer ou à renvoyer des données incorrectes. Dans ces cas-là, le status renvoyé pour le travail sera failed . Dans ce cas, vous pouvez réexécuter exactement la même demande de travail.
Tant que le travail est toujours en cours de traitement par notre moteur, il continuera à renvoyer le statut pending .
<?phpnamespace AppHttpControllers;use GuzzleHttpExceptionGuzzleException;use SharpAPISharpApiServiceSharpApiService;class SharpTest extends Controller{fonction publique __construct(public SharpApiService $sharpApiService)
{
}/** * @throws GuzzleException */public function detector_phones(): void{$statusUrl = $this->sharpApiService->detectPhones('Où nous trouver ? Appelez un conseiller technique commercial : Appelez : 1800-394-7486 ou notre bureau de Singapour +65 8888 8888'); $result = $this->sharpApiService->fetchResults($statusUrl); dd($result->getResultJson());/* renvoyé : [ { "numéro_détecté": "1800-394-7486", "numéro_parsé": "+18003947486" }, { "numéro_détecté": "+65 8888 8888" , "parsed_number": "+6588888888" } ] */}
}Les requêtes HTTP sous-jacentes sont facilitées par Laravel HTTP Client/Guzzle, il est donc conseillé de vous familiariser avec les exceptions Guzzle courantes.
utilisez GuzzleHttpExceptionClientException ;// Étape 1 : envoyez le travail à l'API avec l'une des méthodes, par exemple : essayez {$statusUrl = SharpApiService::summarizeText($text, 'Allemand', // langue facultative500, // longueur facultative' tonalité vocale neutre' // tonalité vocale facultative
);// Exemple de valeur $statusUrl : 'http://sharpapi.com/api/v1/job/status/75acb6dc-a975-4969-9ef1-c62cebc511cb'} catch (ClientException $e) { $e->getResponse( )
}// Étape 2 : demande de vérification de l'état du travail en mode d'interrogation et attente du résultat$jobResult = SharpApiService::fetchResults($statusUrl);// Étape 3 : obtient les résultats du travail API distribué, car cela renvoie le résultat du travail sous forme de joli JSON$jobResultJson = $jobResult->getResultJson();// ..ou tableau PHP :$jobResultArray = $jobResult->getResultArray();// ..ou PHP stdClass:$jobResultObject = $jobResult->getResultObject(); Vous pouvez donc écraser ces valeurs avec les paramètres .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
Chaque méthode renvoie toujours un objet SharpApiJob , où ses méthodes getResultJson / getResultArray / getResultObject renverront une structure de données différente. Veuillez vous référer aux exemples détaillés fournis sur SharpAPI.com
Pour les méthodes qui ont un paramètre language vous pouvez également utiliser les valeurs SharpApiLanguages Enum pour rendre votre code plus lisible.
Analyse un fichier de CV (CV) à partir de plusieurs formats (PDF/DOC/DOCX/TXT/RTF) et renvoie un objet complet 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', 'Anglais'); Sur la base de la liste de paramètres détaillés, ce point de terminaison fournit des détails concis sur le travail dans le format de réponse, y compris une brève description, les exigences du poste et les responsabilités du poste. Le seul paramètre obligatoire est name .
Cette fonctionnalité utilise un paramètre spécialisé de classe DTO ( Data Transfer Object ) nommé JobDescriptionParameters pour faciliter 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 du 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 = nouveaux JobDescriptionParameters(
nom : "Ingénieur PHP Senior",
nom_de l'entreprise : "ACME LTD", // expérience_de_travail minimale facultative : "5 ans", // formation minimale facultative : "Bachelor", // type d'emploi facultatif : "temps plein", // compétences_requises facultatives : ['PHP8', 'Laravel'], // optionnel_skills : ['AWS', 'Redis'], // optionnelpays : "Royaume-Uni", // optionnel à distance : vrai, // optionnelvisa_sponsored : vrai, // optionnelvoice_tone : 'Professionnel et Geeky', // contexte de tonalité vocale facultatif : nul, // contexte facultatif, instructions de traitement IA supplémentaireslangage : nul // langage de sortie facultatif
);$statusUrl = SharpApiService::generateJobDescription($jobDescriptionParameters);Génère une liste de compétences associées avec leurs pondérations sous forme de valeur flottante (1,0-10,0) où 10 est égal à 100 %, le score de pertinence le plus élevé.
Seul le premier paramètre ( name ) est requis.
Vous pouvez limiter la sortie avec le paramètre max_quantity .
$statusUrl = SharpApiService::ratedSkills('MySQL', 'English', // langue facultative10 // quantité facultative
);Génère une liste de postes associés avec leurs pondérations sous forme de valeur flottante (1,0-10,0), où 10 est égal à 100 %, le score de pertinence le plus élevé.
Seul le premier paramètre ( name ) est requis.
Vous pouvez limiter la sortie avec le paramètre max_quantity .
$statusUrl = SharpApiService::ratedJobPositions('Senior PHP Engineer', 'English', // langue facultative10 // quantité facultative
);Analyse l'avis sur le produit du client et fournit son sentiment (POSITIF/NÉGATIF/NEUTRE) avec un score compris entre 0 et 100 %. Idéal pour le traitement des rapports d’opinion pour n’importe quelle boutique en ligne.
$statusUrl = SharpApiService::productReviewSentiment('contenu des avis clients');Génère une liste de catégories appropriées pour le produit avec des pondérations de pertinence sous forme de valeur flottante (1,0-10,0), où 10 est égal à 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. Très pratique pour alimenter les données du catalogue de produits et traiter les 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 du 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 compte lors du processus de mappage (par exemple vos catégories de commerce électronique actuelles).
$statusUrl = SharpApiService::productCategories('Sony Playstation 5', 'English', // langue facultative5, // quantité facultative'Tech-savvy', // tonalité vocale facultative'Console de jeu, console PS5' // contexte facultatif, catégories actuelles qui correspondent
);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. Très pratique pour alimenter les données du catalogue de produits et traiter les produits en vrac.
Vous pouvez limiter la sortie avec le paramètre max_length . Veuillez garder à l'esprit que max_length constitue une suggestion forte pour le modèle linguistique, plutôt qu'une exigence stricte, afin de conserver 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 du nom d'un écrivain célèbre.
$statusUrl = SharpApiService::generateProductIntro('Sony Playstation 5', SharpApiLanguages::ENGLISH, // langue facultative300, // longueur facultative 'Drôle' // tonalité vocale facultative
);Génère un e-mail de remerciement personnalisé au client après l'achat. Le contenu de la réponse ne contient pas le titre, le message d'accueil ou les informations sur 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 constitue une suggestion forte pour le modèle linguistique, plutôt qu'une exigence stricte, afin de conserver 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 du 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, // langue facultative250, // longueur facultative 'Neutre', // tonalité vocale facultative'Doit inviter le client à revenir avant les vacances' // facultatif contexte
); Traduit le texte fourni dans la langue sélectionnée. 80 langues sont prises en charge. Veuillez vérifier la classe SharpApiLanguages Enum incluse 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 du 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 des explications supplémentaires.
$statusUrl = SharpApiService::translate('turn', SharpApiLanguages::FRENCH, // langue optionnelle'neutre', // tonalité vocale optionnelle'pour tourner une page' // contexte facultatif
);// donnera :// {"content": "tourner", "to_langue": "Français", "from_langue": "Anglais"} Génère une version paraphrasée du texte fourni. Seul le paramètre content est obligatoire. Vous pouvez définir la langue de sortie, la longueur maximale des caractères 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 constitue une suggestion forte pour le modèle linguistique, plutôt qu'une exigence stricte, afin de conserver 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 facultatif. Il peut s'agir d'adjectifs comme funny ou joyous , ou même du 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, // langue500 facultative, // longueur facultative 'neutre', // tonalité vocale facultative'éviter d'utiliser des abréviations' // contexte facultative
);Relit (et vérifie la grammaire) un texte fourni.
$statusUrl = SharpApiService::proofread($text);
Vérifie si le contenu fourni réussit un test de filtration anti-spam. Fournit un pourcentage de confiance et une explication indiquant s'il s'agit d'un spam ou non. Ces informations sont utiles aux modérateurs pour prendre 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 originale détectée et son format E.164. Cela peut être utile dans le cas du traitement et de la validation de gros morceaux de données par rapport à des numéros de téléphone ou si vous souhaitez détecter des numéros de téléphone dans des endroits où ils ne sont pas censés se trouver.
$statusUrl = SharpApiService::detectPhones($text);
Analyse le texte fourni pour tous les e-mails possibles. Cela peut être utile en cas de traitement et de validation de gros morceaux de données par rapport à des adresses e-mail ou si vous souhaitez détecter des e-mails dans des endroits où ils ne sont pas censés se trouver.
$statusUrl = SharpApiService::detectEmails($text);
Génère une liste de mots-clés/balises uniques en fonction du 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', // langue facultative5, // longueur facultative « Freaky & Curious », // tonalité vocale facultative « ajouter des emojis ! » // instructions contextuelles supplémentaires facultatives pour le traitement du contenu );
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 constitue une suggestion forte pour le modèle linguistique, plutôt qu'une exigence stricte, afin de conserver 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 du nom d'un écrivain célèbre.
$statusUrl = SharpApiService::summarizeText($text, 'English', // langue facultative « David Attenborough », // tonalité vocale facultative « ajouter des emojis ! » // instructions contextuelles supplémentaires facultatives pour le traitement du contenu );
Génère toutes les balises META les plus importantes en fonction du contenu fourni. Assurez-vous d'inclure un lien vers le site Web et l'URL des images pour que autant de balises soient remplies 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 du nom d'un écrivain célèbre.
$statusUrl = SharpApiService::generateSeoTags($text, 'English', // langue facultative 'David Attenborough' // tonalité vocale facultative );
Analyse l'évaluation du produit Voyage/Hôtellerie et fournit son sentiment (POSITIF/NÉGATIF/NEUTRE) avec un score compris entre 0 et 100 %. Idéal pour le traitement des rapports d’opinion pour n’importe quelle boutique en ligne.
$statusUrl = SharpApiService::travelReviewSentiment($text);
Génère une liste de catégories appropriées pour le produit Tours & Activités avec des pondérations de pertinence sous forme de valeur flottante (1,0-10,0), où 10 est égal à 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. Très pratique pour alimenter les données du catalogue de produits et traiter les 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 du 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 compte lors du processus de mappage (par exemple vos catégories de commerce électronique actuelles).
$statusUrl = SharpApiService::toursAndActivitiesProductCategories('Oasis of the Bay''Ha Long', // ville facultative'Vietnam', // pays facultatif'anglais', // langue facultative10, // quantité facultative'Aventurier', // tonalité vocale facultative « Bay Hotels, Ha Long Hotels » // contexte facultatif, catégories actuelles correspondantes
); Génère une liste de catégories appropriées pour le produit de type Hospitalité avec des pondérations de pertinence sous forme de valeur flottante (1,0-10,0), où 10 est égal à 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. Très pratique pour alimenter les données des catalogues de produits et traiter les 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 du 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 compte lors du processus de mappage (par exemple vos catégories de commerce électronique actuelles).
$statusUrl = SharpApiService::hospitalityProductCategories('Hotel Crystal 大人専用''Tokyo', // facultatif ville'Japon', // facultatif pays'anglais', // facultatif langue10, // facultatif quantité'Aventurous', // facultatif tonalité vocale « Tokyo Hotels, Crystal Hotels » // contexte facultatif, catégories actuelles correspondantes
);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","subscribe": 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 actuelle du quota mensuel et peut 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 sur https://sharpapi.com/dashboard/credits pour éviter une interruption de service.
Ces valeurs sont également disponibles dans le tableau de bord sur https://sharpapi.com/dashboard
Point de terminaison PING simple pour vérifier la disponibilité de l'API et sa zone horaire interne (horodatage).
$statusUrl = SharpApiService :: ping ();
entraînera :
{ "ping": "pong", "timestamp": "2024-03-12T08:50:11.188308Z"}Veuillez nous le faire savoir via GitHub »
ou Rejoignez notre groupe Telegram »
Veuillez consulter CHANGELOG pour plus d'informations sur ce qui a changé récemment.
A2Z WEB LTD
David Makowski
Boostez vos capacités d'IA Laravel !
La licence MIT (MIT). Veuillez consulter le fichier de licence pour plus d'informations.
Pour les dernières actualités, tutoriels et études de cas, n'oubliez pas de nous suivre sur :
SharpAPI X (anciennement Twitter)
SharpAPI YouTube
SharpAPI Vimeo
SharpAPI LinkedIn
SharpAPI Facebook
