Combined plugin options, extending common options with subplugin-specific options

interface PluginOptions {
    googleAuth?: GoogleAuthOptions<JSONClient>;
    location: string;
    models?: (
        | string
        | ModelReference<
            ZodObject<
                extendShape<
                    {
                        maxOutputTokens: ZodOptional<ZodNumber>;
                        stopSequences: ZodOptional<ZodArray<ZodString, "many">>;
                        temperature: ZodOptional<ZodNumber>;
                        topK: ZodOptional<ZodNumber>;
                        topP: ZodOptional<ZodNumber>;
                        version: ZodOptional<ZodString>;
                    },
                    {
                        functionCallingConfig: ZodOptional<
                            ZodObject<
                                {
                                    allowedFunctionNames: ZodOptional<(...)>;
                                    mode: ZodOptional<(...)>;
                                },
                                "strip",
                                ZodTypeAny,
                                {
                                    allowedFunctionNames?: (...)
                                    | (...);
                                    mode?: (...) | (...) | (...) | (...) | (...);
                                },
                                {
                                    allowedFunctionNames?: (...)
                                    | (...);
                                    mode?: (...) | (...) | (...) | (...) | (...);
                                },
                            >,
                        >;
                        googleSearchRetrieval: ZodOptional<
                            ZodObject<
                                { disableAttribution: ZodOptional<(...)> },
                                "strip",
                                ZodTypeAny,
                                { disableAttribution?: (...) | (...) | (...) },
                                { disableAttribution?: (...) | (...) | (...) },
                            >,
                        >;
                        location: ZodOptional<ZodString>;
                        safetySettings: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    { category: ...; threshold: ... },
                                    "strip",
                                    ZodTypeAny,
                                    { category: ...; threshold: ... },
                                    { category: ...; threshold: ... },
                                >,
                                "many",
                            >,
                        >;
                        vertexRetrieval: ZodOptional<
                            ZodObject<
                                {
                                    datastore: ZodObject<(...), (...), (...), (...), (...)>;
                                    disableAttribution: ZodOptional<(...)>;
                                },
                                "strip",
                                ZodTypeAny,
                                {
                                    datastore: { dataStoreId: ...; location?: ...; projectId?: ... };
                                    disableAttribution?: (...) | (...) | (...);
                                },
                                {
                                    datastore: { dataStoreId: ...; location?: ...; projectId?: ... };
                                    disableAttribution?: (...) | (...) | (...);
                                },
                            >,
                        >;
                    },
                >,
                "strip",
                ZodTypeAny,
                {
                    functionCallingConfig?: {
                        allowedFunctionNames?: string[];
                        mode?: "MODE_UNSPECIFIED"
                        | "AUTO"
                        | "ANY"
                        | "NONE";
                    };
                    googleSearchRetrieval?: { disableAttribution?: boolean };
                    location?: string;
                    maxOutputTokens?: number;
                    safetySettings?: {
                        category: HarmCategory;
                        threshold: HarmBlockThreshold;
                    }[];
                    stopSequences?: string[];
                    temperature?: number;
                    topK?: number;
                    topP?: number;
                    version?: string;
                    vertexRetrieval?: {
                        datastore: {
                            dataStoreId: string;
                            location?: string;
                            projectId?: string;
                        };
                        disableAttribution?: boolean;
                    };
                },
                {
                    functionCallingConfig?: {
                        allowedFunctionNames?: string[];
                        mode?: "MODE_UNSPECIFIED"
                        | "AUTO"
                        | "ANY"
                        | "NONE";
                    };
                    googleSearchRetrieval?: { disableAttribution?: boolean };
                    location?: string;
                    maxOutputTokens?: number;
                    safetySettings?: {
                        category: HarmCategory;
                        threshold: HarmBlockThreshold;
                    }[];
                    stopSequences?: string[];
                    temperature?: number;
                    topK?: number;
                    topP?: number;
                    version?: string;
                    vertexRetrieval?: {
                        datastore: {
                            dataStoreId: string;
                            location?: string;
                            projectId?: string;
                        };
                        disableAttribution?: boolean;
                    };
                },
            >,
        >
    )[];
    projectId?: string;
}

