Multilingual Studio Home > PHP Library > API Reference

Multilingual Studio PHP Library Reference

Multilingual Studio PHP Library contains APIs for using functions provided by the Language Grid, such as back translation, sound reproduction and multi-hop translation, in various languages. Multilingual Studio PHP Library is a library that enables users to easily invoke the wrapped Language Grid PHP API (SOAP). This library is compatible with PHP5.3 or higher.

Please see Function list page for the list of functions in this library. Please refer to Tutorial page for how to use this library.

Service Grid API
Local Service API
1. Local Dictionary
2. Local Parallel Text

Service Grid API

Services: Common

Specification for authentication information

There are two ways to specify authentication information.

Specification of default authentication information of common services
Specification of specific authentication information for each service

In specification of default authentication information of common services, once you fill in the following code in the configuration file for the entire application and keep it readable until service execution, you don’t need to specify ID and password each time when running services. This is the commonly used method.

        ClientFactory::setDefaultUserId('someUserId');
        ClientFactory::setDefaultPassword('somePassword');

Specification of specific authentication information of each service specifies the ID and password individually when creating the service client. This method is used when a server in the service grid is different for each provided service and so on.

        $client = ClientFactory::createTranslationClient('Service URL');
        $client->setUserId('someUserId');
        $client->setUserId('somePassword');

Exception on failure of invoking SOAP

In the case of failure of invoking SOAP, such as authentication error, LangridException (the standardException class) occurs. When using a client, be sure to catch the exception by using the try~catch syntax.

        try {
            $client = ClientFactory::createBilingualDictionaryClient('Service URL');
            $client->getSupportedLanguagePairs();
        } catch(LangridException $e) {
            // Some error handling
        }

AdjacencyPairClient

Interface of the AdjacencyPairs service client.

search

Parameter

(string) category - category
(string) language - language code based on RFC3066. (In the case that only the prefix corresponds to the defined language, only the first option is invoked (For example: In the case that the supporting language has zh-Hans and zh specified as the language))
(string) firstTurn - utterance (REQUIRED)
(const MatchingMethod) matchingMethod - search method ("COMPLETE"，"PREFIX"，"SUFFIX"，"PARTIAL"，"REGEX") (REQUIRED)

Return value

category - category
firstTurn - utterance
secondTurns - adjacency array reply

[An example of execution results]

        .array(2) {
          [0]=>
          object(stdClass)#207 (3) {
            ["category"]=>
            string(7) "Payment"
            ["firstTurn"]=>
            string(23) "test/examination charge"
            ["secondTurns"]=>
            array(1) {
              [0]=>
              string(98) "charges for specimen tests, ie.blood, urine etc. and physical examinations ie. ECG, endoscopy etc."
            }
          }
          [1]=>
          object(stdClass)#205 (3) {
            ["category"]=>
            string(7) "account"
            ["firstTurn"]=>
            string(23) "test/examination charge"
            ["secondTurns"]=>
            array(1) {
              [0]=>
              string(100) "charges for specimen tests ie.blood, urine etc. and physical examinations ie.EKG/ECG, endoscopy etc."
            }
          }
        }

