C E F G I P R S T V

C

ClarifaiBadRequestException - Exception in com.clarifai.api.exception

Thrown for requests that fail due to bad input.

ClarifaiBadRequestException(String) - Constructor for exception com.clarifai.api.exception.ClarifaiBadRequestException

ClarifaiClient - Class in com.clarifai.api

A simple client for the Clarifai image recognition API.

ClarifaiClient() - Constructor for class com.clarifai.api.ClarifaiClient

Constructs a new ClarifaiClient, using the CLARIFAI_APP_ID and CLARIFAI_APP_SECRET environment variables to identify the application.

ClarifaiClient(String, String) - Constructor for class com.clarifai.api.ClarifaiClient

Constructs a new ClarifaiClient.

ClarifaiException - Exception in com.clarifai.api.exception

Base class for all exceptions thrown by Clarifai API.

ClarifaiException(String) - Constructor for exception com.clarifai.api.exception.ClarifaiException

ClarifaiException(String, Throwable) - Constructor for exception com.clarifai.api.exception.ClarifaiException

ClarifaiNotAuthorizedException - Exception in com.clarifai.api.exception

Thrown for requests that are not authorized.

ClarifaiNotAuthorizedException(String) - Constructor for exception com.clarifai.api.exception.ClarifaiNotAuthorizedException

ClarifaiRequest - Class in com.clarifai.api

Base class for requests to the Clarifai API.

ClarifaiRequest() - Constructor for class com.clarifai.api.ClarifaiRequest

ClarifaiThrottledException - Exception in com.clarifai.api.exception

Thrown when the client is making too many requests.

ClarifaiThrottledException(String, int) - Constructor for exception com.clarifai.api.exception.ClarifaiThrottledException

com.clarifai.api - package com.clarifai.api

com.clarifai.api.auth - package com.clarifai.api.auth

com.clarifai.api.exception - package com.clarifai.api.exception

Credential - Class in com.clarifai.api.auth

An OAuth2 credential for that may be stored in a CredentialCache.

Credential(String, String, long) - Constructor for class com.clarifai.api.auth.Credential

Constructs a new Credential.

CredentialCache - Interface in com.clarifai.api.auth

Interface for a cache of @{link Credentials}.

E

embedAllowed() - Method in class com.clarifai.api.InfoResult

Returns whether the current user is allowed to use embed operations.

F

FeedbackRequest - Class in com.clarifai.api

A request for providing feedback on one or more images.

FeedbackRequest() - Constructor for class com.clarifai.api.FeedbackRequest

G

getAccessToken() - Method in class com.clarifai.api.auth.Credential

Returns the access token.

getAddTags() - Method in class com.clarifai.api.FeedbackRequest

Returns the list of tags that should be added to the images.

getConnectTimeout() - Method in class com.clarifai.api.ClarifaiClient

Returns the connection timeout, in milliseconds.

getCredential(String) - Method in interface com.clarifai.api.auth.CredentialCache

Returns the Credential for the given appId or null if it is not cached.

getCredential(String) - Method in class com.clarifai.api.auth.InMemoryCredentialCache

getDissimilarDocIds() - Method in class com.clarifai.api.FeedbackRequest

Returns the docids to be marked as dissimilar to the docids set with FeedbackRequest.setDocIds(java.lang.String...).

getDocId() - Method in class com.clarifai.api.RecognitionResult

Returns a unique and stable identifier for the content.

getDocIds() - Method in class com.clarifai.api.FeedbackRequest

Returns the docids for the images that the feedback applies to.

getEmbedding() - Method in class com.clarifai.api.RecognitionResult

Returns embedding vector or null if embeddings were not requested or the request failed.

getExpirationTimeMillis() - Method in class com.clarifai.api.auth.Credential

Returns the time at which the current access token expires.

getIncludeEmbedding() - Method in class com.clarifai.api.RecognitionRequest

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

getIncludeTags() - Method in class com.clarifai.api.RecognitionRequest

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

getInfo() - Method in class com.clarifai.api.ClarifaiClient

Makes an API info request.

getInstance() - Static method in class com.clarifai.api.auth.InMemoryCredentialCache

Returns the singleton instance.

getMaxAttempts() - Method in class com.clarifai.api.ClarifaiClient

Returns the maximum number of attempts for a request.

getMaxBatchSize() - Method in class com.clarifai.api.InfoResult

Gets the maximum number of images allowed in a single batch request.

getMaxImageSize() - Method in class com.clarifai.api.InfoResult

Gets the maximum allowed image size (on the minimum dimension).

getMinImageSize() - Method in class com.clarifai.api.InfoResult

Gets the minimum allowed image size (on the minimum dimension).

getModel() - Method in class com.clarifai.api.RecognitionRequest

Returns the name of the model to use for recognition.

getName() - Method in class com.clarifai.api.Tag

Returns the name of the tag.

