curl --request POST \
--url https://api.example.com/api/semantic-models/generate/context \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"domain_name": "<string>",
"domain_urn": "<string>",
"user_prompt": "<string>",
"include_tables": [
"<string>"
],
"exclude_tables": [
"<string>"
],
"documents": [
"<string>"
],
"business_rules": [
"<string>"
]
}
'import requests
url = "https://api.example.com/api/semantic-models/generate/context"
payload = {
"domain_name": "<string>",
"domain_urn": "<string>",
"user_prompt": "<string>",
"include_tables": ["<string>"],
"exclude_tables": ["<string>"],
"documents": ["<string>"],
"business_rules": ["<string>"]
}
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({
domain_name: '<string>',
domain_urn: '<string>',
user_prompt: '<string>',
include_tables: ['<string>'],
exclude_tables: ['<string>'],
documents: ['<string>'],
business_rules: ['<string>']
})
};
fetch('https://api.example.com/api/semantic-models/generate/context', 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.example.com/api/semantic-models/generate/context",
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([
'domain_name' => '<string>',
'domain_urn' => '<string>',
'user_prompt' => '<string>',
'include_tables' => [
'<string>'
],
'exclude_tables' => [
'<string>'
],
'documents' => [
'<string>'
],
'business_rules' => [
'<string>'
]
]),
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 := "https://api.example.com/api/semantic-models/generate/context"
payload := strings.NewReader("{\n \"domain_name\": \"<string>\",\n \"domain_urn\": \"<string>\",\n \"user_prompt\": \"<string>\",\n \"include_tables\": [\n \"<string>\"\n ],\n \"exclude_tables\": [\n \"<string>\"\n ],\n \"documents\": [\n \"<string>\"\n ],\n \"business_rules\": [\n \"<string>\"\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("https://api.example.com/api/semantic-models/generate/context")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"domain_name\": \"<string>\",\n \"domain_urn\": \"<string>\",\n \"user_prompt\": \"<string>\",\n \"include_tables\": [\n \"<string>\"\n ],\n \"exclude_tables\": [\n \"<string>\"\n ],\n \"documents\": [\n \"<string>\"\n ],\n \"business_rules\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/semantic-models/generate/context")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"domain_name\": \"<string>\",\n \"domain_urn\": \"<string>\",\n \"user_prompt\": \"<string>\",\n \"include_tables\": [\n \"<string>\"\n ],\n \"exclude_tables\": [\n \"<string>\"\n ],\n \"documents\": [\n \"<string>\"\n ],\n \"business_rules\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"domain_name": "<string>",
"domain_urn": "<string>",
"tables": [
"<string>"
],
"documents": [
{
"urn": "<string>",
"title": "<string>",
"excerpts": [
"<string>"
]
}
],
"business_rules": [
{
"ref": "<string>",
"name": "",
"version": 123,
"readable": true,
"note": "<string>"
}
],
"sensitive_columns": [
{
"table": "<string>",
"column": "<string>",
"labels": [
"<string>"
]
}
],
"columns_total": 0,
"columns_with_glossary_terms": 0,
"tables_with_failing_quality": [
"<string>"
]
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Preview generation context
What a generation would be built from, before running it: the reference documents it will use, the business rules it will apply, sensitive columns, glossary-term coverage and sources failing data-quality checks. Advisory only — nothing here blocks generating. Changes nothing.
Required roles: nx1_semantic_modeller or nx1_semantic_admin
curl --request POST \
--url https://api.example.com/api/semantic-models/generate/context \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"domain_name": "<string>",
"domain_urn": "<string>",
"user_prompt": "<string>",
"include_tables": [
"<string>"
],
"exclude_tables": [
"<string>"
],
"documents": [
"<string>"
],
"business_rules": [
"<string>"
]
}
'import requests
url = "https://api.example.com/api/semantic-models/generate/context"
payload = {
"domain_name": "<string>",
"domain_urn": "<string>",
"user_prompt": "<string>",
"include_tables": ["<string>"],
"exclude_tables": ["<string>"],
"documents": ["<string>"],
"business_rules": ["<string>"]
}
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({
domain_name: '<string>',
domain_urn: '<string>',
user_prompt: '<string>',
include_tables: ['<string>'],
exclude_tables: ['<string>'],
documents: ['<string>'],
business_rules: ['<string>']
})
};
fetch('https://api.example.com/api/semantic-models/generate/context', 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.example.com/api/semantic-models/generate/context",
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([
'domain_name' => '<string>',
'domain_urn' => '<string>',
'user_prompt' => '<string>',
'include_tables' => [
'<string>'
],
'exclude_tables' => [
'<string>'
],
'documents' => [
'<string>'
],
'business_rules' => [
'<string>'
]
]),
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 := "https://api.example.com/api/semantic-models/generate/context"
payload := strings.NewReader("{\n \"domain_name\": \"<string>\",\n \"domain_urn\": \"<string>\",\n \"user_prompt\": \"<string>\",\n \"include_tables\": [\n \"<string>\"\n ],\n \"exclude_tables\": [\n \"<string>\"\n ],\n \"documents\": [\n \"<string>\"\n ],\n \"business_rules\": [\n \"<string>\"\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("https://api.example.com/api/semantic-models/generate/context")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"domain_name\": \"<string>\",\n \"domain_urn\": \"<string>\",\n \"user_prompt\": \"<string>\",\n \"include_tables\": [\n \"<string>\"\n ],\n \"exclude_tables\": [\n \"<string>\"\n ],\n \"documents\": [\n \"<string>\"\n ],\n \"business_rules\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/semantic-models/generate/context")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"domain_name\": \"<string>\",\n \"domain_urn\": \"<string>\",\n \"user_prompt\": \"<string>\",\n \"include_tables\": [\n \"<string>\"\n ],\n \"exclude_tables\": [\n \"<string>\"\n ],\n \"documents\": [\n \"<string>\"\n ],\n \"business_rules\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"domain_name": "<string>",
"domain_urn": "<string>",
"tables": [
"<string>"
],
"documents": [
{
"urn": "<string>",
"title": "<string>",
"excerpts": [
"<string>"
]
}
],
"business_rules": [
{
"ref": "<string>",
"name": "",
"version": 123,
"readable": true,
"note": "<string>"
}
],
"sensitive_columns": [
{
"table": "<string>",
"column": "<string>",
"labels": [
"<string>"
]
}
],
"columns_total": 0,
"columns_with_glossary_terms": 0,
"tables_with_failing_quality": [
"<string>"
]
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
What a generation would be built from, before running it.
Domain name.
Domain URN.
The generation brief.
Document URNs to use; omit to let it pick.
20Business rules as workspace/key.
20Response
Successful Response
The context a generation would use. Nothing here blocks generating.
The documents that will be used. Tell the user which.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?

