{ "opencollection": "1.0.0", "info": { "name": "Rasa SDK - Action Server Endpoint Domain Tracker API", "version": "0.0.0" }, "items": [ { "info": { "name": "Tracker", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a conversations tracker", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5055/webhook/conversations/:conversation_id/tracker", "params": [ { "name": "conversation_id", "value": "default", "type": "path", "description": "Id of the conversation" }, { "name": "include_events", "value": "AFTER_RESTART", "type": "query", "description": "Specify which events of the tracker the response should contain.\n* `ALL` - every logged event.\n* `APPLIED` - only events that contribute to the trackers state. This excludes reverted utterances and actions that got undone.\n* `AFTER_RESTART` - all events since the last `restarted` event.\n This includes utterances that got reverted and actions that got undone.\n\n* `NONE` - no events." }, { "name": "until", "value": "1559744410", "type": "query", "description": "All events previous to the passed timestamp will be replayed. Events that occur exactly at the target time will be included." } ] }, "docs": "The tracker represents the state of the conversation. The state of the tracker is created by applying a sequence of events, which modify the state. These events can optionally be included in the response." }, { "info": { "name": "Append events to a tracker", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:5055/webhook/conversations/:conversation_id/tracker/events", "params": [ { "name": "conversation_id", "value": "default", "type": "path", "description": "Id of the conversation" }, { "name": "include_events", "value": "AFTER_RESTART", "type": "query", "description": "Specify which events of the tracker the response should contain.\n* `ALL` - every logged event.\n* `APPLIED` - only events that contribute to the trackers state. This excludes reverted utterances and actions that got undone.\n* `AFTER_RESTART` - all events since the last `restarted` event.\n This includes utterances that got reverted and actions that got undone.\n\n* `NONE` - no events." }, { "name": "output_channel", "value": "slack", "type": "query", "description": "The bot's utterances will be forwarded to this channel. It uses the credentials listed in `credentials.yml` to connect. In case the channel does not support this, the utterances will be returned in the response body. Use `latest` to try to send the messages to the latest channel the user used. Currently supported channels are listed in the permitted values for the parameter." }, { "name": "execute_side_effects", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Appends one or multiple new events to the tracker state of the conversation. Any existing events will be kept and the new events will be appended, updating the existing state. If events are appended to a new conversation ID, the tracker will be initialised with a new session." }, { "info": { "name": "Replace a trackers events", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:5055/webhook/conversations/:conversation_id/tracker/events", "params": [ { "name": "conversation_id", "value": "default", "type": "path", "description": "Id of the conversation" }, { "name": "include_events", "value": "AFTER_RESTART", "type": "query", "description": "Specify which events of the tracker the response should contain.\n* `ALL` - every logged event.\n* `APPLIED` - only events that contribute to the trackers state. This excludes reverted utterances and actions that got undone.\n* `AFTER_RESTART` - all events since the last `restarted` event.\n This includes utterances that got reverted and actions that got undone.\n\n* `NONE` - no events." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces all events of a tracker with the passed list of events. This endpoint should not be used to modify trackers in a production setup, but rather for creating training data." }, { "info": { "name": "Retrieve an end-to-end story corresponding to a conversation", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5055/webhook/conversations/:conversation_id/story", "params": [ { "name": "conversation_id", "value": "default", "type": "path", "description": "Id of the conversation" }, { "name": "until", "value": "1559744410", "type": "query", "description": "All events previous to the passed timestamp will be replayed. Events that occur exactly at the target time will be included." }, { "name": "all_sessions", "value": "false", "type": "query", "description": "Whether to fetch all sessions in a conversation, or only the latest session\n* `true` - fetch all conversation sessions.\n* `false` - [default] fetch only the latest conversation session." } ] }, "docs": "The story represents the whole conversation in end-to-end format. This can be posted to the '/test/stories' endpoint and used as a test." }, { "info": { "name": "Run an action in a conversation", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:5055/webhook/conversations/:conversation_id/execute", "params": [ { "name": "conversation_id", "value": "default", "type": "path", "description": "Id of the conversation" }, { "name": "include_events", "value": "AFTER_RESTART", "type": "query", "description": "Specify which events of the tracker the response should contain.\n* `ALL` - every logged event.\n* `APPLIED` - only events that contribute to the trackers state. This excludes reverted utterances and actions that got undone.\n* `AFTER_RESTART` - all events since the last `restarted` event.\n This includes utterances that got reverted and actions that got undone.\n\n* `NONE` - no events." }, { "name": "output_channel", "value": "slack", "type": "query", "description": "The bot's utterances will be forwarded to this channel. It uses the credentials listed in `credentials.yml` to connect. In case the channel does not support this, the utterances will be returned in the response body. Use `latest` to try to send the messages to the latest channel the user used. Currently supported channels are listed in the permitted values for the parameter." } ], "body": { "type": "json", "data": "{}" } }, "docs": "DEPRECATED. Runs the action, calling the action server if necessary. Any responses sent by the executed action will be forwarded to the channel specified in the output_channel parameter. If no output channel is specified, any messages that should be sent to the user will be included in the response of this endpoint." }, { "info": { "name": "Inject an intent into a conversation", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:5055/webhook/conversations/:conversation_id/trigger_intent", "params": [ { "name": "conversation_id", "value": "default", "type": "path", "description": "Id of the conversation" }, { "name": "include_events", "value": "AFTER_RESTART", "type": "query", "description": "Specify which events of the tracker the response should contain.\n* `ALL` - every logged event.\n* `APPLIED` - only events that contribute to the trackers state. This excludes reverted utterances and actions that got undone.\n* `AFTER_RESTART` - all events since the last `restarted` event.\n This includes utterances that got reverted and actions that got undone.\n\n* `NONE` - no events." }, { "name": "output_channel", "value": "slack", "type": "query", "description": "The bot's utterances will be forwarded to this channel. It uses the credentials listed in `credentials.yml` to connect. In case the channel does not support this, the utterances will be returned in the response body. Use `latest` to try to send the messages to the latest channel the user used. Currently supported channels are listed in the permitted values for the parameter." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sends a specified intent and list of entities in place of a user message. The bot then predicts and executes a response action. Any responses sent by the executed action will be forwarded to the channel specified in the ``output_channel`` parameter. If no output channel is specified, any messages that should be sent to the user will be included in the response of this endpoint." }, { "info": { "name": "Predict the next action", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:5055/webhook/conversations/:conversation_id/predict", "params": [ { "name": "conversation_id", "value": "default", "type": "path", "description": "Id of the conversation" } ] }, "docs": "Runs the conversations tracker through the model's policies to predict the scores of all actions present in the model's domain. Actions are returned in the 'scores' array, sorted on their 'score' values. The state of the tracker is not modified." }, { "info": { "name": "Add a message to a tracker", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:5055/webhook/conversations/:conversation_id/messages", "params": [ { "name": "conversation_id", "value": "default", "type": "path", "description": "Id of the conversation" }, { "name": "include_events", "value": "AFTER_RESTART", "type": "query", "description": "Specify which events of the tracker the response should contain.\n* `ALL` - every logged event.\n* `APPLIED` - only events that contribute to the trackers state. This excludes reverted utterances and actions that got undone.\n* `AFTER_RESTART` - all events since the last `restarted` event.\n This includes utterances that got reverted and actions that got undone.\n\n* `NONE` - no events." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a message to a tracker. This doesn't trigger the prediction loop. It will log the message on the tracker and return, no actions will be predicted or run. This is often used together with the predict endpoint." } ] } ], "bundled": true }