Interface PluginOptions

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

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

Hierarchy

  • CommonPluginOptions
    • PluginOptions

Properties

experimental_debugTraces? googleAuth? location models? projectId?

Properties

Optionalexperimental_debugTraces

experimental_debugTraces?: boolean

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

OptionalgoogleAuth

googleAuth?: GoogleAuthOptions<JSONClient>

Provide custom authentication configuration for connecting to Vertex AI.

location

location: string

The Google Cloud region to call.

Optionalmodels

models?: (
    | string
    | ModelReference<
        z.ZodObject<
            z.objectUtil.extendShape<
                {
                    maxOutputTokens: z.ZodOptional<z.ZodNumber>;
                    stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
                    temperature: z.ZodOptional<z.ZodNumber>;
                    topK: z.ZodOptional<z.ZodNumber>;
                    topP: z.ZodOptional<z.ZodNumber>;
                    version: z.ZodOptional<z.ZodString>;
                },
                {
                    functionCallingConfig: z.ZodOptional<
                        z.ZodObject<
                            {
                                allowedFunctionNames: z.ZodOptional<(...)>;
                                mode: z.ZodOptional<(...)>;
                            },
                            "strip",
                            z.ZodTypeAny,
                            {
                                allowedFunctionNames?: (...)
                                | (...);
                                mode?: (...) | (...) | (...) | (...) | (...);
                            },
                            {
                                allowedFunctionNames?: (...)
                                | (...);
                                mode?: (...) | (...) | (...) | (...) | (...);
                            },
                        >,
                    >;
                    googleSearchRetrieval: z.ZodOptional<
                        z.ZodObject<
                            { disableAttribution: z.ZodOptional<(...)> },
                            "strip",
                            z.ZodTypeAny,
                            { disableAttribution?: (...) | (...) | (...) },
                            { disableAttribution?: (...) | (...) | (...) },
                        >,
                    >;
                    location: z.ZodOptional<z.ZodString>;
                    maxOutputTokens: z.ZodOptional<z.ZodNumber>;
                    safetySettings: z.ZodOptional<
                        z.ZodArray<
                            z.ZodObject<
                                { category: ...; threshold: ... },
                                "strip",
                                z.ZodTypeAny,
                                { category: ...; threshold: ... },
                                { category: ...; threshold: ... },
                            >,
                            "many",
                        >,
                    >;
                    temperature: z.ZodOptional<z.ZodNumber>;
                    topK: z.ZodOptional<z.ZodNumber>;
                    topP: z.ZodOptional<z.ZodNumber>;
                    vertexRetrieval: z.ZodOptional<
                        z.ZodObject<
                            {
                                datastore: z.ZodObject<(...), (...), (...), (...), (...)>;
                                disableAttribution: z.ZodOptional<(...)>;
                            },
                            "strip",
                            z.ZodTypeAny,
                            {
                                datastore: { dataStoreId: ...; location?: ...; projectId?: ... };
                                disableAttribution?: (...) | (...) | (...);
                            },
                            {
                                datastore: { dataStoreId: ...; location?: ...; projectId?: ... };
                                disableAttribution?: (...) | (...) | (...);
                            },
                        >,
                    >;
                },
            >,
            "passthrough",
            z.ZodTypeAny,
            z.objectOutputType<
                z.objectUtil.extendShape<
                    {
                        maxOutputTokens: z.ZodOptional<z.ZodNumber>;
                        stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
                        temperature: z.ZodOptional<z.ZodNumber>;
                        topK: z.ZodOptional<z.ZodNumber>;
                        topP: z.ZodOptional<z.ZodNumber>;
                        version: z.ZodOptional<z.ZodString>;
                    },
                    {
                        functionCallingConfig: z.ZodOptional<
                            z.ZodObject<
                                { allowedFunctionNames: ...; mode: ... },
                                "strip",
                                z.ZodTypeAny,
                                { allowedFunctionNames?: ...; mode?: ... },
                                { allowedFunctionNames?: ...; mode?: ... },
                            >,
                        >;
                        googleSearchRetrieval: z.ZodOptional<
                            z.ZodObject<
                                { disableAttribution: ... },
                                "strip",
                                z.ZodTypeAny,
                                { disableAttribution?: ... },
                                { disableAttribution?: ... },
                            >,
                        >;
                        location: z.ZodOptional<z.ZodString>;
                        maxOutputTokens: z.ZodOptional<z.ZodNumber>;
                        safetySettings: z.ZodOptional<
                            z.ZodArray<z.ZodObject<(...), (...), (...), (...), (...)>, "many">,
                        >;
                        temperature: z.ZodOptional<z.ZodNumber>;
                        topK: z.ZodOptional<z.ZodNumber>;
                        topP: z.ZodOptional<z.ZodNumber>;
                        vertexRetrieval: z.ZodOptional<
                            z.ZodObject<
                                { datastore: ...; disableAttribution: ... },
                                "strip",
                                z.ZodTypeAny,
                                { datastore: ...; disableAttribution?: ... },
                                { datastore: ...; disableAttribution?: ... },
                            >,
                        >;
                    },
                >,
                z.ZodTypeAny,
                "passthrough",
            >,
            z.objectInputType<
                z.objectUtil.extendShape<
                    {
                        maxOutputTokens: z.ZodOptional<z.ZodNumber>;
                        stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
                        temperature: z.ZodOptional<z.ZodNumber>;
                        topK: z.ZodOptional<z.ZodNumber>;
                        topP: z.ZodOptional<z.ZodNumber>;
                        version: z.ZodOptional<z.ZodString>;
                    },
                    {
                        functionCallingConfig: z.ZodOptional<
                            z.ZodObject<
                                { allowedFunctionNames: ...; mode: ... },
                                "strip",
                                z.ZodTypeAny,
                                { allowedFunctionNames?: ...; mode?: ... },
                                { allowedFunctionNames?: ...; mode?: ... },
                            >,
                        >;
                        googleSearchRetrieval: z.ZodOptional<
                            z.ZodObject<
                                { disableAttribution: ... },
                                "strip",
                                z.ZodTypeAny,
                                { disableAttribution?: ... },
                                { disableAttribution?: ... },
                            >,
                        >;
                        location: z.ZodOptional<z.ZodString>;
                        maxOutputTokens: z.ZodOptional<z.ZodNumber>;
                        safetySettings: z.ZodOptional<
                            z.ZodArray<z.ZodObject<(...), (...), (...), (...), (...)>, "many">,
                        >;
                        temperature: z.ZodOptional<z.ZodNumber>;
                        topK: z.ZodOptional<z.ZodNumber>;
                        topP: z.ZodOptional<z.ZodNumber>;
                        vertexRetrieval: z.ZodOptional<
                            z.ZodObject<
                                { datastore: ...; disableAttribution: ... },
                                "strip",
                                z.ZodTypeAny,
                                { datastore: ...; disableAttribution?: ... },
                                { datastore: ...; disableAttribution?: ... },
                            >,
                        >;
                    },
                >,
                z.ZodTypeAny,
                "passthrough",
            >,
        >,
    >
)[]

OptionalprojectId

projectId?: string

The Google Cloud project id to call.

Settings

Member Visibility

On This Page

Properties