1Update AI Space Settings
Overview
This API updates the AI settings in an AI Space.
Method: POST
Request URL: {kyvos-url}/rest/v2/ai-spaces/{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 AI Space whose AI settings need to be updated. Note: If the AI Space name is provided, then 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 AI Space name or AI Space ID. If by=name, provide the AI Space name in the name-or-id parameter. If by=id, provide the AI Space 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 AI Space. If the AI Space is present in the root directory, specify [Root]. Note: If neither folderName nor folderId is provided, the AI Space will be treated as a root-level entity by default. | – |
folderId | String | ID of the folder containing the AI Space. | – |
aiSettingsJson (Required) | String | JSON string which is used for updating the AI settings in an AI Space. 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. Required 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.
{
"NLQuerying": {
"queryPrompt": "Generate accurate SQL queries by following business rules, SQL syntax, joins, aggregations, and date-handling guidelines. Ensure the query is optimized and compatible with the semantic model.",
"userPrompt": "",
"connection": {
"mode": "MANUAL",
"name": "Azure-4-1"
},
"embedding": {
"mode": "MANUAL",
"name": "Azure-Embedding"
}
},
"NLSummary": {
"connection": {
"mode": "MANUAL",
"name": "Azure-4-1"
},
"summaryPrompt": "Generate a clear and concise summary of the query results while preserving Markdown formatting. Follow cumulative data rules and accurately describe trends, comparisons, and insights."
},
"metadataGenConfig": {
"connection": {
"mode": "MANUAL",
"name": "AWS-OSS"
}
},
"properties": [
{
"mode": "MANUAL",
"name": "max_rows_summary",
"value": "6"
}
],
"AI_SpaceObject": {
"businessContext": "This AI Space is designed to help business users analyze enterprise data through natural language queries. It enables users to explore datasets, generate SQL queries, summarize results, and derive actionable insights from the underlying semantic model while following the organization's business rules and terminology."
}
}
JSON Field Definitions
Field | Type | Description | Possible Values | Example |
NLQuerying | object | Settings for natural language query generation. Required. | JSON object. | {...} |
NLQuerying.queryPrompt | string | Custom prompt or instructions used when the AI converts a natural language question into a query. Optional. | Any text. | "" |
NLQuerying.userPrompt | string | Custom prompt or instructions displayed to or used for the end user. Optional. | Any text. | "" |
NLQuerying.connection | object | AI connection configuration used for natural language query generation. Optional. | JSON object with mode and name. | {...} |
NLQuerying.connection.mode | string | Specifies how the AI connection is selected. Optional. | MANUAL or other configured mode. | "MANUAL" |
NLQuerying.connection.name | string | Name of the AI connection to use when the connection mode is MANUAL. Optional when mode is MANUAL. | Any configured connection name. | "Azure-4-1" |
NLQuerying.embedding | object | Embedding model configuration used for natural language query generation. Optional. | JSON object with mode and name. | {...} |
NLQuerying.embedding.mode | string | Specifies how the embedding model is selected. Optional. | MANUAL or other configured mode. | "MANUAL" |
NLQuerying.embedding.name | string | Name of the embedding model to use when the embedding mode is MANUAL. Optional when mode is MANUAL. | Any configured embedding name. | "Azure-Embedding" |
NLSummary | object | Settings for natural language summarization. Required. | JSON object. | {...} |
NLSummary.summaryPrompt | string | Custom prompt or instructions used for generating summaries. Optional. | Any text. | "" |
NLSummary.connection | object | AI connection configuration used for summary generation. Optional. | JSON object with mode and name. | {...} |
NLSummary.connection.mode | string | Specifies how the AI connection is selected. Optional. | MANUAL or other configured mode. | "MANUAL" |
NLSummary.connection.name | string | Name of the AI connection to use when the connection mode is MANUAL. Optional when mode is MANUAL. | Any configured connection name. | "Azure-4-1" |
metadataGenConfig | object | Settings for metadata generation. Optional. | JSON object. | {...} |
metadataGenConfig.connection | object | AI connection configuration used for metadata generation. Optional. | JSON object with mode and name. | {...} |
metadataGenConfig.connection.mode | string | Specifies how the AI connection is selected. Optional. | MANUAL or other configured mode. | "MANUAL" |
metadataGenConfig.connection.name | string | Name of the AI connection to use when the connection mode is MANUAL. Optional when mode is MANUAL. | Any configured connection name. | "AWS-OSS" |
properties | array | List of custom key-value properties for AI settings. Optional. | Array of {name, value, mode} objects. | [{...}] |
properties[*].name | string | Name of the custom property. Required inside a property object. | Any text. | "max_rows_summary" |
properties[*].value | string | Value of the custom property. Required inside a property object. | Any text. | "6" |
properties[*].mode | string | Specifies how the property is configured. Optional inside a property object. | MANUAL or other configured mode. | "MANUAL" |
AI_SpaceObject | object | Space-level business context configuration. Optional. | JSON object. | {...} |
AI_SpaceObject.businessContext | string | Description of the business context for the AI Space. Optional. | Any text. | "" |