Note: There is a newer version (0.2.5) of this package available. Click here to view docs for the latest version.

nadheeshjihan/agent

0.1.25

Functions

extractToolsFromOpenApiSpec

function extractToolsFromOpenApiSpec(string filePath, *AdditionInfoFlags additionInfoFlags) returns ApiSpecification|error

Parameters

filePath string -

additionInfoFlags *AdditionInfoFlags -

Classes

agent: Agent

Isolated

Agent implementation to perform tools with LLMs to add computational power and knowledge to the LLMs

Constructor

Initialize an Agent

init (LlmModel model, (ToolKit|Tool)... tools)

model LlmModel - LLM model instance

tools (ToolKit|Tool)... -

createAgentExecutor

Isolated Function

function createAgentExecutor(string query, string|map<json> context) returns AgentExecutor

Parameters

query string -

context string|map<json> (default {}) -

iterator

Isolated Function

function iterator(string query, string|map<json> context) returns AgentIterator

Parameters

query string -

context string|map<json> (default {}) -

run

Isolated Function

function run(string query, int maxIter, string|map<json> context, boolean verbose) returns ExecutorOutput[]

Execute the agent for a given user's query

Parameters

query string - Natural langauge commands to the agent

maxIter int (default 5) - No. of max iterations that agent will run to execute the task

context string|map<json> (default {}) - Context values to be used by the agent to execute the task

verbose boolean (default true) -

Return Type

ExecutorOutput[] - Returns error, in case of a failure

agent: AgentExecutor

Isolated Function

function next() returns record {| value ExecutorOutput |}?

agent: AgentIterator

iterator

function iterator() returns object {
        public function next() returns record {|ExecutorOutput value;|}?;
    }

agent: ChatGptModel

Isolated

generate

Isolated Function

function generate(PromptConstruct prompt) returns string|error

Method included from *LlmModel

chatComplete

Isolated Function

function chatComplete(ChatMessage[] messages) returns string|error

Parameters

messages ChatMessage[] -

Fields

Fields Included from *LlmModel

llmClient LlmRemoteClient

agent: Gpt3Model

Isolated

generate

Isolated Function

function generate(PromptConstruct prompt) returns string|error

Method included from *LlmModel

complete

Isolated Function

function complete(string prompt) returns string|error

Parameters

prompt string -

Fields

Fields Included from *LlmModel

llmClient LlmRemoteClient

agent: HttpToolKit

Isolated

Enums

agent: ComplexInputType

Members

OBJECT

ARRAY

agent: HttpMethod

Members

GET

POST

DELETE

PUT

PATCH

HEAD

OPTIONS

agent: PrimitiveInputType

Members

STRING

INTEGER

FLOAT

BOOLEAN

NUMBER

Records

agent: AdditionInfoFlags

Closed record

Fields

extractDescrition boolean(default false) -

extractDefault boolean(default false) -

agent: AllOfInputSchema

Closed record

Fields

allOf SubSchema[] -

agent: AnyOfInputSchema

Closed record

Fields

anyOf SubSchema[] -

agent: ArrayInputSchema

Closed record

Fields

'type ARRAY(default ARRAY) -

items SubSchema -

agent: ChatGptModelConfig

Read OnlyClosed record

Fields

model string(default GPT3_5_MODEL_NAME) -

temperature decimal(default DEFAULT_TEMPERATURE) -

messages never? -

stop never? -

agent: ExecutorOutput

Closed record

Fields

thought string -

observation any|error? -

agent: Gpt3ModelConfig

Read OnlyClosed record

Fields

model string(default GPT3_MODEL_NAME) -

temperature decimal(default DEFAULT_TEMPERATURE) -

max_tokens int(default DEFAULT_MAX_TOKEN_COUNT) -

stop never? -

prompt never? -

agent: HttpHeader

Read Only

Fields

string|string[]... - Rest field

agent: HttpTool

Closed record

Fields

name string -

description string -

method HttpMethod -

path string -

queryParams InputSchema?(default ()) -

requestBody InputSchema?(default ()) -

agent: NotInputSchema

Closed record

Fields

not SubSchema -

agent: ObjectInputSchema

Closed record

Fields

'type OBJECT(default OBJECT) -

required string[]? -

properties map<SubSchema> -

agent: OneOfInputSchema

Closed record

Fields

oneOf SubSchema[] -

agent: PrimitiveInputSchema

Closed record

Fields

'type PrimitiveInputType -

format string? -

pattern string? -

description string? -

default anydata? -

'enum string[]? -

agent: PromptConstruct

Closed record

Fields

instruction string -

query string -

history string[] -

agent: SimpleInputSchema

Fields

'type never? -

string|SimpleInputSchema|SimpleInputSchema[]... - Rest field

agent: Tool

Closed record

Fields

name string -

description string -

inputs InputSchema?(default ()) -

caller function() () -

Object types

agent: LlmModel

Distinct

Extendable LLM model object that can be used for completion tasks Useful to initialize the agents

Union types

agent: InputSchema

SimpleInputSchema|JsonInputSchema

InputSchema

agent: JsonInputSchema

JsonInputSchema

agent: LlmRemoteClient

Client|Client

LlmRemoteClient

Defines allowed LLM client types

agent: SubSchema

JsonInputSchema|PrimitiveInputSchema

SubSchema

Import

import nadheeshjihan/agent;

Other versions

0.2.5 0.2.4 0.2.3 0.2.2 0.2.1

Metadata

Released date: over 3 years ago

Version: 0.1.25

Compatibility

Platform: any

Ballerina version: 2201.5.0

GraalVM compatible: Yes

Pull count

Total: 66

Current verison: 2

Weekly downloads

Dependencies

ballerina/io/1.4.0 ballerina/log/2.7.0 ballerina/http/2.7.0

Cookie policy

Delete policy

functions

classes

enums

records

objectTypes

unionTypes

nadheeshjihan/agent

Functions

extractToolsFromOpenApiSpec

Parameters

Classes

agent: Agent

Constructor

createAgentExecutor

Parameters

iterator

Parameters

run

Parameters

Return Type

agent: AgentExecutor

next

agent: AgentIterator

iterator

agent: ChatGptModel

generate

chatComplete

Parameters

Fields

agent: Gpt3Model

generate

complete

Parameters

Fields

agent: HttpToolKit

Enums

agent: ComplexInputType

Members

agent: HttpMethod

Members

agent: PrimitiveInputType

Members

Records

agent: AdditionInfoFlags

Fields

agent: AllOfInputSchema

Fields

agent: AnyOfInputSchema

Fields

agent: ArrayInputSchema

Fields

agent: ChatGptModelConfig

Fields

agent: ExecutorOutput

Fields

agent: Gpt3ModelConfig

Fields

agent: HttpHeader

Fields

agent: HttpTool

Fields

agent: NotInputSchema

Fields

agent: ObjectInputSchema

Fields

agent: OneOfInputSchema

Fields

agent: PrimitiveInputSchema

Fields

agent: PromptConstruct

Fields

agent: SimpleInputSchema

Fields

agent: Tool

Fields

Object types

agent: LlmModel

Union types

agent: InputSchema

agent: JsonInputSchema