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

Go to download
/* Copyright 2017 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 java.util.List;

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

import retrofit.client.Response;
import retrofit.http.Body;
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 {

    @POST("/api/v2/extract")
    EntityExtractionResponse extract(
    		@Body String text,
    		@Query("confidence") int confidence,
    		@Query("context") String context,
    		@Query("documentId") String documentId,
    		@Query("language") String language,
    		@Query("type") String type);
    
    @POST("/api/v2/extract")
    EntityExtractionResponse extract(
    		@Body String text,
    		@Query("confidence") int confidence,
    		@Query("context") String context,
    		@Query("documentId") String documentId,
    		@Query("language") String language,
    		@Query("type") String type,
    		@Query("metadataKeys") List metadataKeys,
    		@Query("metadataValues") List metadataValues);
    
    @POST("/api/v2/extract")
    EntityExtractionResponse extract(
    		@Body String text);
    
    @POST("/api/v2/extract")
    EntityExtractionResponse extract(
    		@Body String text,
    		@Query("confidence") int confidence);
            
    @Deprecated
    @POST("/api/v2/ingest")
    Response ingest(
    		@Body String text,
    		@Query("confidence") int confidence);
    
    @Deprecated
    @POST("/api/v2/ingest")
    Response ingest(
    		@Body String text,
    		@Query("confidence") int confidence,
    		@Query("context") String context,
    		@Query("documentId") String documentId,
    		@Query("language") String language,
    		@Query("type") String type);
    
    @Deprecated
    @POST("/api/v2/ingest")
    Response ingest(
    		@Body String text,
    		@Query("confidence") int confidence,
    		@Query("context") String context,
    		@Query("documentId") String documentId,
    		@Query("language") String language,
    		@Query("type") String type,
    		@Query("metadataKeys") List metadataKeys,
    		@Query("metadataValues") List metadataValues);
    
    @POST("/api/v2/annotate")
    String annotate(
    		@Body String text,
    		@Query("confidence") int confidence,
    		@Query("language") String language,
    		@Query("format") String format,
    		@Query("type") String type);
    
    @POST("/api/v2/sanitize")
    String sanitize(
    		@Body String text,
    		@Query("confidence") int confidence,
    		@Query("language") String language,
    		@Query("type") String type);

    @Multipart
    @POST("/api/v2/upload")
    EntityExtractionResponse extractFromFile(
    		@Part("file") TypedFile file,
    		@Part("parameters") FileExtractionParameters parameters);
        
    @GET("/api/status")
    Status getStatus();
    
}