Method name	Arguments	Return value	Description
remove	· (Boolean) force [= false]: logical delete or physical delete	void
add_language	· (Language) language: language to add	(DictionaryLanguage) added DictionaryLanguage record	Add languages to the dictionary
get_languages		(array) A list of language codes	Get the language contained in the dictionary
remove_language	· (Language) $ language: language to remove · (Boolean) $ force [= false]: whether to delete the content		Remove the language from dictionary
update_languages	· (array) languages: language list to be updated · (Boolean) force_on_delete [= false]: whether to delete the content when deleting		Update the language included in the dictionary to specify the list. (Delete content not included in the argument. )
is_deploy		(Boolean) deployment status	Return the deployment status of the dictionary service
deploy			Deploy dictionary as a service
undeploy			Undeploy dictionary from the service
add_record	· (array) params: content to add · (String) create_user [= null]: ID of the user adding content		Add content to the dictionary. Specify parameters in the hash of {language=>content}
records_count		(Integer) The number	Count the total number of content included in the dictionary
get_records	· (array) options: search condition	(DictionaryRecord) Record the results	Return records that match the search criteria included in the dictionary. Search criteria is described below .
count_records_each_language		(array) Registration number for each language	Get the number of registrations for each language
count_records_by_language	· (Language) language: language to obtain	(Integer) Registration number	Get the number of registrations in the target language
can_view	· (String) user_id [= null]: ID of the user	(Boolean) Result	Get whether specified user (the default is all users) can view parallel texts
can_edit	· (String) user_id [= null]: ID of the user	(Boolean) Result	Get whether specified user (the default is all users) can edit parallel texts
is_owner	· (String) user_id [= null]: ID of the user	(Boolean) Result	Get whether the specified user is the owner of the dictionary
to_json		(String) JSON text	Convert the dictionary to Json format. (Contents are not included)
to_xml		(String) XML text	Convert the dictionary to the XML format. (Contents are not included)

Method name	Arguments	Return value	Description
create_with_records	· (Array) params: properties and records of the dictionary · (String) create_user: ID of the user to create	(Dictionary) created dictionary	Create dictionary and record immediately. Used in import etc.. details of params [Required] name, languages, records [Optional] licenser records is in the form of array of the same number as languages. (Example) `Dictionary::create_with_records(array(` `'name' => 'Dictionary name',` `'languages' => array('ja', 'en', 'ko'),` `'records' => array(` `array('こんにちは', 'Hello', ''),` `array('こんばんは', 'Good evening', '')` `)` `));`
first	· (array) $ options [= array ()]: the search criteria	(Dictionary) Dictionary	Get the first parallel text that match the search criteria. Search criteria is described below
last	· (array) $ options [= array ()]: the search criteria	(Dictionary) Dictionary	Get the last parallel text that match the search criteria. Search criteria is described below
all	· (array) $ options [= array ()]: the search criteria	(Dictionary []) list dictionary	Get all of the dictionary that match the search criteria. Search criteria is described below
count	· (array) $ options [= array ()]: the search criteria	(Dictionary) Dictionary	Get the number of dictionary that match the search criteria. Search criteria is described below
first_with_deleted	· (array) $ options [= array ()]: the search criteria	(Dictionary) Dictionary	Get the first parallel text that match the search criteria. (Including logical deleted one) Search criteria is described below
last_with_deleted	· (array) $ options [= array ()]: the search criteria	(Dictionary) Dictionary	Get the last parallel text that match the search criteria. (Including logical deleted one) Search criteria is described below
all_with_deleted	· (array) $ options [= array ()]: the search criteria	(Dictionary) Dictionary	Get all of the dictionary that match the search criteria. (Including logical deleted one) Search criteria is described below
count_with_deleted	· (array) $ options [= array ()]: the search criteria	(Dictionary) Dictionary	Get the number of dictionary that match the search criteria. (Including logical deleted one) Search criteria is described below

Method name	Parameter	Return value	Description
remove			Delete the dictionary record
get_contents	・(Boolean) withAllProperty [= false]: Data format of contents	(array) Hashing format array of contents	Acquire contents included in the record If withAllProperty is false (Default)，return using the format, {$languageCode => $content}. [例] `array('ja' => 'こんにちは', 'en' => 'Hello')` If withAllProperty is true, return using the format {'language code' => {$propertyName => $propertyValue} } [例] `array( 'ja' => array('text' => 'こんにちは', 'created_at' => '2012-03-10 16:44:46'), 'en' => array('text' => 'Hello', 'created_by' => '0000001' )`
get_contents_as_ordered_array	・(array) languageOrder: Array of languages	(array) Array of contens	Acquire contents against the assigned language in assigned order. If data in the assigned language doesn't exist, return null character string. If set array ('ja', 'en', 'ko') as the parameter, return array ('contents of ja', 'contents of en', 'contents of ko') as return value. Use this if you can get data separated by comma.
update_contents	・(array) params: Update data ・(String) update_user [= '']: Update user	(DictionaryRecord) Updated record	Update the dictionary record. params set in {$languageCode => $contentText} format [例] `$reocrd->update_contents(array('ja' => '大阪', 'en' => 'Osaka'));`

