langchain.js
    Preparing search index...

    Interface EvaluateOptions

    interface EvaluateOptions {
        client?: Client;
        data: DataT;
        description?: string;
        evaluationConcurrency?: number;
        evaluators?: EvaluatorT[];
        experimentPrefix?: string;
        includeAttachments?: boolean;
        maxConcurrency?: number;
        metadata?: KVMap;
        numRepetitions?: number;
        summaryEvaluators?: SummaryEvaluatorT[];
        targetConcurrency?: number;
    }

    Hierarchy

    • BaseEvaluateOptions
      • EvaluateOptions
    Index

    Properties

    client? data description? evaluationConcurrency? evaluators? experimentPrefix? includeAttachments? maxConcurrency? metadata? numRepetitions? summaryEvaluators? targetConcurrency?

    Properties

    client?: Client

    The LangSmith client to use.

    undefined
    data: DataT

    The dataset to evaluate on. Can be a dataset name, a list of examples, or a generator of examples.

    description?: string

    A free-form description of the experiment.

    evaluationConcurrency?: number

    The maximum number of concurrent evaluators to run. If not provided, defaults to maxConcurrency when set.

    undefined
    evaluators?: EvaluatorT[]

    A list of evaluators to run on each example.

    undefined
    experimentPrefix?: string

    A prefix to provide for your experiment name.

    undefined
    includeAttachments?: boolean

    Whether to use attachments for the experiment.

    false
    maxConcurrency?: number

    The maximum concurrency to use for predictions/evaluations when a more specific concurrency option is not provided.

    undefined
    metadata?: KVMap

    Metadata to attach to the experiment.

    undefined
    numRepetitions?: number

    The number of repetitions to perform. Each example will be run this many times.

    1
    summaryEvaluators?: SummaryEvaluatorT[]

    A list of summary evaluators to run on the entire dataset.

    undefined
    targetConcurrency?: number

    The maximum number of concurrent predictions to run. If not provided, defaults to maxConcurrency when set.

    undefined

    Settings

    Member Visibility

    On This Page

    Properties