Genkit JS API reference
    Preparing search index...

    Function restartTool

    Copyright 2024 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.

    • Beta

      restartTool constructs a tool request corresponding to the provided interrupt tool request that will then re-trigger the tool after e.g. a user confirms. In contrast to ToolAction.restart, this is a standalone utility that does not require an active ToolAction instance.

      Parameters

      • interrupt: {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text?: undefined;
            toolRequest: {
                input?: unknown;
                name: string;
                partial?: boolean;
                ref?: string;
            };
            toolResponse?: undefined;
        }

        The interrupt tool request you want to restart.

      • OptionalresumedMetadata: any

        The metadata you want to provide to the tool to aide in reprocessing. Defaults to true if none is supplied.

      • Optionaloptions: { replaceInput?: any }

        Additional options for restarting the tool.

        • OptionalreplaceInput?: any

          Replace the existing input arguments to the tool with different ones.

      Returns {
          custom?: Record<string, unknown>;
          data?: unknown;
          media?: undefined;
          metadata?: Record<string, unknown>;
          reasoning?: undefined;
          resource?: undefined;
          text?: undefined;
          toolRequest: {
              input?: unknown;
              name: string;
              partial?: boolean;
              ref?: string;
          };
          toolResponse?: undefined;
      }

    Settings

    Member Visibility