Hierarchy

  • CommonPluginOptions
    • PluginOptions

Properties

googleAuth?: GoogleAuthOptions<JSONClient>

Provide custom authentication configuration for connecting to Vertex AI.

location: string

The Google Cloud region to call.

models?: (
    | string
    | ModelReference<
        ZodObject<
            extendShape<
                {
                    maxOutputTokens: ZodOptional<ZodNumber>;
                    stopSequences: ZodOptional<ZodArray<ZodString, "many">>;
                    temperature: ZodOptional<ZodNumber>;
                    topK: ZodOptional<ZodNumber>;
                    topP: ZodOptional<ZodNumber>;
                    version: ZodOptional<ZodString>;
                },
                {
                    functionCallingConfig: ZodOptional<
                        ZodObject<
                            {
                                allowedFunctionNames: ZodOptional<(...)>;
                                mode: ZodOptional<(...)>;
                            },
                            "strip",
                            ZodTypeAny,
                            {
                                allowedFunctionNames?: (...)
                                | (...);
                                mode?: (...) | (...) | (...) | (...) | (...);
                            },
                            {
                                allowedFunctionNames?: (...)
                                | (...);
                                mode?: (...) | (...) | (...) | (...) | (...);
                            },
                        >,
                    >;
                    googleSearchRetrieval: ZodOptional<
                        ZodObject<
                            { disableAttribution: ZodOptional<(...)> },
                            "strip",
                            ZodTypeAny,
                            { disableAttribution?: (...) | (...) | (...) },
                            { disableAttribution?: (...) | (...) | (...) },
                        >,
                    >;
                    location: ZodOptional<ZodString>;
                    safetySettings: ZodOptional<
                        ZodArray<
                            ZodObject<
                                { category: ...; threshold: ... },
                                "strip",
                                ZodTypeAny,
                                { category: ...; threshold: ... },
                                { category: ...; threshold: ... },
                            >,
                            "many",
                        >,
                    >;
                    vertexRetrieval: ZodOptional<
                        ZodObject<
                            {
                                datastore: ZodObject<(...), (...), (...), (...), (...)>;
                                disableAttribution: ZodOptional<(...)>;
                            },
                            "strip",
                            ZodTypeAny,
                            {
                                datastore: { dataStoreId: ...; location?: ...; projectId?: ... };
                                disableAttribution?: (...) | (...) | (...);
                            },
                            {
                                datastore: { dataStoreId: ...; location?: ...; projectId?: ... };
                                disableAttribution?: (...) | (...) | (...);
                            },
                        >,
                    >;
                },
            >,
            "strip",
            ZodTypeAny,
            {
                functionCallingConfig?: {
                    allowedFunctionNames?: string[];
                    mode?: "MODE_UNSPECIFIED"
                    | "AUTO"
                    | "ANY"
                    | "NONE";
                };
                googleSearchRetrieval?: { disableAttribution?: boolean };
                location?: string;
                maxOutputTokens?: number;
                safetySettings?: {
                    category: HarmCategory;
                    threshold: HarmBlockThreshold;
                }[];
                stopSequences?: string[];
                temperature?: number;
                topK?: number;
                topP?: number;
                version?: string;
                vertexRetrieval?: {
                    datastore: {
                        dataStoreId: string;
                        location?: string;
                        projectId?: string;
                    };
                    disableAttribution?: boolean;
                };
            },
            {
                functionCallingConfig?: {
                    allowedFunctionNames?: string[];
                    mode?: "MODE_UNSPECIFIED"
                    | "AUTO"
                    | "ANY"
                    | "NONE";
                };
                googleSearchRetrieval?: { disableAttribution?: boolean };
                location?: string;
                maxOutputTokens?: number;
                safetySettings?: {
                    category: HarmCategory;
                    threshold: HarmBlockThreshold;
                }[];
                stopSequences?: string[];
                temperature?: number;
                topK?: number;
                topP?: number;
                version?: string;
                vertexRetrieval?: {
                    datastore: {
                        dataStoreId: string;
                        location?: string;
                        projectId?: string;
                    };
                    disableAttribution?: boolean;
                };
            },
        >,
    >
)[]
projectId?: string

The Google Cloud project id to call.