Serialized Form

Package ai.api

Class ai.api.AIServiceException extends java.lang.Exception implements Serializable

Serialized Fields

aiResponse

AIResponse aiResponse

Package ai.api.model

Class ai.api.model.AIContext extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

Class ai.api.model.AIError extends java.lang.Object implements Serializable

Serialized Fields

message

java.lang.String message

aiResponse

AIResponse aiResponse

exception

AIServiceException exception

Class ai.api.model.AIOutputContext extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

parameters

java.util.HashMap<K,V> parameters

Class ai.api.model.AIRequest extends QuestionMetadata implements Serializable

Serialized Fields

query

java.lang.String[] query

confidence

float[] confidence

contexts

java.util.ArrayList<E> contexts

resetContexts

java.lang.Boolean resetContexts

Class ai.api.model.AIResponse extends java.lang.Object implements Serializable

Serialized Fields

id

java.lang.String id

Unique identifier of the result.

timestamp

java.util.Date timestamp

result

Result result

Result object

status

Status status

Class ai.api.model.Fulfillment extends java.lang.Object implements Serializable

Serialized Fields

speech

java.lang.String speech

Class ai.api.model.Metadata extends java.lang.Object implements Serializable

Serialized Fields

intentName

java.lang.String intentName

Name of the intent that produced this result

intentId

java.lang.String intentId

Id of the intent that produced this result

Class ai.api.model.QuestionMetadata extends java.lang.Object implements Serializable

Serialized Fields

timezone

java.lang.String timezone

language

java.lang.String language

sessionId

java.lang.String sessionId

Class ai.api.model.Result extends java.lang.Object implements Serializable

Serialized Fields

action

java.lang.String action

parameters

java.util.HashMap<K,V> parameters

This field will be deserialized as hashMap container with all parameters and it's values

contexts

AIOutputContext[] contexts

Currently active contexts

metadata

Metadata metadata

resolvedQuery

java.lang.String resolvedQuery

The query that was used to produce this result

fulfillment

Fulfillment fulfillment

Fulfillment of the response

Class ai.api.model.Status extends java.lang.Object implements Serializable

Serialized Fields

code

java.lang.Integer code

Response Status Code. Possible values

• 400 bad_request - Some required parameter is missing or has wrong value. Details will be in the errorDetails field.
• 401 unauthorized - Internal authorization failed. It might mean missing or wrong credentials.
• 404 not_found - Returned if uri is not found or some resource with provided id is not found.
• 405 not_allowed - Attempting to use POST with a GET-only endpoint, or vice-versa.
• 406 not_acceptable - Can be returned if uploaded files have some problems with it.
• 200 deprecated - Can be used to indicate that some resource is deprecated and will be removed in the future.
• 409 conflict - The request could not be completed due to a conflict with the current state of the resource. This code is only allowed in situations where it is expected that the user might be able to resolve the conflict and resubmit the request.

errorType

java.lang.String errorType

Error type. Possible values:

• bad_request - Some required parameter is missing or has wrong value. Details will be in the errorDetails field.
• unauthorized - Internal authorization failed. It might mean missing or wrong credentials.
• not_found - Returned if uri is not found or some resource with provided id is not found.
• not_allowed - Attempting to use POST with a GET-only endpoint, or vice-versa.
• not_acceptable - Can be returned if uploaded files have some problems with it.
• deprecated - Can be used to indicate that some resource is deprecated and will be removed in the future.
• conflict - The request could not be completed due to a conflict with the current state of the resource. This code is only allowed in situations where it is expected that the user might be able to resolve the conflict and resubmit the request.

errorDetails

java.lang.String errorDetails

Human readable error description.

errorID

java.lang.String errorID

Error unique ID. Use it in the requests to API.AI support.