diff --git a/resources/py/README.md b/resources/py/README.md index ef29806..8c72500 100644 --- a/resources/py/README.md +++ b/resources/py/README.md @@ -64,6 +64,7 @@ bash ./py-build.sh - [ValidationOutcome](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/ValidationOutcome.md); - [ValidationOutcomeValidatedOutput](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/ValidationOutcomeValidatedOutput.md); - [ValidationResult](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/ValidationResult.md); + - [ValidationSummary](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/ValidationSummary.md); - [ValidationType](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/ValidationType.md); - [ValidatorLog](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/ValidatorLog.md); - [ValidatorLogInstanceId](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/ValidatorLogInstanceId.md); diff --git a/resources/py/docs/ValidationOutcome.md b/resources/py/docs/ValidationOutcome.md index f32eeda..cd353d4 100644 --- a/resources/py/docs/ValidationOutcome.md +++ b/resources/py/docs/ValidationOutcome.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **call_id** | **str** | Foreign key to the most recent Call this resulted from. | **raw_llm_output** | **str** | The raw, unchanged string content from the LLM call. | [optional] +**validation_summaries** | [**List[ValidationSummary]**](ValidationSummary.md) | | [optional] **validated_output** | [**ValidationOutcomeValidatedOutput**](ValidationOutcomeValidatedOutput.md) | | [optional] **reask** | [**Reask**](Reask.md) | If validation continuously fails and all allocated reasks are used, this field will contain the final reask that would have been sent to the LLM if additional reasks were available. | [optional] **validation_passed** | **bool** | A boolean to indicate whether or not the LLM output passed validation. If this is False, the validated_output may be invalid. | [optional] diff --git a/resources/py/docs/ValidationSummary.md b/resources/py/docs/ValidationSummary.md new file mode 100644 index 0000000..cefb8b8 --- /dev/null +++ b/resources/py/docs/ValidationSummary.md @@ -0,0 +1,33 @@ +# ValidationSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**validator_name** | **str** | The class name of the validator. | +**validator_status** | **str** | | +**property_path** | **str** | The JSON path to the property which was validated that produced this log. | [optional] +**failure_reason** | **str** | The error message indicating why validation failed. | [optional] +**error_spans** | [**List[ErrorSpan]**](ErrorSpan.md) | | [optional] + +## Example + +```python +from guardrails_api_client.models.validation_summary import ValidationSummary + +# TODO update the JSON string below +json = "{}" +# create an instance of ValidationSummary from a JSON string +validation_summary_instance = ValidationSummary.from_json(json) +# print the JSON string representation of the object +print(ValidationSummary.to_json()) + +# convert the object into a dict +validation_summary_dict = validation_summary_instance.to_dict() +# create an instance of ValidationSummary from a dict +validation_summary_from_dict = ValidationSummary.from_dict(validation_summary_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/resources/py/pyproject.toml.template b/resources/py/pyproject.toml.template index 4a31aaf..485c931 100644 --- a/resources/py/pyproject.toml.template +++ b/resources/py/pyproject.toml.template @@ -1,6 +1,6 @@ [project] name = "guardrails-api-client" -version = "0.3.12" +version = "0.3.13" description = "Guardrails API Client." authors = [ {name = "Guardrails AI", email = "contact@guardrailsai.com"} diff --git a/resources/ts/docs/interfaces/ValidationOutcome.md b/resources/ts/docs/interfaces/ValidationOutcome.md index 8d64e65..7623a5e 100644 --- a/resources/ts/docs/interfaces/ValidationOutcome.md +++ b/resources/ts/docs/interfaces/ValidationOutcome.md @@ -18,6 +18,7 @@ ValidationOutcome - [reask](ValidationOutcome.md#reask) - [validatedOutput](ValidationOutcome.md#validatedoutput) - [validationPassed](ValidationOutcome.md#validationpassed) +- [validationSummaries](ValidationOutcome.md#validationsummaries) ## Properties @@ -33,7 +34,7 @@ ValidationOutcome #### Defined in -src/models/ValidationOutcome.ts:33 +src/models/ValidationOutcome.ts:38 ___ @@ -49,7 +50,7 @@ ValidationOutcome #### Defined in -src/models/ValidationOutcome.ts:63 +src/models/ValidationOutcome.ts:74 ___ @@ -65,7 +66,7 @@ ValidationOutcome #### Defined in -src/models/ValidationOutcome.ts:39 +src/models/ValidationOutcome.ts:44 ___ @@ -81,7 +82,7 @@ ValidationOutcome #### Defined in -src/models/ValidationOutcome.ts:51 +src/models/ValidationOutcome.ts:62 ___ @@ -95,7 +96,7 @@ ValidationOutcome #### Defined in -src/models/ValidationOutcome.ts:45 +src/models/ValidationOutcome.ts:56 ___ @@ -111,4 +112,18 @@ ValidationOutcome #### Defined in -src/models/ValidationOutcome.ts:57 +src/models/ValidationOutcome.ts:68 + +___ + +### validationSummaries + +• `Optional` **validationSummaries**: [`ValidationSummary`](ValidationSummary.md)[] + +**`Memberof`** + +ValidationOutcome + +#### Defined in + +src/models/ValidationOutcome.ts:50 diff --git a/resources/ts/docs/interfaces/ValidationSummary.md b/resources/ts/docs/interfaces/ValidationSummary.md new file mode 100644 index 0000000..5b05004 --- /dev/null +++ b/resources/ts/docs/interfaces/ValidationSummary.md @@ -0,0 +1,93 @@ +[@guardrails-ai/api-client](../README.md) / [Exports](../modules.md) / ValidationSummary + +# Interface: ValidationSummary + +**`Export`** + +ValidationSummary + +## Table of contents + +### Properties + +- [errorSpans](ValidationSummary.md#errorspans) +- [failureReason](ValidationSummary.md#failurereason) +- [propertyPath](ValidationSummary.md#propertypath) +- [validatorName](ValidationSummary.md#validatorname) +- [validatorStatus](ValidationSummary.md#validatorstatus) + +## Properties + +### errorSpans + +• `Optional` **errorSpans**: [`ErrorSpan`](ErrorSpan.md)[] + +**`Memberof`** + +ValidationSummary + +#### Defined in + +src/models/ValidationSummary.ts:53 + +___ + +### failureReason + +• `Optional` **failureReason**: `string` + +The error message indicating why validation failed. + +**`Memberof`** + +ValidationSummary + +#### Defined in + +src/models/ValidationSummary.ts:47 + +___ + +### propertyPath + +• `Optional` **propertyPath**: `string` + +The JSON path to the property which was validated that produced this log. + +**`Memberof`** + +ValidationSummary + +#### Defined in + +src/models/ValidationSummary.ts:41 + +___ + +### validatorName + +• **validatorName**: `string` + +The class name of the validator. + +**`Memberof`** + +ValidationSummary + +#### Defined in + +src/models/ValidationSummary.ts:29 + +___ + +### validatorStatus + +• **validatorStatus**: [`ValidationSummaryValidatorStatusEnum`](../modules.md#validationsummaryvalidatorstatusenum) + +**`Memberof`** + +ValidationSummary + +#### Defined in + +src/models/ValidationSummary.ts:35 diff --git a/resources/ts/docs/modules.md b/resources/ts/docs/modules.md index d44b17f..134e87b 100644 --- a/resources/ts/docs/modules.md +++ b/resources/ts/docs/modules.md @@ -77,6 +77,7 @@ - [ValidationOutcome](interfaces/ValidationOutcome.md) - [ValidationOutcomeValidatedOutput](interfaces/ValidationOutcomeValidatedOutput.md) - [ValidationResult](interfaces/ValidationResult.md) +- [ValidationSummary](interfaces/ValidationSummary.md) - [ValidationType](interfaces/ValidationType.md) - [ValidatorLog](interfaces/ValidatorLog.md) - [ValidatorLogInstanceId](interfaces/ValidatorLogInstanceId.md) @@ -98,6 +99,7 @@ - [OnType](modules.md#ontype) - [SimpleTypes](modules.md#simpletypes) - [ValidationResultOutcomeEnum](modules.md#validationresultoutcomeenum) +- [ValidationSummaryValidatorStatusEnum](modules.md#validationsummaryvalidatorstatusenum) - [ValidatorLogValidationResultOutcomeEnum](modules.md#validatorlogvalidationresultoutcomeenum) - [ValidatorReferenceOnFailEnum](modules.md#validatorreferenceonfailenum) @@ -109,6 +111,7 @@ - [LLMResource](modules.md#llmresource-1) - [SimpleTypes](modules.md#simpletypes-1) - [ValidationResultOutcomeEnum](modules.md#validationresultoutcomeenum-1) +- [ValidationSummaryValidatorStatusEnum](modules.md#validationsummaryvalidatorstatusenum-1) - [ValidatorLogValidationResultOutcomeEnum](modules.md#validatorlogvalidationresultoutcomeenum-1) - [ValidatorReferenceOnFailEnum](modules.md#validatorreferenceonfailenum-1) @@ -221,6 +224,9 @@ - [ValidationResultFromJSON](modules.md#validationresultfromjson) - [ValidationResultFromJSONTyped](modules.md#validationresultfromjsontyped) - [ValidationResultToJSON](modules.md#validationresulttojson) +- [ValidationSummaryFromJSON](modules.md#validationsummaryfromjson) +- [ValidationSummaryFromJSONTyped](modules.md#validationsummaryfromjsontyped) +- [ValidationSummaryToJSON](modules.md#validationsummarytojson) - [ValidationToJSON](modules.md#validationtojson) - [ValidationTypeFromJSON](modules.md#validationtypefromjson) - [ValidationTypeFromJSONTyped](modules.md#validationtypefromjsontyped) @@ -274,6 +280,7 @@ - [instanceOfValidationOutcome](modules.md#instanceofvalidationoutcome) - [instanceOfValidationOutcomeValidatedOutput](modules.md#instanceofvalidationoutcomevalidatedoutput) - [instanceOfValidationResult](modules.md#instanceofvalidationresult) +- [instanceOfValidationSummary](modules.md#instanceofvalidationsummary) - [instanceOfValidationType](modules.md#instanceofvalidationtype) - [instanceOfValidatorLog](modules.md#instanceofvalidatorlog) - [instanceOfValidatorLogInstanceId](modules.md#instanceofvalidatorloginstanceid) @@ -455,6 +462,18 @@ src/models/ValidationResult.ts:48 ___ +### ValidationSummaryValidatorStatusEnum + +Ƭ **ValidationSummaryValidatorStatusEnum**: typeof [`ValidationSummaryValidatorStatusEnum`](modules.md#validationsummaryvalidatorstatusenum-1)[keyof typeof [`ValidationSummaryValidatorStatusEnum`](modules.md#validationsummaryvalidatorstatusenum-1)] + +#### Defined in + +src/models/ValidationSummary.ts:59 + +src/models/ValidationSummary.ts:63 + +___ + ### ValidatorLogValidationResultOutcomeEnum Ƭ **ValidatorLogValidationResultOutcomeEnum**: typeof [`ValidatorLogValidationResultOutcomeEnum`](modules.md#validatorlogvalidationresultoutcomeenum-1)[keyof typeof [`ValidatorLogValidationResultOutcomeEnum`](modules.md#validatorlogvalidationresultoutcomeenum-1)] @@ -601,6 +620,27 @@ src/models/ValidationResult.ts:48 ___ +### ValidationSummaryValidatorStatusEnum + +• `Const` **ValidationSummaryValidatorStatusEnum**: `Object` + +**`Export`** + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `Fail` | ``"fail"`` | +| `Pass` | ``"pass"`` | + +#### Defined in + +src/models/ValidationSummary.ts:59 + +src/models/ValidationSummary.ts:63 + +___ + ### ValidatorLogValidationResultOutcomeEnum • `Const` **ValidatorLogValidationResultOutcomeEnum**: `Object` @@ -2658,7 +2698,7 @@ ___ #### Defined in -src/models/ValidationOutcome.ts:74 +src/models/ValidationOutcome.ts:85 ___ @@ -2679,7 +2719,7 @@ ___ #### Defined in -src/models/ValidationOutcome.ts:78 +src/models/ValidationOutcome.ts:89 ___ @@ -2699,7 +2739,7 @@ ___ #### Defined in -src/models/ValidationOutcome.ts:100 +src/models/ValidationOutcome.ts:117 ___ @@ -2825,6 +2865,67 @@ src/models/ValidationResult.ts:78 ___ +### ValidationSummaryFromJSON + +▸ **ValidationSummaryFromJSON**(`json`): [`ValidationSummary`](interfaces/ValidationSummary.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `json` | `any` | + +#### Returns + +[`ValidationSummary`](interfaces/ValidationSummary.md) + +#### Defined in + +src/models/ValidationSummary.ts:75 + +___ + +### ValidationSummaryFromJSONTyped + +▸ **ValidationSummaryFromJSONTyped**(`json`, `ignoreDiscriminator`): [`ValidationSummary`](interfaces/ValidationSummary.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `json` | `any` | +| `ignoreDiscriminator` | `boolean` | + +#### Returns + +[`ValidationSummary`](interfaces/ValidationSummary.md) + +#### Defined in + +src/models/ValidationSummary.ts:79 + +___ + +### ValidationSummaryToJSON + +▸ **ValidationSummaryToJSON**(`value?`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value?` | ``null`` \| [`ValidationSummary`](interfaces/ValidationSummary.md) | + +#### Returns + +`any` + +#### Defined in + +src/models/ValidationSummary.ts:100 + +___ + ### ValidationToJSON ▸ **ValidationToJSON**(`value?`): `any` @@ -3910,7 +4011,7 @@ Check if a given object implements the ValidationOutcome interface. #### Defined in -src/models/ValidationOutcome.ts:69 +src/models/ValidationOutcome.ts:80 ___ @@ -3958,6 +4059,28 @@ src/models/ValidationResult.ts:54 ___ +### instanceOfValidationSummary + +▸ **instanceOfValidationSummary**(`value`): `boolean` + +Check if a given object implements the ValidationSummary interface. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `object` | + +#### Returns + +`boolean` + +#### Defined in + +src/models/ValidationSummary.ts:69 + +___ + ### instanceOfValidationType ▸ **instanceOfValidationType**(`value`): `boolean` diff --git a/resources/ts/package-lock.json b/resources/ts/package-lock.json index f5295bd..cb8c4b8 100644 --- a/resources/ts/package-lock.json +++ b/resources/ts/package-lock.json @@ -1,12 +1,12 @@ { "name": "@guardrails-ai/api-client", - "version": "0.3.12", + "version": "0.3.13", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@guardrails-ai/api-client", - "version": "0.3.12", + "version": "0.3.13", "license": "Apache-2.0", "devDependencies": { "@types/node": "^20.12.11", diff --git a/resources/ts/package.json b/resources/ts/package.json index b520613..935bab5 100644 --- a/resources/ts/package.json +++ b/resources/ts/package.json @@ -1,6 +1,6 @@ { "name": "@guardrails-ai/api-client", - "version": "0.3.12", + "version": "0.3.13", "description": "Client libaray for interacting with the guardrails-api", "main": "dist/index.js", "types": "dist/index.d.ts",