Get dataset readiness
curl --request GET \
--url https://api.withsplendor.com/v1/datasets/{dataset_id}/readiness \
--header 'Authorization: Bearer <token>' \
--header 'x-splendor-tenant-id: <x-splendor-tenant-id>'import requests
url = "https://api.withsplendor.com/v1/datasets/{dataset_id}/readiness"
headers = {
"x-splendor-tenant-id": "<x-splendor-tenant-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'x-splendor-tenant-id': '<x-splendor-tenant-id>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.withsplendor.com/v1/datasets/{dataset_id}/readiness', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.withsplendor.com/v1/datasets/{dataset_id}/readiness",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"x-splendor-tenant-id: <x-splendor-tenant-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.withsplendor.com/v1/datasets/{dataset_id}/readiness"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-splendor-tenant-id", "<x-splendor-tenant-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.withsplendor.com/v1/datasets/{dataset_id}/readiness")
.header("x-splendor-tenant-id", "<x-splendor-tenant-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withsplendor.com/v1/datasets/{dataset_id}/readiness")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-splendor-tenant-id"] = '<x-splendor-tenant-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"dataset_id": "app-logs",
"dataset_semantic_backlog_count": 0,
"document_semantic_backlog_count": 0,
"document_semantic_search_ready": true,
"documents": {
"expected": 1240000,
"index_committed": 1240000,
"parsed": 1240000,
"schema_observed": 1240000,
"semantic_embedded": 1240000,
"semantic_failed": 0,
"semantic_total": 1240000
},
"ingest_run_count": 3,
"lifecycle": {
"reasons": [],
"repairable": false,
"state": "ready"
},
"ready_for": {
"semantic_search": true,
"sql_search": true,
"text_search": true
},
"schema_ready": true,
"semantic_configured": true,
"semantic_failures": [],
"semantic_search_ready": true,
"status_counts": [
{
"count": 3,
"status": "ready"
}
],
"text_search_ready": true,
"vocabulary_semantic_backlog_count": 0,
"vocabulary_semantic_ready": true
}{
"detail": "Dataset not found"
}{
"detail": "Dataset not found"
}{
"detail": "Dataset not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Datasets & schema
Get dataset readiness
Reports which capabilities are available for a dataset yet: schema inference, text search, and semantic search. Ingestion and indexing are asynchronous, so poll readiness before relying on a search mode.
GET
/
v1
/
datasets
/
{dataset_id}
/
readiness
Get dataset readiness
curl --request GET \
--url https://api.withsplendor.com/v1/datasets/{dataset_id}/readiness \
--header 'Authorization: Bearer <token>' \
--header 'x-splendor-tenant-id: <x-splendor-tenant-id>'import requests
url = "https://api.withsplendor.com/v1/datasets/{dataset_id}/readiness"
headers = {
"x-splendor-tenant-id": "<x-splendor-tenant-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'x-splendor-tenant-id': '<x-splendor-tenant-id>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.withsplendor.com/v1/datasets/{dataset_id}/readiness', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.withsplendor.com/v1/datasets/{dataset_id}/readiness",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"x-splendor-tenant-id: <x-splendor-tenant-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.withsplendor.com/v1/datasets/{dataset_id}/readiness"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-splendor-tenant-id", "<x-splendor-tenant-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.withsplendor.com/v1/datasets/{dataset_id}/readiness")
.header("x-splendor-tenant-id", "<x-splendor-tenant-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withsplendor.com/v1/datasets/{dataset_id}/readiness")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-splendor-tenant-id"] = '<x-splendor-tenant-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"dataset_id": "app-logs",
"dataset_semantic_backlog_count": 0,
"document_semantic_backlog_count": 0,
"document_semantic_search_ready": true,
"documents": {
"expected": 1240000,
"index_committed": 1240000,
"parsed": 1240000,
"schema_observed": 1240000,
"semantic_embedded": 1240000,
"semantic_failed": 0,
"semantic_total": 1240000
},
"ingest_run_count": 3,
"lifecycle": {
"reasons": [],
"repairable": false,
"state": "ready"
},
"ready_for": {
"semantic_search": true,
"sql_search": true,
"text_search": true
},
"schema_ready": true,
"semantic_configured": true,
"semantic_failures": [],
"semantic_search_ready": true,
"status_counts": [
{
"count": 3,
"status": "ready"
}
],
"text_search_ready": true,
"vocabulary_semantic_backlog_count": 0,
"vocabulary_semantic_ready": true
}{
"detail": "Dataset not found"
}{
"detail": "Dataset not found"
}{
"detail": "Dataset not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Authorizations
API token issued from the Splendor console.
Headers
Selects the tenant (workspace) the request acts within.
Path Parameters
Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes