@soat/sdk 0.19.0 → 0.19.2

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/dist/index.d.cts CHANGED
@@ -525,7 +525,7 @@ type Agent = {
525
525
  };
526
526
  } | null;
527
527
  /**
528
- * JSON Schema describing the structured object the model must return. When set, non-streaming generations use the AI SDK to constrain output to this schema; the parsed value is returned as `output.object` in the generation response. See the Structured Output section in the Agents module docs.
528
+ * JSON Schema describing the structured object the model must return. When set, non-streaming generations constrain output to this schema and the parsed value is returned as `output.object`. The schema is enforced on the way back, not just sent to the model: an object that violates it fails the generation with 502 `OUTPUT_SCHEMA_VALIDATION_FAILED`, naming the violated field. Constraints beyond `required`/`type` (`minLength`, `enum`, `pattern`, `minItems`) are honored and are what reject a structurally valid but degenerate answer. See the Structured Output section in the Agents module docs.
529
529
  */
530
530
  output_schema?: {
531
531
  [key: string]: unknown;
@@ -723,7 +723,7 @@ type CreateAgentRequest = {
723
723
  };
724
724
  };
725
725
  /**
726
- * JSON Schema describing the structured object the model must return. When set, non-streaming generations use the AI SDK to constrain output to this schema; the parsed value is returned as `output.object` in the generation response. See the Structured Output section in the Agents module docs.
726
+ * JSON Schema describing the structured object the model must return. When set, non-streaming generations constrain output to this schema and the parsed value is returned as `output.object`. The schema is enforced on the way back, not just sent to the model: an object that violates it fails the generation with 502 `OUTPUT_SCHEMA_VALIDATION_FAILED`, naming the violated field. Constraints beyond `required`/`type` (`minLength`, `enum`, `pattern`, `minItems`) are honored and are what reject a structurally valid but degenerate answer. See the Structured Output section in the Agents module docs.
727
727
  */
728
728
  output_schema?: {
729
729
  [key: string]: unknown;
@@ -827,7 +827,7 @@ type UpdateAgentRequest = {
827
827
  };
828
828
  } | null;
829
829
  /**
830
- * JSON Schema describing the structured object the model must return. When set, non-streaming generations use the AI SDK to constrain output to this schema; the parsed value is returned as `output.object` in the generation response. See the Structured Output section in the Agents module docs.
830
+ * JSON Schema describing the structured object the model must return. When set, non-streaming generations constrain output to this schema and the parsed value is returned as `output.object`. The schema is enforced on the way back, not just sent to the model: an object that violates it fails the generation with 502 `OUTPUT_SCHEMA_VALIDATION_FAILED`, naming the violated field. Constraints beyond `required`/`type` (`minLength`, `enum`, `pattern`, `minItems`) are honored and are what reject a structurally valid but degenerate answer. See the Structured Output section in the Agents module docs.
831
831
  */
