@gooddata/api-client-tiger 10.13.0-alpha.9 → 10.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. package/esm/__version.d.ts +1 -1
  2. package/esm/__version.d.ts.map +1 -1
  3. package/esm/__version.js +1 -1
  4. package/esm/__version.js.map +1 -1
  5. package/esm/api-client-tiger.d.ts +1190 -812
  6. package/esm/genAI.d.ts +1 -1
  7. package/esm/genAI.d.ts.map +1 -1
  8. package/esm/genAI.js.map +1 -1
  9. package/esm/generated/afm-rest-api/api.d.ts +261 -220
  10. package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
  11. package/esm/generated/afm-rest-api/api.js +169 -23
  12. package/esm/generated/afm-rest-api/api.js.map +1 -1
  13. package/esm/generated/afm-rest-api/openapi-spec.json +208 -215
  14. package/esm/generated/metadata-json-api/api.d.ts +952 -618
  15. package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
  16. package/esm/generated/metadata-json-api/api.js +320 -16
  17. package/esm/generated/metadata-json-api/api.js.map +1 -1
  18. package/esm/generated/metadata-json-api/openapi-spec.json +2928 -2806
  19. package/esm/index.d.ts +1 -1
  20. package/esm/index.d.ts.map +1 -1
  21. package/esm/index.js.map +1 -1
  22. package/esm/profile.d.ts +1 -0
  23. package/esm/profile.d.ts.map +1 -1
  24. package/esm/profile.js.map +1 -1
  25. package/package.json +3 -3
package/esm/generated/afm-rest-api/openapi-spec.json CHANGED
@@ -651,6 +651,48 @@
651
651
  }
652
652
  }
653
653
  },
654
+ "/api/v1/actions/workspaces/{workspaceId}/ai/chatHistory": {
655
+ "post": {
656
+ "tags": ["Smart Functions", "actions"],
657
+ "summary": "(BETA) Get Chat History",
658
+ "description": "(BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history.",
659
+ "operationId": "aiChatHistory",
660
+ "parameters": [
661
+ {
662
+ "name": "workspaceId",
663
+ "in": "path",
664
+ "description": "Workspace identifier",
665
+ "required": true,
666
+ "schema": {
667
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
668
+ "type": "string"
669
+ }
670
+ }
671
+ ],
672
+ "requestBody": {
673
+ "content": {
674
+ "application/json": {
675
+ "schema": {
676
+ "$ref": "#/components/schemas/ChatHistoryRequest"
677
+ }
678
+ }
679
+ },
680
+ "required": true
681
+ },
682
+ "responses": {
683
+ "200": {
684
+ "description": "OK",
685
+ "content": {
686
+ "application/json": {
687
+ "schema": {
688
+ "$ref": "#/components/schemas/ChatHistoryResult"
689
+ }
690
+ }
691
+ }
692
+ }
693
+ }
694
+ }
695
+ },
654
696
  "/api/v1/actions/workspaces/{workspaceId}/ai/chat": {
655
697
  "post": {
656
698
  "tags": ["Smart Functions", "actions"],
@@ -2856,17 +2898,7 @@
2856
2898
  }
2857
2899
  },
