export COMPOSE_FILE=ci
./cjl up -d && ./cjl run backend_service

Initializes a new conversation

URL : /new

Method : POST

Data constraints

Provide the user's name and person type.

{
    "name": "[unicode 40 chars max]",
    "person_type": "(TENANT|LANDLORD)"
}

Code : 200 OK

Content examples

{
    "conversation_id": 1
}

Code : 400 Bad Request - Invalid person_type provided

Stores the user confirmation or text supplied in order to confirm whether an NLP prediction was accurate. This is request is sent when the user either accepts or rejects an intent classification via interface buttons.

URL : /store-user-confirmation

Method : POST

Data constraints

Provide the conversation id and confirmation text of the user.

{
    "conversation_id": 1,
    "confirmation": true | false | "$5000"
}

Code : 200 OK

Content examples

{
    "message": "User confirmation stored successfully"
}

Code : 400 Bad Request

Code : 404 Not Found

Sends a message to the bot. This will be the message that the bot displays to the user

URL : /conversation

Method : POST

Data constraints

Provide the conversation_id and a message. Message should be empty string for first call.

{
    "conversation_id": "[integer]",
    "message": "[unicode]"
}

Code : 200 OK

Content examples

Simple response containing a message and conversation progress. Messages may contain pipe characters (|) which indicate that a sentence should be split into separate conversation windows. Note that the first message will not contain a pipe character. Each subsequent sentence will begin with a pipe character if it is meant to be split.

Converation progress will be null at the beginning of the conversation, and if the user ends up asking a FAQ question (which have no progress). However, if the user asks a question that requires the bot to resolve facts, progress will indicate a percentage of how far along the conversation is to getting a prediction.

{
    "conversation_id": 1,
    "message": "Hello Tim Timmens!|What kind of problem are you having?",
    "progress": null
}

This is formatted in the web interface as:

Message 1: Hello Tim Timmens!

Message 2: What kind of problem are you having?

{
    "conversation_id": 5,
    "message": "Oh I see you're having problems with lease termination!|I have a few questions for you.|Do you have a lease?",
    "progress": 0
}

This is formatted in the web interface as:

Message 1: Oh I see you're having problems with lease termination!

Message 2: I have a few questions for you.

Message 3: Do you have a lease

{
    "conversation_id": 1,
    "file_request": {
        "document_type": "LEASE"
    },
    "message": "Could you please upload your lease if you have it, Tim Timmens?"
}

LEASE: A lease for a dwelling

Code : 404 Not Found

Gets the message history for a conversation

URL : /conversation/:conversation_id

Method : GET

Code : 200 OK

Content examples

