chore: Adding Documentation for OpenAI client

README.md

@@ -46,7 +46,8 @@ $ npm install @sap-ai-sdk/ai-api
 
 This package incorporates generative AI foundation models into your AI activities in SAP AI Core and SAP AI Launchpad.
 
-To install the  Gen AI Hub package in your project, run:
+To install the Gen AI Hub package in your project, run:
+
 ```
 $ npm install @sap-ai-sdk/foundation-models
 ```
@@ -55,7 +56,8 @@ $ npm install @sap-ai-sdk/foundation-models
 
 This package incorporates generative AI orchestration capabilities into your AI activities in SAP AI Core and SAP AI Launchpad.
 
-To install the  Gen AI Hub package in your project, run:
+To install the Gen AI Hub package in your project, run:
+
 ```
 $ npm install @sap-ai-sdk/orchestration
 ```
@@ -64,10 +66,9 @@ $ npm install @sap-ai-sdk/orchestration
 
 We have created a sample project demonstrating the different clients' usage of the SAP Cloud SDK for AI for TypeScript/JavaScript. The [project README](./sample-code/README.md) outlines the set-up needed to build and run it locally.
 
-
 ## Support, Feedback, Contribution
 
-This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/ai-sdk-js/issues). 
+This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/ai-sdk-js/issues).
 
 Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
 

packages/foundation-models/README.md

@@ -17,9 +17,54 @@ $ npm install @sap-ai-sdk/foundation-models
   - Create a `.env` file in the sample-code directory.
   - Add an entry `AICORE_SERVICE_KEY='<content-of-service-key>'`.
 
-## Usage
+## OpenAI client
 
-<!-- Details to be added -->
+The OpenAI client can be used to send chat completion or embedding requests to the OpenAI model deployed in SAP Generative AI Hub.
+
+### Prerequisites
+
+- A deployed OpenAI model in SAP Generative AI Hub.
+  - You can use the [`DeploymentApi`](../ai-api/README.md#deploymentapi) from `@sap-ai-sdk/ai-api` to deploy a model to SAP Generative AI Hub.
+- `sap-ai-sdk/foundation-models` package installed in your project.
+
+### Chat completion Client Usage
+
+```TS
+import { OpenAiChatClient } from '@sap-ai-sdk/foundation-models';
+
+const client = new OpenAiChatClient('gpt-35-turbo');
+const response = await client.run({
+      messages: [
+        {
+          role: 'user',
+          content: 'Where is the deepest place on earth located'
+        }
+      ]
+    })
+const responseContent = response.getContent();
+```
+
+It is also possible to create a chat client by passing a `deploymentId` instead of a `modelName`.
+
+On the response obtained from the client, you could also use convenience functions like `getContent()`, `getFinishReason()` and `getTokenUsage()` to get easy access to the certain parts of the response.
+
+### Embedding Client Usage
+
+```TS
+import { OpenAiEmbeddingClient } from '@sap-ai-sdk/foundation-models';
+
+const client = new OpenAiEmbeddingClient({ deploymentId: 'd123456abcdefg' });
+const response = await client.run({
+      input: 'AI is fascinating'
+    });
+const embedding = response.data[0]?.embedding;
+```
+
+It is also possible to create an embedding client by passing a `modelName` instead of a `deploymentId`.
+
+## Caching
+
+The deployment information which includes deployment id and properties like model name and model version is also cached by default for 5 mins. So, if you create an OpenAI client with a `modelName`, the deployment information is fetched from the cache if it is available.
 
 ## Support, Feedback, Contribution