Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions resources/py/docs/CallInputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**llm_api** | **str** | The LLM resource targeted by the user. e.g. openai.chat.completions.create | [optional]
**llm_output** | **str** | The string output from an external LLM call provided by the user via Guard.parse. | [optional]
**instructions** | **str** | The instructions for chat models. | [optional]
**prompt** | **str** | The prompt for the LLM. | [optional]
**msg_history** | **List[Dict[str, object]]** | The message history for chat models. | [optional]
**prompt_params** | **Dict[str, object]** | Parameters to be formatted into the prompt. | [optional]
**messages** | **List[Dict[str, object]]** | The messages for chat models. | [optional]
**prompt_params** | **Dict[str, object]** | Parameters to be formatted into the messages. | [optional]
**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]
Expand Down
6 changes: 2 additions & 4 deletions resources/py/docs/Inputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**llm_api** | **str** | The LLM resource targeted by the user. e.g. openai.chat.completions.create | [optional]
**llm_output** | **str** | The string output from an external LLM call provided by the user via Guard.parse. | [optional]
**instructions** | **str** | The instructions for chat models. | [optional]
**prompt** | **str** | The prompt for the LLM. | [optional]
**msg_history** | **List[Dict[str, object]]** | The message history for chat models. | [optional]
**prompt_params** | **Dict[str, object]** | Parameters to be formatted into the prompt. | [optional]
**messages** | **List[Dict[str, object]]** | The messages for chat models. | [optional]
**prompt_params** | **Dict[str, object]** | Parameters to be formatted into the messages. | [optional]
**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]
Expand Down
2 changes: 1 addition & 1 deletion resources/py/docs/ValidatorReference.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **object** | The unique identifier for this Validator. Often the hub id; e.g. guardrails/regex_match |
**on** | [**AnyOfAnyTypeAnyType**](AnyOfAnyTypeAnyType.md) | A reference to the property this validator should be applied against. Can be a valid JSON path or a meta-property such as \"prompt\" or \"output\" | [optional]
**on** | [**AnyOfAnyTypeAnyType**](AnyOfAnyTypeAnyType.md) | A reference to the property this validator should be applied against. Can be a valid JSON path or a meta-property such as \"messages\" or \"output\" | [optional]
**on_fail** | **object** | | [optional]
**args** | [**List[object]**](AnyType.md) | | [optional]
**kwargs** | **Dict[str, object]** | | [optional]
Expand Down
2 changes: 1 addition & 1 deletion resources/py/pyproject.toml.template
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "guardrails-api-client"
version = "0.3.13"
version = "0.4.0-alpha1"
description = "Guardrails API Client."
authors = [
{name = "Guardrails AI", email = "[email protected]"}
Expand Down
74 changes: 20 additions & 54 deletions resources/ts/docs/interfaces/CallInputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,12 @@ CallInputs

- [args](CallInputs.md#args)
- [fullSchemaReask](CallInputs.md#fullschemareask)
- [instructions](CallInputs.md#instructions)
- [kwargs](CallInputs.md#kwargs)
- [llmApi](CallInputs.md#llmapi)
- [llmOutput](CallInputs.md#llmoutput)
- [messages](CallInputs.md#messages)
- [metadata](CallInputs.md#metadata)
- [msgHistory](CallInputs.md#msghistory)
- [numReasks](CallInputs.md#numreasks)
- [prompt](CallInputs.md#prompt)
- [promptParams](CallInputs.md#promptparams)
- [stream](CallInputs.md#stream)

Expand All @@ -35,7 +33,7 @@ CallInputs

#### Defined in

src/models/CallInputs.ts:86
src/models/CallInputs.ts:74

___

Expand All @@ -51,23 +49,7 @@ CallInputs

#### Defined in

src/models/CallInputs.ts:74

___

### instructions

• `Optional` **instructions**: `string`

The instructions for chat models.

**`Memberof`**

CallInputs

#### Defined in

src/models/CallInputs.ts:38
src/models/CallInputs.ts:62

___

Expand All @@ -85,7 +67,7 @@ CallInputs

#### Defined in

src/models/CallInputs.ts:92
src/models/CallInputs.ts:80

___

Expand Down Expand Up @@ -121,39 +103,39 @@ src/models/CallInputs.ts:32

___

### metadata
### messages

• `Optional` **metadata**: `Object`
• `Optional` **messages**: \{ `[key: string]`: `any`; }[]

Additional data to be used by Validators during execution time.
The messages for chat models.

**`Memberof`**

CallInputs

#### Index signature

▪ [key: `string`]: `any`

#### Defined in

src/models/CallInputs.ts:68
src/models/CallInputs.ts:38

___

### msgHistory
### metadata

• `Optional` **msgHistory**: \{ `[key: string]`: `any`; }[]
• `Optional` **metadata**: `Object`

The message history for chat models.
Additional data to be used by Validators during execution time.

**`Memberof`**

CallInputs

#### Index signature

▪ [key: `string`]: `any`

#### Defined in

src/models/CallInputs.ts:50
src/models/CallInputs.ts:56

___

Expand All @@ -169,31 +151,15 @@ CallInputs

#### Defined in

src/models/CallInputs.ts:62

___

### prompt

• `Optional` **prompt**: `string`

The prompt for the LLM.

**`Memberof`**

CallInputs

#### Defined in

src/models/CallInputs.ts:44
src/models/CallInputs.ts:50

___

### promptParams

• `Optional` **promptParams**: `Object`

Parameters to be formatted into the prompt.
Parameters to be formatted into the messages.

**`Memberof`**

Expand All @@ -205,7 +171,7 @@ CallInputs

#### Defined in

src/models/CallInputs.ts:56
src/models/CallInputs.ts:44

___

Expand All @@ -221,4 +187,4 @@ CallInputs

#### Defined in

src/models/CallInputs.ts:80
src/models/CallInputs.ts:68
70 changes: 18 additions & 52 deletions resources/ts/docs/interfaces/Inputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,11 @@ Inputs
### Properties

- [fullSchemaReask](Inputs.md#fullschemareask)
- [instructions](Inputs.md#instructions)
- [llmApi](Inputs.md#llmapi)
- [llmOutput](Inputs.md#llmoutput)
- [messages](Inputs.md#messages)
- [metadata](Inputs.md#metadata)
- [msgHistory](Inputs.md#msghistory)
- [numReasks](Inputs.md#numreasks)
- [prompt](Inputs.md#prompt)
- [promptParams](Inputs.md#promptparams)
- [stream](Inputs.md#stream)

Expand All @@ -35,23 +33,7 @@ Inputs

#### Defined in

src/models/Inputs.ts:74

___

### instructions

• `Optional` **instructions**: `string`

The instructions for chat models.

**`Memberof`**

Inputs

#### Defined in

src/models/Inputs.ts:38
src/models/Inputs.ts:62

___

Expand Down Expand Up @@ -87,39 +69,39 @@ src/models/Inputs.ts:32

___

### metadata
### messages

• `Optional` **metadata**: `Object`
• `Optional` **messages**: \{ `[key: string]`: `any`; }[]

Additional data to be used by Validators during execution time.
The messages for chat models.

**`Memberof`**

Inputs

#### Index signature

▪ [key: `string`]: `any`

#### Defined in

src/models/Inputs.ts:68
src/models/Inputs.ts:38

___

### msgHistory
### metadata

• `Optional` **msgHistory**: \{ `[key: string]`: `any`; }[]
• `Optional` **metadata**: `Object`

The message history for chat models.
Additional data to be used by Validators during execution time.

**`Memberof`**

Inputs

#### Index signature

▪ [key: `string`]: `any`

#### Defined in

src/models/Inputs.ts:50
src/models/Inputs.ts:56

___

Expand All @@ -135,31 +117,15 @@ Inputs

#### Defined in

src/models/Inputs.ts:62

___

### prompt

• `Optional` **prompt**: `string`

The prompt for the LLM.

**`Memberof`**

Inputs

#### Defined in

src/models/Inputs.ts:44
src/models/Inputs.ts:50

___

### promptParams

• `Optional` **promptParams**: `Object`

Parameters to be formatted into the prompt.
Parameters to be formatted into the messages.

**`Memberof`**

Expand All @@ -171,7 +137,7 @@ Inputs

#### Defined in

src/models/Inputs.ts:56
src/models/Inputs.ts:44

___

Expand All @@ -187,4 +153,4 @@ Inputs

#### Defined in

src/models/Inputs.ts:80
src/models/Inputs.ts:68
2 changes: 1 addition & 1 deletion resources/ts/docs/interfaces/ValidatorReference.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ ___

• `Optional` **on**: `string`

A reference to the property this validator should be applied against. Can be a valid JSON path or a meta-property such as "prompt" or "output"
A reference to the property this validator should be applied against. Can be a valid JSON path or a meta-property such as "messages" or "output"

**`Memberof`**

Expand Down
Loading