Skip to content

Latest commit

 

History

History

examples

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
address_similarity.php
address_similarity.php
 
 
categories.php
categories.php
 
 
composer.json
composer.json
 
 
entities.php
entities.php
 
 
events.php
events.php
 
 
info.php
info.php
 
 
language.php
language.php
 
 
language_multilingual.php
language_multilingual.php
 
 
morphology_complete.php
morphology_complete.php
 
 
morphology_compound-components.php
morphology_compound-components.php
 
 
morphology_han-readings.php
morphology_han-readings.php
 
 
morphology_lemmas.php
morphology_lemmas.php
 
 
morphology_parts-of-speech.php
morphology_parts-of-speech.php
 
 
name_deduplication.php
name_deduplication.php
 
 
name_similarity.php
name_similarity.php
 
 
name_translation.php
name_translation.php
 
 
ping.php
ping.php
 
 
record_similarity.php
record_similarity.php
 
 
relationships.php
relationships.php
 
 
run_examples.sh
run_examples.sh
 
 
semantic_vectors.php
semantic_vectors.php
 
 
sentences.php
sentences.php
 
 
sentiment.php
sentiment.php
 
 
similar_terms.php
similar_terms.php
 
 
syntax_dependencies.php
syntax_dependencies.php
 
 
tokens.php
tokens.php
 
 
topics.php
topics.php
 
 
transliteration.php
transliteration.php
 
 

README.md

Endpoint Examples

These examples are scripts that can be run independently to demonstrate the Babel Street Analytics API functionality.

Each example file demonstrates one of the capabilities of the Analytics Platform. Each example, when run, prints its output to the console.

Here are some methods for running the examples. Each example will also accept an optional --url= parameter for overriding the default URL.

Also, the examples are dual purpose in that they're used to test both source and packagist. The instructions include steps to address this depending on what you are testing.

A note on prerequisites. Analytics API only supports TLS 1.2 so ensure your toolchain also supports it.

Docker/Latest Version From Packagist

git clone git@github.com:rosette-api/php.git
cd php
docker run -it -v $(pwd):/source --entrypoint bash php:8.2-cli

apt-get update
apt-get install -y git zip

curl -s -o /usr/local/bin/composer https://getcomposer.org/composer.phar
chmod +x /usr/local/bin/composer
composer self-update

cd /source/examples
composer require "rosette/api"
mv vendor/ ../.

php ping.php --key $API_KEY

Docker/Latest Source

git clone git@github.com:rosette-api/php.git
cd php
docker run -it -v $(pwd):/source --entrypoint bash php:8.2-cli

apt-get update
apt-get install -y git zip

curl -s -o /usr/local/bin/composer https://getcomposer.org/composer.phar
chmod +x /usr/local/bin/composer
composer self-update

cd /source
composer install
cd examples

php ping.php --key $API_KEY