@fern-api/parea-ai v0.0.8
Parea TypeScript SDK
The Parea TypeScript library provides access to the Parea API from JavaScript/TypeScript.
Documentation
API reference documentation is available here.
Installation
npm install --save @fern-api/parea-ai
# or
yarn add @fern-api/parea-ai
Usage
import { PareaAIClient } from '@fern-api/parea-ai';
const parea = new PareaAIClient({
apiKey: 'YOUR_API_KEY',
});
const response = await parea.completion({
deploymentId: 'Deployment_ID',
llmInputs: { query: "Your query..." },
});
Handling Errors
When the API returns a non-success status code (4xx or 5xx response), a subclass of VitalError will be thrown:
import { PareaAITimeoutError, PareaAIError } from '@fern-api/parea-ai';
try {
await parea.completion(...);
} catch (err) {
if (err instanceof PareaAITimeoutError) {
// handle timeout error
} else if (err instanceof PareaAIError) {
console.log(err.statusCode);
console.log(err.message);
console.log(err.body);
}
}
Request Options
Each method in the SDK accepts an additional optional parameter where you can specify request options such as a timeout.
const completion = await parea.completion(..., {
timeoutInSeconds: 40 // wait 40 seconds for this call
});
Beta status
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your package.json file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
Contributing
While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!