kb-cloud-client-typescript 2.3.0-alpha.96 → 2.3.0-alpha.97

package/src/adminapi/apis/aiagent-api.ts

@@ -106,6 +106,55 @@ export const AIAgentApiAxiosParamCreator = function (configuration?: Configurati
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * 
+         * @summary Browse a generated AI diagnosis report artifact
+         * @param {string} orgName 
+         * @param {string} conversationId 
+         * @param {string} actionId 
+         * @param {string} artifactId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        browseAIAgentTurnActionArtifact: async (orgName: string, conversationId: string, actionId: string, artifactId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('browseAIAgentTurnActionArtifact', 'orgName', orgName)
+            // verify required parameter 'conversationId' is not null or undefined
+            assertParamExists('browseAIAgentTurnActionArtifact', 'conversationId', conversationId)
+            // verify required parameter 'actionId' is not null or undefined
+            assertParamExists('browseAIAgentTurnActionArtifact', 'actionId', actionId)
+            // verify required parameter 'artifactId' is not null or undefined
+            assertParamExists('browseAIAgentTurnActionArtifact', 'artifactId', artifactId)
+            const localVarPath = `/admin/v1/organizations/{orgName}/ai-agent/conversations/{conversationId}/turn-actions/{actionId}/artifacts/{artifactId}/browse`
+                .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
+                .replace(`{${"conversationId"}}`, encodeURIComponent(String(conversationId)))
+                .replace(`{${"actionId"}}`, encodeURIComponent(String(actionId)))
+                .replace(`{${"artifactId"}}`, encodeURIComponent(String(artifactId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BearerToken required
+            await setApiKeyToObject(localVarHeaderParameter, "authorization", configuration)
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 
          * @summary Create an AI diagnosis conversation
@@ -181,6 +230,55 @@ export const AIAgentApiAxiosParamCreator = function (configuration?: Configurati
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Download a generated AI diagnosis report artifact
+         * @param {string} orgName 
+         * @param {string} conversationId 
+         * @param {string} actionId 
+         * @param {string} artifactId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadAIAgentTurnActionArtifact: async (orgName: string, conversationId: string, actionId: string, artifactId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('downloadAIAgentTurnActionArtifact', 'orgName', orgName)
+            // verify required parameter 'conversationId' is not null or undefined
+            assertParamExists('downloadAIAgentTurnActionArtifact', 'conversationId', conversationId)
+            // verify required parameter 'actionId' is not null or undefined
+            assertParamExists('downloadAIAgentTurnActionArtifact', 'actionId', actionId)
+            // verify required parameter 'artifactId' is not null or undefined
+            assertParamExists('downloadAIAgentTurnActionArtifact', 'artifactId', artifactId)
+            const localVarPath = `/admin/v1/organizations/{orgName}/ai-agent/conversations/{conversationId}/turn-actions/{actionId}/artifacts/{artifactId}/download`
+                .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
+                .replace(`{${"conversationId"}}`, encodeURIComponent(String(conversationId)))
+                .replace(`{${"actionId"}}`, encodeURIComponent(String(actionId)))
+                .replace(`{${"artifactId"}}`, encodeURIComponent(String(artifactId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BearerToken required
+            await setApiKeyToObject(localVarHeaderParameter, "authorization", configuration)
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -681,6 +779,22 @@ export const AIAgentApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['AIAgentApi.approveAIAgentToolConfirmation']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 
+         * @summary Browse a generated AI diagnosis report artifact
+         * @param {string} orgName 
+         * @param {string} conversationId 
+         * @param {string} actionId 
+         * @param {string} artifactId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async browseAIAgentTurnActionArtifact(orgName: string, conversationId: string, actionId: string, artifactId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.browseAIAgentTurnActionArtifact(orgName, conversationId, actionId, artifactId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AIAgentApi.browseAIAgentTurnActionArtifact']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary Create an AI diagnosis conversation
@@ -709,6 +823,22 @@ export const AIAgentApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['AIAgentApi.deleteAIAgentConversation']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 
+         * @summary Download a generated AI diagnosis report artifact
+         * @param {string} orgName 
+         * @param {string} conversationId 
+         * @param {string} actionId 
+         * @param {string} artifactId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async downloadAIAgentTurnActionArtifact(orgName: string, conversationId: string, actionId: string, artifactId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.downloadAIAgentTurnActionArtifact(orgName, conversationId, actionId, artifactId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AIAgentApi.downloadAIAgentTurnActionArtifact']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary Get an AI diagnosis conversation
@@ -880,6 +1010,16 @@ export const AIAgentApiFactory = function (configuration?: Configuration, basePa
         approveAIAgentToolConfirmation(requestParameters: AIAgentApiApproveAIAgentToolConfirmationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AiAgentToolConfirmationDecisionResponse> {
             return localVarFp.approveAIAgentToolConfirmation(requestParameters.orgName, requestParameters.conversationId, requestParameters.confirmationId, requestParameters.aiAgentToolConfirmationDecisionRequest, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 
+         * @summary Browse a generated AI diagnosis report artifact
+         * @param {AIAgentApiBrowseAIAgentTurnActionArtifactRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        browseAIAgentTurnActionArtifact(requestParameters: AIAgentApiBrowseAIAgentTurnActionArtifactRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
+            return localVarFp.browseAIAgentTurnActionArtifact(requestParameters.orgName, requestParameters.conversationId, requestParameters.actionId, requestParameters.artifactId, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary Create an AI diagnosis conversation
@@ -900,6 +1040,16 @@ export const AIAgentApiFactory = function (configuration?: Configuration, basePa
         deleteAIAgentConversation(requestParameters: AIAgentApiDeleteAIAgentConversationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AiAgentDeleteConversationResponse> {
             return localVarFp.deleteAIAgentConversation(requestParameters.orgName, requestParameters.conversationId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 
+         * @summary Download a generated AI diagnosis report artifact
+         * @param {AIAgentApiDownloadAIAgentTurnActionArtifactRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadAIAgentTurnActionArtifact(requestParameters: AIAgentApiDownloadAIAgentTurnActionArtifactRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
+            return localVarFp.downloadAIAgentTurnActionArtifact(requestParameters.orgName, requestParameters.conversationId, requestParameters.actionId, requestParameters.artifactId, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary Get an AI diagnosis conversation
@@ -1019,6 +1169,16 @@ export interface AIAgentApiInterface {
      */
     approveAIAgentToolConfirmation(requestParameters: AIAgentApiApproveAIAgentToolConfirmationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AiAgentToolConfirmationDecisionResponse>;
 
+    /**
+     * 
+     * @summary Browse a generated AI diagnosis report artifact
+     * @param {AIAgentApiBrowseAIAgentTurnActionArtifactRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AIAgentApiInterface
+     */
+    browseAIAgentTurnActionArtifact(requestParameters: AIAgentApiBrowseAIAgentTurnActionArtifactRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+
     /**
      * 
      * @summary Create an AI diagnosis conversation
@@ -1039,6 +1199,16 @@ export interface AIAgentApiInterface {
      */
     deleteAIAgentConversation(requestParameters: AIAgentApiDeleteAIAgentConversationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AiAgentDeleteConversationResponse>;
 
+    /**
+     * 
+     * @summary Download a generated AI diagnosis report artifact
+     * @param {AIAgentApiDownloadAIAgentTurnActionArtifactRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AIAgentApiInterface
+     */
+    downloadAIAgentTurnActionArtifact(requestParameters: AIAgentApiDownloadAIAgentTurnActionArtifactRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+
     /**
      * 
      * @summary Get an AI diagnosis conversation
@@ -1176,6 +1346,41 @@ export interface AIAgentApiApproveAIAgentToolConfirmationRequest {
     readonly aiAgentToolConfirmationDecisionRequest?: AiAgentToolConfirmationDecisionRequest
 }
 
+/**
+ * Request parameters for browseAIAgentTurnActionArtifact operation in AIAgentApi.
+ * @export
+ * @interface AIAgentApiBrowseAIAgentTurnActionArtifactRequest
+ */
+export interface AIAgentApiBrowseAIAgentTurnActionArtifactRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof AIAgentApiBrowseAIAgentTurnActionArtifact
+     */
+    readonly orgName: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof AIAgentApiBrowseAIAgentTurnActionArtifact
+     */
+    readonly conversationId: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof AIAgentApiBrowseAIAgentTurnActionArtifact
+     */
+    readonly actionId: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof AIAgentApiBrowseAIAgentTurnActionArtifact
+     */
+    readonly artifactId: string
+}
+
 /**
  * Request parameters for createAIAgentConversation operation in AIAgentApi.
  * @export
@@ -1218,6 +1423,41 @@ export interface AIAgentApiDeleteAIAgentConversationRequest {
     readonly conversationId: string
 }
 
+/**
+ * Request parameters for downloadAIAgentTurnActionArtifact operation in AIAgentApi.
+ * @export
+ * @interface AIAgentApiDownloadAIAgentTurnActionArtifactRequest
+ */
+export interface AIAgentApiDownloadAIAgentTurnActionArtifactRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof AIAgentApiDownloadAIAgentTurnActionArtifact
+     */
+    readonly orgName: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof AIAgentApiDownloadAIAgentTurnActionArtifact
+     */
+    readonly conversationId: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof AIAgentApiDownloadAIAgentTurnActionArtifact
+     */
+    readonly actionId: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof AIAgentApiDownloadAIAgentTurnActionArtifact
+     */
+    readonly artifactId: string
+}
+
 /**
  * Request parameters for getAIAgentConversation operation in AIAgentApi.
  * @export
@@ -1524,6 +1764,18 @@ export class AIAgentApi extends BaseAPI implements AIAgentApiInterface {
         return AIAgentApiFp(this.configuration).approveAIAgentToolConfirmation(requestParameters.orgName, requestParameters.conversationId, requestParameters.confirmationId, requestParameters.aiAgentToolConfirmationDecisionRequest, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * 
+     * @summary Browse a generated AI diagnosis report artifact
+     * @param {AIAgentApiBrowseAIAgentTurnActionArtifactRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AIAgentApi
+     */
+    public browseAIAgentTurnActionArtifact(requestParameters: AIAgentApiBrowseAIAgentTurnActionArtifactRequest, options?: RawAxiosRequestConfig) {
+        return AIAgentApiFp(this.configuration).browseAIAgentTurnActionArtifact(requestParameters.orgName, requestParameters.conversationId, requestParameters.actionId, requestParameters.artifactId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary Create an AI diagnosis conversation
@@ -1548,6 +1800,18 @@ export class AIAgentApi extends BaseAPI implements AIAgentApiInterface {
         return AIAgentApiFp(this.configuration).deleteAIAgentConversation(requestParameters.orgName, requestParameters.conversationId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * 
+     * @summary Download a generated AI diagnosis report artifact
+     * @param {AIAgentApiDownloadAIAgentTurnActionArtifactRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AIAgentApi
+     */
+    public downloadAIAgentTurnActionArtifact(requestParameters: AIAgentApiDownloadAIAgentTurnActionArtifactRequest, options?: RawAxiosRequestConfig) {
+        return AIAgentApiFp(this.configuration).downloadAIAgentTurnActionArtifact(requestParameters.orgName, requestParameters.conversationId, requestParameters.actionId, requestParameters.artifactId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary Get an AI diagnosis conversation

package/src/adminapi.yaml

@@ -1414,6 +1414,100 @@ paths:
           $ref: '#/components/responses/404'
         '500':
           $ref: '#/components/responses/500'
+  /admin/v1/organizations/{orgName}/ai-agent/conversations/{conversationId}/turn-actions/{actionId}/artifacts/{artifactId}/browse:
+    get:
+      tags:
+        - AI Agent
+      operationId: browseAIAgentTurnActionArtifact
+      summary: Browse a generated AI diagnosis report artifact
+      parameters:
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: conversationId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: actionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: artifactId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Generated report artifact content for browser preview
+          content:
+            application/octet-stream:
+              schema:
+                type: string
+                format: binary
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '500':
+          $ref: '#/components/responses/500'
+        '503':
+          $ref: '#/components/responses/503'
+  /admin/v1/organizations/{orgName}/ai-agent/conversations/{conversationId}/turn-actions/{actionId}/artifacts/{artifactId}/download:
+    get:
+      tags:
+        - AI Agent
+      operationId: downloadAIAgentTurnActionArtifact
+      summary: Download a generated AI diagnosis report artifact
+      parameters:
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: conversationId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: actionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: artifactId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Generated report artifact content
+          content:
+            application/octet-stream:
+              schema:
+                type: string
+                format: binary
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '500':
+          $ref: '#/components/responses/500'
+        '503':
+          $ref: '#/components/responses/503'
   /admin/v1/organizations/{orgName}/ai-agent/conversations/{conversationId}/events:
     get:
       tags: