ExtensionsOpenAIModelFactory.ResponsesCustomToolParam Method

Definition

Custom tool.

public static Azure.AI.Extensions.OpenAI.ResponsesCustomToolParam ResponsesCustomToolParam(string name = default, string description = default, Azure.AI.Extensions.OpenAI.ResponsesCustomToolParamFormat format = default, bool? shouldDeferLoading = default);
static member ResponsesCustomToolParam : string * string * Azure.AI.Extensions.OpenAI.ResponsesCustomToolParamFormat * Nullable<bool> -> Azure.AI.Extensions.OpenAI.ResponsesCustomToolParam
Public Shared Function ResponsesCustomToolParam (Optional name As String = Nothing, Optional description As String = Nothing, Optional format As ResponsesCustomToolParamFormat = Nothing, Optional shouldDeferLoading As Nullable(Of Boolean) = Nothing) As ResponsesCustomToolParam

Parameters

name
String

The name of the custom tool, used to identify it in tool calls.

description
String

Optional description of the custom tool, used to provide more context.

format
ResponsesCustomToolParamFormat

The input format for the custom tool. Default is unconstrained text.

shouldDeferLoading
Nullable<Boolean>

Whether this tool should be deferred and discovered via tool search.

Returns

A new ResponsesCustomToolParam instance for mocking.

Applies to