getProbability() - Method in class com.clarifai.api.Tag

Returns the probability that this tag is associated with the input image.

getReadTimeout() - Method in class com.clarifai.api.ClarifaiClient

Returns the read timeout, in milliseconds.

getRefreshToken() - Method in class com.clarifai.api.auth.Credential

Returns the refresh token, or null if there is none.

getRemoveTags() - Method in class com.clarifai.api.FeedbackRequest

Returns the list of tags that should be removed from the images.

getSimilarDocIds() - Method in class com.clarifai.api.FeedbackRequest

Returns the docids to be marked as similar to the docids set with FeedbackRequest.setDocIds(java.lang.String...).

getStatusCode() - Method in class com.clarifai.api.RecognitionResult

Returns the status of the request.

getStatusMessage() - Method in class com.clarifai.api.RecognitionResult

Returns additional information about the status of the request.

getTags() - Method in class com.clarifai.api.RecognitionResult

Returns a list of Tags or null if tags were not requested or the request failed.

getWaitSeconds() - Method in exception com.clarifai.api.exception.ClarifaiThrottledException

I

InfoResult - Class in com.clarifai.api

API details and usage limits.

InfoResult() - Constructor for class com.clarifai.api.InfoResult

InMemoryCredentialCache - Class in com.clarifai.api.auth

Default in-memory CredentialCache implementation.

P

putCredential(String, Credential) - Method in interface com.clarifai.api.auth.CredentialCache

Stores a Credential for a given appId.

putCredential(String, Credential) - Method in class com.clarifai.api.auth.InMemoryCredentialCache

R

RecognitionRequest - Class in com.clarifai.api

A request for recognition to be performed on one or more images.

RecognitionRequest(File...) - Constructor for class com.clarifai.api.RecognitionRequest

Constructs a new request for recognition on one or more images

RecognitionRequest(byte[]...) - Constructor for class com.clarifai.api.RecognitionRequest

Constructs a new request for recognition on one or more images.

RecognitionRequest(String...) - Constructor for class com.clarifai.api.RecognitionRequest

Constructs a new request for recognition on one or more images

RecognitionResult - Class in com.clarifai.api

Recognition results for a single image.

RecognitionResult.StatusCode - Enum in com.clarifai.api

Indicates the status of the request.

recognize(RecognitionRequest) - Method in class com.clarifai.api.ClarifaiClient

Makes a recognition request for tags and/or embeddings.

removeCredential(String) - Method in interface com.clarifai.api.auth.CredentialCache

Returns the Credential for a given appId from the cache.

removeCredential(String) - Method in class com.clarifai.api.auth.InMemoryCredentialCache

S

sendFeedback(FeedbackRequest) - Method in class com.clarifai.api.ClarifaiClient

Makes a feedback request.

setAddTags(String...) - Method in class com.clarifai.api.FeedbackRequest

Sets the list of tags that should be added to the images.

setConnectTimeout(int) - Method in class com.clarifai.api.ClarifaiClient

Sets the timeout, in milliseconds, for establishing a connection.

setCredentialCache(CredentialCache) - Method in class com.clarifai.api.ClarifaiClient

Sets the cache used to store Credentials for the app.

setDissimilarDocIds(String...) - Method in class com.clarifai.api.FeedbackRequest

Sets the docids to be marked as dissimilar to the docids set with FeedbackRequest.setDocIds(java.lang.String...).

setDocIds(String...) - Method in class com.clarifai.api.FeedbackRequest

Sets the docids for the images that the feedback applies to.

setIncludeEmbedding(boolean) - Method in class com.clarifai.api.RecognitionRequest

Sets whether to include embeddings in the result.

setIncludeTags(boolean) - Method in class com.clarifai.api.RecognitionRequest

Sets whether to include tags in the result.

setMaxAttempts(int) - Method in class com.clarifai.api.ClarifaiClient

Sets the maximum number of times to try to successfully make a request.

setModel(String) - Method in class com.clarifai.api.RecognitionRequest

Sets the model to use for recognition.

setReadTimeout(int) - Method in class com.clarifai.api.ClarifaiClient

Sets the read timeout, in milliseconds.

setRemoveTags(String...) - Method in class com.clarifai.api.FeedbackRequest

Sets the list of tags that should be removed from the images.

setSimilarDocIds(String...) - Method in class com.clarifai.api.FeedbackRequest

Sets the docids to be marked as similar to the docids set with FeedbackRequest.setDocIds(java.lang.String...).

T

Tag - Class in com.clarifai.api

A tag returned by the recognition API.

toString() - Method in class com.clarifai.api.InfoResult

toString() - Method in class com.clarifai.api.Tag

V

valueOf(String) - Static method in enum com.clarifai.api.RecognitionResult.StatusCode

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.clarifai.api.RecognitionResult.StatusCode

Returns an array containing the constants of this enum type, in the order they are declared.

C E F G I P R S T V