Genkit JS API reference
    Preparing search index...

    Interface OperationOptions

    Options for Genkit.checkOperation and Genkit.cancelOperation.

    Extends the generic BackgroundActionRunOptions with a top-level config field so callers can supply per-call configuration overrides (e.g. baseUrl, location) for calls that don't otherwise carry a request config.

    interface OperationOptions {
        config?: Record<string, any>;
        context?: ActionContext;
        telemetryLabels?: Record<string, string>;
    }

    Hierarchy

    • BackgroundActionRunOptions
      • OperationOptions
    Index

    Properties

    config? context? telemetryLabels?

    Properties

    config?: Record<string, any>

    Per-call configuration overrides. Because operation check/cancel calls don't include the original request's config, this is the mechanism for supplying critical config options (e.g. baseUrl, location) at call time.

    Under the hood this is delivered to plugins via options.context.config.

    context?: ActionContext

    Additional runtime context data (ex. auth context data).

    telemetryLabels?: Record<string, string>

    Additional span attributes to apply to OT spans.

    Settings

    Member Visibility

    On This Page

    Properties