832
832
  output_schema?: {
833
833
  [key: string]: unknown;
@@ -6091,7 +6091,7 @@ type CreateAgentGenerationErrors = {
6091
6091
  */
6092
6092
  404: ErrorResponse;
6093
6093
  /**
6094
- * Upstream AI provider error (AI_PROVIDER_ERROR). The error `meta` includes the `generation_id` and `trace_id` of the failed generation for post-mortem debugging via GET /api/v1/generations/{generation_id}.
6094
+ * Upstream AI provider error (AI_PROVIDER_ERROR); model output that does not satisfy the agent's `output_schema` (OUTPUT_SCHEMA_VALIDATION_FAILED — the violated field is named in the message); or a model that wrote a tool invocation out as plain assistant text instead of calling the tool, so the tool never ran (TEXT_ENCODED_TOOL_CALL — `meta.tool_name` names the tool). The error `meta` includes the `generation_id` and `trace_id` of the failed generation for post-mortem debugging via GET /api/v1/generations/{generation_id}.
6095
6095
  *
6096
6096
  */
6097
6097
  502: ErrorResponse;
@@ -6130,6 +6130,11 @@ type SubmitAgentToolOutputsErrors = {
6130
6130
  * Agent or generation not found
6131
6131
  */
6132
6132
  404: ErrorResponse;
6133
+ /**
6134
+ * Upstream AI provider error (AI_PROVIDER_ERROR); model output that does not satisfy the agent's `output_schema` (OUTPUT_SCHEMA_VALIDATION_FAILED); or a model that wrote a tool invocation out as plain assistant text instead of calling the tool (TEXT_ENCODED_TOOL_CALL — `meta.tool_name` names the tool). The resumed generation is recorded `failed`.
6135
+ *
6136
+ */
6137
+ 502: ErrorResponse;
6133
6138
  };
6134
6139
  type SubmitAgentToolOutputsError = SubmitAgentToolOutputsErrors[keyof SubmitAgentToolOutputsErrors];
6135
6140
  type SubmitAgentToolOutputsResponses = {
package/dist/index.d.mts CHANGED
@@ -525,7 +525,7 @@ type Agent = {
525
525
  };
526
526
  } | null;
527
527
  /**
528
- * JSON Schema describing the structured object the model must return. When set, non-streaming generations use the AI SDK to constrain output to this schema; the parsed value is returned as `output.object` in the generation response. See the Structured Output section in the Agents module docs.
528
+ * JSON Schema describing the structured object the model must return. When set, non-streaming generations constrain output to this schema and the parsed value is returned as `output.object`. The schema is enforced on the way back, not just sent to the model: an object that violates it fails the generation with 502 `OUTPUT_SCHEMA_VALIDATION_FAILED`, naming the violated field. Constraints beyond `required`/`type` (`minLength`, `enum`, `pattern`, `minItems`) are honored and are what reject a structurally valid but degenerate answer. See the Structured Output section in the Agents module docs.
529
529
  */
530
530
  output_schema?: {
531
531
  [key: string]: unknown;
@@ -723,7 +723,7 @@ type CreateAgentRequest = {
723
723
  };
724
724
  };
725
725
  /**
726
- * JSON Schema describing the structured object the model must return. When set, non-streaming generations use the AI SDK to constrain output to this schema; the parsed value is returned as `output.object` in the generation response. See the Structured Output section in the Agents module docs.
726
+ * JSON Schema describing the structured object the model must return. When set, non-streaming generations constrain output to this schema and the parsed value is returned as `output.object`. The schema is enforced on the way back, not just sent to the model: an object that violates it fails the generation with 502 `OUTPUT_SCHEMA_VALIDATION_FAILED`, naming the violated field. Constraints beyond `required`/`type` (`minLength`, `enum`, `pattern`, `minItems`) are honored and are what reject a structurally valid but degenerate answer. See the Structured Output section in the Agents module docs.
727
727
  */
728
728
  output_schema?: {
729
729
  [key: string]: unknown;
@@ -827,7 +827,7 @@ type UpdateAgentRequest = {
827
827
  };
828
828
  } | null;
829
829
  /**
830
- * JSON Schema describing the structured object the model must return. When set, non-streaming generations use the AI SDK to constrain output to this schema; the parsed value is returned as `output.object` in the generation response. See the Structured Output section in the Agents module docs.
830
+ * JSON Schema describing the structured object the model must return. When set, non-streaming generations constrain output to this schema and the parsed value is returned as `output.object`. The schema is enforced on the way back, not just sent to the model: an object that violates it fails the generation with 502 `OUTPUT_SCHEMA_VALIDATION_FAILED`, naming the violated field. Constraints beyond `required`/`type` (`minLength`, `enum`, `pattern`, `minItems`) are honored and are what reject a structurally valid but degenerate answer. See the Structured Output section in the Agents module docs.
831
831
  */
832
832
  output_schema?: {
833
833
  [key: string]: unknown;
@@ -6091,7 +6091,7 @@ type CreateAgentGenerationErrors = {
6091
6091
  */
6092
6092
  404: ErrorResponse;
6093
6093
  /**
6094
- * Upstream AI provider error (AI_PROVIDER_ERROR). The error `meta` includes the `generation_id` and `trace_id` of the failed generation for post-mortem debugging via GET /api/v1/generations/{generation_id}.
6094
+ * Upstream AI provider error (AI_PROVIDER_ERROR); model output that does not satisfy the agent's `output_schema` (OUTPUT_SCHEMA_VALIDATION_FAILED — the violated field is named in the message); or a model that wrote a tool invocation out as plain assistant text instead of calling the tool, so the tool never ran (TEXT_ENCODED_TOOL_CALL — `meta.tool_name` names the tool). The error `meta` includes the `generation_id` and `trace_id` of the failed generation for post-mortem debugging via GET /api/v1/generations/{generation_id}.
6095
6095
  *
6096
6096
  */
6097
6097
  502: ErrorResponse;
@@ -6130,6 +6130,11 @@ type SubmitAgentToolOutputsErrors = {
6130
6130
  * Agent or generation not found
6131
6131
  */
6132
6132
  404: ErrorResponse;
6133
+ /**
6134
+ * Upstream AI provider error (AI_PROVIDER_ERROR); model output that does not satisfy the agent's `output_schema` (OUTPUT_SCHEMA_VALIDATION_FAILED); or a model that wrote a tool invocation out as plain assistant text instead of calling the tool (TEXT_ENCODED_TOOL_CALL — `meta.tool_name` names the tool). The resumed generation is recorded `failed`.
6135
+ *
6136
+ */
6137
+ 502: ErrorResponse;
6133
6138
  };
6134
6139
  type SubmitAgentToolOutputsError = SubmitAgentToolOutputsErrors[keyof SubmitAgentToolOutputsErrors];
6135
6140
  type SubmitAgentToolOutputsResponses = {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@soat/sdk",
3
- "version": "0.19.0",
3
+ "version": "0.19.2",
4
4
  "description": "TypeScript SDK for the SOAT API",
5
5
  "type": "module",
6
6
  "main": "dist/index.mjs",