Skip to content

Commit 74f008f

Browse files
Update README.md
Update README default example to include API call to open ai
1 parent e90c408 commit 74f008f

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Prompt Foundry Node API Library
22

3+
The prompt engineering, prompt management, and prompt evaluation tool for TypeScript, JavaScript, and NodeJS.
4+
35
[![NPM version](https://img.shields.io/npm/v/@prompt-foundry/typescript-sdk.svg)](https://npmjs.org/package/@prompt-foundry/typescript-sdk) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@prompt-foundry/typescript-sdk)
46

57
This library provides convenient access to the Prompt Foundry REST API from server-side TypeScript or JavaScript.
68

7-
The REST API documentation can be found [on docs.promptfoundry.ai](https://docs.promptfoundry.ai). The full API of this library can be found in [api.md](api.md).
9+
The REST API documentation can be found on [docs.promptfoundry.ai](https://docs.promptfoundry.ai). The full API of this library can be found in [api.md](api.md).
810

911
It is generated with [Stainless](https://www.stainlessapi.com/).
1012

@@ -27,9 +29,13 @@ const promptFoundry = new PromptFoundry({
2729
});
2830

2931
async function main() {
30-
const modelParameters = await promptFoundry.prompts.getParameters('1212121');
32+
const modelParameters = await promptFoundry.prompts.getParameters('1212121', {
33+
variables: { hello: 'world' },
34+
});
35+
36+
const modelResponse = await openai.chat.completions.create(modelParameters.parameters)
3137

32-
console.log(modelParameters.parameters);
38+
console.log(modelResponse);
3339
}
3440

3541
main();

0 commit comments

Comments
 (0)