@gooddata/api-client-tiger 11.52.0-alpha.4 → 11.52.0-alpha.6

package/esm/generated/ai-json-api/api.d.ts

@@ -331,6 +331,49 @@ export interface AiBoundedFilterOutput {
 export interface AiBucketRefObject {
     'field': string;
 }
+/**
+ * What one search looked for in the semantic catalog, what came back, and what it used.
+ */
+export interface AiCatalogSearchDetail {
+    /**
+     * Category this body belongs to.
+     */
+    'category'?: AiCatalogSearchDetailCategoryEnum;
+    /**
+     * Titles the search returned, grouped by object type.
+     */
+    'found'?: Array<AiSearchedGroup>;
+    /**
+     * Keywords the search looked for. Each runs against every requested type.
+     */
+    'query'?: Array<string>;
+    /**
+     * Catalog types the search asked for.
+     */
+    'requestedTypes'?: Array<string>;
+    /**
+     * Best-matching object per type. Empty for the search modes that do not rank.
+     */
+    'used'?: Array<AiCatalogSearchMatch>;
+}
+export type AiCatalogSearchDetailCategoryEnum = 'catalogSearch';
+/**
+ * The highest-ranked object of one searched type, with the score that ranked it.
+ */
+export interface AiCatalogSearchMatch {
+    /**
+     * Catalog type the object is the best match of.
+     */
+    'objectType': string;
+    /**
+     * Relevance score that ranked it.
+     */
+    'score': number;
+    /**
+     * Title of the highest-ranked object.
+     */
+    'title': string;
+}
 export interface AiClusteringAmount {
 }
 export interface AiComparison {
@@ -387,6 +430,20 @@ export declare const AiComparisonMeasureValueOperator: {
     readonly NOT_EQUAL_TO: "NOT_EQUAL_TO";
 };
 export type AiComparisonMeasureValueOperator = typeof AiComparisonMeasureValueOperator[keyof typeof AiComparisonMeasureValueOperator];
+/**
+ * How the answer itself came out: what it is and which model wrote it.
+ */
+export interface AiComposeAnswerDetail {
+    /**
+     * Category this body belongs to.
+     */
+    'category'?: AiComposeAnswerDetailCategoryEnum;
+    'modelId'?: string | null;
+    'output'?: AiComposeAnswerDetailOutputEnum | null;
+    'suggestedActions'?: number | null;
+}
+export type AiComposeAnswerDetailCategoryEnum = 'composeAnswer';
+export type AiComposeAnswerDetailOutputEnum = 'text' | 'visualization' | 'dashboard' | 'keyDriverAnalysis' | 'whatIf' | 'searchResults' | 'alertProposal';
 export interface AiCompoundMeasureValueFilter {
     'compoundMeasureValueFilter': AiCompoundMeasureValueFilterBody;
 }
@@ -454,6 +511,7 @@ export interface AiConversationItemResponse {
      * Item creation timestamp (ISO-8601 UTC).
      */
     'createdAt': string;
+    'detail'?: AiConversationItemResponseDetail | null;
     /**
      * Conversation item identifier.
      */
@@ -464,17 +522,32 @@ export interface AiConversationItemResponse {
     'itemIndex': number;
     'newAgentId'?: string | null;
     'oldAgentId'?: string | null;
+    'reasoningEffort'?: AiRequestedReasoningEffort | null;
     'replyTo'?: string | null;
     'responseId'?: string | null;
     /**
      * Author role of the item.
      */
     'role': AiConversationItemResponseRoleEnum;
+    'stepId'?: string | null;
     'taskId'?: string | null;
     'trigger'?: AiConversationItemResponseTriggerEnum | null;
 }
 export type AiConversationItemResponseRoleEnum = 'user' | 'assistant' | 'tool' | 'system';
 export type AiConversationItemResponseTriggerEnum = 'agent_switched' | 'agent_updated';
+/**
+ * @type AiConversationItemResponseDetail
+ * What one item\'s action did.
+ */
+export type AiConversationItemResponseDetail = ({
+    category: 'catalogSearch';
+} & AiCatalogSearchDetail) | ({
+    category: 'composeAnswer';
+} & AiComposeAnswerDetail) | ({
+    category: 'knowledgeSearch';
+} & AiKnowledgeSearchDetail) | ({
+    category: 'skillRouting';
+} & AiSkillRoutingDetail);
 export interface AiConversationListMeta {
     'page': AiConversationListPageMeta;
 }
@@ -599,7 +672,8 @@ export interface AiDashboardIdUpdateRequest {
 }
 export interface AiDashboardPart {
     'dashboard'?: AiDashboard | null;
-    'savedDashboardId'?: string | null;
+    'references'?: AiDashboardReferences | null;
+    'saved_dashboard_id'?: string | null;
     /**
      * Type of multipart part.
      */
@@ -613,6 +687,16 @@ export interface AiDashboardRef {
     'id': string;
     'title'?: string | null;
 }
+/**
+ * AAC bodies of every widget-referenced visualization in a dashboard draft.  Each entry is opaque AAC pass-through (dict), not modeled as a schema — same treatment the codebase gives elsewhere to full AAC visualization bodies.
+ */
+export interface AiDashboardReferences {
+    [key: string]: any;
+    /**
+     * Full AAC body of every widget-referenced visualization that has one available.
+     */
+    'visualizations': Array<object>;
+}
 /**
  * AAC ref: dashboard.json section.
  */
@@ -814,6 +898,48 @@ export interface AiInlineFilterDefinitionBody {
     'filter': string;
     'localIdentifier'?: string | null;
 }
+/**
+ * Interaction step list response.
+ */
+export interface AiInteractionStepListResponse {
+    /**
+     * Ordered list of interaction steps.
+     */
+    'steps': Array<AiInteractionStepResponse>;
+}
+/**
+ * One LLM call of a turn and the tools it dispatched.  Carries only what belongs to the whole call -- ordering, duration, spend. What each action did lives on the items that link here via their ``stepId``.
+ */
+export interface AiInteractionStepResponse {
+    /**
+     * Parent conversation identifier.
+     */
+    'conversationId': string;
+    /**
+     * Step start timestamp (ISO-8601 UTC).
+     */
+    'createdAt': string;
+    /**
+     * Wall-clock duration of the LLM call and its tool dispatches.
+     */
+    'durationMs': number;
+    /**
+     * Response/turn identifier the step belongs to.
+     */
+    'responseId': string;
+    /**
+     * Interaction step identifier.
+     */
+    'stepId': string;
+    /**
+     * Zero-based step order within the turn.
+     */
+    'stepIndex': number;
+    /**
+     * Token usage of the step\'s LLM call.
+     */
+    'tokens': AiStepTokens;
+}
 /**
  * Date granularity for the interval of an ONCE_PER_INTERVAL trigger.
  */
@@ -869,6 +995,32 @@ export interface AiKeyDriverAnalysisPart {
     'type'?: AiKeyDriverAnalysisPartTypeEnum;
 }
 export type AiKeyDriverAnalysisPartTypeEnum = 'kda';
+/**
+ * What one action looked for in the knowledge base and which documents it reached.
+ */
+export interface AiKnowledgeSearchDetail {
+    'bestMatch'?: string | null;
+    /**
+     * Category this body belongs to.
+     */
+    'category'?: AiKnowledgeSearchDetailCategoryEnum;
+    /**
+     * Documents the action reached, best-scoring first.
+     */
+    'documents'?: Array<AiKnowledgeSearchDocument>;
+    'query'?: string | null;
+}
+export type AiKnowledgeSearchDetailCategoryEnum = 'knowledgeSearch';
+/**
+ * One knowledge document an action reached, named as the user would recognise it.
+ */
+export interface AiKnowledgeSearchDocument {
+    'score'?: number | null;
+    /**
+     * Document title, falling back to its filename when it has none.
+     */
+    'title': string;
+}
 export interface AiLabel {
     'identifier': AiAfmObjectIdentifierBody;
     'localIdentifier': string;
@@ -1409,6 +1561,19 @@ export interface AiSearchStatistics {
     'averageSimilarityScore': number;
     'totalResults': number;
 }
+/**
+ * The results of a search that share one object type.
+ */
+export interface AiSearchedGroup {
+    /**
+     * Catalog type name the group belongs to.
+     */
+    'objectType': string;
+    /**
+     * Titles of that type that came back.
+     */
+    'titles'?: Array<string>;
+}
 export interface AiSendMessageContent {
     'text': string;
     'type': AiSendMessageContentTypeEnum;
@@ -1457,6 +1622,32 @@ export interface AiSkillResponse {
     'tags': Array<string>;
     'title': string;
 }
+/**
+ * Which skills the turn could reach for, and which this call left active.
+ */
+export interface AiSkillRoutingDetail {
+    /**
+     * Titles of the skills active after the call replaced the active set.
+     */
+    'activated'?: Array<string>;
+    /**
+     * Titles of the skills the model could choose from, in the order the prompt lists them.
+     */
+    'available'?: Array<string>;
+    /**
+     * Category this body belongs to.
+     */
+    'category'?: AiSkillRoutingDetailCategoryEnum;
+}
+export type AiSkillRoutingDetailCategoryEnum = 'skillRouting';
+/**
+ * What the step\'s LLM call spent; a field is null when the provider did not report it.
+ */
+export interface AiStepTokens {
+    'input'?: number | null;
+    'output'?: number | null;
+    'total'?: number | null;
+}
 /**
  * A quick-reply action button rendered alongside the follow-up question.
  */
@@ -2529,6 +2720,86 @@ export declare class DashboardsAi extends BaseAPI implements DashboardsAiInterfa
      */
     patchDashboardApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdDashboardsDashboardIdPatch(requestParameters: DashboardsAiPatchDashboardApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdDashboardsDashboardIdPatchRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
 }
+/**
+ *
+ * @summary Get Conversation Interaction Steps
+ * @param {string} workspaceId
+ * @param {string} conversationId
+ * @param {string} [responseId]
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function InteractionStepsAiAxiosParamCreator_GetConversationInteractionStepsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdStepsGet(workspaceId: string, conversationId: string, responseId?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ *
+ * @summary Get Conversation Interaction Steps
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {InteractionStepsAiGetConversationInteractionStepsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdStepsGetRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function InteractionStepsAi_GetConversationInteractionStepsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdStepsGet(axios: AxiosInstance, basePath: string, requestParameters: InteractionStepsAiGetConversationInteractionStepsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdStepsGetRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AiInteractionStepListResponse>;
+/**
+ * InteractionStepsAi - interface
+ * @export
+ * @interface InteractionStepsAi
+ */
+export interface InteractionStepsAiInterface {
+    /**
+     *
+     * @summary Get Conversation Interaction Steps
+     * @param {InteractionStepsAiGetConversationInteractionStepsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdStepsGetRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InteractionStepsAiInterface
+     */
+    getConversationInteractionStepsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdStepsGet(requestParameters: InteractionStepsAiGetConversationInteractionStepsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdStepsGetRequest, options?: AxiosRequestConfig): AxiosPromise<AiInteractionStepListResponse>;
+}
+/**
+ * Request parameters for getConversationInteractionStepsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdStepsGet operation in InteractionStepsAi.
+ * @export
+ * @interface InteractionStepsAiGetConversationInteractionStepsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdStepsGetRequest
+ */
+export interface InteractionStepsAiGetConversationInteractionStepsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdStepsGetRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof InteractionStepsAiGetConversationInteractionStepsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdStepsGet
+     */
+    readonly workspaceId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof InteractionStepsAiGetConversationInteractionStepsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdStepsGet
+     */
+    readonly conversationId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof InteractionStepsAiGetConversationInteractionStepsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdStepsGet
+     */
+    readonly responseId?: string;
+}
+/**
+ * InteractionStepsAi - object-oriented interface
+ * @export
+ * @class InteractionStepsAi
+ * @extends {BaseAPI}
+ */
+export declare class InteractionStepsAi extends BaseAPI implements InteractionStepsAiInterface {
+    /**
+     *
+     * @summary Get Conversation Interaction Steps
+     * @param {InteractionStepsAiGetConversationInteractionStepsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdStepsGetRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InteractionStepsAi
+     */
+    getConversationInteractionStepsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdStepsGet(requestParameters: InteractionStepsAiGetConversationInteractionStepsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdStepsGetRequest, options?: AxiosRequestConfig): AxiosPromise<AiInteractionStepListResponse>;
+}
 /**
  *
  * @summary Get Conversation Items
@@ -2834,7 +3105,7 @@ export declare function KnowledgeAi_DeleteOrgDocument(axios: AxiosInstance, base
  * @param {Configuration} [configuration] Optional configuration.
  * @throws {RequiredError}
  */
-export declare function KnowledgeAi_DownloadDocument(axios: AxiosInstance, basePath: string, requestParameters: KnowledgeAiDownloadDocumentRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<any>;
+export declare function KnowledgeAi_DownloadDocument(axios: AxiosInstance, basePath: string, requestParameters: KnowledgeAiDownloadDocumentRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<File>;
 /**
  * Download an org-scoped knowledge document\'s raw file.
  * @summary Download Document Org
@@ -2845,7 +3116,7 @@ export declare function KnowledgeAi_DownloadDocument(axios: AxiosInstance, baseP
  * @param {Configuration} [configuration] Optional configuration.
  * @throws {RequiredError}
  */
-export declare function KnowledgeAi_DownloadOrgDocument(axios: AxiosInstance, basePath: string, requestParameters: KnowledgeAiDownloadOrgDocumentRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<any>;
+export declare function KnowledgeAi_DownloadOrgDocument(axios: AxiosInstance, basePath: string, requestParameters: KnowledgeAiDownloadOrgDocumentRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<File>;
 /**
  * Get a single knowledge document\'s metadata. Inherited and org-level docs are visible.
  * @summary Get Document
@@ -3006,7 +3277,7 @@ export interface KnowledgeAiInterface {
      * @throws {RequiredError}
      * @memberof KnowledgeAiInterface
      */
-    downloadDocument(requestParameters: KnowledgeAiDownloadDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<any>;
+    downloadDocument(requestParameters: KnowledgeAiDownloadDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
     /**
      * Download an org-scoped knowledge document\'s raw file.
      * @summary Download Document Org
@@ -3015,7 +3286,7 @@ export interface KnowledgeAiInterface {
      * @throws {RequiredError}
      * @memberof KnowledgeAiInterface
      */
-    downloadOrgDocument(requestParameters: KnowledgeAiDownloadOrgDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<any>;
+    downloadOrgDocument(requestParameters: KnowledgeAiDownloadOrgDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
     /**
      * Get a single knowledge document\'s metadata. Inherited and org-level docs are visible.
      * @summary Get Document
@@ -3570,7 +3841,7 @@ export declare class KnowledgeAi extends BaseAPI implements KnowledgeAiInterface
      * @throws {RequiredError}
      * @memberof KnowledgeAi
      */
-    downloadDocument(requestParameters: KnowledgeAiDownloadDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<any>;
+    downloadDocument(requestParameters: KnowledgeAiDownloadDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
     /**
      * Download an org-scoped knowledge document\'s raw file.
      * @summary Download Document Org
@@ -3579,7 +3850,7 @@ export declare class KnowledgeAi extends BaseAPI implements KnowledgeAiInterface
      * @throws {RequiredError}
      * @memberof KnowledgeAi
      */
-    downloadOrgDocument(requestParameters: KnowledgeAiDownloadOrgDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<any>;
+    downloadOrgDocument(requestParameters: KnowledgeAiDownloadOrgDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
     /**
      * Get a single knowledge document\'s metadata. Inherited and org-level docs are visible.
      * @summary Get Document
@@ -3692,7 +3963,7 @@ export declare function MessagesAiAxiosParamCreator_PostMessagesApiV1AiWorkspace
  * @param {Configuration} [configuration] Optional configuration.
  * @throws {RequiredError}
  */
-export declare function MessagesAi_PostMessagesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdMessagesPost(axios: AxiosInstance, basePath: string, requestParameters: MessagesAiPostMessagesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdMessagesPostRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<any>;
+export declare function MessagesAi_PostMessagesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdMessagesPost(axios: AxiosInstance, basePath: string, requestParameters: MessagesAiPostMessagesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdMessagesPostRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<string>;
 /**
  * MessagesAi - interface
  * @export
@@ -3707,7 +3978,7 @@ export interface MessagesAiInterface {
      * @throws {RequiredError}
      * @memberof MessagesAiInterface
      */
-    postMessagesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdMessagesPost(requestParameters: MessagesAiPostMessagesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdMessagesPostRequest, options?: AxiosRequestConfig): AxiosPromise<any>;
+    postMessagesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdMessagesPost(requestParameters: MessagesAiPostMessagesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdMessagesPostRequest, options?: AxiosRequestConfig): AxiosPromise<string>;
 }
 /**
  * Request parameters for postMessagesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdMessagesPost operation in MessagesAi.
@@ -3749,7 +4020,7 @@ export declare class MessagesAi extends BaseAPI implements MessagesAiInterface {
      * @throws {RequiredError}
      * @memberof MessagesAi
      */
-    postMessagesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdMessagesPost(requestParameters: MessagesAiPostMessagesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdMessagesPostRequest, options?: AxiosRequestConfig): AxiosPromise<any>;
+    postMessagesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdMessagesPost(requestParameters: MessagesAiPostMessagesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdMessagesPostRequest, options?: AxiosRequestConfig): AxiosPromise<string>;
 }
 /**
  *