Completion

Get completion for a prompt.

A completion is a summary of the applicable laws provided in answer to provied prompt. The response will include the prompt, the completion, and the sources used to generate the completion.

If the stream parameter is set to true, the response will be a stream of events.

application/json

Request Body required

prompt Prompt required
stream Stream

Default value: false

Responses

• 200
• 422

---

Successful Response

application/json

Schema

Example (from schema)

---

Schema

prompt Prompt required
completion Completion required
sources object[] required
Array [
source_id Source Id required
ids string[] required
reference Reference
metadata object required
document_id Document Id required
document_title Document Title
document_citation Document Citation
section_id Section Id
section_title Section Title
section_citation Section Citation
instrument Instrument required
instrument_subtype Instrument Subtype
jurisdiction_id Jurisdiction Id required
jurisdiction Jurisdiction required
country Country required
province Province
other object
created_at date-time
source_id Source Id required
id Id required
document_html_url Document Html Url
document_pdf_url Document Pdf Url
section_html_url Section Html Url
section_pdf_url Section Pdf Url
]

{
  "prompt": "string",
  "completion": "string",
  "sources": [
    {
      "source_id": "string",
      "ids": [
        "string"
      ],
      "reference": "string",
      "metadata": {
        "document_id": "string",
        "document_title": "string",
        "document_citation": "string",
        "section_id": "string",
        "section_title": "string",
        "section_citation": "string",
        "instrument": "string",
        "instrument_subtype": "string",
        "jurisdiction_id": "string",
        "jurisdiction": "string",
        "country": "string",
        "province": "string",
        "other": {},
        "created_at": "2023-09-19T17:21:52.252Z",
        "source_id": "string",
        "id": "string",
        "document_html_url": "string",
        "document_pdf_url": "string",
        "section_html_url": "string",
        "section_pdf_url": "string"
      }
    }
  ]
}

Validation Error

application/json

Schema

Example (from schema)

---

Schema

detail object[]
Array [
loc object[] required
Array [
anyOf
MOD1
MOD2
---
string
integer
]
msg Message required
type Error Type required
]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...