2858
2900
  "SearchResultObject": {
2859
- "required": [
2860
- "description",
2861
- "id",
2862
- "score",
2863
- "scoreDescriptor",
2864
- "scoreExactMatch",
2865
- "scoreTitle",
2866
- "title",
2867
- "type",
2868
- "workspaceId"
2869
- ],
2901
+ "required": ["id", "title", "type", "workspaceId"],
2870
2902
  "type": "object",
2871
2903
  "properties": {
2872
2904
  "id": {
@@ -2945,86 +2977,53 @@
2945
2977
  }
2946
2978
  },
2947
2979
  "RouteResult": {
2948
- "required": ["results"],
2949
- "type": "object",
2950
- "properties": {
2951
- "results": {
2952
- "type": "array",
2953
- "items": {
2954
- "$ref": "#/components/schemas/RouteResultObject"
2955
- }
2956
- }
2957
- }
2958
- },
2959
- "RouteResultObject": {
2960
- "required": ["exampleDescription", "score", "useCase"],
2980
+ "required": ["reasoning", "useCase"],
2961
2981
  "type": "object",
2962
2982
  "properties": {
2963
2983
  "useCase": {
2964
2984
  "type": "string",
2965
- "description": "Use case where to route, e.g. 'list dashboards' or 'create visualization'."
2985
+ "description": "Use case where LLM routed based on question.",
2986
+ "enum": [
2987
+ "SEARCH_ALL",
2988
+ "SEARCH_VISUALIZATIONS",
2989
+ "SEARCH_DASHBOARDS",
2990
+ "CREATE_VISUALIZATION",
2991
+ "EXTEND_VISUALIZATION",
2992
+ "GENERAL",
2993
+ "INVALID"
2994
+ ]
2966
2995
  },
2967
- "exampleDescription": {
2996
+ "reasoning": {
2968
2997
  "type": "string",
2969
- "description": "Use case description, which was hit by the similarity search."
2970
- },
2971
- "score": {
2972
- "type": "number",
2973
- "description": "Similarity score between input query and the use case description.",
2974
- "format": "float"
2998
+ "description": "Explanation why LLM picked this use case."
2975
2999
  }
2976
3000
  }
2977
3001
  },
2978
- "ActiveObjectIdentification": {
2979
- "required": ["id", "type", "workspaceId"],
3002
+ "ChatHistoryRequest": {
2980
3003
  "type": "object",
2981
3004
  "properties": {
2982
- "id": {
3005
+ "threadIdSuffix": {
2983
3006
  "type": "string",
2984
- "description": "Object ID."
3007
+ "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows."
2985
3008
  },
2986
- "type": {
2987
- "type": "string",
2988
- "description": "Object type, e.g. dashboard."
3009
+ "chatHistoryInteractionId": {
3010
+ "type": "integer",
3011
+ "description": "Return chat history records only after this interaction ID. If empty, complete chat history is returned.",
3012
+ "format": "int64"
2989
3013
  },
2990
- "workspaceId": {
3014
+ "userFeedback": {
2991
3015
  "type": "string",
2992
- "description": "Workspace ID."
2993
- }
2994
- },
2995
- "description": "Object, with which the user is actively working."
2996
- },
2997
- "ChatInteraction": {
2998
- "required": ["content", "role"],
2999
- "type": "object",
3000
- "properties": {
3001
- "content": {
3002
- "type": "array",
3003
- "description": "Interaction content.",
3004
- "items": {
3005
- "oneOf": [
3006
- {
3007
- "$ref": "#/components/schemas/CreatedVisualizationInteractionWithContext"
3008
- },
3009
- {
3010
- "$ref": "#/components/schemas/FoundObjectInteractionWithContext"
3011
- },
3012
- {
3013
- "$ref": "#/components/schemas/TextInteractionWithContext"
3014
- }
3015
- ]
3016
- }
3016
+ "description": "User feedback.",
3017
+ "enum": ["POSITIVE", "NEGATIVE", "NONE"]
3017
3018
  },
3018
- "role": {
3019
- "type": "string",
3020
- "description": "Role of actor.",
3021
- "enum": ["USER", "AI"]
3019
+ "reset": {
3020
+ "type": "boolean",
3021
+ "description": "User feedback."
3022
3022
  }
3023
- },
3024
- "description": "List of chat interactions"
3023
+ }
3025
3024
  },
3026
- "ChatRequest": {
3027
- "required": ["question"],
3025
+ "ChatHistoryInteraction": {
3026
+ "required": ["chatHistoryInteractionId", "interactionFinished", "question", "routing"],
3028
3027
  "type": "object",
3029
3028
  "properties": {
3030
3029
  "question": {
@@ -3032,57 +3031,45 @@
3032
3031
  "type": "string",
3033
3032
  "description": "User question"
3034
3033
  },
3035
- "limitSearch": {
3036
- "type": "integer",
3037
- "description": "Maximum number of search results.",
3038
- "format": "int32",
3039
- "default": 5
3040
- },
3041
- "limitCreateContext": {
3042
- "type": "integer",
3043
- "description": "Maximum number of relevant objects included into context for LLM (for each object type).",
3044
- "format": "int32",
3045
- "default": 10
3034
+ "threadIdSuffix": {
3035
+ "type": "string",
3036
+ "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows."
3046
3037
  },
3047
- "limitCreate": {
3038
+ "chatHistoryInteractionId": {
3048
3039
  "type": "integer",
3049
- "description": "Maximum number of created results.",
3050
- "format": "int32",
3051
- "default": 3
3052
- },
3053
- "chatHistory": {
3054
- "type": "array",
3055
- "description": "List of chat interactions",
3056
- "items": {
3057
- "$ref": "#/components/schemas/ChatInteraction"
3058
- }
3040
+ "description": "Chat History interaction ID. Unique ID for each interaction.",
3041
+ "format": "int64"
3059
3042
  },
3060
- "userContext": {
3061
- "$ref": "#/components/schemas/UserContext"
3043
+ "interactionFinished": {
3044
+ "type": "boolean",
3045
+ "description": "Has the interaction already finished? Can be used for polling when interaction is in progress."
3062
3046
  },
3063
- "titleToDescriptorRatio": {
3064
- "type": "number",
3065
- "description": "Temporary for experiments. Ratio of title score to descriptor score.",
3066
- "format": "double",
3067
- "default": 0.7
3047
+ "routing": {
3048
+ "$ref": "#/components/schemas/RouteResult"
3068
3049
  },
3069
- "routeScoreThreshold": {
3070
- "type": "number",
3071
- "description": "Score, below which we set invalidQuestion to true. The question does not match to any use case",
3072
- "format": "double",
3073
- "default": 0.2
3050
+ "textResponse": {
3051
+ "type": "string",
3052
+ "description": "Text response for general questions."
3074
3053
  },
3075
- "searchScoreThreshold": {
3076
- "type": "number",
3077
- "description": "Score, above which we return found object(s) and don't call LLM to create new objects.",
3078
- "format": "double",
3079
- "default": 0.9
3054
+ "foundObjects": {
3055
+ "$ref": "#/components/schemas/FoundObjects"
3080
3056
  },
3081
- "relevantScoreThreshold": {
3082
- "type": "number",
3083
- "description": "Score, above which we return found objects. Below this score objects are not relevant.",
3084
- "format": "double",
3085
- "default": 0.3
3057
+ "createdVisualizations": {
3058
+ "$ref": "#/components/schemas/CreatedVisualizations"
3059
+ }
3060
+ },
3061
+ "description": "List of chat history interactions."
3062
+ },
3063
+ "ChatHistoryResult": {
3064
+ "required": ["interactions"],
3065
+ "type": "object",
3066
+ "properties": {
3067
+ "interactions": {
3068
+ "type": "array",
3069
+ "description": "List of chat history interactions.",
3070
+ "items": {
3071
+ "$ref": "#/components/schemas/ChatHistoryInteraction"
3072
+ }
3086
3073
  }
3087
3074
  }
3088
3075
  },
@@ -3121,24 +3108,25 @@
3121
3108
  }
3122
3109
  }
3123
3110
  },
3124
- "description": "Visualization created by AI."
3111
+ "description": "List of created visualization objects"
3125
3112
  },
3126
- "CreatedVisualizationInteractionWithContext": {
3127
- "required": ["createdVisualization"],
3113
+ "CreatedVisualizations": {
3114
+ "required": ["objects", "reasoning"],
3128
3115
  "type": "object",
3129
- "allOf": [
3130
- {
3131
- "$ref": "#/components/schemas/InteractionWithContext"
3132
- },
3133
- {
3134
- "type": "object",
3135
- "properties": {
3136
- "createdVisualization": {
3137
- "$ref": "#/components/schemas/CreatedVisualization"
3138
- }
3116
+ "properties": {
3117
+ "objects": {
3118
+ "type": "array",
3119
+ "description": "List of created visualization objects",
3120
+ "items": {
3121
+ "$ref": "#/components/schemas/CreatedVisualization"
3139
3122
  }
3123
+ },
3124
+ "reasoning": {
3125
+ "type": "string",
3126
+ "description": "Reasoning from LLM. Description of how and why the answer was generated."
3140
3127
  }
3141
- ]
3128
+ },
3129
+ "description": "Visualization definitions created by AI."
3142
3130
  },
3143
3131
  "DimAttribute": {
3144
3132
  "required": ["id", "type"],
@@ -3158,37 +3146,23 @@
3158
3146
  },
3159
3147
  "description": "List of attributes representing the dimensionality of the new visualization"
3160
3148
  },
3161
- "FoundObjectInteractionWithContext": {
3162
- "required": ["foundObject"],
3163
- "type": "object",
3164
- "allOf": [
3165
- {
3166
- "$ref": "#/components/schemas/InteractionWithContext"
3167
- },
3168
- {
3169
- "type": "object",
3170
- "properties": {
3171
- "foundObject": {
3172
- "$ref": "#/components/schemas/SearchResultObject"
3173
- }
3174
- }
3175
- }
3176
- ]
3177
- },
3178
- "InteractionWithContext": {
3149
+ "FoundObjects": {
3150
+ "required": ["objects", "reasoning"],
3179
3151
  "type": "object",
3180
3152
  "properties": {
3181
- "includeToChatContext": {
3182
- "type": "boolean",
3183
- "description": "Include all in the chat context. Used for further questions. Use if it's not clear which objects relate to the question."
3153
+ "objects": {
3154
+ "type": "array",
3155
+ "description": "List of objects found with a similarity search.",
3156
+ "items": {
3157
+ "$ref": "#/components/schemas/SearchResultObject"
3158
+ }
3184
3159
  },
3185
- "userFeedback": {
3160
+ "reasoning": {
3186
3161
  "type": "string",
3187
- "description": "User feedback",
3188
- "enum": ["POSITIVE", "NEGATIVE", "NONE"]
3162
+ "description": "Reasoning from LLM. Description of how and why the answer was generated."
3189
3163
  }
3190
3164
  },
3191
- "description": "Interaction content."
3165
+ "description": "List of objects found by similarity search and post-processed by LLM."
3192
3166
  },
3193
3167
  "Metric": {
3194
3168
  "required": ["id", "type"],
@@ -3213,23 +3187,78 @@
3213
3187
  },
3214
3188
  "description": "List of metrics to be used in the new visualization"
3215
3189
  },
3216
- "TextInteractionWithContext": {
3217
- "required": ["text"],
3190
+ "ActiveObjectIdentification": {
3191
+ "required": ["id", "type", "workspaceId"],
3218
3192
  "type": "object",
3219
- "allOf": [
3220
- {
3221
- "$ref": "#/components/schemas/InteractionWithContext"
3193
+ "properties": {
3194
+ "id": {
3195
+ "type": "string",
3196
+ "description": "Object ID."
3222
3197
  },
3223
- {
3224
- "type": "object",
3225
- "properties": {
3226
- "text": {
3227
- "type": "string",
3228
- "description": "Object found by similarity search."
3229
- }
3230
- }
3198
+ "type": {
3199
+ "type": "string",
3200
+ "description": "Object type, e.g. dashboard."
3201
+ },
3202
+ "workspaceId": {
3203
+ "type": "string",
3204
+ "description": "Workspace ID."
3231
3205
  }
3232
- ]
3206
+ },
3207
+ "description": "Object, with which the user is actively working."
3208
+ },
3209
+ "ChatRequest": {
3210
+ "required": ["question"],
3211
+ "type": "object",
3212
+ "properties": {
3213
+ "question": {
3214
+ "maxLength": 2000,
3215
+ "type": "string",
3216
+ "description": "User question"
3217
+ },
3218
+ "limitSearch": {
3219
+ "type": "integer",
3220
+ "description": "Maximum number of search results.",
3221
+ "format": "int32",
3222
+ "default": 5
3223
+ },
3224
+ "limitCreateContext": {
3225
+ "type": "integer",
3226
+ "description": "Maximum number of relevant objects included into context for LLM (for each object type).",
3227
+ "format": "int32",
3228
+ "default": 10
3229
+ },
3230
+ "limitCreate": {
3231
+ "type": "integer",
3232
+ "description": "Maximum number of created results.",
3233
+ "format": "int32",
3234
+ "default": 3
3235
+ },
3236
+ "threadIdSuffix": {
3237
+ "type": "string",
3238
+ "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows."
3239
+ },
3240
+ "userContext": {
3241
+ "$ref": "#/components/schemas/UserContext"
3242
+ },
3243
+ "titleToDescriptorRatio": {
3244
+ "type": "number",
3245
+ "description": "Temporary for experiments. Ratio of title score to descriptor score.",
3246
+ "format": "double",
3247
+ "default": 0.7
3248
+ },
3249
+ "searchScoreThreshold": {
3250
+ "type": "number",
3251
+ "description": "Score, above which we return found object(s) and don't call LLM to create new objects.",
3252
+ "format": "double",
3253
+ "default": 0.9
3254
+ },
3255
+ "relevantScoreThreshold": {
3256
+ "type": "number",
3257
+ "description": "Score, above which we return found objects. Below this score objects are not relevant.",
3258
+ "format": "double",
3259
+ "default": 0.4
3260
+ }
3261
+ }
3233
3262
  },
3234
3263
  "UserContext": {
3235
3264
  "required": ["activeObject"],
@@ -3242,63 +3271,27 @@
3242
3271
  "description": "User context, which can affect the behavior of the underlying AI features."
3243
3272
  },
3244
3273
  "ChatResult": {
3245
- "required": ["invalidQuestion", "useCases"],
3274
+ "required": ["routing"],
3246
3275
  "type": "object",
3247
3276
  "properties": {
3248
- "useCases": {
3249
- "type": "array",
3250
- "description": "Use cases with scores. The question was routed to the use case with highest score.",
3251
- "items": {
3252
- "$ref": "#/components/schemas/RouteResultObject"
3253
- }
3277
+ "routing": {
3278
+ "$ref": "#/components/schemas/RouteResult"
3254
3279
  },
3255
- "invalidQuestion": {
3256
- "type": "boolean",
3257
- "description": "Flag detecting invalid/irrelevant user question. No user case was found."
3280
+ "textResponse": {
3281
+ "type": "string",
3282
+ "description": "Text response for general questions."
3258
3283
  },
3259
3284
  "foundObjects": {
3260
3285
  "$ref": "#/components/schemas/FoundObjects"
3261
3286
  },
3262
3287
  "createdVisualizations": {
3263
3288
  "$ref": "#/components/schemas/CreatedVisualizations"
3264
- }
3265
- }
3266
- },
3267
- "CreatedVisualizations": {
3268
- "required": ["objects", "reasoning"],
3269
- "type": "object",
3270
- "properties": {
3271
- "objects": {
3272
- "type": "array",
3273
- "description": "List of created visualization objects",
3274
- "items": {
3275
- "$ref": "#/components/schemas/CreatedVisualization"
3276
- }
3277
3289
  },
3278
- "reasoning": {
3290
+ "threadIdSuffix": {
3279
3291
  "type": "string",
3280
- "description": "Reasoning from LLM. Description of how the answer was generated."
3292
+ "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows."
3281
3293
  }
3282
- },
3283
- "description": "Visualization definitions created by AI."
3284
- },
3285
- "FoundObjects": {
3286
- "required": ["objects", "reasoning"],
3287
- "type": "object",
3288
- "properties": {
3289
- "objects": {
3290
- "type": "array",
3291
- "description": "List of objects found with a similarity search.",
3292
- "items": {
3293
- "$ref": "#/components/schemas/SearchResultObject"
3294
- }
3295
- },
3296
- "reasoning": {
3297
- "type": "string",
3298
- "description": "Reasoning from LLM. Description of how the answer was generated."
3299
- }
3300
- },
3301
- "description": "List of objects found by similarity search."
3294
+ }
3302
3295
  },
3303
3296
  "ForecastResult": {
3304
3297
  "required": ["attribute", "lowerBound", "origin", "prediction", "upperBound"],