View portkey-ai on Snyk Open Source Advisor

Package Health Score

80 / 100

security
No known security issues
popularity
Recognized
maintenance
Healthy
community
Sustainable

Explore Similar Packages

shinobi
48

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.5.4	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.4.0	\|	09/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.16	\|	10/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (18,556)

GitHub Stars: 26
Forks: 8
Contributors: 9

Direct Usage Popularity

The npm package portkey-ai receives a total of 18,556 downloads a week. As such, we scored portkey-ai popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package portkey-ai, we found that it has been starred 26 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 9
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 4
Open PR: 1
Last Release: 29 days ago
Last Commit: 29 days ago

Further analysis of the maintenance status of portkey-ai based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that portkey-ai demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 1 year
Dependencies: 3 Direct
Versions: 37
Install Size: 7.45 MB
Dist-tags: 1
# of Files: 264
Maintainers: 1
TS Typings: No

portkey-ai has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Control Panel for AI Apps

npm install portkey-ai

Features

The Portkey SDK is built on top of the OpenAI SDK, allowing you to seamlessly integrate Portkey's advanced features while retaining full compatibility with OpenAI methods. With Portkey, you can enhance your interactions with OpenAI or any other OpenAI-like provider by leveraging robust monitoring, reliability, prompt management, and more features - without modifying much of your existing code.

AI Gateway

Unified API Signature If you've used OpenAI, you already know how to use Portkey with any other provider.	Interoperability Write once, run with any provider. Switch between any model from_any provider seamlessly.
Automated Fallbacks & Retries Ensure your application remains functional even if a primary service fails.	Load Balancing Efficiently distribute incoming requests among multiple models.
Semantic Caching Reduce costs and latency by intelligently caching results.	Virtual Keys Secure your LLM API keys by storing them in Portkey vault and using disposable virtual keys.
Request Timeouts Manage unpredictable LLM latencies effectively by setting custom request timeouts on requests.

Observability

Logging Keep track of all requests for monitoring and debugging.	Requests Tracing Understand the journey of each request for optimization.
Custom Metadata Segment and categorize requests for better insights.	Feedbacks Collect and analyse weighted feedback on requests from users.
Analytics Track your app & LLM's performance with 40+ production-critical metrics in a single place.

Usage

Prerequisites

Sign up on Portkey and grab your Portkey API Key
Add your OpenAI key to Portkey's Virtual Keys page and keep it handy

# Installing the SDK

$ npm install portkey-ai
$ export PORTKEY_API_KEY="PORTKEY_API_KEY"

Making a Request to OpenAI

Portkey fully adheres to the OpenAI SDK signature. You can instantly switch to Portkey and start using our production features right out of the box.
Just replace import OpenAI from 'openai' with import Portkey from 'portkey-ai':

import Portkey from 'portkey-ai';

const portkey = new Portkey({
    virtualKey: "VIRTUAL_KEY"
})

async function main() {
    const chatCompletion = await portkey.chat.completions.create({
        messages: [{ role: 'user', content: 'Say this is a test' }],
        model: 'gpt-4',
    });

    console.log(chatCompletion.choices);
};

main();

Check out Portkey docs for the full list of supported providers

Contributing

Get started by checking out Github issues. Email us at support@portkey.ai or just ping on Discord to chat.

portkey-ai dependencies

agentkeepalive dotenv openai

portkey-ai development dependencies

@babel/core @babel/preset-env @babel/preset-typescript @jest/globals @types/jest @types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser babel-jest eslint eslint-config-prettier eslint-plugin-prettier eslint-plugin-unused-imports jest prettier ts-jest ts-node typescript

FAQs

What is portkey-ai?

Node client library for the Portkey API. Visit Snyk Advisor to see a full health score report for portkey-ai, including popularity, security, maintenance & community analysis.

Is portkey-ai popular?

The npm package portkey-ai receives a total of 18,556 weekly downloads. As such, portkey-ai popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is portkey-ai well maintained?

We found that portkey-ai demonstrated a healthy version release cadence and project activity. It has a community of 9 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is portkey-ai safe to use?

The npm package portkey-ai was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 3 December-2024, at 00:10 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP