Skip to content

Latest commit

 

History

History
254 lines (167 loc) · 6.07 KB

README.md

File metadata and controls

254 lines (167 loc) · 6.07 KB
Raw

GenkitRedis

A Redis Plugin for GenKit that adds Redis for efficient state storage, trace storage, caching, and rate limiting..

Chat on Discord

License

About

Caution

Vectors support is still in development (indexer, retriever) and not available here.

This plugin facilitates seamless interaction with Redis in GenKit for storing flow states and traces, managing cached data, and implementing rate limiting mechanisms, enhancing the scalability and performance of applications built with the GenKit AI framework.

npm install @invertase/genkit-plugin-redis

Examples

See the examples directory for sample code demonstrating how to use the Redis plugin in a GenKit application.

API Reference

redis

Initializes the Redis plugin.

import { configureGenkit } from "@genkit-ai/core";
import { redis } from "@invertase/genkit-plugin-redis";

configureGenkit({
  plugins: [
    redis({
      // Tell the plugin where to connect, if not provided
      // it defaults to localhost:6379 as below:
      // connectionString: "redis://localhost:6379",

      // Optional
      flowStateStore: {
        // The Redis key to use for storing flow states.
        storageKey: "flowState",
      },

      // Optional
      traceStore: {
        // The Redis key to use for storing trace data.
        storageKey: "trace",
      },
    }),
  ],
  enableTracingAndMetrics: true,
  // Tell GenKit to use the Redis plugin for flow state.
  flowStateStore: "redis",
  // Tell GenKit to use the Redis plugin for trace data.
  traceStore: "redis",
});

Parameters:

  • params (optional): RedisPluginParams configuration for initializing the Redis client.

Returns:

  • An object containing:
    • flowStateStore: An instance of RedisFlowStateStore.
    • traceStore: An instance of RedisTraceStore.

Store Operations

clearTraceStore

Clears all entries in the trace store. Caution: This will delete all traces from the store.

Usage:

await clearTraceStore();

clearFlowStore

Clears all entries in the flow state store. Caution: This will delete all flow states from the store.

Usage:

await clearFlowStore();

Cache Operations

clearCache

Clears all values from the cache or those matching a specific prefix.

Parameters:

  • prefix (optional): A string prefix to filter which keys to clear from the cache. If not provided, all keys will be deleted.

Usage:

await clearCache(prefix);

cacheSet

Sets a value in the cache.

Parameters:

  • key: The key to set in the cache.
  • value: The value to set in the cache. If null, the key will be deleted from the cache.
  • ttlSeconds (optional): The time to live for the key in seconds. If not provided, the key will not expire.

Usage:

await cacheSet(key, value, ttlSeconds);

cacheGet

Gets a value from the cache.

Parameters:

  • key: The key to get from the cache.

Returns:

  • The value from the cache, or null if the key does not exist or has expired.

Usage:

const value = await cacheGet<T>(key);

cacheFunction

Caches the result of a function.

Parameters:

  • key: The key to cache the result under.
  • fn: The callback function to execute and cache the result of.
  • ttlSeconds (optional): The time to live for the cached result in seconds. If not provided, the result will not expire.

Returns:

  • The result of the cached function.

Usage:

const result = await cacheFunction(key, () => myFunction(), ttlSeconds);

Rate Limiting Operations

rateLimit

Checks if a rate limit is exceeded for a given identifier. This counts as a single request for the given identifier.

Parameters:

  • identifier: The identifier to check the rate limit for, e.g., a user ID or a session ID.
  • limit: The maximum number of requests allowed in a given time period.
  • limitIntervalSeconds: The time period in seconds for which the limit is applied.

Returns:

  • true if the rate limit is exceeded, false otherwise.

Usage:

const isRateLimited = await rateLimit(identifier, limit, limitIntervalSeconds);

rateLimitWithStatus

Checks the rate limit status for a given identifier. This counts as a single request for the given identifier.

Parameters:

  • identifier: The identifier to check the rate limit for, e.g., a user ID or a session ID.
  • limit: The maximum number of requests allowed in a given time period.
  • limitIntervalSeconds: The time period in seconds for which the limit is applied.

Returns:

  • The rate limit status for the identifier.

Usage:

const status = await rateLimitWithStatus(
  identifier,
  limit,
  limitIntervalSeconds,
);

resetRateLimit

Resets the rate limit for a given identifier.

Parameters:

  • identifier: The identifier to reset the rate limit for, e.g., a user ID or a session ID.

Usage:

await resetRateLimit(identifier);

clearRateLimits

Clears all rate limits.

Usage:

await clearRateLimits();

Built and maintained by Invertase.