All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.idilia.services.kb.Client Maven / Gradle / Ivy

    Go to download

    Idilia Java SDK provides Java APIs for building software using Idilia linguistic services (Language graph, word sense disambiguation, paraphrasing, matching).

    The newest version!
    /**
 * Copyright (c) 2011 Idilia Inc, All rights reserved.
 * Description:
 *     This file implements a client for communicating with Idilia's
 *     document server for sense analysis.
 *     
 *     Both the queries and responses use multipart messaging.
 *     
 *     This is a singleton object that can use up to "maxConnectionsPerRoute"
 *     for each destination Url. This parameter can be set prior to calling
 *     getInstance().
 */

package com.idilia.services.kb;

import java.io.IOException;
import java.net.URL;

import org.apache.http.HttpStatus;
import org.apache.http.client.methods.CloseableHttpResponse;

import com.idilia.services.base.IdiliaClientException;
import com.idilia.services.base.IdiliaCredentials;
import com.idilia.services.base.SyncClientBase;


/**
 * Client for accessing the servers that return annotated document.
 * 
 * This is a synchronous client that blocks until the server returns a
 * response. Only one instance is needed and is obtained through a singleton
 * interface.
 * 
 * Internally the class uses an HttpClient that supports multiple simultaneous operations.
 * The number of requests is controlled using member "maxConnectionsPerRoute".
 */
public class Client extends SyncClientBase {

  /**
   * Constructs a client for requesting text services provided at the default service URL.
   * 
    
   * This is a lightweight object. Allocated instances share an underlying HTTP client.
   * Multithread safe.
   * 
    
   * @param creds Idilia API credentials for a project
   */
  public Client(IdiliaCredentials creds) {
    this(creds, defaultApiUrl);
  }
  
  
  /**
   * Constructs a client for requesting text services provided at the given service URL.
   * 
    
   * This is a lightweight object. Allocated instances share an underlying HTTP client.
   * Multithread safe.
   * 
    
   * @param creds Idilia API credentials for a project
   * @param url   URL to reach the API. Normally http://api.idilia.com
   */
  public Client(IdiliaCredentials creds, URL url) {
    super(creds, url);
  }
  

  /**
   * Sends a request to the kb server.
   * 
   * @param req Request message. One concrete implementation of {@link QueryRequest}
   * @return {@link QueryResponse}
   * @throws IdiliaClientException when the request is not successful for any reason
   */
  public QueryResponse query(QueryRequest req) throws IdiliaClientException {
    return query(req, Object.class);
  }
  
  
  /**
   * Sends a kb/query request to the kb server.
   * 
   * @param  A POJO that can be JSON serialized and reconstituted. The query and responses may include
   *           multiple instances of it. 
   * @param req   Request message. One concrete implementation of {@link QueryRequest}
   * @param tpRef Type of the object into which to deserialize the result of each query.
   * @return {@link QueryResponse}
   * @throws IdiliaClientException when the request is not successful for any reason
   */
  public  QueryResponse query(QueryRequest req, Class tpRef) throws IdiliaClientException {
    try (CloseableHttpResponse httpResponse = getServerResponse(req)) {
    
      // Recover the response.
      QueryResponse resp = QueryCodec.decode(jsonMapper_, tpRef, httpResponse.getEntity());
      if (resp.getStatus() != HttpStatus.SC_OK)
        throw new IdiliaClientException(resp);
      return resp;
  	} catch (IOException e) {
  	  throw new IdiliaClientException(e);
  	}
  }
  

  /**
   * Sends a request to obtain a sense menu
   * @param req populated req menu request
   * @return an instance of SenseMenuResponse with the decoded result from the server
   * @throws IdiliaClientException on any error encountered
   */
  public SenseMenuResponse senseMenu(SenseMenuRequest req) throws IdiliaClientException {
      return (SenseMenuResponse)perform(req);
  }
  
  
  /**
   * Sends a request to obtain a tagging menu
   * @param req populated req menu request
   * @return an instance of TaggingMenuResponse with the decoded result from the server
   * @throws IdiliaClientException on any error encountered
   */
  public TaggingMenuResponse taggingMenu(TaggingMenuRequest req) throws IdiliaClientException {
      return (TaggingMenuResponse)perform(req);
  }
  
  
  /**
   * Retrieve a sense card an as HTML string.
   * @param req populated sense card request
   * @return A string containing the card's HTML
   * @throws IdiliaClientException when the request is not successful for any reason
   */
  public SenseCardResponse senseCard(SenseCardRequest req) throws IdiliaClientException {
    return (SenseCardResponse)perform(req);
  }
    
}
    
    
    
    

    




    
    
    © 2015 - 2024 Weber Informatics LLC | Privacy Policy