com.mtnfog.idyl.e3.sdk.IdylE3Client Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of idyl-e3-java-sdk Show documentation

Java SDK for Mountain Fog's Idyl E3.

There is a newer version: 2.3.1

/* Copyright 2016 Mountain Fog, Inc.

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

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. */

package com.mtnfog.idyl.e3.sdk;

import com.mtnfog.idyl.e3.sdk.model.EntityExtractionResponse;
import com.mtnfog.idyl.e3.sdk.model.FileExtractionParameters;

import retrofit.client.Response;
import retrofit.http.GET;
import retrofit.http.Multipart;
import retrofit.http.POST;
import retrofit.http.Part;
import retrofit.http.Query;
import retrofit.mime.TypedFile;

/**
 * Interface for Idyl E3 API client.
 * @author Mountain Fog, Inc.
 *
 */
public interface IdylE3Client {

    @GET("/api/extract")
    EntityExtractionResponse extract(
    		@Query("text") String text,
    		@Query("confidence") int confidence,
    		@Query("context") String context,
    		@Query("documentId") String documentId,
    		@Query("language") String language);
    
    @GET("/api/extract")
    EntityExtractionResponse extract(
    		@Query("text") String text);
    
    @GET("/api/extract")
    EntityExtractionResponse extract(
    		@Query("text") String text,
    		@Query("confidence") int confidence);
            
    @POST("/api/ingest")
    Response ingest(
    		@Query("text") String text,
    		@Query("confidence") int confidence);
    
    @POST("/api/ingest")
    Response ingest(
    		@Query("text") String text,
    		@Query("confidence") int confidence,
    		@Query("context") String context,
    		@Query("documentId") String documentId,
    		@Query("language") String language);

    @Multipart
    @POST("/api/upload")
    EntityExtractionResponse extractFromFile(
    		@Part("file") TypedFile file,
    		@Part("parameters") FileExtractionParameters parameters);
    
    @GET("/api/health")
    String getHealth();
    
    @GET("/api/status")
    String getStatus();
    
    @GET("/api/extractionTime")
    double getExtractionTime();
    
}