agents/src/Agents/Agent.php at 6efdc62dfdc63dc0f5cdcb20fa09c0afde8bf83e · utopia-php/agents · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
<?php

namespace Utopia\Agents;

class Agent
{
    /**
     * @var string
     */
    protected string $description;

    /**
     * @var array<string, string>
     */
    protected array $instructions;

    /**
     * @var Schema|null
     */
    protected ?Schema $schema = null;

    /**
     * @var Adapter
     */
    protected Adapter $adapter;

    /**
     * Create a new agent
     *
     * @param  Adapter  $adapter The AI model adapter to use
     *
     * @throws \Exception
     */
    public function __construct(Adapter $adapter)
    {
        $this->adapter = $adapter;
        $this->instructions = [];
        $this->description = '';

        $this->adapter->setAgent($this);
    }

    /**
     * Set the agent's description
     *
     * @param  string  $description
     * @return self
     */
    public function setDescription(string $description): self
    {
        $this->description = $description;

        return $this;
    }

    /**
     * Set the agent's instructions
     *
     * @param  array<string, string>  $instructions
     * @return self
     */
    public function setInstructions(array $instructions): self
    {
        $this->instructions = $instructions;

        return $this;
    }

    /**
     * Add an instruction to the agent
     *
     * @param  string  $name
     * @param  string  $content
     * @return self
     */
    public function addInstruction(string $name, string $content): self
    {
        $this->instructions[$name] = $content;

        return $this;
    }

    /**
     * Get the agent's description
     *
     * @return string
     */
    public function getDescription(): string
    {
        return $this->description;
    }

    /**
     * Get the agent's instructions
     *
     * @return array<string, string>
     */
    public function getInstructions(): array
    {
        return $this->instructions;
    }

    /**
     * Get the agent's adapter
     *
     * @return Adapter
     */
    public function getAdapter(): Adapter
    {
        return $this->adapter;
    }

    /**
     * Get the agent's schema
     *
     * @return Schema|null
     */
    public function getSchema(): ?Schema
    {
        return $this->schema;
    }

    /**
     * Set the agent's schema
     *
     * @param  Schema  $schema
     * @return self
     */
    public function setSchema(Schema $schema): self
    {
        if (! $this->adapter->isSchemaSupported()) {
            throw new \Exception('Schema is not supported for this model');
        }

        $this->schema = $schema;

        return $this;
    }

    /**
     * Get embedding for input text using underlying adapter (if supported)
     *
     * @param  string  $text
     * @return array{
     *     embedding: array<int, float>,
     *     tokensProcessed: int|null,
     *     totalDuration: int|null ,
     *     modelLoadingDuration: int|null
     * }
     *
     * @throws \Exception
     */
    public function embed(string $text): array
    {
        if (! $this->adapter->getSupportForEmbeddings()) {
            throw new \Exception('This adapter does not support embedding/embedding API.');
        }

        return $this->adapter->embed($text);
    }
}