sharpapi laravel client
v1.2.2
在 SharpAPI.com 網站上查看更多資訊 »
PHP >= 8.1
Laravel >= 9.0
如果您不使用 Laravel，那麼您可以在這裡找到通用 SharpAPI PHP 用戶端 »
請依照以下步驟安裝和設定 SharpAPI Laravel 用戶端套件。
透過composer安裝套件：
作曲家需要 Sharpapi/sharpapi-laravel-client
在 SharpAPI.com 註冊並取得 API 金鑰。
在.env中設定 API 金鑰
SHARP_API_KEY=金鑰
[可選]發布設定檔sharpapi-client.php 。
注意：您不再需要發布設定檔即可使用此套件。預設情況下，該套件將使用合理的預設值。如果您想自訂配置，只需發布配置即可。
php artisan 供應商：發布 --tag=sharpapi-laravel-client
？電子商務
快速產生引人入勝的產品介紹以吸引客戶。
自動建立個人化的感謝電子郵件以增強客戶體驗。
簡化產品分類，形成組織良好的目錄。
情緒分析：了解和分析產品評論中的情緒，以進行數據驅動的決策。
️內容和行銷自動化
為全球受眾輕鬆翻譯文字。
釋義和校對任何文本（包括語法檢查）
垃圾郵件內容偵測：有效辨識並過濾掉垃圾郵件內容。
聯絡資訊擷取：從非標準格式中提取電話號碼和電子郵件地址，以簡化通訊。
產生簡潔的摘要和獨特的關鍵字/標籤以改善內容消耗。
根據內容自動產生 META 標籤，促進 SEO 工作。
人力資源技術
輕鬆產生複雜的職位描述，節省招募過程中的時間。
技能和職位洞察：確定相關的工作職位和技能以簡化招募。
自動簡歷解析：有效地解析和提取簡歷文件中的信息，以便於處理。
旅行、旅遊與酒店業
分析旅遊評論中的情緒以改善服務。
簡化旅遊、活動和飯店產品的分類。
請參考官方：
API文件
多語言支援：每個內容或資料分析 API 端點支援 80 種語言。檢查這裡的列表。
易於使用的 RESTful 格式：具有標準化的端點集 - 透過分析端點獲得有價值的見解，涵蓋產品類別、技能和職位，並提供相關分數。
始終相同、乾淨的資料格式：所有傳回的資料都具有一致、可預測的 JSON 格式，請放心。無需擔心人工智慧資料模糊。
技術支援：由開發人員為開發人員精心打造，我們在您的整個旅程中提供持續的幫助。
您可以注入SharpApiService類別或使用外觀SharpApiService單例。
我們建議您使用 Laravel 佇列系統來最佳化排程作業和檢查結果的流程，特別是當您處理較大批次的資料時。
典型用例需要以下步驟：
調度可用的 AI 處理方法之一（這將傳回作業處理狀態 URL）
運行fetchResults($statusUrl)方法，該方法在輪詢模式下運行，每 10 秒發送一次底層請求，持續 180 秒（這些值可以自訂）。
將傳回SharpApiJob物件。
對於以success傳回狀態完成的作業，您可以使用其中一種方法來取得結果，例如$jobResultJson = $jobResult->getResultJson() 。
每個調度的作業通常需要幾秒鐘到一分鐘的時間。
在此期限之後，傳回的作業通常會具有success狀態，並且其結果可用於進一步處理。每個API方法傳回不同的回傳格式。請參閱下面的 API 方法/端點清單以了解詳細資訊»
我們的 API 保證每次都會回傳正確的格式。 SharpAPI 在極少數情況下使用的人工智慧引擎容易出現行為異常、逾時或傳回錯誤資料的情況。在這些情況下，作業的回傳status將會是failed 。在這種情況下，您可以重新執行完全相同的作業請求。
只要我們的引擎仍在處理作業，它就會繼續回到pending狀態。
<?phpnamespace AppHttpControllers;use GuzzleHttpExceptionGuzzleException;use SharpAPISharpApiServiceSharpApiService;類別 SharpTest 擴充控制器{public function __construct(public SharpApiService $sharpApiService)
{
}/** * @throws GuzzleException */public function detector_phones(): void{$statusUrl = $this->sharpApiService->detectPhones('在哪裡可以找到我們？致電銷售技術顧問：致電：1800-394-7486或哪裡可以找到我們？致電銷售技術顧問：致電：1800-394-7486或哪裡可以找到我們？致電銷售技術顧問：致電：1800-394-7486或我們的新加坡辦事處+65 8888 8888'）； $result = $this->sharpApiService->fetchResults($statusUrl); dd($result->getResultJson());/* 返回: [ { "Detected_number": "1800-394-7486", "parsed_number": "+18003947486" }, { "Detected_number": "+18003947486" }, { "Detected_number": "+65 8888」 , "parsed_number": "+6588888888" } ] */}
}底層 HTTP 請求由 Laravel HTTP Client/Guzzle 提供便利，因此建議您熟悉常見的 Guzzle 異常。
use GuzzleHttpExceptionClientException;// 步驟 1：使用其中一個方法將作業分派到API，例如：try {$statusUrl = SharpApiService::summarizeText($text, 'German', // 可選語言500, // 可選長度'中性語音' // 可選語音
);// $statusUrl 範例值： 'http://sharpapi.com/api/v1/job/status/75acb6dc-a975-4969-9ef1-c62cebc511cb'} catch (ClientException $e) { $e->getResponse( ）
}// 步驟 2：請求以輪詢模式檢查作業狀態並等待結果$jobResult = SharpApiService::fetchResults($statusUrl);// 第 3 步：取得已排程 API 作業的結果，這裡傳回作業結果為漂亮的JSON$jobResultJson = $jobResult->getResultJson();// ..或PHP 數組:$jobResultArray = $jobResult->getResultArray();// ..或PHP stdClass:$jobResultObject = $getResultObject = $getReult-get ;因此，您可以使用.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=CK_STATUS
每個方法總是傳回SharpApiJob對象，其中getResultJson / getResultArray / getResultObject方法將會傳回不同的資料結構。請參考 SharpAPI.com 提供的詳細範例
對於具有language參數的方法，您還可以使用SharpApiLanguages枚舉值來使程式碼更具可讀性。
解析多種格式（PDF/DOC/DOCX/TXT/RTF）的履歷（CV）檔案並傳回廣泛的資料點物件。
還可以提供可選的輸出語言參數（預設為English值）。
$statusUrl = SharpApiService::parseResume('/test/resume.pdf', '英文');基於廣泛的參數列表，該端點以響應格式提供簡潔的工作詳細信息，包括簡短描述、工作要求和工作職責。唯一的強制參數是name 。
此功能利用名為JobDescriptionParameters的專用DTO類別（ Data Transfer Object ）參數來協助驗證輸入參數。此DTO的建構子中只有name參數是必要的。
您可以透過提供 voice_tone 參數來設定您喜歡的書寫風格。它可以是形容詞，如funny或joyous ，甚至可以是著名作家的名字。
此 API 方法還提供了一個可選的上下文參數，可用於為內容處理提供額外的彈性指令。
$jobDescriptionParameters = 新的 JobDescriptionParameters(
姓名：“PHP高級工程師”，
Company_name: "ACME LTD", // 可選的最低工作經驗: "5 年", // 可選的最低教育: "學士學位", // 可選的就業類型: "全職", // 可選的必要技能: ['PHP8', 'Laravel'], //可選的可選_技能：['AWS'，'Redis']，//可選的國家/地區：“英國”，//可選的遠端：true，//可選的visa_owned：true，//可選的voice_tone：'專業和極客'，//可選的語音語氣context：null , // 可選上下文，附加AI 處理指令language: null // 可選輸出語言
);$statusUrl = SharpApiService::generateJobDescription($jobDescriptionParameters);產生相關技能的列表，其權重為浮點值 (1.0-10.0)，其中 10 等於 100%，即最高相關性分數。
僅需要第一個參數（ name ）。
您可以使用max_quantity參數限制輸出。
$statusUrl = SharpApiService::latedSkills('MySQL', 'English', // 可選語言10 // 可選數量
）；產生相關職位的列表，其權重為浮點值 (1.0-10.0)，其中 10 等於 100%，即最高相關性分數。
僅需要第一個參數（ name ）。
您可以使用max_quantity參數限制輸出。
$statusUrl = SharpApiService::latedJobPositions('高級PHP工程師', '英語', // 可選語言10 // 可選數量
）；解析客戶的產品評論並提供其情緒（正面/負面/中性），分數介於 0-100% 之間。非常適合任何在線商店的情緒報告處理。
$statusUrl = SharpApiService::productReviewSentiment('客戶評論內容');產生產品的合適類別列表，相關權重為浮點值 (1.0-10.0)，其中 10 等於 100%，即最高相關性得分。提供產品名稱及其參數，以獲得盡可能最佳的類別匹配。可以方便地填充產品目錄資料和批量產品處理。
您可以使用max_quantity參數限制輸出。
您可以透過提供voice_tone參數來設定您喜歡的書寫風格。它可以是形容詞，如funny或joyous ，甚至可以是著名作家的名字。
在附加的選用參數上下文中，您可以提供映射過程中將考慮的其他類別清單（例如您目前的電子商務類別）。
$statusUrl = SharpApiService::productCategories('Sony Playstation 5', 'English', // 可選語言5, // 可選數量'Tech-savvy', // 可選語音提示'Game Console, PS5 Console' / / 可選上下文,目前要匹配的類別
）；產生產品描述的較短版本。提供盡可能多的產品細節和參數，以獲得最佳的行銷介紹。可以方便地填充產品目錄資料和批量產品處理。
您可以使用max_length參數限制輸出。請記住， max_length作為語言模型的強烈建議，而不是嚴格的要求，以保持結果的一般意義。
您可以透過提供voice_tone參數來設定您喜歡的書寫風格。它可以是形容詞，如funny或joyous ，甚至可以是著名作家的名字。
$statusUrl = SharpApiService::generateProductIntro('Sony Playstation 5', SharpApiLanguages::ENGLISH, // 可選語言300, // 可選長度 'Funny' // 可選語音
）；購買後向客戶產生個人化的感謝電子郵件。回覆內容末尾不包含標題、問候語或寄件者訊息，因此您可以輕鬆個性化電子郵件的其餘部分。
您可以使用 max_length 參數限制輸出。請記住， max_length作為語言模型的強烈建議，而不是嚴格的要求，以保持結果的一般意義。
您可以透過提供voice_tone參數來設定您喜歡的書寫風格。它可以是形容詞，如有趣或歡樂，甚至是著名作家的名字。
此 API 方法還提供了一個可選的上下文參數，可用於為內容處理提供額外的彈性指令。
$statusUrl = SharpApiService::generateThankYouEmail('Sony Playstation 5', SharpApiLanguages::ENGLISH, // optional language250, // optional length'Neutral', // optional voice tone'Must invite customer to visit again before Holidays' // optional情境
）；將提供的文本翻譯為選定的語言。支援 80 種語言。請檢查包含的SharpApiLanguages枚舉類別以了解詳細資訊。
您可以透過提供voice_tone參數來設定您喜歡的書寫風格。它可以是形容詞，如有趣或歡樂，甚至是著名作家的名字。
也可以使用可選的context參數。它可用於為翻譯文字提供更多上下文，例如使用案例範例或一些附加解釋。
$statusUrl = SharpApiService::translate('turn', SharpApiLanguages::FRENCH, // 可選語言 'neutral', // 可選語音 '翻頁' // 可選上下文
);// 將導致 :// {"content": "tourner", "to_language": "French", "from_language": "English"}產生所提供文本的釋義版本。僅需content參數。您可以定義輸出語言、最大字元長度和語氣。
可以在上下文參數中提供有關如何處理文字的附加說明。請記住， max_length作為語言模型的強烈建議，而不是嚴格的要求，以保持結果的一般意義。
您可以透過提供可選的voice_tone參數來設定您喜歡的書寫風格。它可以是形容詞，如funny或joyous ，甚至可以是著名作家的名字。
此 API 方法還提供了一個可選的context參數，可用於為內容處理提供額外的彈性指令。
$statusUrl = SharpApiService::paraphrase($text, SharpApiLanguages::FRENCH, // 可選 language500, // 可選長度 'neutral', // 可選語氣 'avoid using abbreviations' // 可選上下文
）；校對（並檢查文法）提供的文字。
$statusUrl = SharpApiService::proofread($text);
檢查提供的內容是否經過垃圾郵件過濾測試。提供百分比置信度分數以及是否被視為垃圾郵件的解釋。此資訊對於主持人做出最終決定很有用。
$statusUrl = SharpApiService::detectSpam($text);
解析提供的文字中的任何電話號碼，並傳回偵測到的原始版本及其 E.164 格式。如果您想在不應該出現的地方偵測電話號碼，那麼在根據電話號碼或 fe 處理和驗證大量資料的情況下可能會派上用場。
$statusUrl = SharpApiService::DetectPhones($text);
解析提供的文字以查找任何可能的電子郵件。如果您想在不應該出現的地方偵測電子郵件，那麼在根據電子郵件地址處理和驗證大量資料時可能會派上用場。
$statusUrl = SharpApiService::detectEmails($text);
根據提供的內容產生唯一關鍵字/標籤的清單。
您可以使用max_quantity參數限制輸出。
您可以透過提供voice_tone參數來設定您喜歡的書寫風格。
$statusUrl = SharpApiService::generateKeywords($text, 'English', // 可選language5, // 可選長度'Freaky & Curious', // 可選語音'add emojis!' // 可選用於內容處理的額外上下文指令 ）；
產生所提供內容的摘要版本。非常適合產生較長文字的行銷介紹。
您可以使用max_length參數限制輸出。請記住， max_length作為語言模型的強烈建議，而不是嚴格的要求，以保持結果的一般意義。
您可以透過提供voice_ton e 參數來設定您喜歡的書寫風格。它可以是形容詞，如funny或joyous ，甚至可以是著名作家的名字。
$statusUrl = SharpApiService::summarizeText($text, 'English', // 可選語言 'David Attenborough', // 可選語音 'add emojis!' // 可選用於內容處理的額外上下文指令 ）；
根據提供的內容產生所有最重要的 META 標籤。確保包含網站連結和圖片 URL，以填充盡可能多的標籤。
您可以透過提供voice_ton e 參數來設定您喜歡的書寫風格。它可以是形容詞，如funny或joyous ，甚至可以是著名作家的名字。
$statusUrl = SharpApiService::generateSeoTags($text, 'English', // 可選語言 'David Attenborough' // 可選語音 ）；
解析旅行/酒店產品評論並提供其情緒（正面/負面/中性），分數介於 0-100% 之間。非常適合任何在線商店的情緒報告處理。
$statusUrl = SharpApiService::travelReviewSentiment($text);
產生旅遊和活動產品的合適類別列表，相關權重為浮點值 (1.0-10.0)，其中 10 等於 100%，即最高相關性得分。提供產品名稱及其參數，以獲得盡可能最佳的類別匹配。可以方便地填充產品目錄資料和批量產品處理。只需要第一個參數productName 。
您可以使用max_quantity參數限制輸出。
您可以透過提供voice_tone參數來設定您喜歡的書寫風格。它可以是形容詞，如funny或joyous ，甚至可以是著名作家的名字。
在附加的選用參數context中，您可以提供映射過程中將考慮的其他類別清單（例如您目前的電子商務類別）。
$statusUrl = SharpApiService::toursAndActivitiesProductCategories('海灣綠洲''下龍', // 可選城市'越南', // 可選國家'英語', // 可選語言10, // 可選數量'Adventurous' , //可選語音提示'Bay Hotels, Ha Long Hotels' // 可選上下文，目前要匹配的類別
）；產生酒店類型產品的合適類別列表，相關權重為浮點值 (1.0-10.0)，其中 10 等於 100%，即最高相關性得分。提供產品名稱及其參數，以獲得盡可能最佳的類別匹配。可以方便地填充產品目錄資料和批量產品處理。只需要第一個參數productName 。
您可以使用max_quantity參數限制輸出。
您可以透過提供voice_tone參數來設定您喜歡的書寫風格。它可以是形容詞，如funny或joyous ，甚至可以是著名作家的名字。
在附加的選用參數context中，您可以提供映射過程中將考慮的其他類別清單（例如您目前的電子商務類別）。
$statusUrl = SharpApiService::hospitalityProductCategories('Hotel Crystal 大人専用''Tokyo', // 可選城市'Japan', // 可選國家'English', // 可選language10, // 可選數量'Adventurous' , // 可選語音提示 'Tokyo Hotels, Crystal Hotels' // 可選上下文，目前要匹配的類別
）；用於檢查當前訂閱週期詳細資訊的端點
$statusUrl = SharpApiService::quota();
將導致：
{“時間戳記”：“2024-03-19T12：49：41.445736Z”，“on_Trial”：假，“Trial_ends”：“2024-03-17T07：57：46.000000Z”，“訂閱”：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。 subscription_words_used_percentage是目前每月配額使用量的百分比，可以作為信用耗盡的使用者警報。如果價值高於 80%，建議在 https://sharpapi.com/dashboard/credits 訂閱更多積分，以避免服務中斷。
這些值也可以在儀表板中找到：https://sharpapi.com/dashboard
簡單的 PING 端點，用於檢查 API 及其內部 timze 區域（時間戳記）的可用性。
$statusUrl = SharpApiService::ping();
將導致：
{“ping”：“pong”，“時間戳”：“2024-03-12T08：50：11.188308Z”}請透過 GitHub 告知我們 »
或加入我們的電報群 »
請參閱變更日誌以了解有關最近更改內容的更多資訊。
A2Z網路有限公司
大衛·馬考斯基
提升您的 Laravel AI 能力！
麻省理工學院許可證 (MIT)。請參閱許可證文件以獲取更多資訊。
如需最新消息、教學和案例研究，請不要忘記關注我們：
SharpAPI X（以前的 Twitter）
夏普API YouTube
夏普API Vimeo
SharpAPI 領英
夏普API臉書
