Skip to content

Latest commit

 

History

History
453 lines (244 loc) · 9.98 KB

History.CallInputs.md

File metadata and controls

453 lines (244 loc) · 9.98 KB

@guardrails-ai/core / Exports / History / CallInputs

Class: CallInputs

History.CallInputs

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new CallInputs(llmOutput?, instructions?, prompt?, msgHistory?, promptParams?, numReasks?, metadata?, fullSchemaReask?, args?, kwargs?): CallInputs

Parameters

Name Type
llmOutput? string
instructions? string
prompt? string
msgHistory? Dictionary[]
promptParams? Dictionary
numReasks? number
metadata? Dictionary
fullSchemaReask? boolean
args? any[]
kwargs? Dictionary

Returns

CallInputs

Overrides

Inputs.constructor

Defined in

src/history/call-inputs.ts:15

Properties

_args

Private Optional _args: any[]

Additional arguments for the LLM as provided by the user.",

Defined in

src/history/call-inputs.ts:9


_fullSchemaReask

Protected Optional _fullSchemaReask: boolean

Whether to perform reasks across the entire schema or at the field level.

Inherited from

Inputs._fullSchemaReask

Defined in

src/history/inputs.ts:36


_instructions

Protected Optional _instructions: string

The instructions for chat model calls.

Inherited from

Inputs._instructions

Defined in

src/history/inputs.ts:12


_kwargs

Private Optional _kwargs: Dictionary

Additional keyword-arguments for the LLM as provided by the user.

Defined in

src/history/call-inputs.ts:13


_llmOutput

Protected Optional _llmOutput: string

The string output from an external LLM call provided by the user via Guard.parse.

Inherited from

Inputs._llmOutput

Defined in

src/history/inputs.ts:8


_metadata

Protected Optional _metadata: Dictionary

The metadata provided by the user to be used during validation.

Inherited from

Inputs._metadata

Defined in

src/history/inputs.ts:32


_msgHistory

Protected Optional _msgHistory: Dictionary[]

The message history provided by the user for chat model calls.

Inherited from

Inputs._msgHistory

Defined in

src/history/inputs.ts:20


_numReasks

Protected Optional _numReasks: number

The total number of reasks allowed; user provided or defaulted.

Inherited from

Inputs._numReasks

Defined in

src/history/inputs.ts:28


_prompt

Protected Optional _prompt: string

The prompt.

Inherited from

Inputs._prompt

Defined in

src/history/inputs.ts:16


_promptParams

Protected Optional _promptParams: Dictionary

The parameters provided by the user that will be formatted into the final LLM prompt.

Inherited from

Inputs._promptParams

Defined in

src/history/inputs.ts:24

Accessors

args

get args(): undefined | any[]

Returns

undefined | any[]

Defined in

src/history/call-inputs.ts:93


fullSchemaReask

get fullSchemaReask(): undefined | boolean

Returns

undefined | boolean

Inherited from

Inputs.fullSchemaReask

Defined in

src/history/inputs.ts:113


instructions

get instructions(): undefined | string

The instructions string as provided by the user.

Returns

undefined | string

Overrides

Inputs.instructions

Defined in

src/history/call-inputs.ts:90


kwargs

get kwargs(): undefined | Dictionary

Returns

undefined | Dictionary

Defined in

src/history/call-inputs.ts:96


llmOutput

get llmOutput(): undefined | string

Returns

undefined | string

Inherited from

Inputs.llmOutput

Defined in

src/history/inputs.ts:92


metadata

get metadata(): undefined | Dictionary

Returns

undefined | Dictionary

Inherited from

Inputs.metadata

Defined in

src/history/inputs.ts:110


msgHistory

get msgHistory(): undefined | Dictionary[]

Returns

undefined | Dictionary[]

Inherited from

Inputs.msgHistory

Defined in

src/history/inputs.ts:101


numReasks

get numReasks(): undefined | number

Returns

undefined | number

Inherited from

Inputs.numReasks

Defined in

src/history/inputs.ts:107


prompt

get prompt(): undefined | string

The prompt string as provided by the user.

Returns

undefined | string

Overrides

Inputs.prompt

Defined in

src/history/call-inputs.ts:84


promptParams

get promptParams(): undefined | Dictionary

Returns

undefined | Dictionary

Inherited from

Inputs.promptParams

Defined in

src/history/inputs.ts:104

Methods

fromPyCallInputs

fromPyCallInputs(pyCallInputs): Promise<CallInputs>

Parameters

Name Type
pyCallInputs any

Returns

Promise<CallInputs>

Defined in

src/history/call-inputs.ts:41


fromPyInputs

fromPyInputs(pyInputs): Promise<Inputs>

Parameters

Name Type
pyInputs any

Returns

Promise<Inputs>

Inherited from

Inputs.fromPyInputs

Defined in

src/history/inputs.ts:58