BotSharp/BotSharp.RestApi/BotSharp.RestApi.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>BotSharp.RestApi</name>
    </assembly>
    <members>
        <member name="T:BotSharp.RestApi.AgentController">
            <summary>
            Agent
            </summary>
        </member>
        <member name="M:BotSharp.RestApi.AgentController.#ctor(BotSharp.Core.Engines.IBotPlatform)">
            <summary>
            Initialize dialog controller and get a platform instance
            </summary>
            <param name="platform"></param>
        </member>
        <member name="M:BotSharp.RestApi.AgentController.Restore(Microsoft.AspNetCore.Http.IFormFile)">
            <summary>
            Restore a agent from a uploaded zip file 
            </summary>
            <param name="file"></param>
            <returns></returns>
        </member>
        <member name="M:BotSharp.RestApi.AgentController.Train(System.String)">
            <summary>
            Train agent
            </summary>
            <param name="agentId"></param>
            <returns></returns>
        </member>
        <member name="M:BotSharp.RestApi.AgentController.Dump(System.String)">
            <summary>
            Dump agent
            </summary>
            <param name="agentId"></param>
            <returns></returns>
        </member>
        <member name="P:BotSharp.RestApi.Dialogflow.QueryModel.Contexts">
            <summary>
            Array of additional context objects. Should be sent via a POST /query request. 
            Contexts sent in a query are activated before the query.
            </summary>
        </member>
        <member name="P:BotSharp.RestApi.Dialogflow.QueryModel.Event">
            <summary>
            Object containing event name and additional data. 
            The "data" parameter can be submitted only in POST requests.
            </summary>
        </member>
        <member name="P:BotSharp.RestApi.Dialogflow.QueryModel.Lang">
            <summary>
            Language tag, e.g., en, es etc.
            </summary>
        </member>
        <member name="P:BotSharp.RestApi.Dialogflow.QueryModel.Query">
            <summary>
            Natural language text to be processed. Query length should not exceed 256 characters.
            </summary>
        </member>
        <member name="P:BotSharp.RestApi.Dialogflow.QueryModel.SessionId">
            <summary>
            A string token up to 36 symbols long, used to identify the client and to manage session parameters (including contexts) per client.
            </summary>
        </member>
        <member name="P:BotSharp.RestApi.Dialogflow.QueryModel.Timezone">
            <summary>
            Time zone from IANA Time Zone Database Examples: America/New_York, Europe/Paris
            </summary>
        </member>
        <member name="T:BotSharp.RestApi.Rasa.ParseController">
            <summary>
            send a text request
            </summary>
        </member>
        <member name="M:BotSharp.RestApi.Rasa.ParseController.#ctor(BotSharp.Core.Engines.IBotPlatform)">
            <summary>
            Initialize dialog controller and get a platform instance
            </summary>
            <param name="platform"></param>
        </member>
        <member name="M:BotSharp.RestApi.Rasa.ParseController.Parse(BotSharp.RestApi.Rasa.RasaRequestModel)">
            <summary>
            parse request
            </summary>
            <param name="request"></param>
            <returns></returns>
        </member>
        <member name="T:BotSharp.RestApi.Rasa.StatusController">
            <summary>
            This returns all the currently available projects.
            </summary>
        </member>
        <member name="M:BotSharp.RestApi.Rasa.StatusController.#ctor(BotSharp.Core.Engines.IBotPlatform)">
            <summary>
            Initialize status controller and get a platform instance
            </summary>
            <param name="platform"></param>
        </member>
        <member name="M:BotSharp.RestApi.Rasa.StatusController.Get">
            <summary>
            Returns a list of available projects the server can use to fulfill /parse requests.
            </summary>
            <returns></returns>
        </member>
        <member name="T:BotSharp.RestApi.Rasa.TrainController">
            <summary>
            You can post your training data to this endpoint to train a new model for a project.
            This request will wait for the server answer: either the model was trained successfully or the training exited with an error. 
            </summary>
        </member>
        <member name="M:BotSharp.RestApi.Rasa.TrainController.#ctor(BotSharp.Core.Engines.IBotPlatform)">
            <summary>
            Initialize dialog controller and get a platform instance
            </summary>
            <param name="platform"></param>
        </member>
        <member name="M:BotSharp.RestApi.Rasa.TrainController.Train(System.String,System.String)">
            <summary>
            Using the HTTP server, you must specify the project you want to train a new model for to be able to use it during parse requests later on : /train?project=my_project.
            </summary>
            <param name="model">Model name</param>
            <param name="project">Agent name or agent id</param>
            <returns></returns>
        </member>
        <member name="P:BotSharp.RestApi.Integrations.FacebookMessenger.WebhookMessageRecipient.Id">
            <summary>
            PAGE_ID
            </summary>
        </member>
        <member name="P:BotSharp.RestApi.Integrations.FacebookMessenger.WebhookMessageSender.Id">
            <summary>
            PSID
            </summary>
        </member>
        <member name="M:BotSharp.RestApi.Ontology.EntityController.#ctor(BotSharp.Core.Engines.IBotPlatform)">
            <summary>
            Initialize dialog controller and get a platform instance
            </summary>
            <param name="platform"></param>
        </member>
    </members>
</doc>