publish php apidocs 1.12.1

Jenkinsfile

@@ -1,4 +1,4 @@
-node {
+node ("docker-light") {
     def SOURCEDIR = pwd()
     try {
         stage("Clean up") {

README.md

@@ -1,8 +1,13 @@
+<<<<<<< HEAD
+=======
+[![Build Status](https://travis-ci.org/rosette-api/php.svg?branch=develop)](https://travis-ci.org/rosette-api/php)
+
+>>>>>>> develop
 # PHP client binding for Rosette API #
 See the wiki for more information.
 
 ## Installation ##
-`composer require "rosette/api: ~1.8"`
+`composer require "rosette/api"`
 
 If the version you are using is not [the latest from Packagist](https://packagist.org/packages/rosette/api),
 please check for its [**compatibilty with api.rosette.com**](https://developer.rosette.com/features-and-functions?php).

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "rosette/api",
-  "version": "1.9.0",
+  "version": "1.12.1",
   "description": "Rosette API PHP client SDK",
   "license": "Apache",
   "keywords": [

examples/categories.php

@@ -13,7 +13,7 @@
     echo 'Usage: php ' . __FILE__ . " --key <api_key> --url=<alternate_url>\n";
     exit();
 }
-$categories_url_data = "http://www.onlocationvacations.com/2015/03/05/the-new-ghostbusters-movie-begins-filming-in-boston-in-june/";
+$categories_url_data = "https://onlocationvacations.com/2015/03/05/the-new-ghostbusters-movie-begins-filming-in-boston-in-june/";
 $api = isset($options['url']) ? new Api($options['key'], $options['url']) : new Api($options['key']);
 $params = new DocumentParameters();
 $params->set('contentUri', $categories_url_data);

examples/relationships.php

@@ -17,7 +17,6 @@
 $api = isset($options['url']) ? new Api($options['key'], $options['url']) : new Api($options['key']);
 $params = new DocumentParameters();
 $params->set('content', $relationships_text_data);
-$api->setOption('accuracyMode', 'RECALL');
 
 try {
     $result = $api->relationships($params);

examples/text_embedding.php → examples/semantic_vectors.php

@@ -13,14 +13,14 @@
     echo 'Usage: php ' . __FILE__ . " --key <api_key> --url=<alternate_url>\n";
     exit();
 }
-$embeddings_data = "Cambridge, Massachusetts";
+$semantic_vectors_data = "Cambridge, Massachusetts";
 $api = isset($options['url']) ? new Api($options['key'], $options['url']) : new Api($options['key']);
 $params = new DocumentParameters();
-$content = $embeddings_data;
+$content = $semantic_vectors_data;
 $params->set('content', $content);
 
 try {
-    $result = $api->textEmbedding($params, false);
+    $result = $api->semanticVectors($params, false);
     var_dump($result);
 } catch (RosetteException $e) {
     error_log($e);

examples/similar_terms.php

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * Example code to call Rosette API to get related terms from sample text
+ **/
+require_once dirname(__FILE__) . '/../vendor/autoload.php';
+use rosette\api\Api;
+use rosette\api\DocumentParameters;
+use rosette\api\RosetteException;
+
+$options = getopt(null, array('key:', 'url::'));
+if (!isset($options['key'])) {
+    echo 'Usage: php ' . __FILE__ . " --key <api_key> --url=<alternate_url>\n";
+    exit();
+}
+$similar_terms_data = 'spy';
+$api = isset($options['url']) ? new Api($options['key'], $options['url']) : new Api($options['key']);
+$params = new DocumentParameters();
+$content = $similar_terms_data;
+$params->set('content', $content);
+$api->setOption('resultLanguages', array('spa', 'deu', 'jpn'));
+
+try {
+    $result = $api->similarTerms($params, false);
+    var_dump($result);
+} catch (RosetteException $e) {
+    error_log($e);
+}

source/rosette/api/Api.php

@@ -5,7 +5,7 @@
  *
  * Primary class for interfacing with the Rosette API
  *
- * @copyright 2015-2016 Basis Technology Corporation.
+ * @copyright 2015-2018 Basis Technology Corporation.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
  * with the License. You may obtain a copy of the License at
@@ -38,7 +38,7 @@ class Api
      *
      * @var string
      */
-    private static $binding_version = '1.9.0';
+    private static $binding_version = '1.12.1';
 
     /**
      * User key (required for Rosette API).
@@ -697,6 +697,8 @@ public function relationships($params)
     /**
      * Calls the text-embedding endpoint.
      *
+     * Deprecated.  Please use `semanticVectors` instead
+     *
      * @param $params
      *
      * @return mixed
@@ -708,6 +710,20 @@ public function textEmbedding($params)
         return $this->callEndpoint($params, 'text-embedding');
     }
 
+    /**
+     * Calls the semantic vectors endpoint.
+     *
+     * @param $params
+     *
+     * @return mixed
+     *
+     * @throws RosetteException
+     */
+    public function semanticVectors($params)
+    {
+        return $this->callEndpoint($params, 'semantics/vector');
+    }
+
     /**
     * Calls the syntax/dependencies endpoint
     *
@@ -749,4 +765,18 @@ public function topics($params)
     {
         return $this->callEndpoint($params, 'topics');
     }
+
+    /**
+    * Calls the similarTerms endpoint
+    *
+    * @param $params
+    *
+    * @return mixed
+    *
+    * @throws RosetteException
+    */
+    public function similarTerms($params)
+    {
+        return $this->callEndpoint($params, 'semantics/similar');
+    }
 }

spec/rosette/api/ApiSpec.php

@@ -226,7 +226,7 @@ public function it_calls_the_relationships_endpoint($params, $request)
         $this->setMockRequest($request);
         $this->relationships($params)->shouldHaveKeyWithValue('name', 'Rosette API');
     }
-    public function it_calls_the_text_embedding_endpoint($params, $request)
+    public function it_calls_the_semantic_vectors_endpoint($params, $request)
     {
         $params->beADoubleOf('\rosette\api\DocumentParameters');
         $params->contentUri = 'http://some.dummysite.com';
@@ -235,7 +235,7 @@ public function it_calls_the_text_embedding_endpoint($params, $request)
         $request->getResponseCode()->willReturn(200);
         $request->getResponse()->willReturn([ 'name' => 'Rosette API']);
         $this->setMockRequest($request);
-        $this->textEmbedding($params)->shouldHaveKeyWithValue('name', 'Rosette API');
+        $this->semanticVectors($params)->shouldHaveKeyWithValue('name', 'Rosette API');
     }
     public function it_calls_the_syntax_dependencies_endpoint($params, $request)
     {
@@ -269,6 +269,17 @@ public function it_calls_the_topics_endpoint($params, $request)
         $this->setMockRequest($request);
         $this->topics($params)->shouldHaveKeyWithValue('name', 'Rosette API');
     }
+    public function it_calls_the_similar_terms_endpoint($params, $request)
+    {
+        $params->beADoubleOf('\rosette\api\DocumentParameters');
+        $params->content = 'Sample Data';
+        $request->beADoubleOf('rosette\api\RosetteRequest');
+        $request->makeRequest(Argument::any(), Argument::any(), Argument::any(), Argument::any(), Argument::any())->willReturn(true);
+        $request->getResponseCode()->willReturn(200);
+        $request->getResponse()->willReturn([ 'name' => 'Rosette API']);
+        $this->setMockRequest($request);
+        $this->similarTerms($params)->shouldHaveKeyWithValue('name', 'Rosette API');
+    }
     public function it_fails_with_non_200_response($params, $request)
     {
         $params->beADoubleOf('\rosette\api\DocumentParameters');