The In-Dataset Discovery Service provides a secure API for performing natural
language exploration queries on structured or unstructured data within datasets.
It supports geospatial queries and text-to-SQL conversion using LLM
capabilities.
{"message":"In Data Exploration API is running.","status":"success"}
⚠️This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.Schema of the response body
{"properties":{"message":{"example":"In Data Exploration API is running.","type":"string"},"status":{"example":"success","type":"string"}},"type":"object"}
Checks the availability of the API service. Returns a 200 OK if the service
is healthy. This endpoint does not require authentication.
Response 200OK
{"status":"ok"}
⚠️This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.Schema of the response body
Processes a natural language geospatial question, identifies the place using
Wikidata, generates an OverpassQL query, and returns geospatial results
including coordinates, GeoJSON data, and bounding boxes.
Input parameters
Parameter
In
Type
Default
Nullable
Description
OAuth2Bearer
header
string
N/A
No
JWT token for authentication, obtained from the OIDC provider.
question
query
string
No
The geospatial query question to be processed.
Response 200OK
{"most_relevant_wikidata":{"place":"string","reasoning":"string","wiki_id":"string","wiki_properties":{"aliases":"string","coordinate location":"string","country":"string","description":"string","found_osm_json":true,"instance of":"string","label":"string","located in the administrative territorial entity":"string","part of":"string"}},"oql":{"OQL":"string","reasoning":"string"},"place":"string","results":{"bounds":{"maxlat":10.12,"maxlon":10.12,"minlat":10.12,"minlon":10.12},"center":[10.12],"geojson_data":{},"points":[{"lat":"string","lon":"string"}]}}
⚠️This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.Schema of the response body
{"properties":{"most_relevant_wikidata":{"$ref":"#/components/schemas/MostRelevantWikidata","description":"The most relevant Wikidata entity related to the query."},"oql":{"$ref":"#/components/schemas/OQLResponse","description":"The OverpassQL query generated from the geospatial question."},"place":{"description":"The place identified in the geospatial query.","type":"string"},"results":{"$ref":"#/components/schemas/GeospatialResults","description":"The results of the OverpassQL query includes points, bounding box, multipolygons and centroid."}},"required":["place","most_relevant_wikidata","oql","results"],"type":"object"}
⚠️This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.Schema of the response body
{"properties":{"code":{"description":"HTTP status code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}
Takes a natural language question and database connection information,
generates a SQL query using LLM capabilities, and executes it to return
results.
Input parameters
Parameter
In
Type
Default
Nullable
Description
OAuth2Bearer
header
string
N/A
No
JWT token for authentication, obtained from the OIDC provider.
Request body
{"parameters":{"db_info":{"db_database":"string","db_host":"string","db_pass":"string","db_port":0,"db_schema":"string","db_username":"string"},"results":{"points":[[10.12]]}},"question":"What are the average mean temperatures in the coordinates (lon, lat) in year 2020?"}
⚠️This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.Schema of the request body
{"properties":{"parameters":{"$ref":"#/components/schemas/SQLQueryParameters","description":"The parameters for the SQL query, including results."},"question":{"description":"The text question to be converted to SQL.","example":"What are the average mean temperatures in the coordinates (lon, lat) in year 2020?","type":"string"}},"required":["question","parameters"],"type":"object"}
⚠️This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.Schema of the response body
{"properties":{"input_params":{"description":"Input parameters with coordinates.","items":{"$ref":"#/components/schemas/InputParam"},"type":"array"},"message":{"description":"Message describing the operation result.","type":"string"},"model_name":{"description":"The model name used for SQL generation.","type":"string"},"output_params":{"$ref":"#/components/schemas/OutputParams","description":"Output parameter definitions."},"params":{"additionalProperties":true,"description":"Parameters used in the query.","type":"object"},"question":{"description":"The original question that was converted to SQL.","type":"string"},"reasoning":{"description":"Reasoning behind the SQL query generation.","type":"string"},"sql_pattern":{"description":"The SQL pattern/template generated.","type":"string"},"sql_query":{"description":"The final SQL query with parameters filled in.","type":"string"},"sql_results":{"$ref":"#/components/schemas/SQLResults","description":"Results from executing the SQL query."},"status":{"description":"Status of the operation.","type":"string"}},"required":["status","message","params","question","model_name","sql_pattern","input_params","output_params","reasoning","sql_query","sql_results"],"type":"object"}
⚠️This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.Schema of the response body
{"properties":{"code":{"description":"HTTP status code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}