Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
CalebCourier committed Jun 24, 2024
1 parent 0c49ceb commit b70eedd
Show file tree
Hide file tree
Showing 38 changed files with 961 additions and 833 deletions.
6 changes: 1 addition & 5 deletions resources/py/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,14 @@ bash ./py-build.sh
- [ArgsAndKwargs](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/ArgsAndKwargs.md);
- [ArraysInner](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/ArraysInner.md);
- [Call](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/Call.md);
- [CallException](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/CallException.md);
- [CallExceptionAnyOf](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/CallExceptionAnyOf.md);
- [CallInputs](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/CallInputs.md);
- [Content](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/Content.md);
- [Core](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/Core.md);
- [ErrorSpan](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/ErrorSpan.md);
- [FailResult](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/FailResult.md);
- [FormatAnnotation](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/FormatAnnotation.md);
- [Guard](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/Guard.md);
- [GuardApi](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/GuardApi.md);
- [GuardHistory](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/GuardHistory.md);
- [GuardHistoryAnyOfInner](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/GuardHistoryAnyOfInner.md);
- [HealthCheck](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/HealthCheck.md);
- [HttpError](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/HttpError.md);
- [Inputs](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/Inputs.md);
Expand All @@ -49,7 +46,6 @@ bash ./py-build.sh
- [MetaData](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/MetaData.md);
- [ModelSchema](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/ModelSchema.md);
- [Outputs](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/Outputs.md);
- [OutputsException](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/OutputsException.md);
- [OutputsParsedOutput](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/OutputsParsedOutput.md);
- [OutputsValidationResponse](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/OutputsValidationResponse.md);
- [PassResult](https://github.com/guardrails-ai/guardrails-api-client/tree/main/resources/py/docs/PassResult.md);
Expand Down
2 changes: 1 addition & 1 deletion resources/py/docs/Call.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
**id** | **str** | The unique identifier for this Call. Can be used as an identifier for a specific execution of a Guard. |
**iterations** | [**List[Iteration]**](Iteration.md) | | [optional] [default to []]
**inputs** | [**CallInputs**](CallInputs.md) | | [optional]
**exception** | [**CallException**](CallException.md) | | [optional]
**exception** | **str** | | [optional]

## Example

Expand Down
29 changes: 0 additions & 29 deletions resources/py/docs/CallException.md

This file was deleted.

29 changes: 0 additions & 29 deletions resources/py/docs/CallExceptionAnyOf.md

This file was deleted.

1 change: 1 addition & 0 deletions resources/py/docs/CallInputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Name | Type | Description | Notes
**num_reasks** | **int** | The total number of times the LLM can be called to correct output excluding the initial call. | [optional]
**metadata** | **Dict[str, object]** | Additional data to be used by Validators during execution time. | [optional]
**full_schema_reask** | **bool** | Whether to perform reasks for the entire schema rather than for individual fields. | [optional]
**stream** | **bool** | Whether to use streaming. | [optional]
**args** | [**List[object]**](AnyType.md) | | [optional]
**kwargs** | **Dict[str, object]** | | [optional]

Expand Down
31 changes: 31 additions & 0 deletions resources/py/docs/ErrorSpan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# ErrorSpan


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**start** | **int** | |
**end** | **int** | |
**reason** | **str** | The reason validation failed, specific to this chunk. |

## Example

```python
from guardrails_api_client.models.error_span import ErrorSpan

# TODO update the JSON string below
json = "{}"
# create an instance of ErrorSpan from a JSON string
error_span_instance = ErrorSpan.from_json(json)
# print the JSON string representation of the object
print(ErrorSpan.to_json())

# convert the object into a dict
error_span_dict = error_span_instance.to_dict()
# create an instance of ErrorSpan from a dict
error_span_from_dict = ErrorSpan.from_dict(error_span_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)


6 changes: 4 additions & 2 deletions resources/py/docs/FailResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**outcome** | **object** | | [optional]
**error_message** | **object** | | [optional]
**outcome** | **object** | |
**error_message** | **object** | |
**fix_value** | [**object**](AnyType.md) | | [optional]
**error_spans** | [**List[ErrorSpan]**](ErrorSpan.md) | | [optional]
**metadata** | **Dict[str, object]** | | [optional]
**validated_chunk** | [**object**](AnyType.md) | | [optional]

## Example

Expand Down
2 changes: 1 addition & 1 deletion resources/py/docs/Guard.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Name | Type | Description | Notes
**description** | **str** | A description that concisely states the expected behaviour or purpose of the Guard. | [optional]
**validators** | [**List[ValidatorReference]**](ValidatorReference.md) | | [optional]
**output_schema** | [**ModelSchema**](ModelSchema.md) | | [optional]
**history** | [**GuardHistory**](GuardHistory.md) | | [optional]
**history** | [**List[Call]**](Call.md) | | [optional]

## Example

Expand Down
28 changes: 0 additions & 28 deletions resources/py/docs/GuardHistory.md

This file was deleted.

29 changes: 0 additions & 29 deletions resources/py/docs/GuardHistoryAnyOfInner.md

This file was deleted.

1 change: 1 addition & 0 deletions resources/py/docs/Inputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Name | Type | Description | Notes
**num_reasks** | **int** | The total number of times the LLM can be called to correct output excluding the initial call. | [optional]
**metadata** | **Dict[str, object]** | Additional data to be used by Validators during execution time. | [optional]
**full_schema_reask** | **bool** | Whether to perform reasks for the entire schema rather than for individual fields. | [optional]
**stream** | **bool** | Whether to use streaming. | [optional]

## Example

Expand Down
3 changes: 2 additions & 1 deletion resources/py/docs/LLMResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**prompt_token_count** | **int** | | [optional]
**response_token_count** | **int** | | [optional]
**output** | **str** | | [optional]
**output** | **str** | |
**stream_output** | **List[str]** | | [optional]
**async_stream_output** | **List[str]** | | [optional]

## Example

Expand Down
1 change: 0 additions & 1 deletion resources/py/docs/Outputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ Name | Type | Description | Notes
**reasks** | [**List[Reask]**](Reask.md) | | [optional]
**validator_logs** | [**List[ValidatorLog]**](ValidatorLog.md) | | [optional]
**error** | **str** | The error message from any exception which interrupted the Guard execution process. | [optional]
**exception** | [**OutputsException**](OutputsException.md) | | [optional]

## Example

Expand Down
30 changes: 0 additions & 30 deletions resources/py/docs/OutputsException.md

This file was deleted.

3 changes: 2 additions & 1 deletion resources/py/docs/PassResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**outcome** | **object** | | [optional]
**outcome** | **object** | |
**value_override** | [**object**](AnyType.md) | | [optional]
**metadata** | **Dict[str, object]** | | [optional]
**validated_chunk** | [**object**](AnyType.md) | | [optional]

## Example

Expand Down
3 changes: 2 additions & 1 deletion resources/py/docs/ValidationResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ The output from a single Validator.

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**outcome** | **str** | | [optional]
**outcome** | **str** | |
**metadata** | **Dict[str, object]** | | [optional]
**validated_chunk** | [**object**](AnyType.md) | | [optional]

## Example

Expand Down
8 changes: 4 additions & 4 deletions resources/py/docs/ValidatorLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**validator_name** | **str** | The class name of the validator. | [optional]
**registered_name** | **str** | The registry id of the validator. | [optional]
**validator_name** | **str** | The class name of the validator. |
**registered_name** | **str** | The registry id of the validator. |
**instance_id** | [**ValidatorLogInstanceId**](ValidatorLogInstanceId.md) | | [optional]
**property_path** | **str** | The JSON path to the property which was validated that produced this log. | [optional]
**value_before_validation** | [**object**](AnyType.md) | | [optional]
**property_path** | **str** | The JSON path to the property which was validated that produced this log. |
**value_before_validation** | [**object**](AnyType.md) | |
**value_after_validation** | [**object**](AnyType.md) | | [optional]
**validation_result** | [**ValidatorLogValidationResult**](ValidatorLogValidationResult.md) | | [optional]
**start_time** | **datetime** | | [optional]
Expand Down
6 changes: 4 additions & 2 deletions resources/py/docs/ValidatorLogValidationResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**outcome** | **str** | | [optional]
**outcome** | **str** | |
**value_override** | [**object**](AnyType.md) | | [optional]
**metadata** | **Dict[str, object]** | | [optional]
**error_message** | **object** | | [optional]
**validated_chunk** | [**object**](AnyType.md) | | [optional]
**error_message** | **object** | |
**fix_value** | [**object**](AnyType.md) | | [optional]
**error_spans** | [**List[ErrorSpan]**](ErrorSpan.md) | | [optional]

## Example

Expand Down
10 changes: 5 additions & 5 deletions resources/ts/docs/interfaces/Call.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ Call

### exception

`Optional` **exception**: `string` \| [`CallException`](CallException.md)
`Optional` **exception**: `string`

**`Memberof`**

Call

#### Defined in

src/models/Call.ts:51
src/models/Call.ts:49

___

Expand All @@ -43,7 +43,7 @@ Call

#### Defined in

src/models/Call.ts:33
src/models/Call.ts:31

___

Expand All @@ -57,7 +57,7 @@ Call

#### Defined in

src/models/Call.ts:45
src/models/Call.ts:43

___

Expand All @@ -71,4 +71,4 @@ Call

#### Defined in

src/models/Call.ts:39
src/models/Call.ts:37
Loading

0 comments on commit b70eedd

Please sign in to comment.