{
    "claim_category": "NONPAYMENT",
    "bot_state": "RESOLVING_FACTS",
    "current_fact": {
        "name": "landlord_retakes_apartment",
        "summary": "Landlord intends to retake dwelling",
        "type": "BOOLEAN"
    },
    "fact_entities": [
        {
            "fact": {
                "name": "apartment_impropre",
                "summary": "Dwelling unfit for habitation",
                "type": "BOOLEAN"
            },
            "id": 1,
            "value": "false"
        },
        {
            "fact": {
                "name": "landlord_relocation_indemnity_fees",
                "summary": "Relocation reimbursed following inhabitability",
                "type": "BOOLEAN"
            },
            "id": 2,
            "value": "true"
        }
    ],
    "files": [],
    "id": 1,
    "messages": [
        {
            "enforce_possible_answer": true,
            "file_request": null,
            "id": 1,
            "possible_answers": "[\"Yes\"]",
                "relevant_fact": null,
                "sender_type": "BOT",
                "text": "Hello Bobby! Before we start, I want to make it clear that I am not a replacement for a lawyer and any information I provide you with is not meant to be construed as legal advice. Always check in with your legal professional. You can read more about our terms of use <a href='/legal' target='_blank'>here</a>. Do you accept these conditions?",
                "timestamp": "2017-12-20T01:27:35.993932+00:00"
            },
            {
                "enforce_possible_answer": null,
                "file_request": null,
                "id": 2,
                "possible_answers": null,
                "relevant_fact": null,
                "sender_type": "USER",
                "text": "Yes",
                "timestamp": "2017-12-20T01:27:39.023317+00:00"
            },
            {
                "enforce_possible_answer": false,
                "file_request": {
                    "document_type": "LEASE"
                },
                "id": 3,
                "possible_answers": null,
                "relevant_fact": null,
                "sender_type": "BOT",
                "text": "I see you're a tenant, Bobby. If you have it on hand, it would be very helpful if you could upload your lease. What issue can I help you with today?",
                "timestamp": "2017-12-20T01:27:39.040375+00:00"
            },
            {
                "enforce_possible_answer": null,
                "file_request": null,
                "id": 4,
                "possible_answers": null,
                "relevant_fact": null,
                "sender_type": "USER",
                "text": "I am being kicked out",
                "timestamp": "2017-12-20T01:27:40.694884+00:00"
            },
            {
                "enforce_possible_answer": false,
                "file_request": null,
                "id": 5,
                "possible_answers": null,
                "relevant_fact": {
                    "name": "apartment_impropre",
                    "summary": "Dwelling unfit for habitation",
                    "type": "BOOLEAN"
                },
                "sender_type": "BOT",
                "text": "Oh yes, I know all about problems with nonpayment. Would you deem the apartment unfit for habitation?",
                "timestamp": "2017-12-20T01:27:40.794129+00:00"
            },
            {
                "enforce_possible_answer": null,
                "file_request": null,
                "id": 6,
                "possible_answers": null,
                "relevant_fact": {
                    "name": "apartment_impropre",
                    "summary": "Dwelling unfit for habitation",
                    "type": "BOOLEAN"
                },
                "sender_type": "USER",
                "text": "No",
                "timestamp": "2017-12-20T01:28:46.591573+00:00"
            },
            {
                "enforce_possible_answer": false,
                "file_request": null,
                "id": 7,
                "possible_answers": null,
                "relevant_fact": {
                    "name": "landlord_relocation_indemnity_fees",
                    "summary": "Relocation reimbursed following inhabitability",
                    "type": "BOOLEAN"
                },
                "sender_type": "BOT",
                "text": "Have moving expenses been compensated when the apartment was deemed inhabitable?",
                "timestamp": "2017-12-20T01:28:46.652110+00:00"
            },
            {
                "enforce_possible_answer": null,
                "file_request": null,
                "id": 8,
                "possible_answers": null,
                "relevant_fact": {
                    "name": "landlord_relocation_indemnity_fees",
                    "summary": "Relocation reimbursed following inhabitability",
                    "type": "BOOLEAN"
                },
                "sender_type": "USER",
                "text": "Yes",
                "timestamp": "2017-12-20T01:28:51.529825+00:00"
            }
        ],
    "name": "Bobby",
    "person_type": "TENANT"
}

Code : 400 Bad Request

Code : 404 Not Found

Retrieves a report for a conversation once at least one prediction has been returned. Will return 404 if a report has not been generated yet.

URL : /conversation/:conversation_id/report

Method : GET

Code : 200 OK

Content examples

