@manta-eu/react/lib/structured-data

Reference for @manta-eu/react/lib/structured-data as it is on main.

Type Aliases

GenerateStructuredDataError

GenerateStructuredDataError = object

Properties

code

code: `${GQLStructuredDataErrorCode}`

error

error: string

issues?

optional issues?: object[]

message

message: string

path

path: string

outputExcerpt?

optional outputExcerpt?: string

GenerateStructuredDataOptions

GenerateStructuredDataOptions = object

Properties

maxRetries?

optional maxRetries?: number

timeout?

optional timeout?: number

GenerateStructuredDataRequest

GenerateStructuredDataRequest = object

Properties

context?

optional context?: Record<string, unknown>

prompt

prompt: string

schema

schema: SupportedSchema

GenerateStructuredDataResponse

GenerateStructuredDataResponse<T> = object

Type Parameters

T

T = unknown

Properties

data

data: T

finishReason

finishReason: string

usage?

optional usage?: object

completionTokens

completionTokens: number

promptTokens

promptTokens: number

totalTokens

totalTokens: number

warnings?

optional warnings?: string[]

GQLGenerateStructuredDataMutation

GQLGenerateStructuredDataMutation = object

Properties

__typename?

optional __typename?: "Mutation"

generateStructuredData

generateStructuredData: object

__typename?

optional __typename?: "StructuredDataResponse"

code?

optional code?: GQLStructuredDataErrorCode | null

data?

optional data?: unknown | null

error?

optional error?: string | null

issues?

optional issues?: object[] | null

outputExcerpt?

optional outputExcerpt?: string | null

GQLGenerateStructuredDataMutationVariables

GQLGenerateStructuredDataMutationVariables = Exact<{ input: GQLStructuredDataInput; }>

GQLStructuredDataInput

GQLStructuredDataInput = object

Properties

context?

optional context?: InputMaybe<Scalars["JSONObject"]["input"]>

prompt

prompt: Scalars["String"]["input"]

schema

schema: Scalars["JSONObject"]["input"]

GQLStructuredDataResponse

GQLStructuredDataResponse = object

Properties

__typename?

optional __typename?: "StructuredDataResponse"

code?

optional code?: Maybe<GQLStructuredDataErrorCode>

data?

optional data?: Maybe<Scalars["JSON"]["output"]>

error?

optional error?: Maybe<Scalars["String"]["output"]>

issues?

optional issues?: Maybe<GQLStructuredDataIssue[]>

outputExcerpt?

optional outputExcerpt?: Maybe<Scalars["String"]["output"]>

SupportedSchema

SupportedSchema = YupSchema | ZodSchema | JSONSchema7

YupSchema

YupSchema = object

Properties

isYupSchema

__isYupSchema__: true

cast

cast: (value) => unknown

Parameters

value

unknown

Returns

unknown

describe

describe: () => object

Returns

object

meta?

optional meta?: Record<string, unknown>

type

type: string

validateSync

validateSync: (value) => unknown

Parameters

value

unknown

Returns

unknown

ZodSchema

ZodSchema = ZodType

Functions

isJSONSchema()

isJSONSchema(schema): schema is JSONSchema7

Parameters

schema

unknown

Returns

schema is JSONSchema7

isYupSchema()

isYupSchema(schema): schema is YupSchema

Parameters

schema

unknown

Returns

schema is YupSchema

isZodSchema()

isZodSchema(schema): schema is ZodSchema

Parameters

schema

unknown

Returns

schema is ZodSchema

useGenerateStructuredDataMutation()

useGenerateStructuredDataMutation<TError, TContext>(client, options?, headers?): UseMutationResult<GQLGenerateStructuredDataMutation, TError, Exact<{ input: GQLStructuredDataInput; }>, TContext>

Type Parameters

TError

TError = unknown

TContext

TContext = unknown

Parameters

client

GraphQLClient

options?

UseMutationOptions<GQLGenerateStructuredDataMutation, TError, Exact<{ input: GQLStructuredDataInput; }>, TContext>

headers?

HeadersInit

Returns

UseMutationResult<GQLGenerateStructuredDataMutation, TError, Exact<{ input: GQLStructuredDataInput; }>, TContext>

References