ToolType Class

public final class ToolType
extends ExpandableStringEnum<ToolType>

Defines values for ToolType.

Field Summary

Modifier and Type Field and Description
static final ToolType A2A

Static value a2a for ToolType.

static final ToolType A2A_PREVIEW

Static value a2a_preview for ToolType.

static final ToolType APPLY_PATCH

Static value apply_patch for ToolType.

static final ToolType AZURE_AI_SEARCH

Static value azure_ai_search for ToolType.

static final ToolType AZURE_FUNCTION

Static value azure_function for ToolType.

static final ToolType BING_CUSTOM_SEARCH_PREVIEW

Static value bing_custom_search_preview for ToolType.

static final ToolType BING_GROUNDING

Static value bing_grounding for ToolType.

static final ToolType BROWSER_AUTOMATION

Static value browser_automation for ToolType.

static final ToolType BROWSER_AUTOMATION_PREVIEW

Deprecated

This legacy Browser Automation tool is deprecated and is no longer available. Use BROWSER_AUTOMATION instead. See Browser Automation documentation.

Static value browser_automation_preview for ToolType.

static final ToolType CAPTURE_STRUCTURED_OUTPUTS

Static value capture_structured_outputs for ToolType.

static final ToolType CODE_INTERPRETER

Static value code_interpreter for ToolType.

static final ToolType COMPUTER

Static value computer for ToolType.

static final ToolType COMPUTER_USE_PREVIEW

Static value computer_use_preview for ToolType.

static final ToolType CUSTOM

Static value custom for ToolType.

static final ToolType FABRIC_DATA_AGENT_PREVIEW

Static value fabric_dataagent_preview for ToolType.

static final ToolType FABRIC_IQ_PREVIEW

Static value fabric_iq_preview for ToolType.

static final ToolType FILE_SEARCH

Static value file_search for ToolType.

static final ToolType FUNCTION

Static value function for ToolType.

static final ToolType GITHUB_COPILOT_TOOLSET_PREVIEW

Static value github_copilot_toolset_preview for ToolType.

static final ToolType IMAGE_GENERATION

Static value image_generation for ToolType.

static final ToolType LOCAL_SHELL

Static value local_shell for ToolType.

static final ToolType MCP

Static value mcp for ToolType.

static final ToolType MEMORY_SEARCH_PREVIEW

Static value memory_search_preview for ToolType.

static final ToolType MICROSOFT_COPILOT_TOOLSET_PREVIEW

Static value microsoft_copilot_toolset_preview for ToolType.

static final ToolType NAMESPACE

Static value namespace for ToolType.

static final ToolType OPENAPI

Static value openapi for ToolType.

static final ToolType PROGRAMMATIC_TOOL_CALLING

Static value programmatic_tool_calling for ToolType.

static final ToolType SHAREPOINT_GROUNDING_PREVIEW

Static value sharepoint_grounding_preview for ToolType.

static final ToolType SHELL

Static value shell for ToolType.

static final ToolType TOOLBOX_SEARCH_PREVIEW

Static value toolbox_search_preview for ToolType.

static final ToolType TOOL_SEARCH

Static value tool_search for ToolType.

static final ToolType WEB_IQ_PREVIEW

Static value web_iq_preview for ToolType.

static final ToolType WEB_SEARCH

Static value web_search for ToolType.

static final ToolType WEB_SEARCH_PREVIEW

Static value web_search_preview for ToolType.

static final ToolType WORK_IQ_PREVIEW

Static value work_iq_preview for ToolType.

Constructor Summary

Constructor Description
ToolType()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of ToolType value.

Method Summary

Modifier and Type Method and Description
static ToolType fromString(String name)

Creates or finds a ToolType from its string representation.

static Collection<ToolType> values()

Gets known ToolType values.

Methods inherited from ExpandableStringEnum

Methods inherited from java.lang.Object

Field Details

A2A

public static final ToolType A2A

Static value a2a for ToolType.

A2A_PREVIEW

public static final ToolType A2A_PREVIEW

Static value a2a_preview for ToolType.

APPLY_PATCH

public static final ToolType APPLY_PATCH

Static value apply_patch for ToolType.

public static final ToolType AZURE_AI_SEARCH

Static value azure_ai_search for ToolType.

AZURE_FUNCTION

public static final ToolType AZURE_FUNCTION

Static value azure_function for ToolType.

