com.mtnfog.idyl.e3.sdk.model.StreamingClient Maven / Gradle / Ivy

Go to download

package com.mtnfog.idyl.e3.sdk.model;

import java.io.IOException;

/**
 * Interface for a streaming client.
 * 
 * @author Mountain Fog, Inc.
 *
 */
public interface StreamingClient {

	/**
	 * Sends text to Idyl E3's streaming endpoint.
	 * @param text The text to end.
	 * @return An {@link EntityExtractionResponse}.
	 * @throws IOException Thrown if the text cannot be streamed to Idyl E3.
	 */
	EntityExtractionResponse stream(String text) throws IOException;
	
	/**
	 * Closes the underlying connection.
	 */
	void close();
	
}