Skip to main content

AiProviderProps

@dopt/ai-assistant-react / Exports / AiProviderProps

Interface: AiProviderProps

Providing this configuration to the DoptAiProvider allows the the SDK to fetch relevant data from the Dopt AI API.

Hierarchy

  • PropsWithChildren

    AiProviderProps

Table of contents

Properties

Properties

userId

userId: undefined | string

The userId for the currently active user on the page.

Defined in

packages/@dopt/ai-assistant/react/src/types.ts:13


groupId

Optional groupId: string

An optional groupId for that userId.

Defined in

packages/@dopt/ai-assistant/react/src/types.ts:17


apiKey

apiKey: string

Your AI API key.

Defined in

packages/@dopt/ai-assistant/react/src/types.ts:21


environment

Optional environment: string

Defined in

packages/@dopt/ai-assistant/react/src/types.ts:22


model

Optional model: string

The underlying model you want answers generated with. This parameter is currently ignored by the API. It may be exposed in the future.

Defined in

packages/@dopt/ai-assistant/react/src/types.ts:29


logLevel

Optional logLevel: LogLevels

Defined in

packages/@dopt/ai-assistant/react/src/types.ts:31


children

Optional children: ReactNode

Inherited from

PropsWithChildren.children

Defined in

node_modules/.pnpm/@types+react@18.2.12/node_modules/@types/react/index.d.ts:835