Method name	Parameter	Return calue	Description
first	・(array) options [= array()]: Search criteria	(DictionaryRecord) Dictionary record	Get the first dictionary record matching the search criteria. The search criteria is below
last	・(array) options [= array()]: Search criteria	(DictionaryRecord) Dictionary record	Get the last dictionary record matching the search criteria. The search criteria is below
all	・(array) options [= array()]: Search criteria	(DictionaryRecord[]) Dictionary record list	Get all dictionary records matching the search criteria. The search criteria is below
count	・(array) options [= array()]: Search criteria	(DictionaryRecord) Dictionary record	Get the number of dictionary record matching the search criteria. The search criteria is below
count_by_resource_id_and_language	・(Integer) resource_id: Dictionary ID to be counted ・(Language) languageCode: Language code to be counted	(Integer) the registration number	Get the registration number of the assigned language included in the assigned dictionary.
count_by_resource_id_each_languages	・(Integer) resource_id: Dictionary ID to be counted	(array) Registration number for each dictionary	Get the registration number for each dictionary included in all languages.
create_record	・(Integer) resource_id: Dictionary ID to add record ・(array) params [= array()]: Added data ・(String) create_user [= '']: User ID to add	(DictionaryRecord) Added record	Add a new record to the assigned dictionary

Method name	Arguments	The return value	Description
create_with_records	· (array) params: properties and records of parallel texts · (String) create_user: ID of the user to create	(ParallelText) created parallel texts	Create parallel texts and records immediately. Used in import etc.. details of params [Required] name, languages, records [Optional] licenser records is in the form of an array based on the number of languages. (Example) `ParallelText::create_with_records(array(` `'name' => '用例対訳名',` `'languages' => array('ja', 'en', 'ko'),` `'records' => array(` `array('こんにちは', 'Hello', ''),` `array('こんばんは', 'Good evening', '')` `)` `));`
first	· (array) $ options [= array ()]: the search criteria	(ParallelText) Parallel text	Get the first parallel text that match the search criteria. Search criteria is described below
last	· (array) $ options [= array ()]: the search criteria	(ParallelText) Parallel text	Get the last parallel text that match the search criteria. Search criteria is described below
all	· (array) $ options [= array ()]: the search criteria	(ParallelText []) list of parallel texts	Get all parallel texts that match the search criteria. Search criteria is described below
count	· (array) $ options [= array ()]: the search criteria	(ParallelText) Parallel text	Get the number of parallel texts that match the search criteria. Search criteria is described below
first_with_deleted	· (array) $ options [= array ()]: the search criteria	(ParallelText) Parallel text	Get the first parallel text that match the search criteria. (Including logical deleted one) Search criteria is described below
last_with_deleted	· (array) $ options [= array ()]: the search criteria	(ParallelText) Parallel text	Get the last parallel text that match the search criteria. (Including logical deleted one) Search criteria is described below
all_with_deleted	· (array) $ options [= array ()]: the search criteria	(ParallelText) Parallel text	Get all parallel texts that match the search criteria. (Including logical deleted one) Search criteria is described below
count_with_deleted	· (array) $ options [= array ()]: the search criteria	(ParallelText) Parallel text	Get the number of parallel texts that match the search criteria. (Including logical deleted one) Search criteria is described below

