READ · Advanced Search
Run a search
The matching documents and passages, a summary and a comparison table.
POSThttps://api.rowland.ai/v1/read/searches
Body parameters
questionstringRequiredThe question.
filtersobjectOptionalThe
understood_asfilters from the preview, as they are or changed.
Returns
200OK. For failures, see Errors.
answerstringA short answer to the question.
matchesobject[]The matching documents, best first: the page, the passage and why it matched.
tableobject | nullThe matches side by side, when the question compares them.
curl -X POST "https://api.rowland.ai/v1/read/searches" \
-H "x-api-key: $ROWLAND_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"question": "Leases in Reeves County with a royalty above 3/16 and a primary term over five years",
"filters": {
"types": [
"oil_gas_lease"
],
"royalty": {
"greater_than": 0.1875
},
"primary_term_years": {
"greater_than": 5
},
"keywords": [
"Reeves County"
]
}
}'Response200
{
"object": "search",
"id": "srh_8Lx2qMv5Td",
"answer": "Two leases match. Both reserve a 1/5 royalty; the Ochoa lease has the longer primary term.",
"matches": [
{
"document": "doc_7Rw3nPz9Xc",
"page": 1,
"excerpt": "…for a primary term of seven (7) years… a royalty of one-fifth (1/5)…",
"why": "Reeves County lease, 1/5 royalty, 7-year term"
},
{
"document": "doc_1Ns6wGd3Kf",
"page": 2,
"excerpt": "…primary term of six (6) years… one-fifth (1/5) of all oil…",
"why": "Reeves County lease, 1/5 royalty, 6-year term"
}
],
"table": {
"columns": [
"Lease",
"Royalty",
"Primary term"
],
"rows": [
[
"Ochoa",
"1/5",
"7 years"
],
[
"Garza",
"1/5",
"6 years"
]
]
}
}