1Get AI Space Settings
Overview
This API retrieves the AI settings of the specified AI Space.
Method: GET
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 |
|---|---|---|---|
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 | Represents the name or ID of the AI Space whose AI settings need to be retrieved. 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 an AI Space name or an 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. | – |
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 is treated as a root-level entity by default. | – |
folderId | String | ID of the folder containing the AI Space. | – |
Responses
200 Success
{
"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."
},
"isElasticIndexExits": false,
"isDataSharingAllowed": true,
"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."
},
"properties": [
{
"mode": "MANUAL",
"name": "max_rows_summary",
"value": "6"
}
],
"metadataGenConfig": {
"connection": {
"mode": "MANUAL",
"name": "AWS-OSS"
}
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |