Interpret one natural-language question as read-only KARE catalogue queries.
curl --request POST \
--url http://localhost:3000/rs/search/v1/query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"scope": {
"unitIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"technicalInstallationIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"resolutions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
'import requests
url = "http://localhost:3000/rs/search/v1/query"
payload = {
"query": "<string>",
"scope": {
"unitIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"technicalInstallationIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
},
"resolutions": [{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
scope: {
unitIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
technicalInstallationIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
},
resolutions: [{id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}]
})
};
fetch('http://localhost:3000/rs/search/v1/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/rs/search/v1/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'scope' => [
'unitIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'technicalInstallationIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'resolutions' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/rs/search/v1/query"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"scope\": {\n \"unitIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"technicalInstallationIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"resolutions\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/rs/search/v1/query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"scope\": {\n \"unitIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"technicalInstallationIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"resolutions\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/search/v1/query")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"scope\": {\n \"unitIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"technicalInstallationIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"resolutions\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"answer": {
"kind": "results"
},
"sections": [
{
"entity": "anomaly",
"label": "<string>",
"filters": [
{
"key": "<string>",
"label": "<string>",
"value": "<string>",
"valueLabel": "<string>"
}
],
"cards": [
{
"entityType": "anomaly",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"title": "<string>",
"subtitle": "<string>",
"status": "<string>",
"lifecycle": {
"archived": true,
"historized": true
},
"units": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
],
"technicalInstallations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
],
"matchedField": "ref",
"outsideRequestedScope": true,
"interventionType": "preventive"
}
],
"totalCount": 4503599627370495,
"hasMore": true,
"listParams": {},
"orderBy": {
"param": "<string>",
"direction": "asc"
},
"aggregate": {
"kind": "count",
"count": 4503599627370495
},
"unavailable": "forbidden"
}
],
"plan": "<unknown>",
"degraded": true,
"clarification": {
"kind": "unit",
"candidates": [
{
"entityType": "anomaly",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"title": "<string>",
"subtitle": "<string>",
"status": "<string>",
"lifecycle": {
"archived": true,
"historized": true
},
"units": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
],
"technicalInstallations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
],
"matchedField": "ref",
"outsideRequestedScope": true,
"interventionType": "preventive"
}
]
}
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}search
Interpret one natural-language question as read-only KARE catalogue queries.
POST
/
rs
/
search
/
v1
/
query
Interpret one natural-language question as read-only KARE catalogue queries.
curl --request POST \
--url http://localhost:3000/rs/search/v1/query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"scope": {
"unitIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"technicalInstallationIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"resolutions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
'import requests
url = "http://localhost:3000/rs/search/v1/query"
payload = {
"query": "<string>",
"scope": {
"unitIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"technicalInstallationIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
},
"resolutions": [{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
scope: {
unitIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
technicalInstallationIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
},
resolutions: [{id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}]
})
};
fetch('http://localhost:3000/rs/search/v1/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/rs/search/v1/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'scope' => [
'unitIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'technicalInstallationIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'resolutions' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/rs/search/v1/query"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"scope\": {\n \"unitIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"technicalInstallationIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"resolutions\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/rs/search/v1/query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"scope\": {\n \"unitIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"technicalInstallationIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"resolutions\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/search/v1/query")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"scope\": {\n \"unitIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"technicalInstallationIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"resolutions\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"answer": {
"kind": "results"
},
"sections": [
{
"entity": "anomaly",
"label": "<string>",
"filters": [
{
"key": "<string>",
"label": "<string>",
"value": "<string>",
"valueLabel": "<string>"
}
],
"cards": [
{
"entityType": "anomaly",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"title": "<string>",
"subtitle": "<string>",
"status": "<string>",
"lifecycle": {
"archived": true,
"historized": true
},
"units": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
],
"technicalInstallations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
],
"matchedField": "ref",
"outsideRequestedScope": true,
"interventionType": "preventive"
}
],
"totalCount": 4503599627370495,
"hasMore": true,
"listParams": {},
"orderBy": {
"param": "<string>",
"direction": "asc"
},
"aggregate": {
"kind": "count",
"count": 4503599627370495
},
"unavailable": "forbidden"
}
],
"plan": "<unknown>",
"degraded": true,
"clarification": {
"kind": "unit",
"candidates": [
{
"entityType": "anomaly",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"title": "<string>",
"subtitle": "<string>",
"status": "<string>",
"lifecycle": {
"archived": true,
"historized": true
},
"units": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
],
"technicalInstallations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
],
"matchedField": "ref",
"outsideRequestedScope": true,
"interventionType": "preventive"
}
]
}
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json