generative-ts

Interface CohereChatOptions

interface CohereChatOptions {
    $prompt: string;
    chat_history?: CohereChatHistoryItem[];
    citation_quality?: string;
    conversation_id?: string;
    documents?: Record<string, string>[];
    examplePairs?: {
        assistant: string;
        user: string;
    }[];
    force_single_step?: boolean;
    frequency_penalty?: number;
    k?: number;
    max_input_tokens?: number;
    max_tokens?: number;
    modelId: string;
    p?: number;
    preamble?: string;
    presence_penalty?: number;
    prompt_truncation?: string;
    search_queries_only?: boolean;
    seed?: number;
    stop_sequences?: string[];
    stream?: boolean;
    system?: string;
    temperature?: number;
    tool_results?: CohereChatToolExecutionResult[];
    tools?: {
        description: string;
        name: string;
        parameter_definitions?: Record<string, {
            description?: string;
            required?: boolean;
            type: string;
        }>;
    }[];
}

Hierarchy

  • ModelRequestOptions
  • FewShotRequestOptions
    • CohereChatOptions

Properties

$prompt chat_history? citation_quality? conversation_id? documents? examplePairs? force_single_step? frequency_penalty? k? max_input_tokens? max_tokens? modelId p? preamble? presence_penalty? prompt_truncation? search_queries_only? seed? stop_sequences? stream? system? temperature? tool_results? tools?

Properties

$prompt

$prompt: string

Optional chat_history

chat_history?: CohereChatHistoryItem[]

Optional citation_quality

citation_quality?: string

Optional conversation_id

conversation_id?: string

Optional documents

documents?: Record<string, string>[]

Optional examplePairs

examplePairs?: {
    assistant: string;
    user: string;
}[]

Type declaration

  • assistant: string
  • user: string

Optional force_single_step

force_single_step?: boolean

Optional frequency_penalty

frequency_penalty?: number

Optional k

k?: number

Optional max_input_tokens

max_input_tokens?: number

Optional max_tokens

max_tokens?: number

modelId

modelId: string

Optional p

p?: number

Optional preamble

preamble?: string

Optional presence_penalty

presence_penalty?: number

Optional prompt_truncation

prompt_truncation?: string

Optional search_queries_only

search_queries_only?: boolean

Optional seed

seed?: number

Optional stop_sequences

stop_sequences?: string[]

Optional stream

stream?: boolean

Optional system

system?: string

Optional temperature

temperature?: number

Optional tool_results

tool_results?: CohereChatToolExecutionResult[]

Optional tools

tools?: {
    description: string;
    name: string;
    parameter_definitions?: Record<string, {
        description?: string;
        required?: boolean;
        type: string;
    }>;
}[]

Type declaration

  • description: string
  • name: string
  • Optional parameter_definitions?: Record<string, {
        description?: string;
        required?: boolean;
        type: string;
    }>