Package org.apache.nlpcraft.model

Interface NCRequest

    • Method Detail

      • getUser

        NCUser getUser()
        Gets descriptor of the user on behalf of which this request was submitted.
        Returns:
        User descriptor.

      • getCompany

        NCCompany getCompany()
        Gets descriptor of the user's company on behalf of which this request was submitted.
        Returns:
        User company descriptor.

      • getServerRequestId

        String getServerRequestId()
        Gets globally unique server ID of the current request.

        Server request is defined as a processing of a one user input request. Note that the model can be accessed multiple times during processing of a single user request and therefore multiple instances of this interface can return the same server request ID. In fact, users of this interfaces can use this fact by using this ID, for example, as a map key for a session scoped storage.

        Returns:
        Server request ID.

      • getNormalizedText

        String getNormalizedText()
        Gets normalized text of the user input.
        Returns:
        Normalized text of the user input.

      • getReceiveTimestamp

        long getReceiveTimestamp()
        Gets UTC/GMT timestamp in ms when user input was received.
        Returns:
        UTC/GMT timestamp in ms when user input was received.

      • getRemoteAddress

        Optional<String> getRemoteAddress()
        Gets optional address of the remote client.
        Returns:
        Optional address of the remote client.

      • getClientAgent

        Optional<String> getClientAgent()
        Gets string representation of the user client agent that made the call with this request.
        Returns:
        User agent string from user client (web browser, REST client, etc.).

      • getRequestData

        Map<String,​Object> getRequestData()
        Gets optional JSON data passed in with the user request.
        Returns:
        Optional JSON data, can be empty but never null.