Interface AOAI Function in 24
- App
- System Application
- Namespace
- System.AI
Versions171819202122232425262728latest
Source in 24
src/System Application/App/AI/src/Azure OpenAI/Chat Completion/Tools/AOAIFunction.Interface.al33 lines, Copyright (c) Microsoft Corporation. MIT
// ------------------------------------------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
// ------------------------------------------------------------------------------------------------
namespace System.AI;
interface "AOAI Function"
{
Access = Public;
/// <summary>
/// Get the prompt for the Function. Function prompt object describes the Function and the should contain the following fields:
/// - Type: The name of the Function, currently only function type is supported. For functions following fields are allowed:
/// -- Name: The name of the Function. (Required)
/// -- Description: The description of the Function. (Optional)
/// -- Parameters: The parameters of the Function. (Required)
/// More details can be found here: https://go.microsoft.com/fwlink/?linkid=2254538
/// </summary>
procedure GetPrompt(): JsonObject;
/// <summary>
/// This function is invoked as a response from Azure Open AI.
/// -Arguments: The expected parameters of the Function defined.
/// The function returns a variant, and it's up to the implementation to decide what to return.
/// </summary>
procedure Execute(Arguments: JsonObject): Variant;
/// <summary>
/// Get the name of the function.
/// </summary>
/// <remarks>This needs to match the function name in GetPrompt.</remarks>
procedure GetName(): Text;
}Procedures, 3
| Name | Parameters | Returns | Access | Obsolete |
|---|---|---|---|---|
| GetPrompt | () | JsonObject | public | - |
| Execute | (JsonObject) | Variant | public | - |
| GetName | () | Text | public | - |