詳細については、SharpAPI.com Web サイトをご覧ください。 »
PHP >= 8.1
Laravel >= 9.0
Laravel を使用しない場合は、ここで Generic SharpAPI PHP クライアントを見つけることができます »
以下の手順に従って、SharpAPI Laravel クライアント パッケージをインストールしてセットアップします。
composer
を介してパッケージをインストールします。
作曲家にはsharpapi/sharpapi-laravel-clientが必要です
SharpAPI.com に登録して API キーを取得します。
.env
内にAPIキーを設定します。
SHARP_API_KEY=キー
[オプション]構成ファイルsharpapi-client.php
を公開します。
注:このパッケージを使用するために構成ファイルを公開する必要はなくなりました。デフォルトでは、パッケージは適切なデフォルト値を使用します。構成をカスタマイズしたい場合のみ、構成を公開する必要があります。
php 職人ベンダー:publish --tag=sharpapi-laravel-client
?電子商取引
魅力的な製品紹介を迅速に作成して顧客を引き付けます。
顧客エクスペリエンスを向上させるために、パーソナライズされたお礼メールを自動的に作成します。
製品の分類を合理化し、よく整理されたカタログを作成します。
センチメント分析: データに基づいた意思決定のために、製品レビューのセンチメントを理解および分析します。
️コンテンツとマーケティングの自動化
世界中の視聴者に向けてテキストを簡単に翻訳します。
あらゆるテキストの言い換えと校正(文法チェックを含む)
スパム コンテンツの検出: スパム コンテンツを効果的に特定し、フィルタリングして除去します。
連絡先情報の抽出: コミュニケーションを効率化するために、非標準形式から電話番号と電子メール アドレスを抽出します。
コンテンツの消費を向上させるために、簡潔な要約と独自のキーワード/タグを生成します。
コンテンツに基づいて META タグを自動的に生成することで、SEO の取り組みを強化します。
HRテック
複雑な職務内容を簡単に作成し、採用プロセスの時間を節約します。
スキルとポジションの洞察: 関連するポジションとスキルを特定して、採用を合理化します。
自動履歴書解析: 履歴書ファイルから情報を効率的に解析して抽出し、処理を容易にします。
旅行、観光、ホスピタリティ
旅行レビューの感情を分析してサービスを向上します。
ツアー、アクティビティ、ホスピタリティ商品の分類を合理化します。
公式を参照してください:
APIドキュメント
多言語サポート: すべてのコンテンツまたはデータ分析 API エンドポイントで 80 言語をサポートします。こちらのリストをご確認ください。
使いやすい RESTful 形式: 標準化されたエンドポイントのセットにより、製品カテゴリ、スキル、役職をカバーする分析エンドポイントを通じて貴重な洞察を取得し、関連するスコアを提供します。
常に同じでクリーンなデータ形式: 返されるすべてのデータに対して、一貫性のある予測可能な JSON 形式を使用するので安心です。 AI データのあいまいさを心配する必要はありません。
技術サポート: 開発者によって開発者のために作成され、お客様の取り組み全体を通じて継続的なサポートを提供します。
SharpApiService
クラスを注入することも、ファサードのSharpApiService
シングルトンを使用することもできます。
特に大規模なデータバッチを処理する場合は、Laravel キューシステムを使用して、ディスパッチされたジョブと結果を確認するプロセスを最適化することをお勧めします。
一般的な使用例では、次の手順が必要です。
利用可能な AI 処理メソッドの 1 つをディスパッチします (ジョブ処理ステータス URL が返されます)。
ポーリング モードで動作するfetchResults($statusUrl)
メソッドを実行し、10 秒ごとに 180 秒間リクエストを送信します (これらの値はカスタマイズできます)。
SharpApiJob
オブジェクトが返されます。
success
戻りステータスで終了したジョブの場合は$jobResultJson = $jobResult->getResultJson()
などのメソッドの 1 つを使用して結果を取得できます。
ディスパッチされた各ジョブには通常、数秒から 1 分かかります。
この期間を過ぎると、通常、返されたジョブのステータスはsuccess
となり、その結果はさらなる処理に使用できるようになります。各 API メソッドは異なる戻り形式を返します。詳細については、以下の API メソッド/エンドポイントのリストを参照してください。
私たちの API は、常に正しい形式を返すことを保証します。 SharpAPI が使用する AI エンジンは、まれに誤動作してタイムアウトしたり、間違ったデータを返したりする傾向があります。このような場合、ジョブに対して返されるstatus
はfailed
なります。その場合は、まったく同じジョブ リクエストを再実行できます。
ジョブがエンジンによって処理されている限り、 pending
ステータスが返され続けます。
<?phpnamespace AppHttpControllers;use GuzzleHttpExceptionGuzzleException;use SharpAPISharpApiServiceSharpApiService;class SharpTest extends Controller{public function __construct(public SharpApiService $sharpApiService) { }/** * @throws GuzzleException */public function detect_phones(): void{$statusUrl = $this->sharpApiService->detectPhones('どこで見つけられますか? セールス テクニカル アドバイザーにお電話ください: 電話: 1800-394-7486またはシンガポールオフィス +65 8888 8888'); $result = $this->sharpApiService->fetchResults($statusUrl); dd($result->getResultJson());/* 返された値: [ { "detected_number": "1800-394-7486", "parsed_number": "+18003947486" }, { "detected_number": "+65 8888 8888" , "parsed_number": "+6588888888" } ] */} }
基礎となる HTTP リクエストは Laravel HTTP クライアント/Guzzle によって促進されるため、一般的な Guzzle 例外について理解しておくことをお勧めします。
use GuzzleHttpExceptionClientException;// ステップ 1: いずれかのメソッドを使用してジョブを API にディスパッチします。例:try {$statusUrl = SharpApiService::summarizeText($text, 'German', // オプションの language500, // オプションの長さ'ニュートラルな声のトーン' // オプションの声のトーン );// $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 = $jobResult->getResultObject();
したがって、これらの値を.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
各メソッドは常にSharpApiJob
オブジェクトを返しますが、そのgetResultJson / getResultArray / getResultObject
メソッドは異なるデータ構造を返します。 SharpAPI.com で提供されている詳細な例を参照してください。
language
パラメータを持つメソッドの場合は、 SharpApiLanguages
Enum 値を使用してコードを読みやすくすることもできます。
複数の形式 (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", //Optionalminimum_work_ experience: "5 years", //Optionalminimum_education: "Bachelor Degree", //Optionalemployment_type: "フルタイム", //Optionalrequired_skills: ['PHP8', 'Laravel'], // Optionaloptional_skills: ['AWS', 'Redis'], //Optionalcountry: "United Kingdom", //Optionalremote: true, //Optionalvisa_ Sponsored: true, //Optionalvoice_tone: 'Professional and Geeky', // オプションの音声トーンcontext: null, // オプションのコンテキスト、追加の AI 処理命令言語: null // オプションの出力言語 );$statusUrl = SharpApiService::generateJobDescription($jobDescriptionParameters);
関連するスキルのリストを、その重みを浮動小数点値 (1.0 ~ 10.0) として生成します。10 は 100%、最も高い関連性スコアに相当します。
最初のパラメータ ( name
) のみが必要です。
max_quantity
パラメーターを使用して出力を制限できます。
$statusUrl = SharpApiService::popularSkills('MySQL', 'English', // オプションの language10 // オプションの数量 );
関連する役職のリストを浮動小数点数 (1.0 ~ 10.0) として重み付けして生成します。10 は 100%、最も高い関連性スコアに相当します。
最初のパラメータ ( name
) のみが必要です。
max_quantity
パラメーターを使用して出力を制限できます。
$statusUrl = SharpApiService::popularJobPositions('シニア PHP エンジニア', 'English', // オプションの言語 10 // オプションの数量 );
顧客の製品レビューを解析し、そのセンチメント (肯定的/否定的/中立) を 0 ~ 100% のスコアで提供します。あらゆるオンライン ストアのセンチメント レポートの処理に最適です。
$statusUrl = SharpApiService::productReviewSentiment('顧客レビュー内容');
関連性の重みを浮動小数点値 (1.0 ~ 10.0) として使用して、製品に適したカテゴリのリストを生成します。10 は 100% (最高の関連性スコアに相当します)。製品名とそのパラメータを入力して、可能な限り最良のカテゴリ一致を取得します。製品カタログ データの入力やバルク製品の処理に便利です。
max_quantity
パラメーターを使用して出力を制限できます。
voice_tone
パラメータを指定することで、好みの文章スタイルを設定できます。 funny
」「 joyous
などの形容詞や、有名な作家の名前でも構いません。
追加のオプションのパラメーター コンテキスト内で、マッピング プロセス中に考慮される他のカテゴリ (現在の e コマース カテゴリなど) のリストを提供できます。
$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, // オプションの language300, // オプションの長さ 'Funny' // オプションの声のトーン );
購入後に顧客にパーソナライズされたサンキューメールを生成します。応答コンテンツにはタイトル、挨拶、最後に送信者情報が含まれないため、メールの残りの部分を簡単にカスタマイズできます。
max_length パラメータを使用して出力を制限できます。 max_length
、結果の一般的な意味を維持するための厳密な要件ではなく、言語モデルに対する強力な提案として機能することに留意してください。
voice_tone
パラメータを指定することで、好みの文章スタイルを設定できます。面白い、楽しいなどの形容詞、あるいは有名な作家の名前でも構いません。
この API メソッドは、コンテンツ処理のための追加の柔軟な指示を提供するために使用できるオプションのコンテキスト パラメーターも提供します。
$statusUrl = SharpApiService::generateThankYouEmail('Sony Playstation 5', SharpApiLanguages::ENGLISH, // オプションの language250, // オプションの長さ 'Neutral', // オプションの声のトーン '休暇前に再度訪問するよう顧客に招待する必要があります' // オプションコンテクスト );
提供されたテキストを選択した言語に翻訳します。 80 の言語がサポートされています。詳細については、含まれているSharpApiLanguages
Enumクラスを確認してください。
voice_tone
パラメータを指定することで、好みの文章スタイルを設定できます。面白い、楽しいなどの形容詞、あるいは有名な作家の名前でも構いません。
オプションのcontext
パラメーターも使用できます。これを使用して、ユースケースの例や追加の説明など、翻訳されたテキストにさらに多くのコンテキストを提供できます。
$statusUrl = SharpApiService::translate('turn', SharpApiLanguages::FRENCH, // オプションの言語'neutral', // オプションの声色'ページをめくる' // オプションのコンテキスト );// 結果は :// {"content": "tourner", "to_ language": "French", "from_langage": "English"}
提供されたテキストの言い換えバージョンを生成します。 content
パラメータのみが必要です。出力言語、最大文字長、声のトーンを定義できます。
テキストの処理方法に関する追加の指示を context パラメーターで提供できます。 max_length
、結果の一般的な意味を維持するための厳密な要件ではなく、言語モデルに対する強力な提案として機能することに留意してください。
オプションのvoice_tone
パラメータを指定することで、好みの文章スタイルを設定できます。 funny
」「 joyous
などの形容詞や、有名な作家の名前でも構いません。
この API メソッドは、コンテンツ処理のための追加の柔軟な指示を提供するために使用できるオプションのcontext
パラメーターも提供します。
$statusUrl = SharpApiService::paraphrase($text, SharpApiLanguages::FRENCH, // オプションの言語 500, // オプションの長さ '中立', // オプションの声色 '略語の使用を避ける' // オプションのコンテキスト );
提供されたテキストを校正 (および文法チェック) します。
$statusUrl = SharpApiService::proofread($text);
提供されたコンテンツがスパムフィルタリングテストに合格するかどうかを確認します。信頼スコアのパーセンテージと、スパムと見なされるかどうかの説明を提供します。この情報はモデレーターが最終決定を下すのに役立ちます。
$statusUrl = SharpApiService::detectSpam($text);
提供された電話番号のテキストを解析し、検出された元のバージョンとその E.164 形式を返します。大量のデータを処理して電話番号と照合して検証する場合や、あるはずのない場所にある電話番号を検出したい場合に便利かもしれません。
$statusUrl = SharpApiService::detectPhones($text);
提供されたテキストを解析して、可能性のある電子メールを探します。電子メール アドレスに対して大量のデータを処理および検証する場合や、想定されていない場所にある電子メールを検出したい場合に便利かもしれません。
$statusUrl = SharpApiService::detectEmails($text);
提供されたコンテンツに基づいて一意のキーワード/タグのリストを生成します。
max_quantity
パラメーターを使用して出力を制限できます。
voice_tone
パラメータを指定することで、好みの文章スタイルを設定できます。
$statusUrl = SharpApiService::generateKeywords($text, 'English', // オプションの language5, // オプションの長さ 'Freaky & Curious', // オプションの声色 '絵文字を追加!' // オプションのコンテンツ処理のための追加コンテキスト命令 );
提供されたコンテンツの要約バージョンを生成します。長いテキストのマーケティング紹介文を作成するのに最適です。
max_length
パラメータを使用して出力を制限できます。 max_length
、結果の一般的な意味を維持するための厳密な要件ではなく、言語モデルに対する強力な提案として機能することに留意してください。
voice_ton
e パラメータを指定することで、好みの文章スタイルを設定できます。 funny
」「 joyous
などの形容詞や、有名な作家の名前でも構いません。
$statusUrl = SharpApiService::summarizeText($text, 'English', // オプションの言語'David Attenborough', // オプションの声色'add emojis!' // オプションのコンテンツ処理のための追加コンテキスト命令 );
提供されたコンテンツに基づいて、最も重要なすべての META タグを生成します。できるだけ多くのタグが入力されるように、Web サイトへのリンクと写真の 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
内で、マッピング プロセス中に考慮される他のカテゴリ (現在の e コマース カテゴリなど) のリストを指定できます。
$statusUrl = SharpApiService::toursAndActivitiesProductCatalog('オアシス オブ ザ ベイ''ハロン', // オプションの都市 'ベトナム', // オプションの国 '英語', // オプションの言語 10, // オプションの数量 '冒険的', //オプションの音声トーン「ベイ ホテル、ハロン ホテル」 // オプションのコンテキスト、一致する現在のカテゴリ );
関連性の重みを浮動小数点値 (1.0 ~ 10.0) として使用して、ホスピタリティ タイプの製品に適したカテゴリのリストを生成します (10 は 100%、最高の関連性スコアに相当します)。製品名とそのパラメータを入力して、可能な限り最良のカテゴリ一致を取得します。製品カタログ データの入力やバルク製品の処理に便利です。最初のパラメータproductName
のみが必要です。
max_quantity
パラメーターを使用して出力を制限できます。
voice_tone
パラメータを指定することで、好みの文章スタイルを設定できます。 funny
」「 joyous
などの形容詞や、有名な作家の名前でも構いません。
追加のオプションのパラメータcontext
内で、マッピング プロセス中に考慮される他のカテゴリ (現在の e コマース カテゴリなど) のリストを指定できます。
$statusUrl = SharpApiService::hospitalityProductCatalog('ホテルクリスタル大人専用''Tokyo', // オプションの都市'Japan', // オプションの国'English', // オプションの言語10, // オプションの数量'Adventurous', // オプションvoicetone'Tokyo Hotels, Crystal Hotels' // オプションのコンテキスト、一致する現在のカテゴリ );
サブスクリプションの現在の期間に関する詳細を確認するためのエンドポイント
$statusUrl = SharpApiService::quota();
結果は次のようになります:
{"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
は、現在の月次クォータ使用量の割合であり、クレジットが枯渇した場合のユーザーへのアラートとして機能する可能性があります。値が 80% を超える場合は、サービスの中断を避けるために、https://sharpapi.com/dashboard/credits でさらに多くのクレジットを購読することをお勧めします。
これらの値は、https://sharpapi.com/dashboard のダッシュボードでも利用できます。
API の可用性とその内部 timze ゾーン (タイムスタンプ) をチェックするためのシンプルな PING エンドポイント。
$statusUrl = SharpApiService::ping();
結果は次のようになります:
{ "ping": "ポン"、"タイムスタンプ": "2024-03-12T08:50:11.188308Z"}
GitHub 経由でお知らせください »
またはテレグラムグループに参加してください »
最近の変更点の詳細については、CHANGELOG を参照してください。
A2Zウェブ株式会社
ダウィド・マコウスキー
Laravel AI 機能を強化しましょう!
MIT ライセンス (MIT)。詳細については、ライセンス ファイルを参照してください。
最新のニュース、チュートリアル、ケーススタディについては、ぜひフォローしてください。
SharpAPI X (旧 Twitter)
シャープAPI YouTube
SharpAPI Vimeo
SharpAPI LinkedIn
シャープAPIフェイスブック