@solvers-hub/llm-json 0.1.7 → 0.1.8

package/docs-md/interfaces/ExtractOptions.md

@@ -1,49 +1,49 @@
-[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / ExtractOptions
-
-# Interface: ExtractOptions
-
-Options for JSON extraction.
-
-## Table of contents
-
-### Properties
-
-- [attemptCorrection](ExtractOptions.md#attemptcorrection)
-- [schemas](ExtractOptions.md#schemas)
-
-## Properties
-
-### attemptCorrection
-
-• `Optional` **attemptCorrection**: `boolean`
-
-Whether to attempt to correct malformed JSON.
-
-**`Default`**
-
-```ts
-false
-```
-
-#### Defined in
-
-[types.ts:9](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L9)
-
-___
-
-### schemas
-
-• `Optional` **schemas**: [`SchemaDefinition`](SchemaDefinition.md)[]
-
+[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / ExtractOptions
+
+# Interface: ExtractOptions
+
+Options for JSON extraction.
+
+## Table of contents
+
+### Properties
+
+- [attemptCorrection](ExtractOptions.md#attemptcorrection)
+- [schemas](ExtractOptions.md#schemas)
+
+## Properties
+
+### attemptCorrection
+
+• `Optional` **attemptCorrection**: `boolean`
+
+Whether to attempt to correct malformed JSON.
+
+**`Default`**
+
+```ts
+false
+```
+
+#### Defined in
+
+[types.ts:9](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L9)
+
+___
+
+### schemas
+
+• `Optional` **schemas**: [`SchemaDefinition`](SchemaDefinition.md)[]
+
 JSON schemas to validate extracted JSON against.
-If provided, the extracted JSON will be validated against these schemas.
-
-**`Default`**
-
-```ts
-undefined
-```
-
-#### Defined in
-
-[types.ts:16](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L16)
+If provided, the extracted JSON will be validated against these schemas.
+
+**`Default`**
+
+```ts
+undefined
+```
+
+#### Defined in
+
+[types.ts:16](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L16)

package/docs-md/interfaces/ExtractResult.md

@@ -1,49 +1,49 @@
-[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / ExtractResult
-
-# Interface: ExtractResult
-
-Result of the JSON extraction.
-
-## Table of contents
-
-### Properties
-
-- [json](ExtractResult.md#json)
-- [text](ExtractResult.md#text)
-- [validatedJson](ExtractResult.md#validatedjson)
-
-## Properties
-
-### json
-
-• **json**: `any`[]
-
-Array of parsed JSON objects extracted from the input.
-
-#### Defined in
-
-[types.ts:71](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L71)
-
-___
-
-### text
-
-• **text**: `string`[]
-
-Array of text blocks extracted from the input.
-
-#### Defined in
-
-[types.ts:66](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L66)
-
-___
-
-### validatedJson
-
-• `Optional` **validatedJson**: [`ValidationResult`](ValidationResult.md)[]
-
-Array of validated JSON results, only present if schemas were provided.
-
-#### Defined in
-
-[types.ts:76](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L76)
+[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / ExtractResult
+
+# Interface: ExtractResult
+
+Result of the JSON extraction.
+
+## Table of contents
+
+### Properties
+
+- [json](ExtractResult.md#json)
+- [text](ExtractResult.md#text)
+- [validatedJson](ExtractResult.md#validatedjson)
+
+## Properties
+
+### json
+
+• **json**: `any`[]
+
+Array of parsed JSON objects extracted from the input.
+
+#### Defined in
+
+[types.ts:71](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L71)
+
+___
+
+### text
+
+• **text**: `string`[]
+
+Array of text blocks extracted from the input.
+
+#### Defined in
+
+[types.ts:66](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L66)
+
+___
+
+### validatedJson
+
+• `Optional` **validatedJson**: [`ValidationResult`](ValidationResult.md)[]
+
+Array of validated JSON results, only present if schemas were provided.
+
+#### Defined in
+
+[types.ts:76](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L76)

package/docs-md/interfaces/JsonBlock.md

@@ -1,75 +1,75 @@
-[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / JsonBlock
-
-# Interface: JsonBlock
-
-Information about a detected JSON block.
-
-## Table of contents
-
-### Properties
-
-- [endIndex](JsonBlock.md#endindex)
-- [parsed](JsonBlock.md#parsed)
-- [raw](JsonBlock.md#raw)
-- [startIndex](JsonBlock.md#startindex)
-- [wasCorrected](JsonBlock.md#wascorrected)
-
-## Properties
-
-### endIndex
-
-• **endIndex**: `number`
-
-The end index of the JSON block in the input string.
-
-#### Defined in
-
-[types.ts:96](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L96)
-
-___
-
-### parsed
-
-• `Optional` **parsed**: `any`
-
-The parsed JSON object.
-
-#### Defined in
-
-[types.ts:106](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L106)
-
-___
-
-### raw
-
-• **raw**: `string`
-
-The raw JSON string.
-
-#### Defined in
-
-[types.ts:86](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L86)
-
-___
-
-### startIndex
-
-• **startIndex**: `number`
-
-The start index of the JSON block in the input string.
-
-#### Defined in
-
-[types.ts:91](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L91)
-
-___
-
-### wasCorrected
-
-• `Optional` **wasCorrected**: `boolean`
-
-Whether the JSON was corrected.
-
-#### Defined in
-
-[types.ts:101](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L101)
+[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / JsonBlock
+
+# Interface: JsonBlock
+
+Information about a detected JSON block.
+
+## Table of contents
+
+### Properties
+
+- [endIndex](JsonBlock.md#endindex)
+- [parsed](JsonBlock.md#parsed)
+- [raw](JsonBlock.md#raw)
+- [startIndex](JsonBlock.md#startindex)
+- [wasCorrected](JsonBlock.md#wascorrected)
+
+## Properties
+
+### endIndex
+
+• **endIndex**: `number`
+
+The end index of the JSON block in the input string.
+
+#### Defined in
+
+[types.ts:96](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L96)
+
+___
+
+### parsed
+
+• `Optional` **parsed**: `any`
+
+The parsed JSON object.
+
+#### Defined in
+
+[types.ts:106](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L106)
+
+___
+
+### raw
+
+• **raw**: `string`
+
+The raw JSON string.
+
+#### Defined in
+
+[types.ts:86](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L86)
+
+___
+
+### startIndex
+
+• **startIndex**: `number`
+
+The start index of the JSON block in the input string.
+
+#### Defined in
+
+[types.ts:91](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L91)
+
+___
+
+### wasCorrected
+
+• `Optional` **wasCorrected**: `boolean`
+
+Whether the JSON was corrected.
+
+#### Defined in
+
+[types.ts:101](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L101)

package/docs-md/interfaces/JsonParseError.md

@@ -1,49 +1,49 @@
-[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / JsonParseError
-
-# Interface: JsonParseError
-
-Error information for JSON parsing failures.
-
-## Table of contents
-
-### Properties
-
-- [message](JsonParseError.md#message)
-- [position](JsonParseError.md#position)
-- [raw](JsonParseError.md#raw)
-
-## Properties
-
-### message
-
-• **message**: `string`
-
-The original error message.
-
-#### Defined in
-
-[types.ts:116](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L116)
-
-___
-
-### position
-
-• `Optional` **position**: `number`
-
-The position in the JSON string where the error occurred.
-
-#### Defined in
-
-[types.ts:126](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L126)
-
-___
-
-### raw
-
-• **raw**: `string`
-
-The raw JSON string that failed to parse.
-
-#### Defined in
-
-[types.ts:121](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L121)
+[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / JsonParseError
+
+# Interface: JsonParseError
+
+Error information for JSON parsing failures.
+
+## Table of contents
+
+### Properties
+
+- [message](JsonParseError.md#message)
+- [position](JsonParseError.md#position)
+- [raw](JsonParseError.md#raw)
+
+## Properties
+
+### message
+
+• **message**: `string`
+
+The original error message.
+
+#### Defined in
+
+[types.ts:116](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L116)
+
+___
+
+### position
+
+• `Optional` **position**: `number`
+
+The position in the JSON string where the error occurred.
+
+#### Defined in
+
+[types.ts:126](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L126)
+
+___
+
+### raw
+
+• **raw**: `string`
+
+The raw JSON string that failed to parse.
+
+#### Defined in
+
+[types.ts:121](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L121)

package/docs-md/interfaces/SchemaDefinition.md

@@ -1,36 +1,36 @@
-[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / SchemaDefinition
-
-# Interface: SchemaDefinition
-
-Definition of a JSON schema for validation.
-
-## Table of contents
-
-### Properties
-
-- [name](SchemaDefinition.md#name)
-- [schema](SchemaDefinition.md#schema)
-
-## Properties
-
-### name
-
-• **name**: `string`
-
-A unique name for the schema to identify which schema matched.
-
-#### Defined in
-
-[types.ts:26](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L26)
-
-___
-
-### schema
-
-• **schema**: `object`
-
-The JSON schema object conforming to JSON Schema specification.
-
-#### Defined in
-
-[types.ts:31](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L31)
+[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / SchemaDefinition
+
+# Interface: SchemaDefinition
+
+Definition of a JSON schema for validation.
+
+## Table of contents
+
+### Properties
+
+- [name](SchemaDefinition.md#name)
+- [schema](SchemaDefinition.md#schema)
+
+## Properties
+
+### name
+
+• **name**: `string`
+
+A unique name for the schema to identify which schema matched.
+
+#### Defined in
+
+[types.ts:26](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L26)
+
+___
+
+### schema
+
+• **schema**: `object`
+
+The JSON schema object conforming to JSON Schema specification.
+
+#### Defined in
+
+[types.ts:31](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L31)

package/docs-md/interfaces/ValidationResult.md

@@ -1,62 +1,62 @@
-[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / ValidationResult
-
-# Interface: ValidationResult
-
-Result of schema validation for a JSON object.
-
-## Table of contents
-
-### Properties
-
-- [isValid](ValidationResult.md#isvalid)
-- [json](ValidationResult.md#json)
-- [matchedSchema](ValidationResult.md#matchedschema)
-- [validationErrors](ValidationResult.md#validationerrors)
-
-## Properties
-
-### isValid
-
-• **isValid**: `boolean`
-
-Whether the JSON is valid according to the matched schema.
-
-#### Defined in
-
-[types.ts:51](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L51)
-
-___
-
-### json
-
-• **json**: `any`
-
-The JSON object that was validated.
-
-#### Defined in
-
-[types.ts:41](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L41)
-
-___
-
-### matchedSchema
-
-• **matchedSchema**: ``null`` \| `string`
-
-The name of the schema that matched, or null if no schema matched.
-
-#### Defined in
-
-[types.ts:46](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L46)
-
-___
-
-### validationErrors
-
-• `Optional` **validationErrors**: `any`[]
-
-Validation errors if any, or undefined if validation passed.
-
-#### Defined in
-
-[types.ts:56](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L56)
+[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / ValidationResult
+
+# Interface: ValidationResult
+
+Result of schema validation for a JSON object.
+
+## Table of contents
+
+### Properties
+
+- [isValid](ValidationResult.md#isvalid)
+- [json](ValidationResult.md#json)
+- [matchedSchema](ValidationResult.md#matchedschema)
+- [validationErrors](ValidationResult.md#validationerrors)
+
+## Properties
+
+### isValid
+
+• **isValid**: `boolean`
+
+Whether the JSON is valid according to the matched schema.
+
+#### Defined in
+
+[types.ts:51](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L51)
+
+___
+
+### json
+
+• **json**: `any`
+
+The JSON object that was validated.
+
+#### Defined in
+
+[types.ts:41](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L41)
+
+___
+
+### matchedSchema
+
+• **matchedSchema**: ``null`` \| `string`
+
+The name of the schema that matched, or null if no schema matched.
+
+#### Defined in
+
+[types.ts:46](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L46)
+
+___
+
+### validationErrors
+
+• `Optional` **validationErrors**: `any`[]
+
+Validation errors if any, or undefined if validation passed.
+
+#### Defined in
+
+[types.ts:56](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L56)