1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
use uuid::Uuid;
use lang::Language;
use std::collections::HashMap;

/**
* Response from API.AI call
*/
#[derive(Serialize,Deserialize)]
pub struct ApiResponse {
    pub id : String,
    pub timestamp : String,
    #[serde(default="Language::default")]
    pub lang : Language,
    pub result: ApiResult,

    /**
    * The status object is returned with every request and indicates
    * if the request was successful. If it is not successful, error information is included.
    *
    */
    pub status : ApiStatus,

    /**
    * Session ID
    *
    */
    #[serde( rename = "sessionId" ) ]
    pub session_id : String

}


//////////////////////////////////////////////////////////////////////////////////////////////////
/**
* Result object encapsulates API result including actions, intent name (if applicable) etc.
*
*/
#[derive(Serialize,Deserialize)]
pub struct ApiResult {

    /**
    * Source of the answer. Could be "agent" if the response was retrieved from the agent.
    *
    */
    pub source : String,
    /**
    * The query that was used to produce this result.
    *
    */
    #[serde(rename = "resolvedQuery")]
    pub resolved_query : String,
    /**
    * An action to take. `Example: turn on`
    *
    */
    pub action : String,

    /**
    * `true` if the triggered intent has required parameters and not all the required parameter
    * values have been collected `false` if all required parameter values have been collected
    * or if the triggered intent doesn't containt any required parameters.
    */
    #[serde( rename = "actionIncomplete", default="default_bool") ]
    pub action_incomplete : bool,
    /**
    * A map of parameters associated with this result
    */
    pub parameters : HashMap<String,String>,
    /**
    * Vector of contexts provided by the current conversation
    */
    #[serde(default="Vec::default")]
    pub contexts : Vec<ApiContext>,

    /**
    * Metadata from api.ai
    */
    pub metadata : ApiMetadata,

    /**
    * Metadata from api.ai
    */
    pub fulfillment : ApiFulfillment,

    /**
    * Matching score for the intent. (Between 1 and 0)
    *
    */
    pub score : f32,


}

fn default_bool() -> bool {false}

//////////////////////////////////////////////////////////////////////////////////////////////////
/**
* API Status encapsulates the api http status - usually 200 if all is well
*
*/
#[derive(Serialize,Deserialize)]
pub struct ApiStatus{
    pub code: i32,
    #[serde( rename = "errorType") ]
    pub error_type: String,
    #[serde( rename = "errorDetails", skip_serializing_if = "Option::is_none") ]
    pub error_details: Option<String>,
}

/**
* API.ai metadata struct
*
*/
#[derive(Serialize,Deserialize)]
pub struct ApiMetadata{
    #[serde( rename = "intentId") ]
    pub intent_id: Option<String>,
    #[serde( rename = "webhookUsed", default="default_false_string") ]
    pub webhook_used: String,
    #[serde( rename = "webhookForSlotFillingUsed", default="default_false_string") ]
    pub webhook_slotfilling_used: String,
    #[serde( rename = "intentName", skip_serializing_if = "Option::is_none") ]
    pub intent_name: Option<String>,
}

fn default_false_string() -> String{ String::from("false") }

//////////////////////////////////////////////////////////////////////////////////////////////////

/**
* API.ai fullfilment structure (part of results)
*/
#[derive(Serialize,Deserialize)]
pub struct ApiFulfillment{
    /**
    * The speech to be sent back to the user
    *
    */
    pub speech: String,
    /**
    * Represents an array of message objects as described in ApiMessage
    *
    */
    #[serde(skip_serializing_if = "Option::is_none") ]
    pub messages: Option<Vec<ApiMessage>>
}


//////////////////////////////////////////////////////////////////////////////////////////////////

/**
* API.ai context object representation.
*/
#[derive(Serialize,Deserialize)]
pub struct ApiContext{
    pub name: String,
    pub parameters: HashMap<String, String>,
    pub lifespan: Option<i32>
}

//////////////////////////////////////////////////////////////////////////////////////////////////

/**
* An ApiEvent has a name and may have a list of parameters under the label 'data'.
*/
#[derive(Serialize,Deserialize)]
pub struct ApiEvent{
    pub name: String,
    pub data: Option<HashMap<String,String>>
}

//////////////////////////////////////////////////////////////////////////////////////////////////

/**
* ApiRequest is a structure that encapsulates an api.ai request object
*
*/
#[derive(Serialize,Deserialize)]
pub struct ApiRequest{
    /**
    *  queryis a simple string that holds the query payload for api.ai requests.
    *
    * The [api.ai documentation](https://docs.api.ai/docs/query) defines a query as the natural
    * language to be processed that may be up to 256 characters in length.
    */
    #[serde(skip_serializing_if="Option::is_none",default)]
    pub query: Option<String>,
    #[serde(skip_serializing_if="Option::is_none",default)]
    pub event: Option<ApiEvent>,
    #[serde( rename = "sessionId", skip_serializing_if="String::is_empty", default) ]
    pub session_id: String,
    pub lang: Language,
    pub contexts: Vec<ApiContext>
}

/**
* Default for ApiRequest automatically generates a sessionId if one is not provided.
*
*/
impl Default for ApiRequest {

    fn default() -> ApiRequest{
        ApiRequest{
            query: Option::None,
            event: Option::None,
            session_id: Uuid::new_v4().hyphenated().to_string(),
            lang: Language::English,
            contexts: Vec::new()
        }
    }

}
//////////////////////////////////////////////////////////////////////////////////////////////////
/**
* ApiMesages contain various types of message - text, images, buttons and more.
*
*/
#[derive(Serialize,Deserialize)]
#[serde(untagged)]
pub enum ApiMessage{

    Text {
        speech: String,
        #[serde(rename="type")]
        message_type: i32
    },
    Image {
        #[serde(rename="imageUrl")]
        image_url: String,
        #[serde(rename="type")]
        message_type: i32
    }
}

impl ApiMessage {

    pub fn new_text(speech: String) -> ApiMessage {
        ApiMessage::Text{speech: speech, message_type: 0}
    }

    pub fn new_image(image_url: String) -> ApiMessage {
        ApiMessage::Image{image_url: image_url, message_type: 3}
    }

}