sharpapi php client
v1.2.0 release
Weitere Informationen finden Sie unter Sharpapi.com -Website »
Bitte beziehen Sie sich auf den Beamten:
composer require sharpapi/sharpapi-php-clientRegistrieren Sie sich bei Sharpapi.com und erhalten Sie den API -Schlüssel.
Das war's!
$ 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 ());Typische Anwendungsfall erfordern folgende Schritte:
fetchResults($statusUrl) ausführen, die im Wahllokal operiert, und sendet unter den Anforderungen alle 10 Sekunden für 180 Sekunden (diese Werte können angepasst werden, und überprüfen Sie den Quellcode SharpApiService ).SharpApiJob -Objekt wird zurückgegeben.success beendet ist, können Sie die Ergebnisse mit einer der Methoden erhalten, beispielsweise $jobResultJson = $jobResult->getResultJson() .Jeder Versandauftrag dauert normalerweise zwischen ein paar Sekunden bis zu einer Minute.
Nach diesem Zeitraum hat ein zurückgegebener Job in der Regel success und die Ergebnisse werden für die weitere Verarbeitung verfügbar sein. Jede API -Methode gibt ein anderes Rückgabeformat zurück. Gehen Sie nach unten zur Liste der API -Methoden/-endpunkte, um Details zu erhalten »
Unsere API garantiert jedes Mal das korrekte Format. KI -Motoren, die Sharpapi in seltenen Fällen verwenden, neigen dazu, falsche Daten schlecht zu benehmen und zu verhalten oder zurückzugeben. In diesen Fällen wird der zurückgegebene status für den Job failed . In diesem Fall können Sie genau die gleiche Stellenanforderung erneut ausführen.
Solange der Job immer noch von unserem Motor bearbeitet wird, wird er weiterhin pending Status zurückgeben.
Die zugrunde liegenden HTTP -Anfragen werden mit Guzzle versorgt. Es ist daher eine gute Idee, nach typischen Ausnahmen von Guzzle zu suchen:
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"
}
]
*/
}
} Jede Methode gibt immer SharpApiJob -Objekt zurück, bei dem getResultJson / getResultArray / getResultObject -Methoden unterschiedliche Datenstruktur zurückgibt. Weitere Informationen unter Sharpapi.com finden Sie in den detaillierten Beispielen.
SharpApiLanguages -Enumwerte verwenden, um Ihren Code lesbarer zu gestalten.Pariert eine Lebenslaufdatei (CV) aus mehreren Formaten (PDF/doc/docx/txt/rtf) und gibt ein umfangreiches Objekt von Datenpunkten zurück.
Ein optionaler Parameter der optionalen Ausgabesprachen kann ebenfalls bereitgestellt werden ( English Wert wird als Standardwert festgelegt).
$ statusUrl = SharpApiService:: parseResume ( ' /test/resume.pdf ' , ' English ' ); Basierend auf der Liste der umfangreichen Parameter liefert dieser Endpunkt präzise Jobdetails im Antwortformat, einschließlich der kurzen Beschreibung, der Arbeitsanforderungen und der Aufgaben. Der einzige obligatorische Parameter ist name .
Diese Funktionalität verwendet einen Spezial DTO -Klassenparameter ( Data Transfer Object ) mit dem Namen JobDescriptionParameters , um die Validierung von Eingabeparametern zu unterstützen. Nur der name Parameter im Konstruktor dieses DTO ist obligatorisch.
Sie können Ihren bevorzugten Schreibstil festlegen, indem Sie einen Voice_tone -Parameter bereitstellen. Es können Adjektive wie funny oder joyous oder sogar der Name eines berühmten Schriftstellers sein.
Diese API -Methode bietet auch einen optionalen Kontextparameter, mit dem zusätzliche flexible Anweisungen für die Inhaltsverarbeitung angegeben werden können.
$ 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 );Generiert eine Liste verwandter Fähigkeiten mit ihren Gewichten als Schwimmerwert (1,0-10,0), wobei 10 100%entspricht, der höchsten Relevanzbewertung.
Es ist nur der erste Parameter ( name ) erforderlich.
Sie können die Ausgabe mit dem Parameter max_quantity einschränken.
$ statusUrl = SharpApiService:: relatedSkills (
' MySQL ' ,
' English ' , // optional language
10 // optional quantity
);Generiert eine Liste verwandter Stellenangebote mit ihren Gewichten als Schwimmerwert (1,0-10,0), wobei 10 100%entspricht, der höchsten Relevanzbewertung.
Es ist nur der erste Parameter ( name ) erforderlich.
Sie können die Ausgabe mit dem Parameter max_quantity einschränken.
$ statusUrl = SharpApiService:: relatedJobPositions (
' Senior PHP Engineer ' ,
' English ' , // optional language
10 // optional quantity
);Pariert die Produktüberprüfung des Kunden und bietet ihre Stimmung (positiv/negativ/neutral) mit einer Punktzahl zwischen 0 bis 100%. Ideal für die Verarbeitung von Sentiment -Bericht für jeden Online -Shop.
$ statusUrl = SharpApiService:: productReviewSentiment ( ' customer review contents ' );Erzeugt eine Liste geeigneter Kategorien für das Produkt mit Relevanzgewichten als Schwimmerwert (1,0-10,0), wobei 10 100%entspricht, der höchsten Relevanzbewertung. Geben Sie den Produktnamen und seine Parameter an, um die bestmöglichen Kategorienübereinstimmungen zu erhalten. Ist nützlich mit der Bearbeitung von Produktkatalogdaten und der Verarbeitung von Schüttgutprodukten.
Sie können die Ausgabe mit dem Parameter max_quantity einschränken.
Sie können Ihren bevorzugten Schreibstil festlegen, indem Sie einen voice_tone -Parameter bereitstellen. Es können Adjektive wie funny oder joyous oder sogar der Name eines berühmten Schriftstellers sein.
In einem zusätzlichen optionalen Parameterkontext können Sie eine Liste anderer Kategorien bereitstellen, die während des Zuordnungsprozesses berücksichtigt werden (z. B. Ihre aktuellen E-Commerce-Kategorien).
$ 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
);Generiert eine kürzere Version der Produktbeschreibung. Geben Sie so viele Details und Parameter des Produkts an, um die bestmögliche Marketing -Einführung zu erhalten. Ist nützlich mit der Bearbeitung von Produktkatalogdaten und der Verarbeitung von Bulk -Produkten.
Sie können die Ausgabe mit dem Parameter max_length einschränken. Bitte beachten Sie, dass max_length ein starker Vorschlag für das Sprachmodell und nicht als strenge Anforderung dient, um den allgemeinen Sinn für das Ergebnis aufrechtzuerhalten.
Sie können Ihren bevorzugten Schreibstil festlegen, indem Sie einen voice_tone -Parameter bereitstellen. Es können Adjektive wie funny oder joyous oder sogar der Name eines berühmten Schriftstellers sein.
$ statusUrl = SharpApiService:: generateProductIntro (
' Sony Playstation 5 ' ,
SharpApiLanguages:: ENGLISH , // optional language
300 , // optional length
' Funny ' // optional voice tone
);Generiert nach dem Kauf eine persönliche Dankes-E-Mail an den Kunden. Der Antwortinhalt enthält nicht den Titel, die Begrüßungs- oder Absenderinformationen am Ende, sodass Sie den Rest der E -Mail problemlos personalisieren können.
Sie können die Ausgabe mit dem Parameter max_length einschränken. Bitte beachten Sie, dass max_length ein starker Vorschlag für das Sprachmodell und nicht als strenge Anforderung dient, um den allgemeinen Sinn für das Ergebnis aufrechtzuerhalten.
Sie können Ihren bevorzugten Schreibstil festlegen, indem Sie einen voice_tone -Parameter bereitstellen. Es können Adjektive wie lustig oder freudig oder sogar der Name eines berühmten Schriftstellers sein.
Diese API -Methode bietet auch einen optionalen Kontextparameter, mit dem zusätzliche flexible Anweisungen für die Inhaltsverarbeitung angegeben werden können.
$ 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
); Übersetzt den bereitgestellten Text in die ausgewählte Sprache. 80 Sprachen werden unterstützt. Bitte überprüfen Sie die enthaltenen SharpApiLanguages Enum -Klasse für Details.
Sie können Ihren bevorzugten Schreibstil festlegen, indem Sie einen voice_tone -Parameter bereitstellen. Es können Adjektive wie lustig oder freudig oder sogar der Name eines berühmten Schriftstellers sein.
Ein optionaler context ist ebenfalls verfügbar. Es kann verwendet werden, um den übersetzten Text wie das Anwendungsfallbeispiel oder einige zusätzliche Erklärungen mehr Kontext bereitzustellen.
$ 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"} Generiert eine paraphrasierte Version des bereitgestellten Textes. Es ist nur der content erforderlich. Sie können die Ausgangssprache, die maximale Charakterlänge und den Tonfall definieren.
Zusätzliche Anweisungen zum Verarbeiten des Textes können im Kontextparameter bereitgestellt werden. Bitte beachten Sie, dass max_length ein starker Vorschlag für das Sprachmodell und nicht als strenge Anforderung dient, um den allgemeinen Sinn für das Ergebnis aufrechtzuerhalten.
Sie können Ihren bevorzugten Schreibstil festlegen, indem Sie einen optionalen voice_tone -Parameter bereitstellen. Es können Adjektive wie funny oder joyous oder sogar der Name eines berühmten Schriftstellers sein.
Diese API -Methode bietet auch einen optionalen context , mit dem zusätzliche flexible Anweisungen für die Inhaltsverarbeitung angegeben werden können.
$ statusUrl = SharpApiService:: paraphrase (
$ text ,
SharpApiLanguages:: FRENCH , // optional language
500 , // optional length
' neutral ' , // optional voice tone
' avoid using abbreviations ' // optional context
);Korrekturlesen (und überprüft Grammatik) einen bereitgestellten Text.
$ statusUrl = SharpApiService:: proofread ( $ text );Überprüft, ob der Inhalt bereitgestellt wird, führt ein Spam -Filtrationstest bestehen. Bietet eine prozentuale Vertrauensbewertung und eine Erklärung dafür, ob es als Spam betrachtet wird oder nicht. Diese Informationen sind für Moderatoren nützlich, um eine endgültige Entscheidung zu treffen.
$ statusUrl = SharpApiService:: detectSpam ( $ text );Pariert den bereitgestellten Text für alle Telefonnummern und gibt die ursprüngliche erkannte Version und das E.164 -Format zurück. Könnte bei der Verarbeitung und Validierung großer Datenbrocken gegen Telefonnummern oder Fe nützlich sein, wenn Sie Telefonnummern an Orten erkennen möchten, an denen sie nicht sein sollen.
$ statusUrl = SharpApiService:: detectPhones ( $ text );Analysiert den bereitgestellten Text für mögliche E -Mails. Könnte bei der Verarbeitung und Validierung großer Datenbrocken gegen E -Mail -Adressen oder Fe nützlich sein, wenn Sie E -Mails an Orten erkennen möchten, an denen sie nicht sein sollen.
$ statusUrl = SharpApiService:: detectEmails ( $ text );Generiert eine Liste eindeutiger Schlüsselwörter/Tags basierend auf dem angegebenen Inhalt.
Sie können die Ausgabe mit dem Parameter max_quantity einschränken.
Sie können Ihren bevorzugten Schreibstil festlegen, indem Sie einen voice_tone -Parameter bereitstellen.
$ statusUrl = SharpApiService:: generateKeywords (
$ text ,
' English ' , // optional language
5 , // optional length
' Freaky & Curious ' , // optional voice tone
' add emojis! ' // optional extra context instructions for content processing
);Generiert eine zusammengefasste Version des bereitgestellten Inhalts. Perfekt für Marketing -Einführungen längerer Texte.
Sie können die Ausgabe mit dem Parameter max_length einschränken. Bitte beachten Sie, dass max_length ein starker Vorschlag für das Sprachmodell und nicht als strenge Anforderung dient, um den allgemeinen Sinn für das Ergebnis aufrechtzuerhalten.
Sie können Ihren bevorzugten Schreibstil festlegen, indem Sie einen voice_ton E -Parameter bereitstellen. Es können Adjektive wie funny oder joyous oder sogar der Name eines berühmten Schriftstellers sein.
$ statusUrl = SharpApiService:: summarizeText (
$ text ,
' English ' , // optional language
' David Attenborough ' , // optional voice tone
' add emojis! ' // optional extra context instructions for content processing
);Generiert alle wichtigsten Meta -Tags basierend auf dem bereitgestellten Inhalt. Stellen Sie sicher, dass Sie den Link zur Website und die Picture -URL angeben, um so viele Tags wie möglich besiedelt zu lassen.
Sie können Ihren bevorzugten Schreibstil festlegen, indem Sie einen voice_ton E -Parameter bereitstellen. Es können Adjektive wie funny oder joyous oder sogar der Name eines berühmten Schriftstellers sein.
$ statusUrl = SharpApiService:: generateSeoTags (
$ text ,
' English ' , // optional language
' David Attenborough ' // optional voice tone
);Pariert die Überprüfung des Reis-/Hospitality-Produkts und bietet ihre Stimmung (positiv/negativ/neutral) mit einer Punktzahl zwischen 0 bis 100%. Ideal für die Verarbeitung von Sentiment -Bericht für jeden Online -Shop.
$ statusUrl = SharpApiService:: travelReviewSentiment ( $ text ); Generiert eine Liste geeigneter Kategorien für das Produkt- und Aktivitätenprodukt mit Relevanzgewichten als Schwimmerwert (1,0-10,0), wobei 10 100%entsprechen, die höchste Relevanzbewertung. Geben Sie den Produktnamen und seine Parameter an, um die bestmöglichen Kategorienübereinstimmungen zu erhalten. Kommt nützlich mit der Population von Produktkatalogdaten und der Massenproduktverarbeitung. Es ist nur der erste Parameter productName erforderlich.
Sie können die Ausgabe mit dem Parameter max_quantity einschränken.
Sie können Ihren bevorzugten Schreibstil festlegen, indem Sie einen voice_tone -Parameter bereitstellen. Es können Adjektive wie funny oder joyous oder sogar der Name eines berühmten Schriftstellers sein.
In einem zusätzlichen optionalen context können Sie eine Liste anderer Kategorien bereitstellen, die während des Zuordnungsprozesses berücksichtigt werden (z. B. Ihre aktuellen E-Commerce-Kategorien).
$ 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
); Generiert eine Liste geeigneter Kategorien für das Produkttyp-Produkt mit Relevanzgewichten als Schwimmerwert (1,0-10,0), wobei 10 100%entsprechen, die höchste Relevanzbewertung. Geben Sie den Produktnamen und seine Parameter an, um die bestmöglichen Kategorienübereinstimmungen zu erhalten. Es ist praktisch mit Populing Products Catalogs Data und Bulk Products 'Processing. Es ist nur der erste Parameter productName erforderlich.
Sie können die Ausgabe mit dem Parameter max_quantity einschränken.
Sie können Ihren bevorzugten Schreibstil festlegen, indem Sie einen voice_tone -Parameter bereitstellen. Es können Adjektive wie funny oder joyous oder sogar der Name eines berühmten Schriftstellers sein.
In einem zusätzlichen optionalen context können Sie eine Liste anderer Kategorien bereitstellen, die während des Zuordnungsprozesses berücksichtigt werden (z. B. Ihre aktuellen E-Commerce-Kategorien).
$ 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
);Endpunkt, um Details zum aktuellen Zeitraum des Abonnements zu überprüfen
$ statusUrl = SharpApiService:: quota ();wird nach:
{
"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 ist ein Prozentsatz der aktuellen monatlichen Quotennutzung und dient möglicherweise als Alarm für den Benutzer der erschöpften Credits. Mit einem Wert über 80%wird empfohlen, weitere Credits unter https://sharpapi.com/dashboard/credits zu abonnieren, um eine Störung des Dienstes zu vermeiden.
Diese Werte sind auch im Dashboard unter https://sharpapi.com/dashboard verfügbar
Einfacher Ping -Endpunkt zur Überprüfung der Verfügbarkeit der API und der internen Züchterzone (Zeitstempel).
$ statusUrl = SharpApiService:: ping ();wird nach:
{
"ping" : " pong " ,
"timestamp" : " 2024-03-12T08:50:11.188308Z "
}Bitte lassen Sie es uns wissen »
Weitere Informationen zu dem, was sich in letzter Zeit geändert hat, finden Sie in ChangeLog.
Die MIT -Lizenz (MIT). Weitere Informationen finden Sie unter Lizenzdatei.
