UNPKG

axiom

Version:

Axiom AI SDK provides - an API to wrap your AI calls with observability instrumentation. - offline evals - online evals

264 lines (132 loc) 5.34 kB
[**axiom v0.51.1**](../../README.md) *** [axiom](../../README.md) / [index](../README.md) / experimental\_Type # Variable: experimental\_Type > `const` **experimental\_Type**: `object` ## Type Declaration ### Array() > `readonly` **Array**: \<`T`\>(`items`, ...`args`) => [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TArray`\<`T`\>\> = `createArray` #### Type Parameters ##### T `T` *extends* [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TSchema`\> #### Parameters ##### items `T` ##### args ...\[`ArrayOptions`\] #### Returns [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TArray`\<`T`\>\> ### Boolean() > `readonly` **Boolean**: (...`args`) => [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TBoolean`\> = `createBoolean` #### Parameters ##### args ...\[`SchemaOptions`\] #### Returns [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TBoolean`\> ### Integer() > `readonly` **Integer**: (...`args`) => [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TInteger`\> = `createInteger` #### Parameters ##### args ...\[`IntegerOptions`\] #### Returns [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TInteger`\> ### Literal() > `readonly` **Literal**: \<`T`\>(`value`, ...`args`) => [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TLiteral`\<`T`\>\> = `createLiteral` #### Type Parameters ##### T `T` *extends* `string` \| `number` \| `boolean` #### Parameters ##### value `T` ##### args ...\[`SchemaOptions`\] #### Returns [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TLiteral`\<`T`\>\> ### Null() > `readonly` **Null**: (...`args`) => [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TNull`\> = `createNull` #### Parameters ##### args ...\[`SchemaOptions`\] #### Returns [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TNull`\> ### Number() > `readonly` **Number**: (...`args`) => [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TNumber`\> = `createNumber` #### Parameters ##### args ...\[`NumberOptions`\] #### Returns [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TNumber`\> ### Object() > `readonly` **Object**: \<`T`\>(`properties`, ...`args`) => [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TObject`\<`T`\>\> = `createObject` #### Type Parameters ##### T `T` *extends* `Record`\<`string`, [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TSchema`\>\> #### Parameters ##### properties `T` ##### args ...\[`ObjectOptions`\] #### Returns [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TObject`\<`T`\>\> ### Optional() > `readonly` **Optional**: \<`T`\>(`schema`, ...`args`) => [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TAddOptional`\<`T`\>\> = `createOptional` #### Type Parameters ##### T `T` *extends* [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TSchema`\> #### Parameters ##### schema `T` ##### args ...\[\] #### Returns [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TAddOptional`\<`T`\>\> ### Record() > `readonly` **Record**: \<`V`\>(`value`, ...`args`) => [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TRecord`\<`TString`, `V`\>\> = `createRecord` #### Type Parameters ##### V `V` *extends* [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TSchema`\> #### Parameters ##### value `V` ##### args ...\[`ObjectOptions`\] #### Returns [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TRecord`\<`TString`, `V`\>\> ### String() > `readonly` **String**: (...`args`) => [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TString`\> = `createString` #### Parameters ##### args ...\[`StringOptions`\] #### Returns [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TString`\> ### Tuple() > `readonly` **Tuple**: \<`T`\>(`types`, ...`args`) => [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TTuple`\<`T`\>\> = `createTuple` #### Type Parameters ##### T `T` *extends* [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TSchema`\>[] #### Parameters ##### types \[`...T[]`\] ##### args ...\[`SchemaOptions`\] #### Returns [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TTuple`\<`T`\>\> ### Undefined() > `readonly` **Undefined**: (...`args`) => [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TUndefined`\> = `createUndefined` #### Parameters ##### args ...\[`SchemaOptions`\] #### Returns [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TUndefined`\> ### Union() > `readonly` **Union**: \<`T`\>(`schemas`, ...`args`) => [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`Union`\<`T`\>\> = `createUnion` #### Type Parameters ##### T `T` *extends* [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`TSchema`\>[] #### Parameters ##### schemas \[`...T[]`\] ##### args ...\[`SchemaOptions`\] #### Returns [`experimental_TSchema`](../type-aliases/experimental_TSchema.md)\<`Union`\<`T`\>\>