@formio/uag-openai 2.0.0-rc.7 → 2.0.0-rc.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# @formio/uag-openai
|
|
2
2
|
|
|
3
|
-
<sub>[Form.io UAG](https://github.com/formio/uag/blob/
|
|
3
|
+
<sub>[Form.io UAG](https://github.com/formio/uag/blob/v2.0.0-rc.8/README.md) › [Engines](https://github.com/formio/uag/blob/v2.0.0-rc.8/README.md#engines-and-routing) › this page</sub>
|
|
4
4
|
|
|
5
|
-
The OpenAI engine for the [UAG Agent API](https://github.com/formio/uag/blob/
|
|
5
|
+
The OpenAI engine for the [UAG Agent API](https://github.com/formio/uag/blob/v2.0.0-rc.8/README.md#agent-api). An instance is one of two kinds:
|
|
6
6
|
|
|
7
|
-
- **agent** (the default): extracts and generates open values on OpenAI's Responses API, or, through Chat Completions, on any server that implements that API: local models (Ollama, vLLM, LM Studio) and routers (OpenRouter). When a task lists read-only tools in `uagTools`, it researches with them first. Grok and Gemini have their own packages built on it: [`grok`](https://github.com/formio/uag/tree/
|
|
8
|
-
- **decision**: decides closed-set fields with a probability for each answer, on OpenAI's Decisions API, like the [`jev`](https://github.com/formio/uag/tree/
|
|
7
|
+
- **agent** (the default): extracts and generates open values on OpenAI's Responses API, or, through Chat Completions, on any server that implements that API: local models (Ollama, vLLM, LM Studio) and routers (OpenRouter). When a task lists read-only tools in `uagTools`, it researches with them first. Grok and Gemini have their own packages built on it: [`grok`](https://github.com/formio/uag/tree/v2.0.0-rc.8/engines/grok) and [`gemini`](https://github.com/formio/uag/tree/v2.0.0-rc.8/engines/gemini).
|
|
8
|
+
- **decision**: decides closed-set fields with a probability for each answer, on OpenAI's Decisions API, like the [`jev`](https://github.com/formio/uag/tree/v2.0.0-rc.8/engines/jev) engine. See [Decisions](#decisions).
|
|
9
9
|
|
|
10
10
|
It is included in the `formio/uag` Docker image. Enable it by naming it, and set its model and key:
|
|
11
11
|
|
|
@@ -15,7 +15,7 @@ OPENAI_API_KEY=...
|
|
|
15
15
|
OPENAI_MODEL=<a dated model ID>
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
Its tasks are Agentic Formflow, so the UAG also needs a `LICENSE_KEY` that includes the UAG (see [License](https://github.com/formio/uag/blob/
|
|
18
|
+
Its tasks are Agentic Formflow, so on a self-hosted project the UAG also needs a `LICENSE_KEY` that includes the UAG (see [License](https://github.com/formio/uag/blob/v2.0.0-rc.8/README.md#license)); a project on Form.io's hosted service needs none. A form's chat needs no license on Form.io Open Source or a hosted project.
|
|
19
19
|
|
|
20
20
|
## Settings
|
|
21
21
|
|
|
@@ -55,7 +55,7 @@ UAG_ENGINE_LOCAL_MODEL=llama4:16x17b
|
|
|
55
55
|
CLAUDE_API_KEY=...
|
|
56
56
|
```
|
|
57
57
|
|
|
58
|
-
For Grok and Gemini, use their own engines ([`grok`](https://github.com/formio/uag/tree/
|
|
58
|
+
For Grok and Gemini, use their own engines ([`grok`](https://github.com/formio/uag/tree/v2.0.0-rc.8/engines/grok), [`gemini`](https://github.com/formio/uag/tree/v2.0.0-rc.8/engines/gemini)), which have the right endpoints and keys built in. Any other OpenAI-compatible server works with `baseURL`; check its documentation for model IDs and for which `structuredOutput` mode it supports.
|
|
59
59
|
|
|
60
60
|
## Decisions
|
|
61
61
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@formio/uag-openai",
|
|
3
|
-
"version": "2.0.0-rc.
|
|
3
|
+
"version": "2.0.0-rc.8",
|
|
4
4
|
"description": "OpenAI engine for the Form.io Universal Agent Gateway (UAG): structured extraction, with research over read-only tools, on OpenAI or any server with its chat completions API (Ollama, vLLM, LM Studio, OpenRouter); and decisions with probabilities on OpenAI's Decisions API.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"formio",
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
"access": "public"
|
|
43
43
|
},
|
|
44
44
|
"dependencies": {
|
|
45
|
-
"@formio/uag-sdk": "^2.0.0-rc.
|
|
45
|
+
"@formio/uag-sdk": "^2.0.0-rc.8",
|
|
46
46
|
"openai": "7.45.1"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|