chore: Improve error handling by using ErrorWithCause

packages/ai-api/package.json

@@ -29,6 +29,7 @@
   },
   "dependencies": {
     "@sap-ai-sdk/core": "workspace:^",
-    "@sap-cloud-sdk/connectivity": "^3.26.1"
+    "@sap-cloud-sdk/connectivity": "^3.26.1",
+    "@sap-cloud-sdk/util": "^3.26.1"
   }
 }

packages/ai-api/src/utils/deployment-resolver.test.ts

@@ -4,8 +4,11 @@ import {
   aiCoreDestination,
   mockDeploymentsList
 } from '../../../../test-util/mock-http.js';
-import { type AiDeployment } from '../client/AI_CORE_API';
-import { resolveDeploymentId } from './deployment-resolver.js';
+import { type AiDeployment } from '../client/AI_CORE_API/index.js';
+import {
+  getAllDeployments,
+  resolveDeploymentId
+} from './deployment-resolver.js';
 import { deploymentCache } from './deployment-cache.js';
 
 describe('deployment resolver', () => {
@@ -114,6 +117,44 @@ describe('deployment resolver', () => {
 
     expect(id).toEqual('5');
   });
+
+  describe('get all deployments', () => {
+    it('should return all deployments', async () => {
+      mockResponse();
+      const expected = [
+        {
+          id: '1',
+          details: {
+            resources: {
+              backendDetails: {
+                model: {
+                  name: 'gpt-4o',
+                  version: 'latest'
+                }
+              }
+            }
+          }
+        },
+        {
+          id: '2',
+          details: {
+            resources: {
+              backendDetails: {
+                model: {
+                  name: 'gpt-4o',
+                  version: '0613'
+                }
+              }
+            }
+          }
+        }
+      ];
+      const deployments = await getAllDeployments({
+        scenarioId: 'foundation-models'
+      });
+      expect(deployments).toStrictEqual(expected);
+    });
+  });
 });
 
 function mockResponse() {

packages/ai-api/src/utils/deployment-resolver.ts

@@ -1,3 +1,4 @@
+import { ErrorWithCause } from '@sap-cloud-sdk/util';
 import {
   type AiDeployment,
   DeploymentApi
@@ -138,7 +139,13 @@ export async function resolveDeploymentId(
   return deployments[0].id;
 }
 
-async function getAllDeployments(
+/**
+ * Get all deployments that match the given criteria.
+ * @param opts - The options for the deployment resolution.
+ * @returns A promise of an array of deployments.
+ * @internal
+ */
+export async function getAllDeployments(
   opts: DeploymentResolutionOptions
 ): Promise<AiDeployment[]> {
   const {
@@ -160,8 +167,8 @@ async function getAllDeployments(
     deploymentCache.setAll(opts, resources);
 
     return resources;
-  } catch (error) {
-    throw new Error('Failed to fetch the list of deployments: ' + error);
+  } catch (error: any) {
+    throw new ErrorWithCause('Failed to fetch the list of deployments.', error);
   }
 }
 

packages/core/src/http-client.ts

@@ -1,4 +1,5 @@
 import {
+  ErrorWithCause,
   mergeIgnoreCase,
   removeLeadingSlashes,
   removeTrailingSlashes
@@ -66,13 +67,21 @@ export async function executeRequest(
     data: JSON.stringify(data)
   };
 
-  return executeHttpRequest(
-    { ...aiCoreDestination, url: getTargetUrl(aiCoreDestination.url, url) },
-    mergedRequestConfig,
-    {
-      fetchCsrfToken: false
-    }
-  );
+  try {
+    const response = await executeHttpRequest(
+      { ...aiCoreDestination, url: getTargetUrl(aiCoreDestination.url, url) },
+      mergedRequestConfig,
+      {
+        fetchCsrfToken: false
+      }
+    );
+    return response;
+  } catch (error: any) {
+    throw new ErrorWithCause(
+      `Request failed with status code ${error.status}.`,
+      error
+    );
+  }
 }
 
 function mergeWithDefaultRequestConfig(

sample-code/README.md

@@ -136,11 +136,11 @@ Get chat completion response for a given static input.
 Get chat completion response with template and input parameters.
 Define variable by wrapping it with `{{?...}}`.
 
-#### Image Recognition
+#### Templating with Reference
 
-`GET /orchestration/image`
+`GET /orchestration/templateRef`
 
-Get chat completion response with image input.
+Get chat completion response with template reference and input parameters.
 
 #### Input Filtering
 
@@ -162,6 +162,30 @@ For example, use `buildAzureContentSafetyFilter()` function to build Azure conte
 
 Send chat completion request with a custom header as the custom request configuration.
 
+#### Orchestration Client from JSON config
+
+`GET /orchestration/fromJson`
+
+Get chat completion response with a JSON config initialized orchestration client.
+
+#### Image Recognition
+
+`GET /orchestration/image`
+
+Get chat completion response with image input.
+
+#### Structured Response
+
+`GET /orchestration/responseFormat`
+
+Get chat completion response with structured response format.
+
+#### Mask Grounding Input
+
+`GET /orchestration/maskGroundingInput`
+
+Get chat completion response with masked grounding input.
+
 #### Chat Completion Streaming
 
 `POST /orchestration-stream/chat-completion-stream`

sample-code/src/orchestration.ts

@@ -15,7 +15,8 @@ import type {
   OrchestrationStreamChunkResponse,
   OrchestrationStreamResponse,
   OrchestrationResponse,
-  StreamOptions
+  StreamOptions,
+  ErrorResponse
 } from '@sap-ai-sdk/orchestration';
 
 const logger = createLogger({
@@ -168,8 +169,9 @@ const templating = { template: [{ role: 'user', content: '{{?input}}' }] };
 
 /**
  * Apply multiple content filters to the input.
+ * @returns The orchestration service error response.
  */
-export async function orchestrationInputFiltering(): Promise<void> {
+export async function orchestrationInputFiltering(): Promise<ErrorResponse> {
   // Build Azure content filter with only safe content allowed for hate and violence
   const azureContentSafetyFilter = buildAzureContentSafetyFilter({
     Hate: 'ALLOW_SAFE',
@@ -196,11 +198,12 @@ export async function orchestrationInputFiltering(): Promise<void> {
     });
     throw new Error('Input was not filtered as expected.');
   } catch (error: any) {
-    if (error.response?.status === 400) {
+    if (error.cause?.status === 400) {
       logger.info('Input was filtered as expected.');
     } else {
       throw error;
     }
+    return error.cause?.response?.data;
   }
 }