chore: Make API more consistent (#136)

* Remove unused base config * Shorten type names to “Config” * Remove old deploymentconfig from type tests * simplify orchestration properties * add todo * fix: Changes from lint * fix tests * add type * fix more tests * fix type tests * typo * remove comment to not make check fail * more fixes --------- Co-authored-by: cloud-sdk-js <[email protected]>
SAP · Sep 17, 2024 · 8c28ef9 · 8c28ef9
1 parent 4068a88
commit 8c28ef9
Show file tree

Hide file tree

Showing 15 changed files with 118 additions and 140 deletions.
diff --git a/packages/ai-api/src/index.ts b/packages/ai-api/src/index.ts
@@ -2,7 +2,7 @@ export * from './client/AI_CORE_API/index.js';
 
 export type {
   ModelDeployment,
-  DeploymentIdConfiguration,
-  ModelConfiguration,
-  ResourceGroupConfiguration
+  DeploymentIdConfig,
+  ModelConfig,
+  ResourceGroupConfig
 } from './utils/index.js';
diff --git a/packages/ai-api/src/utils/deployment-resolver.ts b/packages/ai-api/src/utils/deployment-resolver.ts
@@ -9,7 +9,7 @@ import { extractModel, type FoundationModel } from './model.js';
  * The model deployment configuration when using a model.
  * @typeParam ModelNameT - String literal type representing the name of the model.
  */
-export interface ModelConfiguration<ModelNameT = string> {
+export interface ModelConfig<ModelNameT = string> {
   /**
    * The name of the model.
    */
@@ -23,7 +23,7 @@ export interface ModelConfiguration<ModelNameT = string> {
 /**
  * The deployment configuration when using a deployment ID.
  */
-export interface DeploymentIdConfiguration {
+export interface DeploymentIdConfig {
   /**
    * The deployment ID.
    */
@@ -33,7 +33,7 @@ export interface DeploymentIdConfiguration {
 /**
  * The deployment configuration when using a resource group.
  */
-export interface ResourceGroupConfiguration {
+export interface ResourceGroupConfig {
   /**
    * The resource group of the deployment.
    */
@@ -46,17 +46,16 @@ export interface ResourceGroupConfiguration {
  */
 export type ModelDeployment<ModelNameT = string> =
   | ModelNameT
-  | ((ModelConfiguration<ModelNameT> | DeploymentIdConfiguration) &
-      ResourceGroupConfiguration);
+  | ((ModelConfig<ModelNameT> | DeploymentIdConfig) & ResourceGroupConfig);
 
 /**
  * Type guard to check if the given deployment configuration is a deployment ID configuration.
  * @param modelDeployment - Configuration to check.
  * @returns `true` if the configuration is a deployment ID configuration, `false` otherwise.
  */
-function isDeploymentIdConfiguration(
+function isDeploymentIdConfig(
   modelDeployment: ModelDeployment
-): modelDeployment is DeploymentIdConfiguration {
+): modelDeployment is DeploymentIdConfig {
   return (
     typeof modelDeployment === 'object' && 'deploymentId' in modelDeployment
   );
@@ -156,7 +155,7 @@ export async function getDeploymentId(
   modelDeployment: ModelDeployment,
   executableId: string
 ): Promise<string> {
-  if (isDeploymentIdConfiguration(modelDeployment)) {
+  if (isDeploymentIdConfig(modelDeployment)) {
     return modelDeployment.deploymentId;
   }
 
@@ -173,9 +172,7 @@ export async function getDeploymentId(
   });
 }
 
-function translateToFoundationModel(
-  modelConfig: ModelConfiguration
-): FoundationModel {
+function translateToFoundationModel(modelConfig: ModelConfig): FoundationModel {
   if (typeof modelConfig === 'string') {
     return { name: modelConfig };
   }

diff --git a/packages/core/src/http-client.test.ts b/packages/core/src/http-client.test.ts
@@ -9,9 +9,11 @@ describe('http-client', () => {
   beforeEach(() => {
     mockClientCredentialsGrantCall();
   });
+
   afterEach(() => {
     nock.cleanAll();
   });
+
   it('should execute a request to the AI Core service', async () => {
     const mockPrompt = { prompt: 'some test prompt' };
     const mockPromptResponse = { completion: 'some test completion' };

diff --git a/packages/core/src/http-client.ts b/packages/core/src/http-client.ts
@@ -6,25 +6,6 @@ import {
 } from '@sap-cloud-sdk/http-client';
 import { getAiCoreDestination } from './context.js';
 
-/**
- * Input parameters with Deployment ID.
- */
-export interface BaseLlmParametersWithDeploymentId {
-  /**
-   * Deployment ID of the model to use.
-   */
-  deploymentId: string;
-}
-/**
- * Base LLM Input Parameters.
- */
-export interface BaseLlmParameters {
-  /**
-   * Deployment configuration.
-   */
-  deploymentConfiguration: BaseLlmParametersWithDeploymentId;
-}
-
 /**
  * The type for parameters in custom request configuration.
  */

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -1,9 +1,4 @@
-export type {
-  BaseLlmParametersWithDeploymentId,
-  BaseLlmParameters,
-  CustomRequestConfig,
-  EndpointOptions
-} from './http-client.js';
+export type { CustomRequestConfig, EndpointOptions } from './http-client.js';
 export { executeRequest } from './http-client.js';
 export { getAiCoreDestination } from './context.js';
 export { OpenApiRequestBuilder } from './openapi-request-builder.js';

diff --git a/packages/orchestration/src/index.ts b/packages/orchestration/src/index.ts
@@ -30,7 +30,7 @@ export type {
 
 export type {
   OrchestrationModuleConfig,
-  LlmConfig,
+  LlmModuleConfig,
   Prompt
 } from './orchestration-types.js';
 

diff --git a/packages/orchestration/src/orchestration-client.test.ts b/packages/orchestration/src/orchestration-client.test.ts
@@ -12,6 +12,7 @@ import {
 } from './orchestration-client.js';
 import { azureContentFilter } from './orchestration-filter-utility.js';
 import { OrchestrationResponse } from './orchestration-response.js';
+import { OrchestrationModuleConfig } from './orchestration-types.js';
 
 describe('orchestration service client', () => {
   beforeEach(() => {
@@ -24,12 +25,12 @@ describe('orchestration service client', () => {
   });
 
   it('calls chatCompletion with minimum configuration', async () => {
-    const config = {
-      llmConfig: {
+    const config: OrchestrationModuleConfig = {
+      llm: {
         model_name: 'gpt-35-turbo-16k',
         model_params: { max_tokens: 50, temperature: 0.1 }
       },
-      templatingConfig: {
+      templating: {
         template: [{ role: 'user', content: 'Hello!' }]
       }
     };
@@ -61,20 +62,20 @@ describe('orchestration service client', () => {
   });
 
   it('calls chatCompletion with filter configuration supplied using convenience function', async () => {
-    const config = {
-      llmConfig: {
+    const config: OrchestrationModuleConfig = {
+      llm: {
         model_name: 'gpt-35-turbo-16k',
         model_params: { max_tokens: 50, temperature: 0.1 }
       },
-      templatingConfig: {
+      templating: {
         template: [
           {
             role: 'user',
             content: 'Create {{?number}} paraphrases of {{?phrase}}'
           }
         ]
       },
-      filterConfig: {
+      filtering: {
         input: azureContentFilter({ Hate: 4, SelfHarm: 2 }),
         output: azureContentFilter({ Sexual: 0, Violence: 4 })
       }
@@ -106,20 +107,20 @@ describe('orchestration service client', () => {
   });
 
   it('calls chatCompletion with filtering configuration', async () => {
-    const config = {
-      llmConfig: {
+    const config: OrchestrationModuleConfig = {
+      llm: {
         model_name: 'gpt-35-turbo-16k',
         model_params: { max_tokens: 50, temperature: 0.1 }
       },
-      templatingConfig: {
+      templating: {
         template: [
           {
             role: 'user',
             content: 'Create {{?number}} paraphrases of {{?phrase}}'
           }
         ]
       },
-      filterConfig: {
+      filtering: {
         input: {
           filters: [
             {
@@ -169,12 +170,12 @@ describe('orchestration service client', () => {
   });
 
   it('sends message history together with templating config', async () => {
-    const config = {
-      llmConfig: {
+    const config: OrchestrationModuleConfig = {
+      llm: {
         model_name: 'gpt-35-turbo-16k',
         model_params: { max_tokens: 50, temperature: 0.1 }
       },
-      templatingConfig: {
+      templating: {
         template: [{ role: 'user', content: "What's my name?" }],
         messages_history: [
           {

diff --git a/packages/orchestration/src/orchestration-client.ts b/packages/orchestration/src/orchestration-client.ts
@@ -1,7 +1,7 @@
 import { executeRequest, CustomRequestConfig } from '@sap-ai-sdk/core';
 import {
   resolveDeploymentId,
-  ResourceGroupConfiguration
+  ResourceGroupConfig
 } from '@sap-ai-sdk/ai-api/internal.js';
 import { CompletionPostRequest } from './client/api/schema/index.js';
 import { OrchestrationModuleConfig, Prompt } from './orchestration-types.js';
@@ -18,7 +18,7 @@ export class OrchestrationClient {
    */
   constructor(
     private config: OrchestrationModuleConfig,
-    private deploymentConfig?: ResourceGroupConfiguration
+    private deploymentConfig?: ResourceGroupConfig
   ) {}
 
   /**
@@ -60,11 +60,11 @@ export function constructCompletionPostRequest(
     orchestration_config: {
       module_configurations: {
         templating_module_config: {
-          template: config.templatingConfig.template
+          template: config.templating.template
         },
-        llm_module_config: config.llmConfig,
-        ...(Object.keys(config?.filterConfig || {}).length && {
-          filtering_module_config: config.filterConfig
+        llm_module_config: config.llm,
+        ...(Object.keys(config?.filtering || {}).length && {
+          filtering_module_config: config.filtering
         })
       }
     },