@gooddata/api-client-tiger 10.11.0-alpha.2 → 10.11.0-alpha.21

package/esm/generated/afm-rest-api/openapi-spec.json

@@ -567,12 +567,12 @@
                 }
             }
         },
-        "/api/v1/actions/workspaces/{workspaceId}/ai/searchCreate": {
+        "/api/v1/actions/workspaces/{workspaceId}/ai/search": {
             "post": {
                 "tags": ["Smart Functions", "actions"],
-                "summary": "(BETA) Semantic Search in Metadata + creates new visualizations",
+                "summary": "(BETA) Semantic Search in Metadata",
                 "description": "(BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.",
-                "operationId": "aiSearchCreate",
+                "operationId": "aiSearch",
                 "parameters": [
                     {
                         "name": "workspaceId",
@@ -589,7 +589,7 @@
                     "content": {
                         "application/json": {
                             "schema": {
-                                "$ref": "#/components/schemas/SearchCreateRequest"
+                                "$ref": "#/components/schemas/SearchRequest"
                             }
                         }
                     },
@@ -601,7 +601,7 @@
                         "content": {
                             "application/json": {
                                 "schema": {
-                                    "$ref": "#/components/schemas/SearchCreateResult"
+                                    "$ref": "#/components/schemas/SearchResult"
                                 }
                             }
                         }
@@ -609,12 +609,12 @@
                 }
             }
         },
-        "/api/v1/actions/workspaces/{workspaceId}/ai/search": {
+        "/api/v1/actions/workspaces/{workspaceId}/ai/route": {
             "post": {
                 "tags": ["Smart Functions", "actions"],
-                "summary": "(BETA) Semantic Search in Metadata",
-                "description": "(BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.",
-                "operationId": "aiSearch",
+                "summary": "(BETA) Route to supported use cases based on this input query.",
+                "description": "(BETA) Uses similarity (e.g. cosine distance) to find most similar use cases.",
+                "operationId": "aiRoute",
                 "parameters": [
                     {
                         "name": "workspaceId",
@@ -631,7 +631,7 @@
                     "content": {
                         "application/json": {
                             "schema": {
-                                "$ref": "#/components/schemas/SearchRequest"
+                                "$ref": "#/components/schemas/RouteRequest"
                             }
                         }
                     },
@@ -643,7 +643,7 @@
                         "content": {
                             "application/json": {
                                 "schema": {
-                                    "$ref": "#/components/schemas/SearchResult"
+                                    "$ref": "#/components/schemas/RouteResult"
                                 }
                             }
                         }
@@ -651,12 +651,12 @@
                 }
             }
         },
-        "/api/v1/actions/workspaces/{workspaceId}/ai/route": {
+        "/api/v1/actions/workspaces/{workspaceId}/ai/chat": {
             "post": {
                 "tags": ["Smart Functions", "actions"],
-                "summary": "(BETA) Route to supported use cases based on this input query.",
-                "description": "(BETA) Uses similarity (e.g. cosine distance) to find most similar use cases.",
-                "operationId": "aiRoute",
+                "summary": "(BETA) Chat with AI",
+                "description": "(BETA) Combines multiple use cases such as search, create visualizations, ...",
+                "operationId": "aiChat",
                 "parameters": [
                     {
                         "name": "workspaceId",
@@ -673,7 +673,7 @@
                     "content": {
                         "application/json": {
                             "schema": {
-                                "$ref": "#/components/schemas/RouteRequest"
+                                "$ref": "#/components/schemas/ChatRequest"
                             }
                         }
                     },
@@ -685,7 +685,7 @@
                         "content": {
                             "application/json": {
                                 "schema": {
-                                    "$ref": "#/components/schemas/RouteResult"
+                                    "$ref": "#/components/schemas/ChatResult"
                                 }
                             }
                         }
@@ -2738,134 +2738,120 @@
                 },
                 "description": "Entity describing the valid descendants response."
             },
-            "SearchCreateRequest": {
+            "SearchRequest": {
                 "required": ["question"],
                 "type": "object",
                 "properties": {
                     "question": {
                         "maxLength": 1000,
                         "type": "string",
-                        "description": "User question",
-                        "example": "Do you have anything about revenue?"
+                        "description": "Keyword/sentence is input for search."
                     },
-                    "limitSearch": {
-                        "type": "integer",
-                        "description": "Maximum number of search results.",
-                        "format": "int32",
-                        "default": 10
+                    "objectTypes": {
+                        "type": "array",
+                        "description": "List of object types to search for.",
+                        "items": {
+                            "type": "string",
+                            "description": "Object type to search for.",
+                            "enum": [
+                                "attribute",
+                                "metric",
+                                "fact",
+                                "label",
+                                "date",
+                                "dataset",
+                                "visualization",
+                                "dashboard"
+                            ]
+                        }
                     },
-                    "limitCreate": {
+                    "deepSearch": {
+                        "type": "boolean",
+                        "description": "Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations.",
+                        "default": false
+                    },
+                    "limit": {
                         "type": "integer",
-                        "description": "Maximum number of created results.",
+                        "description": "Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested.",
                         "format": "int32",
-                        "default": 5
+                        "default": 10
                     },
                     "titleToDescriptorRatio": {
                         "type": "number",
-                        "description": "Ratio of title to descriptor.",
+                        "description": "Temporary for experiments. Ratio of title score to descriptor score.",
+                        "format": "double",
+                        "default": 0.7
+                    },
+                    "relevantScoreThreshold": {
+                        "type": "number",
+                        "description": "Score, above which we return found objects. Below this score objects are not relevant.",
                         "format": "double",
-                        "default": 0.75
+                        "default": 0.3
                     }
                 }
             },
-            "CreatedVisualization": {
-                "required": ["dimensionality", "id", "metrics", "title", "visualizationType"],
+            "SearchRelationshipObject": {
+                "required": [
+                    "sourceObjectId",
+                    "sourceObjectTitle",
+                    "sourceObjectType",
+                    "sourceWorkspaceId",
+                    "targetObjectId",
+                    "targetObjectTitle",
+                    "targetObjectType",
+                    "targetWorkspaceId"
+                ],
                 "type": "object",
                 "properties": {
-                    "id": {
+                    "sourceWorkspaceId": {
                         "type": "string",
-                        "description": "Proposed ID of the new visualization",
-                        "example": "revenue_by_country"
+                        "description": "Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located."
                     },
-                    "title": {
+                    "sourceObjectId": {
                         "type": "string",
-                        "description": "Proposed title of the new visualization",
-                        "example": "Revenue by Country"
+                        "description": "Source object ID."
                     },
-                    "visualizationType": {
+                    "sourceObjectType": {
                         "type": "string",
-                        "description": "Visualization type requested in question",
-                        "example": "TABLE",
-                        "enum": ["TABLE", "HEADLINE", "BAR", "LINE", "PIE"]
-                    },
-                    "metrics": {
-                        "type": "array",
-                        "description": "List of metrics to be used in the new visualization",
-                        "items": {
-                            "$ref": "#/components/schemas/Metric"
-                        }
+                        "description": "Source object type, e.g. dashboard."
                     },
-                    "dimensionality": {
-                        "type": "array",
-                        "description": "List of attributes representing the dimensionality of the new visualization",
-                        "items": {
-                            "$ref": "#/components/schemas/DimAttribute"
-                        }
-                    }
-                },
-                "description": "List of created visualizations"
-            },
-            "DimAttribute": {
-                "required": ["id", "type"],
-                "type": "object",
-                "properties": {
-                    "id": {
+                    "sourceObjectTitle": {
                         "type": "string",
-                        "description": "ID of the object",
-                        "example": "obj-123"
+                        "description": "Source object title."
                     },
-                    "type": {
+                    "targetWorkspaceId": {
                         "type": "string",
-                        "description": "Object type",
-                        "example": "metric"
-                    }
-                },
-                "description": "List of attributes representing the dimensionality of the new visualization"
-            },
-            "Metric": {
-                "required": ["id", "type"],
-                "type": "object",
-                "properties": {
-                    "id": {
+                        "description": "Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located."
+                    },
+                    "targetObjectId": {
                         "type": "string",
-                        "description": "ID of the object",
-                        "example": "obj-123"
+                        "description": "Target object ID."
                     },
-                    "type": {
+                    "targetObjectType": {
                         "type": "string",
-                        "description": "Object type",
-                        "example": "metric"
+                        "description": "Target object type, e.g. visualization."
                     },
-                    "aggFunction": {
+                    "targetObjectTitle": {
                         "type": "string",
-                        "description": "Agg function. Empty if a stored metric is used.",
-                        "example": "COUNT, SUM, MIN, MAX, AVG, MEDIAN",
-                        "enum": ["COUNT", "SUM", "MIN", "MAX", "AVG", "MEDIAN"]
+                        "description": "Target object title."
                     }
-                },
-                "description": "List of metrics to be used in the new visualization"
+                }
             },
-            "SearchCreateResult": {
-                "required": ["createdVisualizations", "objects", "textResponse"],
+            "SearchResult": {
+                "required": ["relationships", "results"],
                 "type": "object",
                 "properties": {
-                    "objects": {
+                    "results": {
                         "type": "array",
-                        "description": "List of search result objects",
                         "items": {
                             "$ref": "#/components/schemas/SearchResultObject"
                         }
                     },
-                    "createdVisualizations": {
+                    "relationships": {
                         "type": "array",
-                        "description": "List of created visualizations",
                         "items": {
-                            "$ref": "#/components/schemas/CreatedVisualization"
+                            "$ref": "#/components/schemas/SearchRelationshipObject"
                         }
-                    },
-                    "textResponse": {
-                        "type": "string",
-                        "description": "Text answer. Contains reasoning from AI. Can contain an equivalent of \"I don't know\"."
                     }
                 }
             },
@@ -2945,157 +2931,351 @@
                         "description": "Result score for exact match(id/title). 1/1000. Other scores are multiplied by this.",
                         "format": "int32"
                     }
-                },
-                "description": "List of search result objects"
+                }
             },
-            "SearchRequest": {
+            "RouteRequest": {
                 "required": ["question"],
                 "type": "object",
                 "properties": {
                     "question": {
                         "maxLength": 1000,
                         "type": "string",
-                        "description": "Keyword/sentence is input for search."
-                    },
-                    "objectTypes": {
+                        "description": "Route to supported use cases based on this input query."
+                    }
+                }
+            },
+            "RouteResult": {
+                "required": ["results"],
+                "type": "object",
+                "properties": {
+                    "results": {
                         "type": "array",
-                        "description": "List of object types to search for.",
                         "items": {
-                            "type": "string",
-                            "description": "Object type to search for.",
-                            "enum": [
-                                "attribute",
-                                "metric",
-                                "fact",
-                                "label",
-                                "date",
-                                "dataset",
-                                "visualization",
-                                "dashboard"
-                            ]
+                            "$ref": "#/components/schemas/RouteResultObject"
                         }
+                    }
+                }
+            },
+            "RouteResultObject": {
+                "required": ["exampleDescription", "score", "useCase"],
+                "type": "object",
+                "properties": {
+                    "useCase": {
+                        "type": "string",
+                        "description": "Use case where to route, e.g. 'list dashboards' or 'create visualization'."
                     },
-                    "deepSearch": {
-                        "type": "boolean",
-                        "description": "Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations.",
-                        "default": false
+                    "exampleDescription": {
+                        "type": "string",
+                        "description": "Use case description, which was hit by the similarity search."
                     },
-                    "limit": {
+                    "score": {
+                        "type": "number",
+                        "description": "Similarity score between input query and the use case description.",
+                        "format": "float"
+                    }
+                }
+            },
+            "ActiveObjectIdentification": {
+                "required": ["id", "type", "workspaceId"],
+                "type": "object",
+                "properties": {
+                    "id": {
+                        "type": "string",
+                        "description": "Object ID."
+                    },
+                    "type": {
+                        "type": "string",
+                        "description": "Object type, e.g. dashboard."
+                    },
+                    "workspaceId": {
+                        "type": "string",
+                        "description": "Workspace ID."
+                    }
+                },
+                "description": "Object, with which the user is actively working."
+            },
+            "ChatRequest": {
+                "required": ["question"],
+                "type": "object",
+                "properties": {
+                    "question": {
+                        "maxLength": 2000,
+                        "type": "string",
+                        "description": "User question"
+                    },
+                    "limitSearch": {
                         "type": "integer",
-                        "description": "Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested.",
+                        "description": "Maximum number of search results.",
                         "format": "int32",
-                        "default": 10
+                        "default": 5
+                    },
+                    "limitCreate": {
+                        "type": "integer",
+                        "description": "Maximum number of created results.",
+                        "format": "int32",
+                        "default": 5
+                    },
+                    "conversationHistory": {
+                        "type": "array",
+                        "description": "List of conversation interactions",
+                        "items": {
+                            "$ref": "#/components/schemas/ConversationInteraction"
+                        }
+                    },
+                    "userContext": {
+                        "$ref": "#/components/schemas/UserContext"
                     },
                     "titleToDescriptorRatio": {
                         "type": "number",
                         "description": "Temporary for experiments. Ratio of title score to descriptor score.",
                         "format": "double",
                         "default": 0.7
+                    },
+                    "routeScoreThreshold": {
+                        "type": "number",
+                        "description": "Score, below which we set invalidQuestion to true. The question does not match to any use case",
+                        "format": "double",
+                        "default": 0.2
+                    },
+                    "searchScoreThreshold": {
+                        "type": "number",
+                        "description": "Score, above which we return found object(s) and don't call LLM to create new objects.",
+                        "format": "double",
+                        "default": 0.9
+                    },
+                    "relevantScoreThreshold": {
+                        "type": "number",
+                        "description": "Score, above which we return found objects. Below this score objects are not relevant.",
+                        "format": "double",
+                        "default": 0.3
                     }
                 }
             },
-            "SearchRelationshipObject": {
-                "required": [
-                    "sourceObjectId",
-                    "sourceObjectTitle",
-                    "sourceObjectType",
-                    "sourceWorkspaceId",
-                    "targetObjectId",
-                    "targetObjectTitle",
-                    "targetObjectType",
-                    "targetWorkspaceId"
-                ],
+            "ConversationInteraction": {
+                "required": ["content", "role"],
                 "type": "object",
                 "properties": {
-                    "sourceWorkspaceId": {
+                    "content": {
+                        "oneOf": [
+                            {
+                                "$ref": "#/components/schemas/CreatedVisualizationInteractionWithContext"
+                            },
+                            {
+                                "$ref": "#/components/schemas/FoundObjectInteractionWithContext"
+                            },
+                            {
+                                "$ref": "#/components/schemas/TextInteractionWithContext"
+                            }
+                        ]
+                    },
+                    "role": {
                         "type": "string",
-                        "description": "Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located."
+                        "description": "Role of actor.",
+                        "enum": ["USER", "AI"]
+                    }
+                },
+                "description": "List of conversation interactions"
+            },
+            "CreatedVisualization": {
+                "required": ["dimensionality", "id", "metrics", "title", "visualizationType"],
+                "type": "object",
+                "properties": {
+                    "id": {
+                        "type": "string",
+                        "description": "Proposed ID of the new visualization",
+                        "example": "revenue_by_country"
                     },
-                    "sourceObjectId": {
+                    "title": {
                         "type": "string",
-                        "description": "Source object ID."
+                        "description": "Proposed title of the new visualization",
+                        "example": "Revenue by Country"
                     },
-                    "sourceObjectType": {
+                    "visualizationType": {
                         "type": "string",
-                        "description": "Source object type, e.g. dashboard."
+                        "description": "Visualization type requested in question",
+                        "example": "TABLE",
+                        "enum": ["TABLE", "HEADLINE", "BAR", "LINE", "PIE"]
                     },
-                    "sourceObjectTitle": {
+                    "metrics": {
+                        "type": "array",
+                        "description": "List of metrics to be used in the new visualization",
+                        "items": {
+                            "$ref": "#/components/schemas/Metric"
+                        }
+                    },
+                    "dimensionality": {
+                        "type": "array",
+                        "description": "List of attributes representing the dimensionality of the new visualization",
+                        "items": {
+                            "$ref": "#/components/schemas/DimAttribute"
+                        }
+                    }
+                },
+                "description": "Visualization created by AI."
+            },
+            "CreatedVisualizationInteractionWithContext": {
+                "required": ["createdVisualization", "includeToChatContext", "userFeedback"],
+                "type": "object",
+                "allOf": [
+                    {
+                        "$ref": "#/components/schemas/InteractionWithContext"
+                    },
+                    {
+                        "type": "object",
+                        "properties": {
+                            "createdVisualization": {
+                                "$ref": "#/components/schemas/CreatedVisualization"
+                            }
+                        }
+                    }
+                ]
+            },
+            "DimAttribute": {
+                "required": ["id", "type"],
+                "type": "object",
+                "properties": {
+                    "id": {
                         "type": "string",
-                        "description": "Source object title."
+                        "description": "ID of the object",
+                        "example": "country"
                     },
-                    "targetWorkspaceId": {
+                    "type": {
                         "type": "string",
-                        "description": "Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located."
+                        "description": "Object type",
+                        "example": "attribute",
+                        "enum": ["attribute"]
+                    }
+                },
+                "description": "List of attributes representing the dimensionality of the new visualization"
+            },
+            "FoundObjectInteractionWithContext": {
+                "required": ["foundObject", "includeToChatContext", "userFeedback"],
+                "type": "object",
+                "allOf": [
+                    {
+                        "$ref": "#/components/schemas/InteractionWithContext"
                     },
-                    "targetObjectId": {
+                    {
+                        "type": "object",
+                        "properties": {
+                            "foundObject": {
+                                "$ref": "#/components/schemas/SearchResultObject"
+                            }
+                        }
+                    }
+                ]
+            },
+            "InteractionWithContext": {
+                "required": ["includeToChatContext", "userFeedback"],
+                "type": "object",
+                "properties": {
+                    "includeToChatContext": {
+                        "type": "boolean",
+                        "description": "Include all in the chat context. Used for further questions. Use if it's not clear which objects relate to the question."
+                    },
+                    "userFeedback": {
                         "type": "string",
-                        "description": "Target object ID."
+                        "description": "User feedback",
+                        "enum": ["POSITIVE", "NEGATIVE", "NONE"]
+                    }
+                },
+                "description": "Interaction content."
+            },
+            "Metric": {
+                "required": ["id", "type"],
+                "type": "object",
+                "properties": {
+                    "id": {
+                        "type": "string",
+                        "description": "ID of the object",
+                        "example": "revenue"
                     },
-                    "targetObjectType": {
+                    "type": {
                         "type": "string",
-                        "description": "Target object type, e.g. visualization."
+                        "description": "Object type",
+                        "example": "metric",
+                        "enum": ["metric", "fact", "attribute"]
                     },
-                    "targetObjectTitle": {
+                    "aggFunction": {
                         "type": "string",
-                        "description": "Target object title."
+                        "description": "Agg function. Empty if a stored metric is used.",
+                        "enum": ["COUNT", "SUM", "MIN", "MAX", "AVG", "MEDIAN"]
                     }
-                }
+                },
+                "description": "List of metrics to be used in the new visualization"
             },
-            "SearchResult": {
-                "required": ["relationships", "results"],
+            "TextInteractionWithContext": {
+                "required": ["includeToChatContext", "text", "userFeedback"],
                 "type": "object",
-                "properties": {
-                    "results": {
-                        "type": "array",
-                        "items": {
-                            "$ref": "#/components/schemas/SearchResultObject"
-                        }
+                "allOf": [
+                    {
+                        "$ref": "#/components/schemas/InteractionWithContext"
                     },
-                    "relationships": {
-                        "type": "array",
-                        "items": {
-                            "$ref": "#/components/schemas/SearchRelationshipObject"
+                    {
+                        "type": "object",
+                        "properties": {
+                            "text": {
+                                "type": "string",
+                                "description": "Object found by similarity search."
+                            }
                         }
                     }
-                }
+                ]
             },
-            "RouteRequest": {
-                "required": ["question"],
+            "UserContext": {
+                "required": ["activeObject"],
                 "type": "object",
                 "properties": {
-                    "question": {
-                        "maxLength": 1000,
-                        "type": "string",
-                        "description": "Route to supported use cases based on this input query."
+                    "activeObject": {
+                        "$ref": "#/components/schemas/ActiveObjectIdentification"
                     }
-                }
+                },
+                "description": "User context, which can affect the behavior of the underlying AI features."
             },
-            "RouteResult": {
-                "required": ["results"],
+            "ChatResult": {
+                "required": ["invalidQuestion", "useCases"],
                 "type": "object",
                 "properties": {
-                    "results": {
+                    "useCases": {
                         "type": "array",
+                        "description": "Use cases with scores. The question was routed to the use case with highest score.",
                         "items": {
                             "$ref": "#/components/schemas/RouteResultObject"
                         }
+                    },
+                    "invalidQuestion": {
+                        "type": "boolean",
+                        "description": "Flag detecting invalid/irrelevant user question. No user case was found."
+                    },
+                    "foundObjects": {
+                        "type": "array",
+                        "description": "List of objects found by similarity search.",
+                        "items": {
+                            "$ref": "#/components/schemas/SearchResultObject"
+                        }
+                    },
+                    "createdVisualizations": {
+                        "$ref": "#/components/schemas/CreatedVisualizations"
                     }
                 }
             },
-            "RouteResultObject": {
-                "required": ["score", "useCase"],
+            "CreatedVisualizations": {
+                "required": ["objects", "reasoning"],
                 "type": "object",
                 "properties": {
-                    "useCase": {
-                        "type": "string",
-                        "description": "Use case where to route, e.g. 'list dashboards' or 'create visualization'."
+                    "objects": {
+                        "type": "array",
+                        "description": "List of created visualization objects",
+                        "items": {
+                            "$ref": "#/components/schemas/CreatedVisualization"
+                        }
                     },
-                    "score": {
-                        "type": "number",
-                        "description": "Similarity score between input query and use case.",
-                        "format": "float"
+                    "reasoning": {
+                        "type": "string",
+                        "description": "Reasoning from LLM. Description of how the answer was generated."
                     }
-                }
+                },
+                "description": "Visualization definitions created by AI."
             },
             "ForecastResult": {
                 "required": ["attribute", "lowerBound", "origin", "prediction", "upperBound"],