{
    "report": {
        "accuracy": 0.8114285714285714,
        "curves": {
            "additional_indemnity_money": {
                "mean": 1477.7728467101024,
                "outcome_value": 6038,
                "std": 1927.8147997893939,
                "variance": 3716469.9022870203
            }
        },
        "data_set": 8,
        "outcomes": {
            "additional_indemnity_money": 6038,
            "landlord_prejudice_justified": true,
            "orders_expulsion": true,
            "orders_immediate_execution": true,
            "orders_resiliation": true,
            "tenant_ordered_to_pay_landlord": 3092,
            "tenant_ordered_to_pay_landlord_legal_fees": 80
        },
        "similar_case": 5,
        "similar_precedents": [
            {
                "distance": 2.6080129205467784,
                "facts": {
                    "landlord_relocation_indemnity_fees": 0,
                    "tenant_dead": false,
                    "tenant_is_bothered": false,
                    "tenant_left_without_paying": false,
                    "tenant_owes_rent": 0,
                    "tenant_rent_not_paid_more_3_weeks": true
                },
                "outcomes": {
                    "additional_indemnity_money": 5850,
                    "landlord_prejudice_justified": true,
                    "orders_expulsion": true,
                    "orders_immediate_execution": true,
                    "orders_resiliation": true,
                    "tenant_ordered_to_pay_landlord": 7150,
                    "tenant_ordered_to_pay_landlord_legal_fees": 74
                },
                "precedent": "AZ-51412066"
            },
            {
                "distance": 2.6543730465072035,
                "facts": {
                    "landlord_relocation_indemnity_fees": 0,
                    "tenant_dead": false,
                    "tenant_is_bothered": false,
                    "tenant_left_without_paying": false,
                    "tenant_owes_rent": 2460,
                    "tenant_rent_not_paid_more_3_weeks": true
                },
                "outcomes": {
                    "additional_indemnity_money": 3620,
                    "landlord_prejudice_justified": true,
                    "orders_expulsion": true,
                    "orders_immediate_execution": true,
                    "orders_resiliation": true,
                    "tenant_ordered_to_pay_landlord": 2460,
                    "tenant_ordered_to_pay_landlord_legal_fees": 81
                },
                "precedent": "AZ-51163532"
            },
            {
                "distance": 2.6969256661279988,
                "facts": {
                    "landlord_relocation_indemnity_fees": 0,
                    "tenant_dead": false,
                    "tenant_is_bothered": false,
                    "tenant_left_without_paying": false,
                    "tenant_owes_rent": 0,
                    "tenant_rent_not_paid_more_3_weeks": true
                },
                "outcomes": {
                    "additional_indemnity_money": 2463,
                    "landlord_prejudice_justified": true,
                    "orders_expulsion": true,
                    "orders_immediate_execution": true,
                    "orders_resiliation": true,
                    "tenant_ordered_to_pay_landlord": 2886,
                    "tenant_ordered_to_pay_landlord_legal_fees": 83
                },
                "precedent": "AZ-51395624"
            },
            {
                "distance": 2.719885995641093,
                "facts": {
                    "landlord_relocation_indemnity_fees": 0,
                    "tenant_dead": false,
                    "tenant_is_bothered": false,
                    "tenant_left_without_paying": false,
                    "tenant_owes_rent": 0,
                    "tenant_rent_not_paid_more_3_weeks": true
                },
                "outcomes": {
                    "additional_indemnity_money": 3180,
                    "landlord_prejudice_justified": true,
                    "orders_expulsion": true,
                    "orders_immediate_execution": true,
                    "orders_resiliation": true,
                    "tenant_ordered_to_pay_landlord": 3830,
                    "tenant_ordered_to_pay_landlord_legal_fees": 74
                },
                "precedent": "AZ-51395655"
            },
            {
                "distance": 2.7806288394504484,
                "facts": {
                    "landlord_relocation_indemnity_fees": 0,
                    "tenant_dead": false,
                    "tenant_is_bothered": false,
                    "tenant_left_without_paying": false,
                    "tenant_owes_rent": 3600,
                    "tenant_rent_not_paid_more_3_weeks": true
                },
                "outcomes": {
                    "additional_indemnity_money": 3750,
                    "landlord_prejudice_justified": true,
                    "orders_expulsion": true,
                    "orders_immediate_execution": true,
                    "orders_resiliation": true,
                    "tenant_ordered_to_pay_landlord": 3600,
                    "tenant_ordered_to_pay_landlord_legal_fees": 78
                },
                "precedent": "AZ-51187376"
            }
        ]
    }
}

Code : 400 Bad Request

Gets only the list of resolved facts for the conversation

URL : /conversation/:conversation_id/resolved

Method : GET

Code : 200 OK

Content examples

{
    "fact_entities": [
        {
            "fact": {
                "name": "apartment_impropre",
                "summary": "Dwelling unfit for habitation",
                "type": "BOOLEAN"
            },
            "id": 1,
            "value": "false"
        },
        {
            "fact": {
                "name": "landlord_relocation_indemnity_fees",
                "summary": "Relocation reimbursed following inhabitability",
                "type": "BOOLEAN"
            },
            "id": 2,
            "value": "true"
        }
    ]
}

Code : 400 Bad Request

Code : 404 Not Found

Removes a resolved fact from the conversation

URL : /conversation/:conversation_id/resolved/:fact_id

Method : DELETE

Code : 200 OK

Content examples

{
    "success": true
}

Code : 400 Bad Request

Code : 404 Not Found

Upload a file that serves as evidence for a particular conversation.

URL : /conversation/:conversation_id/files

Method : POST

Headers

Content-Type: multipart/form-data

Data constraints

Provide 'file' form key with file data.

Code : 200 OK

Content examples

{
    "name": "leaky_pipes.png",
    "type": "image/png",
    "timestamp": "2017-10-24T00:01:27.806730+00:00"
}

Code : 400 Bad Request

Code : 404 Not Found

Gets a list of file metadata for a conversation

URL : /conversation/:conversation_id/files

Method : GET

Code : 200 OK

Content examples

{
    "files": [
        {
            "name": "leaky_pipes.png",
            "type": "image/png",
            "timestamp": "2017-10-24T00:01:27.000000+00:00"
        },
        {
            "name": "my_least.pdf",
            "type": "application/pdf",
            "timestamp": "2017-10-24T00:01:30.000000+00:00"
        }
    ]
}

Code : 400 Bad Request

Code : 404 Not Found

Obtains information and contents of the latest legal documents

URL : /legal

Method : GET

Code : 200 OK

Content examples

[
    {
        "abbreviation": "EULA",
        "html": {
            "content": [
                {
                    "subtitle": "TL;DR",
                    "summary": "no purse as fully me or point. Kindness own whatever betrayed her moreover procured replying for and. Proposal indulged no do do sociable he throwing settling. Covered ten nor comfort offices carried. Age she way earnestly the fulfilled extremely.",
                    "text": "Prevailed sincerity behaviour to so do principle mr. As departure at no propriety zealously my. On dear rent if girl view. First on smart there he sense. Earnestly enjoyment her you resources. Brother chamber ten old against. Mr be cottage so related minuter is. Delicate say and blessing ladyship exertion few margaret. Delight herself welcome against smiling its for. Suspected discovery by he affection household of principle perfectly he.",
                    "title": "DESCRIPTION OF SERVICE"
                },
                {
                    "subtitle": "TL;DR",
                    "summary": "Scarcely on striking packages by so property in delicate. Up or well must less rent read walk so be. Easy sold at do hour sing spot. Any meant has cease too the decay. Since party burst am it match. By or blushes between besides offices noisier as.",
                    "text": "It prepare is ye nothing blushes up brought. Or as gravity pasture limited evening on. Wicket around beauty say she. Frankness resembled say not new smallness you discovery. Noisier ferrars yet shyness weather ten colonel. Too him himself engaged husband pursuit musical. Man age but him determine consisted therefore. Dinner to beyond regret wished an branch he. Remain bed but expect suffer little repair.",
                    "title": "ACCEPTANCE OF TERMS"
                },
                {
                    "subtitle": "TL;DR",
                    "summary": "Luckily friends do ashamed to do suppose. Tried meant mr smile so. Exquisite behaviour as to middleton perfectly.",
                    "text": "He my polite be object oh change. Consider no mr am overcame yourself throwing sociable children. Hastily her totally conduct may. My solid by stuff first smile fanny. Humoured how advanced mrs elegance sir who. Home sons when them dine do want to. Estimating themselves unsatiable imprudence an he at an. Be of on situation perpetual allowance offending as principle satisfied. Improved carriage securing are desirous too.",
                    "title": "MODIFICATION OF TERMS"
                },
                {
                    "subtitle": "TL;DR",
                    "summary": "Improved own provided blessing may peculiar domestic. Sight house has sex never. No visited raising gravity outward subject my cottage mr be. Hold do at tore in park feet near my case.",
                    "text": "Extremely we promotion remainder eagerness enjoyment an. Ham her demands removal brought minuter raising invited gay. Contented consisted continual curiosity contained get sex. Forth child dried in in aware do. You had met they song how feel lain evil near. Small she avoid six yet table china. And bed make say been then dine mrs. To household rapturous fulfilled attempted on so. ",
                    "title": "REGISTRATION"
                }
            ],
            "header": "End User License Agreement",
            "subheader": "Savings her pleased are several started females met. Short her not among being any. Thing of judge fruit charm views do. Miles mr an forty along as he. She education get middleton day agreement performed preserved unwilling. Do however as pleased offence outward beloved by present. By outward neither he so covered amiable greater. Juvenile proposal betrayed he an informed weddings followed. Precaution day see imprudence sympathize principles. At full leaf give quit to in they up."
        },
        "time_created": "2017-10-26T20:52:41-04:00",
        "type": "End User License Agreement",
        "version": 1
    }
]