1Update Semantic Model AI Settings
Overview
This API updates AI settings in a Semantic Model.
Method: POST
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 |
|---|---|---|---|
Content-Type (Required) | String | Specifies media type of request body. |
|
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 updated. 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 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. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
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 | ID of the folder containing the Semantic Model. | – |
aiSettingsJson (Required) | String | JSON string which is used for updating the AI settings of a Semantic Model. Note: An example JSON is provided under the Resources section below. | – |
Responses
200 Success
{
"code": 0,
"message": "Successfully updated Entity AI settings."
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
412 | Precondition failed. Parameter missing. |
500 | Internal Server Error |
Resources
Below is an example of JSON structure which can be used as a reference for the aiSettingsJson parameter in the request body.
{
"mandatoryRAGColumns":[
],
"isElasticIndexExits":true,
"columnMetadata":{
"userPrompt":""
},
"Calculations":{
"connection":{
"mode":"MANUAL",
"name":"Gemini-Flash"
}
},
"NLQuerying":{
"queryPrompt":"",
"userPrompt":"",
"connection":{
"mode":"MANUAL",
"name":"Azure-4-1"
},
"embedding":{
"mode":"MANUAL",
"name":"Azure-Embedding"
}
},
"NLSummary":{
"connection":{
"mode":"MANUAL",
"name":"Azure-4-1"
},
"summaryPrompt":""
},
"properties":[
],
"metadataGenConfig":{
"connection":{
"mode":"MANUAL",
"name":"AWS-OSS"
}
},
"SMObject":{
"userPrompt":"",
"businessContext":""
}
}