1Get Semantic Model AI Settings
Overview
This API is used to get AI settings of a Semantic Model.
Method: GET
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/ai-settings
Authorization
API Key: sessionid
This method authenticates requests using a session ID which acts like an API key.
BasicAuth: HTTP Authorization Scheme
This method authenticates requests using a username and password sent in the HTTP Authorization header.
Headers
Header Name | Type | Description | Possible Values |
|---|---|---|---|
sessionid | String | The session ID is the token received from the login API. Note: Session ID is required for token-based authentication. | – |
Path Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
name-or-id (Required) | String | Name or ID of the Semantic Model whose AI Settings need to be fetched. Note: If the Semantic Model name is provided, either folderName or folderId must also be provided. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the name-or-id parameter should be interpreted as a Semantic Model name or Semantic Model ID. If by=name, provide the Semantic Model name in the name-or-id parameter. If by=id, provide the Semantic Model ID in the name-or-id parameter. The default value is name. | – |
folderName | String | Name of the folder containing the Semantic Model. If the Semantic Model is present in the root directory, specify [Root]. Note: If neither folderName nor folderId is provided, the Semantic Model will be treated as a root-level entity by default. | – |
folderId | String | Folder ID in which the Semantic Model is located. | – |
Responses
200 Success
{
"mandatoryRAGColumns":[
],
"isElasticIndexExits":false,
"defaultProperties":{
"OTHER_LLM":[
{
"semanticModelSection":"NLSummary",
"applicableForSemanticModel":true,
"defaultValue":"true",
"dataType":"TEXT",
"options":[
{
"display":"genai.lblYes",
"value":"true"
},
{
"display":"genai.lblNo",
"value":"false"
}
],
"description":"genai.descAllowSendingDatatoLLM",
"inputType":"SELECTLIST",
"label":"genai.lblAllowSendingDatatoLLM",
"fullyQualifiedName":"allow_values_for_nlp_generation",
"key":"allow_values_for_nlp_generation"
},
{
"semanticModelSection":"NLSummary",
"applicableForSemanticModel":true,
"defaultValue":"5000",
"dataType":"TEXT",
"description":"genai.descMaxRowsSummary",
"inputType":"TEXTBOX",
"label":"genai.lblMaxRowsSummary",
"fullyQualifiedName":"max_rows_summary",
"key":"max_rows_summary"
}
],
"VERTEX_AI_LLM":[
{
"semanticModelSection":"NLSummary",
"applicableForSemanticModel":true,
"defaultValue":"true",
"dataType":"TEXT",
"options":[
{
"display":"genai.lblYes",
"value":"true"
},
{
"display":"genai.lblNo",
"value":"false"
}
],
"description":"genai.descAllowSendingDatatoLLM",
"inputType":"SELECTLIST",
"label":"genai.lblAllowSendingDatatoLLM",
"fullyQualifiedName":"allow_values_for_nlp_generation",
"key":"allow_values_for_nlp_generation"
},
{
"semanticModelSection":"NLSummary",
"applicableForSemanticModel":true,
"defaultValue":"5000",
"dataType":"TEXT",
"description":"genai.descMaxRowsSummary",
"inputType":"TEXTBOX",
"label":"genai.lblMaxRowsSummary",
"fullyQualifiedName":"max_rows_summary",
"key":"max_rows_summary"
}
],
"AWS_BEDROCK_EMBEDDING":[
{
"semanticModelSection":"NLQuery",
"applicableForSemanticModel":true,
"defaultValue":"0.03",
"dataType":"TEXT",
"description":"genai.descSimilarityUpperThreshold",
"inputType":"TEXTBOX",
"label":"genai.lblSimilarityUpperThreshold",
"fullyQualifiedName":"upper_threshold",
"key":"upper_threshold"
}
],
"OPENAI_EMBEDDING":[
{
"semanticModelSection":"NLQuery",
"applicableForSemanticModel":true,
"defaultValue":"0.6",
"dataType":"TEXT",
"description":"genai.descSimilarityUpperThreshold",
"inputType":"TEXTBOX",
"label":"genai.lblSimilarityUpperThreshold",
"fullyQualifiedName":"upper_threshold",
"key":"upper_threshold"
}
],
"OTHER_EMBEDDING":[
{
"semanticModelSection":"NLQuery",
"applicableForSemanticModel":true,
"defaultValue":"0.6",
"dataType":"TEXT",
"description":"genai.descSimilarityUpperThreshold",
"inputType":"TEXTBOX",
"label":"genai.lblSimilarityUpperThreshold",
"fullyQualifiedName":"upper_threshold",
"key":"upper_threshold"
}
],
"VERTEX_AI_EMBEDDING":[
{
"semanticModelSection":"NLQuery",
"applicableForSemanticModel":true,
"defaultValue":"0.75",
"dataType":"TEXT",
"description":"genai.descSimilarityUpperThreshold",
"inputType":"TEXTBOX",
"label":"genai.lblSimilarityUpperThreshold",
"fullyQualifiedName":"upper_threshold",
"key":"upper_threshold"
}
],
"AZURE_OPENAI_LLM":[
{
"semanticModelSection":"NLSummary",
"applicableForSemanticModel":true,
"defaultValue":"true",
"dataType":"TEXT",
"options":[
{
"display":"genai.lblYes",
"value":"true"
},
{
"display":"genai.lblNo",
"value":"false"
}
],
"description":"genai.descAllowSendingDatatoLLM",
"inputType":"SELECTLIST",
"label":"genai.lblAllowSendingDatatoLLM",
"inheritedValue":{
"LLM-Connection1":"true"
},
"fullyQualifiedName":"allow_values_for_nlp_generation",
"key":"allow_values_for_nlp_generation"
},
{
"semanticModelSection":"NLSummary",
"applicableForSemanticModel":true,
"defaultValue":"5000",
"dataType":"TEXT",
"description":"genai.descMaxRowsSummary",
"inputType":"TEXTBOX",
"label":"genai.lblMaxRowsSummary",
"inheritedValue":{
"LLM-Connection1":"5000"
},
"fullyQualifiedName":"max_rows_summary",
"key":"max_rows_summary"
}
],
"AWS_BEDROCK_LLM":[
{
"semanticModelSection":"NLSummary",
"applicableForSemanticModel":true,
"defaultValue":"true",
"dataType":"TEXT",
"options":[
{
"display":"genai.lblYes",
"value":"true"
},
{
"display":"genai.lblNo",
"value":"false"
}
],
"description":"genai.descAllowSendingDatatoLLM",
"inputType":"SELECTLIST",
"label":"genai.lblAllowSendingDatatoLLM",
"fullyQualifiedName":"allow_values_for_nlp_generation",
"key":"allow_values_for_nlp_generation"
},
{
"semanticModelSection":"NLSummary",
"applicableForSemanticModel":true,
"defaultValue":"5000",
"dataType":"TEXT",
"description":"genai.descMaxRowsSummary",
"inputType":"TEXTBOX",
"label":"genai.lblMaxRowsSummary",
"fullyQualifiedName":"max_rows_summary",
"key":"max_rows_summary"
}
],
"AZURE_OPENAI_EMBEDDING":[
{
"semanticModelSection":"NLQuery",
"applicableForSemanticModel":true,
"defaultValue":"0.6",
"dataType":"TEXT",
"description":"genai.descSimilarityUpperThreshold",
"inputType":"TEXTBOX",
"label":"genai.lblSimilarityUpperThreshold",
"inheritedValue":{
"Embedding-Connection":"0.6"
},
"fullyQualifiedName":"upper_threshold",
"key":"upper_threshold"
}
],
"OPENAI_LLM":[
{
"semanticModelSection":"NLSummary",
"applicableForSemanticModel":true,
"defaultValue":"true",
"dataType":"TEXT",
"options":[
{
"display":"genai.lblYes",
"value":"true"
},
{
"display":"genai.lblNo",
"value":"false"
}
],
"description":"genai.descAllowSendingDatatoLLM",
"inputType":"SELECTLIST",
"label":"genai.lblAllowSendingDatatoLLM",
"fullyQualifiedName":"allow_values_for_nlp_generation",
"key":"allow_values_for_nlp_generation"
},
{
"semanticModelSection":"NLSummary",
"applicableForSemanticModel":true,
"defaultValue":"5000",
"dataType":"TEXT",
"description":"genai.descMaxRowsSummary",
"inputType":"TEXTBOX",
"label":"genai.lblMaxRowsSummary",
"fullyQualifiedName":"max_rows_summary",
"key":"max_rows_summary"
}
]
},
"Calculations":{
"connection":{
"mode":"",
"name":""
}
},
"NLQuerying":{
"queryPrompt":"",
"connection":{
"name":""
},
"embedding":{
"mode":"",
"name":""
}
},
"NLSummary":{
"connection":{
"name":""
},
"summaryPrompt":""
},
"anomalyDetection":{
},
"properties":[
],
"metadataGenConfig":{
"connection":{
"mode":"",
"name":""
}
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |