com.clarifai.api

Class RecognitionRequest

java.lang.Object

com.clarifai.api.ClarifaiRequest

com.clarifai.api.RecognitionRequest

public class RecognitionRequest
extends ClarifaiRequest

A request for recognition to be performed on one or more images. See http://developer.clarifai.com for complete documentation on the Clarifai image recognition API.

Constructor Summary

Constructors

Constructor and Description
RecognitionRequest(byte[]... imageByteArrays) Constructs a new request for recognition on one or more images.
RecognitionRequest(File... files) Constructs a new request for recognition on one or more images
RecognitionRequest(String... urls) Constructs a new request for recognition on one or more images

Method Summary

Modifier and Type	Method and Description
boolean	getIncludeEmbedding() Returns true if embeddings should be included in the result, or false (default) if not.
boolean	getIncludeTags() Returns true (default) if tags should be included in the result, or false if not.
String	getModel() Returns the name of the model to use for recognition.
RecognitionRequest	setIncludeEmbedding(boolean includeEmbedding) Sets whether to include embeddings in the result.
RecognitionRequest	setIncludeTags(boolean includeTags) Sets whether to include tags in the result.
RecognitionRequest	setModel(String model) Sets the model to use for recognition.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecognitionRequest

public RecognitionRequest(File... files)

Constructs a new request for recognition on one or more images

Parameters:

files - Files containing the image data to be recognized

RecognitionRequest

public RecognitionRequest(byte[]... imageByteArrays)

Constructs a new request for recognition on one or more images. The RecognitionRequest will close the input streams when it is done sending them to the server.

Parameters:

imageByteArrays - byte arrays containing image data to be recognized

RecognitionRequest

public RecognitionRequest(String... urls)

Constructs a new request for recognition on one or more images

Parameters:

urls - publicly-accessible URLs for images to be recognized

Method Detail

getModel

public String getModel()

Returns the name of the model to use for recognition.

setModel

public RecognitionRequest setModel(String model)

Sets the model to use for recognition.

getIncludeTags

public boolean getIncludeTags()

Returns true (default) if tags should be included in the result, or false if not.

setIncludeTags

public RecognitionRequest setIncludeTags(boolean includeTags)

Sets whether to include tags in the result.

getIncludeEmbedding

public boolean getIncludeEmbedding()

Returns true if embeddings should be included in the result, or false (default) if not.

setIncludeEmbedding

public RecognitionRequest setIncludeEmbedding(boolean includeEmbedding)

Sets whether to include embeddings in the result.