ProjectsOpenAIModelFactory.OpenAPIFunctionDefinition Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The input definition information for an openapi function.
public static Azure.AI.Projects.OpenAI.OpenAPIFunctionDefinition OpenAPIFunctionDefinition(string name = default, string description = default, BinaryData spec = default, Azure.AI.Projects.OpenAI.OpenAPIAuthenticationDetails auth = default, System.Collections.Generic.IEnumerable<string> defaultParams = default, System.Collections.Generic.IEnumerable<Azure.AI.Projects.OpenAI.OpenAPIFunctionEntry> functions = default);static member OpenAPIFunctionDefinition : string * string * BinaryData * Azure.AI.Projects.OpenAI.OpenAPIAuthenticationDetails * seq<string> * seq<Azure.AI.Projects.OpenAI.OpenAPIFunctionEntry> -> Azure.AI.Projects.OpenAI.OpenAPIFunctionDefinitionPublic Shared Function OpenAPIFunctionDefinition (Optional name As String = Nothing, Optional description As String = Nothing, Optional spec As BinaryData = Nothing, Optional auth As OpenAPIAuthenticationDetails = Nothing, Optional defaultParams As IEnumerable(Of String) = Nothing, Optional functions As IEnumerable(Of OpenAPIFunctionEntry) = Nothing) As OpenAPIFunctionDefinitionParameters
- 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.
- spec
- BinaryData
The openapi function shape, described as a JSON Schema object.
Open API authentication details.
- defaultParams
- IEnumerable<String>
List of OpenAPI spec parameters that will use user-provided defaults.
- functions
- IEnumerable<OpenAPIFunctionEntry>
List of function definitions used by OpenApi tool.
Returns
A new OpenAPIFunctionDefinition instance for mocking.
