@promptbook/langtail
Version:
It's time for a paradigm shift. The future of software in plain English, French or Latin
21 lines (20 loc) • 761 B
TypeScript
import type { ClientOptions } from 'openai';
import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
import type { string_user_id } from '../../types/typeAliases';
/**
* Options for `OpenAiExecutionTools`
*
* This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
* Rest is used by the `OpenAiExecutionTools`.
*
* @public exported from `@promptbook/openai`
*/
export type OpenAiExecutionToolsOptions = CommonToolsOptions & ClientOptions & {
/**
* A unique identifier representing your end-user, which can help OpenAI to monitor
* and detect abuse.
*
* @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids
*/
userId: string_user_id | null;
};