sharpapi php client
v1.2.0 release
Lihat lebih banyak di situs web Sharpapi.com »
Silakan merujuk ke pejabat:
composer require sharpapi/sharpapi-php-clientDaftar di Sharpapi.com dan dapatkan kunci API.
Itu saja!
$ 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 ());Kasus penggunaan yang khas memerlukan langkah -langkah ini:
fetchResults($statusUrl) yang beroperasi dalam mode pemungutan suara, mengirim permintaan di bawah setiap 10 detik selama 180 detik (nilai -nilai ini dapat disesuaikan, periksa kode sumber SharpApiService ).SharpApiJob akan dikembalikan.success Anda dapat memperoleh hasilnya dengan salah satu metode, misalnya $jobResultJson = $jobResult->getResultJson() .Setiap pekerjaan yang dikirim biasanya memakan waktu antara beberapa detik hingga satu menit.
Setelah periode itu pekerjaan yang dikembalikan biasanya akan memiliki status success dan hasilnya akan tersedia untuk pemrosesan lebih lanjut. Setiap metode API mengembalikan format pengembalian yang berbeda. Buka daftar metode/titik akhir API di bawah ini untuk detailnya »
API kami menjamin untuk mengembalikan format yang benar setiap saat. Mesin AI yang digunakan Sharpapi dalam kasus yang jarang memiliki kecenderungan untuk berperilaku buruk dan timeout atau mengembalikan data yang salah. Dalam kasus tersebut, status yang dikembalikan untuk pekerjaan akan failed . Anda dapat menjalankan kembali permintaan pekerjaan yang sama persis dalam kasus itu.
Selama pekerjaan itu masih diproses oleh mesin kami, ia akan terus mengembalikan status pending .
Permintaan HTTP yang mendasari ditenagai dengan Guzzle, jadi itu ide yang bagus untuk memeriksa pengecualian teka -teki yang khas:
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"
}
]
*/
}
} Setiap metode selalu mengembalikan objek SharpApiJob , di mana metode getResultJson / getResultArray / getResultObject akan mengembalikan struktur data yang berbeda. Silakan merujuk ke contoh terperinci yang disediakan di Sharpapi.com.
SharpApiLanguages enum nilai untuk membuat kode Anda lebih mudah dibaca.Parses file resume (CV) dari beberapa format (pdf/doc/docx/txt/rtf) dan mengembalikan objek poin data yang luas.
Parameter bahasa output opsional juga dapat disediakan (nilai English ditetapkan sebagai yang default).
$ statusUrl = SharpApiService:: parseResume ( ' /test/resume.pdf ' , ' English ' ); Berdasarkan daftar parameter luas titik akhir ini memberikan detail pekerjaan yang ringkas dalam format respons, termasuk deskripsi singkat, persyaratan pekerjaan, dan tanggung jawab pekerjaan. Satu -satunya parameter wajib adalah name .
Fungsionalitas ini menggunakan parameter kelas DTO khusus ( Data Transfer Object ) bernama JobDescriptionParameters untuk membantu validasi parameter input. Hanya parameter name dalam konstruktor DTO ini adalah wajib.
Anda dapat mengatur gaya penulisan pilihan Anda dengan memberikan parameter Voice_tone. Ini bisa menjadi kata sifat seperti funny atau joyous , atau bahkan nama penulis terkenal.
Metode API ini juga menyediakan parameter konteks opsional, yang dapat digunakan untuk menyediakan instruksi fleksibel tambahan untuk pemrosesan konten.
$ 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 );Menghasilkan daftar keterampilan terkait dengan bobot mereka sebagai nilai float (1.0-10.0) di mana 10 sama dengan 100%, skor relevansi tertinggi.
Hanya parameter pertama ( name ) yang diperlukan.
Anda dapat membatasi output dengan parameter max_quantity .
$ statusUrl = SharpApiService:: relatedSkills (
' MySQL ' ,
' English ' , // optional language
10 // optional quantity
);Menghasilkan daftar posisi pekerjaan terkait dengan bobotnya sebagai nilai float (1.0-10.0) di mana 10 sama dengan 100%, skor relevansi tertinggi.
Hanya parameter pertama ( name ) yang diperlukan.
Anda dapat membatasi output dengan parameter max_quantity .
$ statusUrl = SharpApiService:: relatedJobPositions (
' Senior PHP Engineer ' ,
' English ' , // optional language
10 // optional quantity
);Parses ulasan produk pelanggan dan memberikan sentimen (positif/negatif/netral) dengan skor antara 0-100%. Bagus untuk pemrosesan laporan sentimen untuk toko online mana pun.
$ statusUrl = SharpApiService:: productReviewSentiment ( ' customer review contents ' );Menghasilkan daftar kategori yang sesuai untuk produk dengan bobot relevansi sebagai nilai float (1.0-10.0) di mana 10 sama dengan 100%, skor relevansi tertinggi. Berikan nama produk dan parameternya untuk mendapatkan kecocokan kategori terbaik. Berhasil dengan mengisi data katalog produk dan pemrosesan produk curah.
Anda dapat membatasi output dengan parameter max_quantity .
Anda dapat mengatur gaya penulisan pilihan Anda dengan memberikan parameter voice_tone . Ini bisa menjadi kata sifat seperti funny atau joyous , atau bahkan nama penulis terkenal.
Dalam konteks parameter opsional tambahan, Anda dapat memberikan daftar kategori lain yang akan dipertimbangkan selama proses pemetaan (misalnya kategori e-commerce Anda saat ini).
$ 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
);Menghasilkan versi deskripsi produk yang lebih pendek. Berikan sebanyak mungkin detail dan parameter produk untuk mendapatkan pengenalan pemasaran terbaik. Berhasil dengan mengisi data katalog produk dan pemrosesan produk curah.
Anda dapat membatasi output dengan parameter max_length . Harap diingat bahwa max_length berfungsi sebagai saran yang kuat untuk model bahasa, daripada persyaratan yang ketat, untuk mempertahankan pengertian umum hasilnya.
Anda dapat mengatur gaya penulisan pilihan Anda dengan memberikan parameter voice_tone . Ini bisa menjadi kata sifat seperti funny atau joyous , atau bahkan nama penulis terkenal.
$ statusUrl = SharpApiService:: generateProductIntro (
' Sony Playstation 5 ' ,
SharpApiLanguages:: ENGLISH , // optional language
300 , // optional length
' Funny ' // optional voice tone
);Menghasilkan email terima kasih yang dipersonalisasi kepada pelanggan setelah pembelian. Konten respons tidak berisi judul, ucapan atau info pengirim di akhir, sehingga Anda dapat mempersonalisasikan sisa email dengan mudah.
Anda dapat membatasi output dengan parameter max_length. Harap diingat bahwa max_length berfungsi sebagai saran yang kuat untuk model bahasa, daripada persyaratan yang ketat, untuk mempertahankan pengertian umum hasilnya.
Anda dapat mengatur gaya penulisan pilihan Anda dengan memberikan parameter voice_tone . Ini bisa menjadi kata sifat seperti lucu atau gembira, atau bahkan nama penulis terkenal.
Metode API ini juga menyediakan parameter konteks opsional, yang dapat digunakan untuk menyediakan instruksi fleksibel tambahan untuk pemrosesan konten.
$ 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
); Menerjemahkan teks yang disediakan ke bahasa yang dipilih. 80 bahasa didukung. Harap periksa termasuk kelas ENUM SharpApiLanguages untuk detailnya.
Anda dapat mengatur gaya penulisan pilihan Anda dengan memberikan parameter voice_tone . Ini bisa menjadi kata sifat seperti lucu atau gembira, atau bahkan nama penulis terkenal.
Parameter context opsional juga tersedia. Ini dapat digunakan untuk memberikan lebih banyak konteks pada teks yang diterjemahkan, seperti contoh kasus penggunaan atau beberapa penjelasan tambahan.
$ 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"} Menghasilkan versi yang diparafrasekan dari teks yang disediakan. Hanya parameter content yang diperlukan. Anda dapat menentukan bahasa output, panjang karakter maksimum, dan nada suara.
Instruksi tambahan tentang cara memproses teks dapat disediakan dalam parameter konteks. Harap diingat bahwa max_length berfungsi sebagai saran yang kuat untuk model bahasa, daripada persyaratan yang ketat, untuk mempertahankan pengertian umum hasilnya.
Anda dapat mengatur gaya penulisan pilihan Anda dengan memberikan parameter voice_tone opsional. Ini bisa menjadi kata sifat seperti funny atau joyous , atau bahkan nama penulis terkenal.
Metode API ini juga menyediakan parameter context opsional, yang dapat digunakan untuk menyediakan instruksi fleksibel tambahan untuk pemrosesan konten.
$ statusUrl = SharpApiService:: paraphrase (
$ text ,
SharpApiLanguages:: FRENCH , // optional language
500 , // optional length
' neutral ' , // optional voice tone
' avoid using abbreviations ' // optional context
);Proofreads (dan memeriksa tata bahasa) teks yang disediakan.
$ statusUrl = SharpApiService:: proofread ( $ text );Periksa apakah konten yang disediakan melewati tes penyaringan spam. Memberikan skor kepercayaan persentase dan penjelasan untuk apakah itu dianggap spam atau tidak. Informasi ini berguna bagi moderator untuk membuat keputusan akhir.
$ statusUrl = SharpApiService:: detectSpam ( $ text );Parse teks yang disediakan untuk nomor telepon apa pun dan mengembalikan versi asli yang terdeteksi dan format E.164 -nya. Mungkin berguna dalam hal memproses dan memvalidasi potongan besar data terhadap nomor telepon atau FE jika Anda ingin mendeteksi nomor telepon di tempat -tempat di mana mereka tidak seharusnya berada.
$ statusUrl = SharpApiService:: detectPhones ( $ text );Parse teks yang disediakan untuk setiap email yang mungkin. Mungkin berguna jika terjadi pemrosesan dan memvalidasi potongan data besar terhadap alamat email atau FE jika Anda ingin mendeteksi email di tempat -tempat di mana mereka tidak seharusnya berada.
$ statusUrl = SharpApiService:: detectEmails ( $ text );Menghasilkan daftar kata kunci/tag unik berdasarkan konten yang disediakan.
Anda dapat membatasi output dengan parameter max_quantity .
Anda dapat mengatur gaya penulisan pilihan Anda dengan memberikan parameter 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
);Menghasilkan versi ringkasan dari konten yang disediakan. Sempurna untuk menghasilkan perkenalan pemasaran teks yang lebih panjang.
Anda dapat membatasi output dengan parameter max_length . Harap diingat bahwa max_length berfungsi sebagai saran yang kuat untuk model bahasa, daripada persyaratan yang ketat, untuk mempertahankan pengertian umum hasilnya.
Anda dapat mengatur gaya penulisan pilihan Anda dengan memberikan parameter voice_ton E. Ini bisa menjadi kata sifat seperti funny atau joyous , atau bahkan nama penulis terkenal.
$ statusUrl = SharpApiService:: summarizeText (
$ text ,
' English ' , // optional language
' David Attenborough ' , // optional voice tone
' add emojis! ' // optional extra context instructions for content processing
);Menghasilkan semua tag meta paling penting berdasarkan konten yang disediakan. Pastikan untuk memasukkan tautan ke situs web dan URL gambar untuk mendapatkan sebanyak mungkin tag yang diisi.
Anda dapat mengatur gaya penulisan pilihan Anda dengan memberikan parameter voice_ton E. Ini bisa menjadi kata sifat seperti funny atau joyous , atau bahkan nama penulis terkenal.
$ statusUrl = SharpApiService:: generateSeoTags (
$ text ,
' English ' , // optional language
' David Attenborough ' // optional voice tone
);Parse Tinjauan Produk Perjalanan/Perhotelan dan memberikan sentimen (positif/negatif/netral) dengan skor antara 0-100%. Bagus untuk pemrosesan laporan sentimen untuk toko online mana pun.
$ statusUrl = SharpApiService:: travelReviewSentiment ( $ text ); Menghasilkan daftar kategori yang sesuai untuk produk Tours & Activities dengan bobot relevansi sebagai nilai float (1.0-10.0) di mana 10 sama dengan 100%, skor relevansi tertinggi. Berikan nama produk dan parameternya untuk mendapatkan kecocokan kategori terbaik. Berhasil dengan mengisi data katalog produk dan pemrosesan produk massal. Hanya productName parameter pertama yang diperlukan.
Anda dapat membatasi output dengan parameter max_quantity .
Anda dapat mengatur gaya penulisan pilihan Anda dengan memberikan parameter voice_tone . Ini bisa menjadi kata sifat seperti funny atau joyous , atau bahkan nama penulis terkenal.
Dalam context parameter opsional tambahan, Anda dapat memberikan daftar kategori lain yang akan dipertimbangkan selama proses pemetaan (misalnya kategori e-commerce Anda saat ini).
$ 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
); Menghasilkan daftar kategori yang sesuai untuk produk tipe perhotelan dengan bobot relevansi sebagai nilai float (1.0-10.0) di mana 10 sama dengan 100%, skor relevansi tertinggi. Berikan nama produk dan parameternya untuk mendapatkan kecocokan kategori terbaik. Berhasil dengan mengisi data katalog produk dan pemrosesan produk curah. Hanya productName parameter pertama yang diperlukan.
Anda dapat membatasi output dengan parameter max_quantity .
Anda dapat mengatur gaya penulisan pilihan Anda dengan memberikan parameter voice_tone . Ini bisa menjadi kata sifat seperti funny atau joyous , atau bahkan nama penulis terkenal.
Dalam context parameter opsional tambahan, Anda dapat memberikan daftar kategori lain yang akan dipertimbangkan selama proses pemetaan (misalnya kategori e-commerce Anda saat ini).
$ 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
);Titik akhir untuk memeriksa detail tentang periode langganan saat ini
$ statusUrl = SharpApiService:: quota ();akan menghasilkan:
{
"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 adalah persentase dari penggunaan kuota bulanan saat ini dan mungkin berfungsi sebagai peringatan bagi pengguna kredit yang habis. Dengan nilai di atas 80%, disarankan untuk berlangganan lebih banyak kredit di https://sharpapi.com/dashboard/credits untuk menghindari gangguan layanan.
Nilai -nilai ini juga tersedia di dasbor di https://sharpapi.com/dashboard
Titik akhir ping sederhana untuk memeriksa ketersediaan API dan zona timze internal (cap waktu).
$ statusUrl = SharpApiService:: ping ();akan menghasilkan:
{
"ping" : " pong " ,
"timestamp" : " 2024-03-12T08:50:11.188308Z "
}Tolong beri tahu kami »
Silakan lihat Changelog untuk informasi lebih lanjut tentang apa yang telah berubah baru -baru ini.
Lisensi MIT (MIT). Silakan lihat file lisensi untuk informasi lebih lanjut.
