Genkit JS API reference
    Preparing search index...

    Copyright 2025 Google LLC

    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0
    

    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

    interface PluginOptions {
        experimental_debugTraces?: boolean;
        googleAuth?: GoogleAuthOptions<JSONClient>;
        location: string;
        projectId?: string;
        rerankers: (string | VertexRerankerConfig)[];
    }

    Hierarchy

    • CommonPluginOptions
    • RerankerOptions
      • PluginOptions
    Index

    Properties

    experimental_debugTraces?: boolean

    Enables additional debug traces (e.g. raw model API call details).

    googleAuth?: GoogleAuthOptions<JSONClient>

    Provide custom authentication configuration for connecting to Vertex AI.

    location: string

    The Google Cloud region to call.

    projectId?: string

    The Google Cloud project id to call.

    rerankers: (string | VertexRerankerConfig)[]

    Configure reranker options