@formio/uag-grok 2.0.0-rc.7 → 2.0.0-rc.9
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 +4 -4
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# @formio/uag-grok
|
|
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 **Grok** agent engine for the [UAG Agent API](https://github.com/formio/uag/blob/
|
|
5
|
+
The **Grok** agent engine for the [UAG Agent API](https://github.com/formio/uag/blob/v2.0.0-rc.8/README.md#agent-api): xAI's models, through xAI's OpenAI-compatible API. It extracts and generates open values (dates, amounts, names, free text) with structured outputs. When a task lists read-only tools in `uagTools`, it researches with them first.
|
|
6
6
|
|
|
7
7
|
It is included in the `formio/uag` Docker image. Enable it by naming it, and set its key and model:
|
|
8
8
|
|
|
@@ -12,7 +12,7 @@ XAI_API_KEY=...
|
|
|
12
12
|
XAI_MODEL=<a Grok model ID>
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
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/
|
|
15
|
+
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.
|
|
16
16
|
|
|
17
17
|
## Settings
|
|
18
18
|
|
|
@@ -44,7 +44,7 @@ There is no default model: set `model` to a specific model ID from xAI's documen
|
|
|
44
44
|
|
|
45
45
|
## How it works
|
|
46
46
|
|
|
47
|
-
It is the [OpenAI engine](https://github.com/formio/uag/tree/
|
|
47
|
+
It is the [OpenAI engine](https://github.com/formio/uag/tree/v2.0.0-rc.8/engines/openai)'s agent kind with xAI's endpoint and key built in: one chat completion with a strict JSON schema per extraction, and a function-calling loop over the task's read-only tools for research, ending in the same structured answer. A refusal, a truncated answer or an answer that is not JSON is an engine failure, and the UAG falls back to the next engine.
|
|
48
48
|
|
|
49
49
|
Each field's format (such as `date`) and pattern are written into its description, not sent as schema constraints. Grok enforces constraints strictly, and every field is required in a strict schema, so it would otherwise invent a value that fits the pattern for a field the input does not state. The UAG validates every value either way.
|
|
50
50
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@formio/uag-grok",
|
|
3
|
-
"version": "2.0.0-rc.
|
|
3
|
+
"version": "2.0.0-rc.9",
|
|
4
4
|
"description": "Grok engine for the Form.io Universal Agent Gateway (UAG): xAI's models, for structured extraction with research over read-only tools.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"formio",
|
|
@@ -33,8 +33,8 @@
|
|
|
33
33
|
"access": "public"
|
|
34
34
|
},
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@formio/uag-openai": "^2.0.0-rc.
|
|
37
|
-
"@formio/uag-sdk": "^2.0.0-rc.
|
|
36
|
+
"@formio/uag-openai": "^2.0.0-rc.9",
|
|
37
|
+
"@formio/uag-sdk": "^2.0.0-rc.9"
|
|
38
38
|
},
|
|
39
39
|
"devDependencies": {
|
|
40
40
|
"chai": "^6.3.0",
|