sharpapi php client
v1.2.0 release
SharpApi.com 웹 사이트에서 자세히보기»
공무원을 참조하십시오.
composer require sharpapi/sharpapi-php-clientSharpApi.com에 등록하고 API 키를 얻으십시오.
그게 다야!
$ 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 ());일반적인 유스 케이스는 다음 단계가 필요합니다.
fetchResults($statusUrl) 메소드를 실행하여 180 초 동안 10 초마다 요청을 보내십시오 (이 값은 사용자 정의 할 수 있습니다. SharpApiService 소스 코드를 확인하십시오).SharpApiJob 객체가 반환됩니다.success 반환 상태로 완료된 작업의 경우 $jobResultJson = $jobResult->getResultJson() 과 같은 방법 중 하나를 사용하여 결과를 얻을 수 있습니다.파견 된 각 작업은 일반적으로 몇 초에서 1 분 사이에 걸립니다.
그 기간이 지나면 반환 된 작업은 일반적으로 success 상태를 가지며 결과는 추가 처리를 위해 사용할 수 있습니다. 각 API 메소드는 다른 리턴 형식을 반환합니다. 자세한 내용은 아래 API 메소드/엔드 포인트 목록으로 이동»
우리의 API는 매번 올바른 형식을 반환하도록 보장합니다. 드문 경우에 SharpApi를 사용하는 AI 엔진은 오해 및 시간 초과 또는 잘못된 데이터를 반환하는 경향이 있습니다. 이 경우 작업에 대한 반환 된 status failed 합니다. 이 경우 동일한 작업 요청을 다시 실행할 수 있습니다.
작업이 여전히 우리 엔진으로 처리되는 한 pending 상태를 계속 반환합니다.
기본 HTTP 요청은 Guzzle로 구동되므로 일반적인 Guzzle 예외를 확인하는 것이 좋습니다.
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"
}
]
*/
}
} 각 메소드는 항상 SharpApiJob getResultJson / getResultArray / getResultObject 메서드가 다른 데이터 구조를 반환합니다. SharpApi.com에서 제공된 자세한 예제를 참조하십시오.
SharpApiLanguages 열거 값을 사용하여 코드를보다 읽기 쉽게 만들 수 있습니다.여러 형식 (PDF/DOC/DOCX/TXT/RTF)에서 이력서 (CV) 파일을 구문 분석하고 광범위한 데이터 포인트 객체를 반환합니다.
선택적 출력 언어 매개 변수도 제공 할 수 있습니다 ( English 값은 기본값으로 설정 됨).
$ statusUrl = SharpApiService:: parseResume ( ' /test/resume.pdf ' , ' English ' ); 광범위한 매개 변수 목록을 기반 으로이 엔드 포인트는 간단한 설명, 작업 요구 사항 및 직무 책임을 포함하여 응답 형식으로 간결한 작업 세부 사항을 제공합니다. 유일한 필수 매개 변수는 name 입니다.
이 기능은 JobDescriptionParameters 라는 특수 DTO 클래스 ( Data Transfer Object ) 매개 변수를 사용하여 입력 매개 변수의 검증을 돕습니다. 이 DTO 의 생성자의 name 매개 변수 만 필수입니다.
Voice_tone 매개 변수를 제공하여 선호하는 쓰기 스타일을 설정할 수 있습니다. 그것은 funny 있거나 joyous 유명한 작가의 이름과 같은 형용사 일 수도 있습니다.
이 API 메소드는 옵션 컨텍스트 매개 변수를 제공하며 컨텐츠 처리를위한 추가 유연한 지침을 제공하는 데 사용할 수 있습니다.
$ 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 );가중치를 플로트 값 (1.0-10.0)으로서의 관련 기술 목록을 생성하며 10은 100%, 가장 높은 관련성 점수입니다.
첫 번째 매개 변수 ( name ) 만 필요합니다.
max_quantity 매개 변수로 출력을 제한 할 수 있습니다.
$ statusUrl = SharpApiService:: relatedSkills (
' MySQL ' ,
' English ' , // optional language
10 // optional quantity
);가중치를 플로트 값 (1.0-10.0)으로 사용하는 관련 작업 위치 목록을 생성하며 10은 100%, 가장 높은 관련성 점수입니다.
첫 번째 매개 변수 ( name ) 만 필요합니다.
max_quantity 매개 변수로 출력을 제한 할 수 있습니다.
$ statusUrl = SharpApiService:: relatedJobPositions (
' Senior PHP Engineer ' ,
' English ' , // optional language
10 // optional quantity
);고객의 제품 검토를 구문 분석하고 0-100%사이의 점수로 감정 (양수/부정/중립)을 제공합니다. 온라인 상점에 대한 감정 보고서 처리에 적합합니다.
$ statusUrl = SharpApiService:: productReviewSentiment ( ' customer review contents ' );관련성 가중치를 플로트 값 (1.0-10.0)으로 사용하는 제품에 적합한 범주 목록을 생성합니다. 여기서 10은 100%, 가장 높은 관련성 점수입니다. 제품 이름과 매개 변수를 제공하여 최상의 카테고리 일치를 얻을 수 있습니다. 제품 카탈로그 데이터 및 대량 제품 처리에 유용합니다.
max_quantity 매개 변수로 출력을 제한 할 수 있습니다.
voice_tone 매개 변수를 제공하여 선호하는 쓰기 스타일을 설정할 수 있습니다. 그것은 funny 있거나 joyous 유명한 작가의 이름과 같은 형용사 일 수도 있습니다.
추가 옵션 매개 변수 컨텍스트 내에서 매핑 프로세스 (예 : 현재 전자 상거래 범주) 중에 고려 될 다른 범주 목록을 제공 할 수 있습니다.
$ 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
);제품 설명의 짧은 버전을 생성합니다. 제품의 많은 세부 사항과 매개 변수를 제공하여 최상의 마케팅 소개를 가능하게하십시오. 제품 카탈로그 데이터 및 대량 제품 처리에 유용합니다.
max_length 매개 변수로 출력을 제한 할 수 있습니다. max_length 결과의 일반적인 감각을 유지하기 위해 엄격한 요구 사항이 아닌 언어 모델에 대한 강력한 제안 역할을합니다.
voice_tone 매개 변수를 제공하여 선호하는 쓰기 스타일을 설정할 수 있습니다. 그것은 funny 있거나 joyous 유명한 작가의 이름과 같은 형용사 일 수도 있습니다.
$ statusUrl = SharpApiService:: generateProductIntro (
' Sony Playstation 5 ' ,
SharpApiLanguages:: ENGLISH , // optional language
300 , // optional length
' Funny ' // optional voice tone
);구매 후 고객에게 맞춤형 감사 이메일을 생성합니다. 응답 내용에는 결국 제목, 인사말 또는 발신자 정보가 포함되어 있지 않으므로 나머지 이메일을 쉽게 개인화 할 수 있습니다.
Max_Length 매개 변수로 출력을 제한 할 수 있습니다. max_length 결과의 일반적인 감각을 유지하기 위해 엄격한 요구 사항이 아닌 언어 모델에 대한 강력한 제안 역할을합니다.
voice_tone 매개 변수를 제공하여 선호하는 쓰기 스타일을 설정할 수 있습니다. 그것은 재미 있거나 즐겁고 유명한 작가의 이름과 같은 형용사 일 수도 있습니다.
이 API 메소드는 옵션 컨텍스트 매개 변수를 제공하며 컨텐츠 처리를위한 추가 유연한 지침을 제공하는 데 사용할 수 있습니다.
$ 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
); 제공된 텍스트를 선택한 언어로 변환합니다. 80 개의 언어가 지원됩니다. 자세한 내용은 SharpApiLanguages Enum 클래스 포함을 확인하십시오.
voice_tone 매개 변수를 제공하여 선호하는 쓰기 스타일을 설정할 수 있습니다. 그것은 재미 있거나 즐겁고 유명한 작가의 이름과 같은 형용사 일 수도 있습니다.
선택적 context 매개 변수도 사용할 수 있습니다. 사용 사례 예제 또는 일부 추가 설명과 같이 번역 된 텍스트에 대한 더 많은 컨텍스트를 제공하는 데 사용할 수 있습니다.
$ 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"} 제공된 텍스트의 역설 버전을 생성합니다. content 매개 변수 만 필요합니다. 출력 언어, 최대 문자 길이 및 음성 톤을 정의 할 수 있습니다.
텍스트 처리 방법에 대한 추가 지침은 컨텍스트 매개 변수에서 제공 될 수 있습니다. max_length 결과의 일반적인 감각을 유지하기 위해 엄격한 요구 사항이 아닌 언어 모델에 대한 강력한 제안 역할을합니다.
선택적인 voice_tone 매개 변수를 제공하여 선호하는 쓰기 스타일을 설정할 수 있습니다. 그것은 funny 있거나 joyous 유명한 작가의 이름과 같은 형용사 일 수도 있습니다.
이 API 메소드는 옵션 context 매개 변수를 제공하며 컨텐츠 처리를위한 추가 유연한 지침을 제공하는 데 사용할 수 있습니다.
$ statusUrl = SharpApiService:: paraphrase (
$ text ,
SharpApiLanguages:: FRENCH , // optional language
500 , // optional length
' neutral ' , // optional voice tone
' avoid using abbreviations ' // optional context
);교정 된 텍스트를 교정하고 문법을 확인하십시오.
$ 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 ' , // optional language
5 , // optional length
' Freaky & Curious ' , // optional voice tone
' add emojis! ' // optional extra context instructions for content processing
);제공된 컨텐츠의 요약 된 버전을 생성합니다. 더 긴 텍스트의 마케팅 소개를 생성하는 데 적합합니다.
max_length 매개 변수로 출력을 제한 할 수 있습니다. max_length 결과의 일반적인 감각을 유지하기 위해 엄격한 요구 사항이 아닌 언어 모델에 대한 강력한 제안 역할을합니다.
voice_ton E 매개 변수를 제공하여 선호하는 쓰기 스타일을 설정할 수 있습니다. 그것은 funny 있거나 joyous 유명한 작가의 이름과 같은 형용사 일 수도 있습니다.
$ statusUrl = SharpApiService:: summarizeText (
$ text ,
' English ' , // optional language
' David Attenborough ' , // optional voice tone
' add emojis! ' // optional extra context instructions for content processing
);제공된 컨텐츠에 따라 가장 중요한 메타 태그를 생성합니다. 웹 사이트 및 사진 URL에 대한 링크를 포함시켜 최대한 많은 태그를 채워집니다.
voice_ton E 매개 변수를 제공하여 선호하는 쓰기 스타일을 설정할 수 있습니다. 그것은 funny 있거나 joyous 유명한 작가의 이름과 같은 형용사 일 수도 있습니다.
$ statusUrl = SharpApiService:: generateSeoTags (
$ text ,
' English ' , // optional language
' David Attenborough ' // optional voice tone
);Travel/Hospitality Product Review를 구문 분석하고 0-100%사이의 점수를 가진 감정 (양수/음성/중립)을 제공합니다. 온라인 상점에 대한 감정 보고서 처리에 적합합니다.
$ statusUrl = SharpApiService:: travelReviewSentiment ( $ text ); 관련성 가중치를 플로트 값 (1.0-10.0)과 관련된 투어 및 활동 제품에 적합한 카테고리 목록을 생성합니다. 여기서 10은 100%, 가장 높은 관련성 점수입니다. 제품 이름과 매개 변수를 제공하여 최상의 카테고리 일치를 얻을 수 있습니다. 제품 카탈로그 데이터 및 대량 제품 처리에 유용합니다. 첫 번째 매개 변수 productName 만 필요합니다.
max_quantity 매개 변수로 출력을 제한 할 수 있습니다.
voice_tone 매개 변수를 제공하여 선호하는 쓰기 스타일을 설정할 수 있습니다. 그것은 funny 있거나 joyous 유명한 작가의 이름과 같은 형용사 일 수도 있습니다.
추가 옵션 매개 변수 context 내에서 매핑 프로세스 (예 : 현재 전자 상거래 범주) 중에 고려 될 다른 범주 목록을 제공 할 수 있습니다.
$ 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
); 관련성 가중치를 플로트 값 (1.0-10.0)과 관련된 환대 유형 제품에 적합한 범주 목록을 생성합니다. 여기서 10은 100%, 가장 높은 관련성 점수입니다. 제품 이름과 매개 변수를 제공하여 최상의 카테고리 일치를 얻을 수 있습니다. 채워진 제품 카탈로그 데이터 및 대량 제품 처리에 유용합니다. 첫 번째 매개 변수 productName 만 필요합니다.
max_quantity 매개 변수로 출력을 제한 할 수 있습니다.
voice_tone 매개 변수를 제공하여 선호하는 쓰기 스타일을 설정할 수 있습니다. 그것은 funny 있거나 joyous 유명한 작가의 이름과 같은 형용사 일 수도 있습니다.
추가 옵션 매개 변수 context 내에서 매핑 프로세스 (예 : 현재 전자 상거래 범주) 중에 고려 될 다른 범주 목록을 제공 할 수 있습니다.
$ 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
);구독의 현재 기간에 대한 세부 정보를 확인하는 엔드 포인트
$ 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 Zone (Timestamp)입니다.
$ statusUrl = SharpApiService:: ping ();결과 :
{
"ping" : " pong " ,
"timestamp" : " 2024-03-12T08:50:11.188308Z "
}알려주세요»
최근에 변경된 내용에 대한 자세한 내용은 ChangElog를 참조하십시오.
MIT 라이센스 (MIT). 자세한 내용은 라이센스 파일을 참조하십시오.