BING_CUSTOM_SEARCH_PREVIEW

public static final ToolType BING_CUSTOM_SEARCH_PREVIEW

Static value bing_custom_search_preview for ToolType.

BING_GROUNDING

public static final ToolType BING_GROUNDING

Static value bing_grounding for ToolType.

BROWSER_AUTOMATION

public static final ToolType BROWSER_AUTOMATION

Static value browser_automation for ToolType.

BROWSER_AUTOMATION_PREVIEW

@Deprecated
public static final ToolType BROWSER_AUTOMATION_PREVIEW

Deprecated

This legacy Browser Automation tool is deprecated and is no longer available. Use BROWSER_AUTOMATION instead. See Browser Automation documentation.

Static value browser_automation_preview for ToolType.

CAPTURE_STRUCTURED_OUTPUTS

public static final ToolType CAPTURE_STRUCTURED_OUTPUTS

Static value capture_structured_outputs for ToolType.

CODE_INTERPRETER

public static final ToolType CODE_INTERPRETER

Static value code_interpreter for ToolType.

COMPUTER

public static final ToolType COMPUTER

Static value computer for ToolType.

COMPUTER_USE_PREVIEW

public static final ToolType COMPUTER_USE_PREVIEW

Static value computer_use_preview for ToolType.

CUSTOM

public static final ToolType CUSTOM

Static value custom for ToolType.

FABRIC_DATA_AGENT_PREVIEW

public static final ToolType FABRIC_DATA_AGENT_PREVIEW

Static value fabric_dataagent_preview for ToolType.

FABRIC_IQ_PREVIEW

public static final ToolType FABRIC_IQ_PREVIEW

Static value fabric_iq_preview for ToolType.

public static final ToolType FILE_SEARCH

Static value file_search for ToolType.

FUNCTION

public static final ToolType FUNCTION

Static value function for ToolType.

GITHUB_COPILOT_TOOLSET_PREVIEW

public static final ToolType GITHUB_COPILOT_TOOLSET_PREVIEW

Static value github_copilot_toolset_preview for ToolType.

IMAGE_GENERATION

public static final ToolType IMAGE_GENERATION

Static value image_generation for ToolType.

LOCAL_SHELL

public static final ToolType LOCAL_SHELL

Static value local_shell for ToolType.

MCP

public static final ToolType MCP

Static value mcp for ToolType.

MEMORY_SEARCH_PREVIEW

public static final ToolType MEMORY_SEARCH_PREVIEW

Static value memory_search_preview for ToolType.

MICROSOFT_COPILOT_TOOLSET_PREVIEW

public static final ToolType MICROSOFT_COPILOT_TOOLSET_PREVIEW

Static value microsoft_copilot_toolset_preview for ToolType.

NAMESPACE

public static final ToolType NAMESPACE

Static value namespace for ToolType.

OPENAPI

public static final ToolType OPENAPI

Static value openapi for ToolType.

PROGRAMMATIC_TOOL_CALLING

public static final ToolType PROGRAMMATIC_TOOL_CALLING

Static value programmatic_tool_calling for ToolType.

SHAREPOINT_GROUNDING_PREVIEW

public static final ToolType SHAREPOINT_GROUNDING_PREVIEW

Static value sharepoint_grounding_preview for ToolType.

SHELL

public static final ToolType SHELL

Static value shell for ToolType.

TOOLBOX_SEARCH_PREVIEW

public static final ToolType TOOLBOX_SEARCH_PREVIEW

Static value toolbox_search_preview for ToolType.

public static final ToolType TOOL_SEARCH

Static value tool_search for ToolType.

WEB_IQ_PREVIEW

public static final ToolType WEB_IQ_PREVIEW

Static value web_iq_preview for ToolType.

public static final ToolType WEB_SEARCH

Static value web_search for ToolType.

WEB_SEARCH_PREVIEW

public static final ToolType WEB_SEARCH_PREVIEW

Static value web_search_preview for ToolType.

WORK_IQ_PREVIEW

public static final ToolType WORK_IQ_PREVIEW

Static value work_iq_preview for ToolType.

Constructor Details

ToolType

@Deprecated
public ToolType()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of ToolType value.

Method Details

fromString

public static ToolType fromString(String name)

Creates or finds a ToolType from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding ToolType.

values

public static Collection<ToolType> values()

Gets known ToolType values.

Returns:

known ToolType values.

Applies to