ExtensionsOpenAIModelFactory.ResponsesOpenApiFunctionDefinition Method

Definition

Namespace:

Azure.AI.Extensions.OpenAI

Assembly:

Azure.AI.Extensions.OpenAI.dll

Package:

Azure.AI.Extensions.OpenAI v2.1.0-beta.4

Source:

ExtensionsOpenAIModelFactory.cs

The input definition information for an openapi function.

public static Azure.AI.Extensions.OpenAI.ResponsesOpenApiFunctionDefinition ResponsesOpenApiFunctionDefinition(string name = default, string description = default, System.Collections.Generic.IDictionary<string,BinaryData> specification = default, Azure.AI.Extensions.OpenAI.ResponsesOpenApiAuthDetails auth = default, System.Collections.Generic.IEnumerable<string> defaultParams = default, System.Collections.Generic.IEnumerable<Azure.AI.Extensions.OpenAI.ResponsesOpenApiFunctionDefinitionFunction> functions = default);

static member ResponsesOpenApiFunctionDefinition : string * string * System.Collections.Generic.IDictionary<string, BinaryData> * Azure.AI.Extensions.OpenAI.ResponsesOpenApiAuthDetails * seq<string> * seq<Azure.AI.Extensions.OpenAI.ResponsesOpenApiFunctionDefinitionFunction> -> Azure.AI.Extensions.OpenAI.ResponsesOpenApiFunctionDefinition

Public Shared Function ResponsesOpenApiFunctionDefinition (Optional name As String = Nothing, Optional description As String = Nothing, Optional specification As IDictionary(Of String, BinaryData) = Nothing, Optional auth As ResponsesOpenApiAuthDetails = Nothing, Optional defaultParams As IEnumerable(Of String) = Nothing, Optional functions As IEnumerable(Of ResponsesOpenApiFunctionDefinitionFunction) = Nothing) As ResponsesOpenApiFunctionDefinition

Parameters

name

String

The name of the function to be called.

description

String

A description of what the function does, used by the model to choose when and how to call the function.

specification

IDictionary<String,BinaryData>

The openapi function shape, described as a JSON Schema object.

auth

ResponsesOpenApiAuthDetails

Open API authentication details.

defaultParams

IEnumerable<String>

List of OpenAPI spec parameters that will use user-provided defaults.

functions

IEnumerable<ResponsesOpenApiFunctionDefinitionFunction>

List of function definitions used by OpenApi tool.

Returns

ResponsesOpenApiFunctionDefinition

A new ResponsesOpenApiFunctionDefinition instance for mocking.