Method name	Arguments	The return value	Description
Remove			Remove parallel texts record
get_contents	· (Boolean) withAllProperty [= false]: data format of the content	(array) hash format array of content	Get the content contained in the record. If withAllProperty is false (the default), return in the form of {$languageCode => $content}. [Example] `array('ja' => 'こんにちは', 'en' => 'Hello')` If withAllProperty is true, return in the form of {'language code' => {$propertyName => $propertyValue} }. [Example] `array( 'ja' => array('text' => 'こんにちは', 'created_at' => '2012-03-10 16:44:46'), 'en' => array('text' => 'Hello', 'created_by' => '0000001' )`
get_contents_as_ordered_array	· (array) languageOrder: array of languages	(array) array of content	Get the content for the specified language in the specified order. If the data in the specified language does not exist, return an empty string. Assuming that the argument array is ('ja', 'en', 'ko'), Return value is array ('content of ja', 'content of en', 'content of ko'). Use commas to separate data.
update_contents	· (array) params: update data · (String) update_user [='']: Update User	(ParallelTextRecord) Updated record	Update parallel texts record. params are specified in the form of {$languageCode => $contentText} [Example] `$reocrd->update_contents(array('ja' => '大阪', 'en' => 'Osaka'));`

Method name	Arguments	The return value	Description
first	· (array) options [= array()]: the search criteria	(ParallelTextRecord) Parallel text record	Get the first parallel text that match the search criteria. Search criteria is described below
last	· (array) options [= array()]: the search criteria	(ParallelTextRecord) Parallel text record	Get the last parallel text that match the search criteria. Search criteria is described below
all	· (array) options [= array()]: the search criteria	(ParallelTextRecord []) parallel texts record list	Get all parallel texts that match the search criteria. Search criteria is described below
count	· (array) options [= array()]: the search criteria	(ParallelTextRecord) Parallel text record	Get the number of parallel texts that match the search criteria. Search criteria is described below
count_by_resource_id_and_language	· (Integer) resource_id: ID of parallel texts to be counted · (Language) languageCode: language code to be counted	(Integer) The number	Get the registration number of the specified language that match the search criteria.
count_by_resource_id_each_languages	· (Integer) resource_id: ID of parallel texts to be counted	(array) Registration number for each language	Get the registration number for each language that match the search criteria.
create_record	· (Integer) resource_id: ID of parallel text to add a record · (array) params [= array()]: additional data · (String) create_user [='']: ID of the user to add	(ParallelTextRecord) Added record	Add a new record to the specified parallel texts

Multilingual Studio PHP Library Reference

Contents

Service Grid API

Services: Common

Specification for authentication information

Exception on failure of invoking SOAP

AdjacencyPairClient

search

BackTranslationClient

backTranslate

BackTranslationWithTemporalDictionaryClient

backTranslate

BilingualDictionaryClient

search

getSupportedLanguagePairs

getSupportedMatchingMethods

getLastUpdate

BilingualDictionaryHeadwordsExtractionClient

extract

BilingualDictionaryWithLongestMatchSearchClient

searchLongestMatchingTerms

ConceptDictionaryClient

getRelatedConcepts

searchConcepts

DependencyParserClient

parseDependency

DocumentTranslationClient

start

isFinished

getProgress

getResult

DictionaryClient

searchLemmaNodes

getLemma

getConcept

LanguageIdentificationClient

identifyLanguageAndEncoding

identify

getSupportedLanguages

getSupportedEncodings

MetadataForParallelTextClient

searchCandidatesWithMetadata

getMetadata

getMetadataSchema

MorphologicalAnalysisClient

analyze

MultihopBackTranslationClient

multihopBackTranslate

MultihopTranslationClient

multihopTranslate

ParallelTextClient

search

ParallelTextWithEmbeddedMetadataClient

searchParallelTextsByMetadata

searchSupportedMetadata

ParallelTextWithExternalMetadataClient

searchParallelTextsFromCandidates

ParallelTextWithIdClient

searchParallelTexts

listCategories

ParaphraseClient

paraphrase

PictogramDictionaryClient

search

QualityEstimationClient

estimate

SimilarityCalculationClient

calculate

SpeechRecognitionClient

recognize

getSupportedLanguages

getSupportedVoiceTypes

getSupportedAudioTypes

TemplateParallelTextClient

listTemplateCategories

getCategoryNames

searchTemplates

getTemplatesByTemplateId

generateSentence

TextToSpeechClient