modules

@dopt/ai-assistant-react / Exports

@dopt/ai-assistant-react

Interfaces

AiProviderProps

Type Aliases

Variables

Functions

Type Aliases

DoptAiContext

Ƭ DoptAiContext: Object

Type declaration

Name	Type
`logger`	`RefObject`<`Logger`>
`assistant`	`Assistant`

Defined in

packages/@dopt/ai-assistant/react/src/context.ts:5

packages/@dopt/ai-assistant/react/src/context.ts:10

AnswerChunk

Ƭ AnswerChunk: Object

Type declaration

Name	Type
`type`	`"answer"`
`answer`	`string`
`sources`	{ `title`: `string` ; `url`: `string` ; `id`: `number` ; `chunks`: { text: string; chunkId: number; score: number; }[] }[]

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:177

packages/@dopt/ai-assistant/definition/dist/index.d.ts:191

AssistantCompletionsRequestBody

Ƭ AssistantCompletionsRequestBody: Object

Type declaration

Name Type

query undefined | string

context undefined | { document: undefined | { value: { title: string; url: string; width: number; height: number; }; type: "document"; } ; visual: undefined | { value: string; type: "visual"; } ; element: undefined | { value: { position: { top: number; left: number; }; content: string; tag: string; }; type: "element"; } ; semantic: undefined | { value: { semanticContent: string; neighboringSemanticContent: string; }; type: "semantic"; } }

Name	Type
`query`	`undefined` \| `string`
`context`	`undefined` \| { `document`: `undefined` \| { value: { title: string; url: string; width: number; height: number; }; type: "document"; } ; `visual`: `undefined` \| { value: string; type: "visual"; } ; `element`: `undefined` \| { value: { position: { top: number; left: number; }; content: string; tag: string; }; type: "element"; } ; `semantic`: `undefined` \| { value: { semanticContent: string; neighboringSemanticContent: string; }; type: "semantic"; } }

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:56

packages/@dopt/ai-assistant/definition/dist/index.d.ts:92

AssistantCompletionsResponse

Ƭ AssistantCompletionsResponse: Object

Type declaration

Name	Type
`answer`	`string`
`sources`	{ `title`: `string` ; `url`: `string` ; `id`: `number` ; `chunks`: { text: string; chunkId: number; score: number; }[] }[]

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:152

packages/@dopt/ai-assistant/definition/dist/index.d.ts:165

AssistantDocumentSources

Ƭ AssistantDocumentSources: Static<typeof AssistantDocumentSources>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:130

packages/@dopt/ai-assistant/definition/dist/index.d.ts:140

AssistantQueryParams

Ƭ AssistantQueryParams: Object

Type declaration

Name	Type
`model`	`undefined` \| `string`
`groupIdentifier`	`undefined` \| `string`
`userIdentifier`	`string`

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:9

packages/@dopt/ai-assistant/definition/dist/index.d.ts:14

AssistantRequestBody

Ƭ AssistantRequestBody: Object

Type declaration

Name Type

query undefined | string

Name	Type
`query`	`undefined` \| `string`
`context`	`undefined` \| { `document`: `undefined` \| { value: { title: string; url: string; width: number; height: number; }; type: "document"; } ; `visual`: `undefined` \| { value: string; type: "visual"; } ; `element`: `undefined` \| { value: { position: { top: number; left: number; }; content: string; tag: string; }; type: "element"; } ; `semantic`: `undefined` \| { value: { semanticContent: string; neighboringSemanticContent: string; }; type: "semantic"; } }

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:19

packages/@dopt/ai-assistant/definition/dist/index.d.ts:55

AssistantRequestParams

Ƭ AssistantRequestParams: Object

Type declaration

Name	Type
`sid`	`string`

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:15

packages/@dopt/ai-assistant/definition/dist/index.d.ts:18

AssistantSearchRequestBody

Ƭ AssistantSearchRequestBody: Object

Type declaration

Name Type

query undefined | string

Name	Type
`query`	`undefined` \| `string`
`context`	`undefined` \| { `document`: `undefined` \| { value: { title: string; url: string; width: number; height: number; }; type: "document"; } ; `visual`: `undefined` \| { value: string; type: "visual"; } ; `element`: `undefined` \| { value: { position: { top: number; left: number; }; content: string; tag: string; }; type: "element"; } ; `semantic`: `undefined` \| { value: { semanticContent: string; neighboringSemanticContent: string; }; type: "semantic"; } }

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:93

packages/@dopt/ai-assistant/definition/dist/index.d.ts:129

AssistantSearchResponse

Ƭ AssistantSearchResponse: Static<typeof AssistantSearchResponse>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:141

packages/@dopt/ai-assistant/definition/dist/index.d.ts:151

ChatStreamChunk

Ƭ ChatStreamChunk: Object

Type declaration

Name	Type
`type`	`"content"` \| `"status"` \| `"answer"`

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:192

packages/@dopt/ai-assistant/definition/dist/index.d.ts:212

ContentStreamChunk

Ƭ ContentStreamChunk: Object

Type declaration

Name	Type
`type`	`"content"`
`content`	`string`

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:172

packages/@dopt/ai-assistant/definition/dist/index.d.ts:176

Context

Ƭ Context: Object

Type declaration

Name	Type
`type`	`"document"` \| `"visual"` \| `"element"` \| `"semantic"`

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:214

packages/@dopt/ai-assistant/definition/dist/index.d.ts:217

DocumentContext

Ƭ DocumentContext: Object

Type declaration

Name	Type
`value`	{ `title`: `string` ; `url`: `string` ; `width`: `number` ; `height`: `number` }
`value.title`	`string`
`value.url`	`string`
`value.width`	`number`
`value.height`	`number`
`type`	`"document"`

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:218

packages/@dopt/ai-assistant/definition/dist/index.d.ts:227

ElementContext

Ƭ ElementContext: Object

Type declaration

Name	Type
`value`	{ `position`: { top: number; left: number; } ; `content`: `string` ; `tag`: `string` }
`value.position`	{ top: number; left: number; }
`value.content`	`string`
`value.tag`	`string`
`type`	`"element"`

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:228

packages/@dopt/ai-assistant/definition/dist/index.d.ts:239

SemanticContext

Ƭ SemanticContext: Object

Type declaration

Name	Type
`value`	{ `semanticContent`: `string` ; `neighboringSemanticContent`: `string` }
`value.semanticContent`	`string`
`value.neighboringSemanticContent`	`string`
`type`	`"semantic"`

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:245

packages/@dopt/ai-assistant/definition/dist/index.d.ts:252

StatusChunk

Ƭ StatusChunk: Object

Type declaration

Name	Type
`type`	`"status"`
`status`	`"searching"` \| `"answering"`

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:167

packages/@dopt/ai-assistant/definition/dist/index.d.ts:171

UserIdentifierParams

Ƭ UserIdentifierParams: Object

Type declaration

Name	Type
`groupIdentifier`	`undefined` \| `string`
`userIdentifier`	`string`

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:4

packages/@dopt/ai-assistant/definition/dist/index.d.ts:8

VisualContext

Ƭ VisualContext: Object

Type declaration

Name	Type
`value`	`string`
`type`	`"visual"`

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:240

packages/@dopt/ai-assistant/definition/dist/index.d.ts:244

Variables

DoptAiContext

• DoptAiContext: Context<DoptAiContext>

Defined in

packages/@dopt/ai-assistant/react/src/context.ts:5

packages/@dopt/ai-assistant/react/src/context.ts:10

AnswerChunk

• Const AnswerChunk: _sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"answer"> ; answer: _sinclair_typebox.TString<string> ; sources: _sinclair_typebox.TArray<_sinclair_typebox.TObject<{ id: _sinclair_typebox.TNumber ; title: _sinclair_typebox.TString<string> ; url: _sinclair_typebox.TString<string> ; chunks: _sinclair_typebox.TArray<_sinclair_typebox.TObject<{ chunkId: _sinclair_typebox.TNumber ; text: _sinclair_typebox.TString<string> ; score: _sinclair_typebox.TNumber }>> }>> }>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:177

packages/@dopt/ai-assistant/definition/dist/index.d.ts:191

AssistantCompletionsRequestBody

• Const AssistantCompletionsRequestBody: _sinclair_typebox.TObject<{ query: _sinclair_typebox.TOptional<_sinclair_typebox.TString<string>> ; context: _sinclair_typebox.TOptional<_sinclair_typebox.TObject<{ document: _sinclair_typebox.TOptional<_sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"document"> ; value: _sinclair_typebox.TObject<{ url: _sinclair_typebox.TString<string> ; title: _sinclair_typebox.TString<string> ; width: _sinclair_typebox.TNumber ; height: _sinclair_typebox.TNumber }> }>> ; visual: _sinclair_typebox.TOptional<_sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"visual"> ; value: _sinclair_typebox.TString<string> }>> ; element: _sinclair_typebox.TOptional<_sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"element"> ; value: _sinclair_typebox.TObject<{ position: _sinclair_typebox.TObject<{ top: _sinclair_typebox.TNumber ; left: _sinclair_typebox.TNumber }> ; content: _sinclair_typebox.TString<string> ; tag: _sinclair_typebox.TString<string> }> }>> ; semantic: _sinclair_typebox.TOptional<_sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"semantic"> ; value: _sinclair_typebox.TObject<{ semanticContent: _sinclair_typebox.TString<string> ; neighboringSemanticContent: _sinclair_typebox.TString<string> }> }>> }>> }>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:56

packages/@dopt/ai-assistant/definition/dist/index.d.ts:92

AssistantCompletionsResponse

• Const AssistantCompletionsResponse: _sinclair_typebox.TObject<{ answer: _sinclair_typebox.TString<string> ; sources: _sinclair_typebox.TArray<_sinclair_typebox.TObject<{ id: _sinclair_typebox.TNumber ; title: _sinclair_typebox.TString<string> ; url: _sinclair_typebox.TString<string> ; chunks: _sinclair_typebox.TArray<_sinclair_typebox.TObject<{ chunkId: _sinclair_typebox.TNumber ; text: _sinclair_typebox.TString<string> ; score: _sinclair_typebox.TNumber }>> }>> }>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:152

packages/@dopt/ai-assistant/definition/dist/index.d.ts:165

AssistantDefaultCompletionsErrorMessage

• Const AssistantDefaultCompletionsErrorMessage: "The AI assistant is unavailable at this time. Please try again later."

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:254

AssistantDocumentSources

• Const AssistantDocumentSources: _sinclair_typebox.TArray<_sinclair_typebox.TObject<{ id: _sinclair_typebox.TNumber ; title: _sinclair_typebox.TString<string> ; url: _sinclair_typebox.TString<string> ; chunks: _sinclair_typebox.TArray<_sinclair_typebox.TObject<{ chunkId: _sinclair_typebox.TNumber ; text: _sinclair_typebox.TString<string> ; score: _sinclair_typebox.TNumber }>> }>>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:130

packages/@dopt/ai-assistant/definition/dist/index.d.ts:140

AssistantQueryParams

• Const AssistantQueryParams: _sinclair_typebox.TObject<{ model: _sinclair_typebox.TOptional<_sinclair_typebox.TString<string>> ; userIdentifier: _sinclair_typebox.TString<string> ; groupIdentifier: _sinclair_typebox.TOptional<_sinclair_typebox.TString<string>> }>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:9

packages/@dopt/ai-assistant/definition/dist/index.d.ts:14

AssistantRequestBody

• Const AssistantRequestBody: _sinclair_typebox.TObject<{ query: _sinclair_typebox.TOptional<_sinclair_typebox.TString<string>> ; context: _sinclair_typebox.TOptional<_sinclair_typebox.TObject<{ document: _sinclair_typebox.TOptional<_sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"document"> ; value: _sinclair_typebox.TObject<{ url: _sinclair_typebox.TString<string> ; title: _sinclair_typebox.TString<string> ; width: _sinclair_typebox.TNumber ; height: _sinclair_typebox.TNumber }> }>> ; visual: _sinclair_typebox.TOptional<_sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"visual"> ; value: _sinclair_typebox.TString<string> }>> ; element: _sinclair_typebox.TOptional<_sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"element"> ; value: _sinclair_typebox.TObject<{ position: _sinclair_typebox.TObject<{ top: _sinclair_typebox.TNumber ; left: _sinclair_typebox.TNumber }> ; content: _sinclair_typebox.TString<string> ; tag: _sinclair_typebox.TString<string> }> }>> ; semantic: _sinclair_typebox.TOptional<_sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"semantic"> ; value: _sinclair_typebox.TObject<{ semanticContent: _sinclair_typebox.TString<string> ; neighboringSemanticContent: _sinclair_typebox.TString<string> }> }>> }>> }>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:19

packages/@dopt/ai-assistant/definition/dist/index.d.ts:55

AssistantRequestParams

• Const AssistantRequestParams: _sinclair_typebox.TObject<{ sid: _sinclair_typebox.TString<string> }>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:15

packages/@dopt/ai-assistant/definition/dist/index.d.ts:18

AssistantSearchRequestBody

• Const AssistantSearchRequestBody: _sinclair_typebox.TObject<{ query: _sinclair_typebox.TOptional<_sinclair_typebox.TString<string>> ; context: _sinclair_typebox.TOptional<_sinclair_typebox.TObject<{ document: _sinclair_typebox.TOptional<_sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"document"> ; value: _sinclair_typebox.TObject<{ url: _sinclair_typebox.TString<string> ; title: _sinclair_typebox.TString<string> ; width: _sinclair_typebox.TNumber ; height: _sinclair_typebox.TNumber }> }>> ; visual: _sinclair_typebox.TOptional<_sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"visual"> ; value: _sinclair_typebox.TString<string> }>> ; element: _sinclair_typebox.TOptional<_sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"element"> ; value: _sinclair_typebox.TObject<{ position: _sinclair_typebox.TObject<{ top: _sinclair_typebox.TNumber ; left: _sinclair_typebox.TNumber }> ; content: _sinclair_typebox.TString<string> ; tag: _sinclair_typebox.TString<string> }> }>> ; semantic: _sinclair_typebox.TOptional<_sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"semantic"> ; value: _sinclair_typebox.TObject<{ semanticContent: _sinclair_typebox.TString<string> ; neighboringSemanticContent: _sinclair_typebox.TString<string> }> }>> }>> }>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:93

packages/@dopt/ai-assistant/definition/dist/index.d.ts:129

AssistantSearchResponse

• Const AssistantSearchResponse: _sinclair_typebox.TArray<_sinclair_typebox.TObject<{ id: _sinclair_typebox.TNumber ; title: _sinclair_typebox.TString<string> ; url: _sinclair_typebox.TString<string> ; chunks: _sinclair_typebox.TArray<_sinclair_typebox.TObject<{ chunkId: _sinclair_typebox.TNumber ; text: _sinclair_typebox.TString<string> ; score: _sinclair_typebox.TNumber }>> }>>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:141

packages/@dopt/ai-assistant/definition/dist/index.d.ts:151

ChatStreamChunk

• Const ChatStreamChunk: _sinclair_typebox.TUnion<[_sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"status"> ; status: _sinclair_typebox.TUnion<[_sinclair_typebox.TLiteral<"searching">, _sinclair_typebox.TLiteral<"answering">]> }>, _sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"content"> ; content: _sinclair_typebox.TString<string> }>, _sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"answer"> ; answer: _sinclair_typebox.TString<string> ; sources: _sinclair_typebox.TArray<_sinclair_typebox.TObject<{ id: _sinclair_typebox.TNumber ; title: _sinclair_typebox.TString<string> ; url: _sinclair_typebox.TString<string> ; chunks: _sinclair_typebox.TArray<_sinclair_typebox.TObject<{ chunkId: _sinclair_typebox.TNumber ; text: _sinclair_typebox.TString<string> ; score: _sinclair_typebox.TNumber }>> }>> }>]>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:192

packages/@dopt/ai-assistant/definition/dist/index.d.ts:212

ContentStreamChunk

• Const ContentStreamChunk: _sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"content"> ; content: _sinclair_typebox.TString<string> }>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:172

packages/@dopt/ai-assistant/definition/dist/index.d.ts:176

Context

• Const Context: _sinclair_typebox.TObject<{ type: _sinclair_typebox.TUnion<[_sinclair_typebox.TLiteral<"document">, _sinclair_typebox.TLiteral<"element">, _sinclair_typebox.TLiteral<"visual">, _sinclair_typebox.TLiteral<"semantic">]> }>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:214

packages/@dopt/ai-assistant/definition/dist/index.d.ts:217

DocumentContext

• Const DocumentContext: _sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"document"> ; value: _sinclair_typebox.TObject<{ url: _sinclair_typebox.TString<string> ; title: _sinclair_typebox.TString<string> ; width: _sinclair_typebox.TNumber ; height: _sinclair_typebox.TNumber }> }>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:218

packages/@dopt/ai-assistant/definition/dist/index.d.ts:227

ElementContext

• Const ElementContext: _sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"element"> ; value: _sinclair_typebox.TObject<{ position: _sinclair_typebox.TObject<{ top: _sinclair_typebox.TNumber ; left: _sinclair_typebox.TNumber }> ; content: _sinclair_typebox.TString<string> ; tag: _sinclair_typebox.TString<string> }> }>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:228

packages/@dopt/ai-assistant/definition/dist/index.d.ts:239

Schemas

• Const Schemas: Object

Type declaration

Name	Type
`DocumentContext`	`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"document"`> ; `value`: `_sinclair_typebox.TObject`<{ `url`: `_sinclair_typebox.TString`<`string`> ; `title`: `_sinclair_typebox.TString`<`string`> ; `width`: `_sinclair_typebox.TNumber` ; `height`: `_sinclair_typebox.TNumber` }> }>
`ElementContext`	`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"element"`> ; `value`: `_sinclair_typebox.TObject`<{ `position`: `_sinclair_typebox.TObject`<{ `top`: `_sinclair_typebox.TNumber` ; `left`: `_sinclair_typebox.TNumber` }> ; `content`: `_sinclair_typebox.TString`<`string`> ; `tag`: `_sinclair_typebox.TString`<`string`> }> }>
`VisualContext`	`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"visual"`> ; `value`: `_sinclair_typebox.TString`<`string`> }>
`SemanticContext`	`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"semantic"`> ; `value`: `_sinclair_typebox.TObject`<{ `semanticContent`: `_sinclair_typebox.TString`<`string`> ; `neighboringSemanticContent`: `_sinclair_typebox.TString`<`string`> }> }>
`UserIdentifierParams`	`_sinclair_typebox.TObject`<{ `userIdentifier`: `_sinclair_typebox.TString`<`string`> ; `groupIdentifier`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TString`<`string`>> }>
`AssistantQueryParams`	`_sinclair_typebox.TObject`<{ `model`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TString`<`string`>> ; `userIdentifier`: `_sinclair_typebox.TString`<`string`> ; `groupIdentifier`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TString`<`string`>> }>
`AssistantRequestParams`	`_sinclair_typebox.TObject`<{ `sid`: `_sinclair_typebox.TString`<`string`> }>
`AssistantRequestBody`	`_sinclair_typebox.TObject`<{ `query`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TString`<`string`>> ; `context`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TObject`<{ `document`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"document"`> ; `value`: `_sinclair_typebox.TObject`<{ `url`: `_sinclair_typebox.TString`<`string`> ; `title`: `_sinclair_typebox.TString`<`string`> ; `width`: `_sinclair_typebox.TNumber` ; `height`: `_sinclair_typebox.TNumber` }> }>> ; `visual`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"visual"`> ; `value`: `_sinclair_typebox.TString`<`string`> }>> ; `element`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"element"`> ; `value`: `_sinclair_typebox.TObject`<{ `position`: `_sinclair_typebox.TObject`<{ `top`: `_sinclair_typebox.TNumber` ; `left`: `_sinclair_typebox.TNumber` }> ; `content`: `_sinclair_typebox.TString`<`string`> ; `tag`: `_sinclair_typebox.TString`<`string`> }> }>> ; `semantic`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"semantic"`> ; `value`: `_sinclair_typebox.TObject`<{ `semanticContent`: `_sinclair_typebox.TString`<`string`> ; `neighboringSemanticContent`: `_sinclair_typebox.TString`<`string`> }> }>> }>> }>
`AssistantCompletionsRequestBody`	`_sinclair_typebox.TObject`<{ `query`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TString`<`string`>> ; `context`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TObject`<{ `document`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"document"`> ; `value`: `_sinclair_typebox.TObject`<{ `url`: `_sinclair_typebox.TString`<`string`> ; `title`: `_sinclair_typebox.TString`<`string`> ; `width`: `_sinclair_typebox.TNumber` ; `height`: `_sinclair_typebox.TNumber` }> }>> ; `visual`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"visual"`> ; `value`: `_sinclair_typebox.TString`<`string`> }>> ; `element`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"element"`> ; `value`: `_sinclair_typebox.TObject`<{ `position`: `_sinclair_typebox.TObject`<{ `top`: `_sinclair_typebox.TNumber` ; `left`: `_sinclair_typebox.TNumber` }> ; `content`: `_sinclair_typebox.TString`<`string`> ; `tag`: `_sinclair_typebox.TString`<`string`> }> }>> ; `semantic`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"semantic"`> ; `value`: `_sinclair_typebox.TObject`<{ `semanticContent`: `_sinclair_typebox.TString`<`string`> ; `neighboringSemanticContent`: `_sinclair_typebox.TString`<`string`> }> }>> }>> }>
`AssistantSearchRequestBody`	`_sinclair_typebox.TObject`<{ `query`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TString`<`string`>> ; `context`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TObject`<{ `document`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"document"`> ; `value`: `_sinclair_typebox.TObject`<{ `url`: `_sinclair_typebox.TString`<`string`> ; `title`: `_sinclair_typebox.TString`<`string`> ; `width`: `_sinclair_typebox.TNumber` ; `height`: `_sinclair_typebox.TNumber` }> }>> ; `visual`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"visual"`> ; `value`: `_sinclair_typebox.TString`<`string`> }>> ; `element`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"element"`> ; `value`: `_sinclair_typebox.TObject`<{ `position`: `_sinclair_typebox.TObject`<{ `top`: `_sinclair_typebox.TNumber` ; `left`: `_sinclair_typebox.TNumber` }> ; `content`: `_sinclair_typebox.TString`<`string`> ; `tag`: `_sinclair_typebox.TString`<`string`> }> }>> ; `semantic`: `_sinclair_typebox.TOptional`<`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"semantic"`> ; `value`: `_sinclair_typebox.TObject`<{ `semanticContent`: `_sinclair_typebox.TString`<`string`> ; `neighboringSemanticContent`: `_sinclair_typebox.TString`<`string`> }> }>> }>> }>
`AssistantDocumentSources`	`_sinclair_typebox.TArray`<`_sinclair_typebox.TObject`<{ `id`: `_sinclair_typebox.TNumber` ; `title`: `_sinclair_typebox.TString`<`string`> ; `url`: `_sinclair_typebox.TString`<`string`> ; `chunks`: `_sinclair_typebox.TArray`<`_sinclair_typebox.TObject`<{ `chunkId`: `_sinclair_typebox.TNumber` ; `text`: `_sinclair_typebox.TString`<`string`> ; `score`: `_sinclair_typebox.TNumber` }>> }>>
`AssistantSearchResponse`	`_sinclair_typebox.TArray`<`_sinclair_typebox.TObject`<{ `id`: `_sinclair_typebox.TNumber` ; `title`: `_sinclair_typebox.TString`<`string`> ; `url`: `_sinclair_typebox.TString`<`string`> ; `chunks`: `_sinclair_typebox.TArray`<`_sinclair_typebox.TObject`<{ `chunkId`: `_sinclair_typebox.TNumber` ; `text`: `_sinclair_typebox.TString`<`string`> ; `score`: `_sinclair_typebox.TNumber` }>> }>>
`AssistantCompletionsResponse`	`_sinclair_typebox.TObject`<{ `answer`: `_sinclair_typebox.TString`<`string`> ; `sources`: `_sinclair_typebox.TArray`<`_sinclair_typebox.TObject`<{ `id`: `_sinclair_typebox.TNumber` ; `title`: `_sinclair_typebox.TString`<`string`> ; `url`: `_sinclair_typebox.TString`<`string`> ; `chunks`: `_sinclair_typebox.TArray`<`_sinclair_typebox.TObject`<{ `chunkId`: `_sinclair_typebox.TNumber` ; `text`: `_sinclair_typebox.TString`<`string`> ; `score`: `_sinclair_typebox.TNumber` }>> }>> }>
`StatusChunk`	`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"status"`> ; `status`: `_sinclair_typebox.TUnion`<[`_sinclair_typebox.TLiteral`<`"searching"`>, `_sinclair_typebox.TLiteral`<`"answering"`>]> }>
`ContentStreamChunk`	`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"content"`> ; `content`: `_sinclair_typebox.TString`<`string`> }>
`AnswerChunk`	`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"answer"`> ; `answer`: `_sinclair_typebox.TString`<`string`> ; `sources`: `_sinclair_typebox.TArray`<`_sinclair_typebox.TObject`<{ `id`: `_sinclair_typebox.TNumber` ; `title`: `_sinclair_typebox.TString`<`string`> ; `url`: `_sinclair_typebox.TString`<`string`> ; `chunks`: `_sinclair_typebox.TArray`<`_sinclair_typebox.TObject`<{ `chunkId`: `_sinclair_typebox.TNumber` ; `text`: `_sinclair_typebox.TString`<`string`> ; `score`: `_sinclair_typebox.TNumber` }>> }>> }>
`ChatStreamChunk`	`_sinclair_typebox.TUnion`<[`_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"status"`> ; `status`: `_sinclair_typebox.TUnion`<[`_sinclair_typebox.TLiteral`<`"searching"`>, `_sinclair_typebox.TLiteral`<`"answering"`>]> }>, `_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"content"`> ; `content`: `_sinclair_typebox.TString`<`string`> }>, `_sinclair_typebox.TObject`<{ `type`: `_sinclair_typebox.TLiteral`<`"answer"`> ; `answer`: `_sinclair_typebox.TString`<`string`> ; `sources`: `_sinclair_typebox.TArray`<`_sinclair_typebox.TObject`<{ `id`: `_sinclair_typebox.TNumber` ; `title`: `_sinclair_typebox.TString`<`string`> ; `url`: `_sinclair_typebox.TString`<`string`> ; `chunks`: `_sinclair_typebox.TArray`<`_sinclair_typebox.TObject`<{ `chunkId`: `_sinclair_typebox.TNumber` ; `text`: `_sinclair_typebox.TString`<`string`> ; `score`: `_sinclair_typebox.TNumber` }>> }>> }>]>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:256

SemanticContext

• Const SemanticContext: _sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"semantic"> ; value: _sinclair_typebox.TObject<{ semanticContent: _sinclair_typebox.TString<string> ; neighboringSemanticContent: _sinclair_typebox.TString<string> }> }>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:245

packages/@dopt/ai-assistant/definition/dist/index.d.ts:252

StatusChunk

• Const StatusChunk: _sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"status"> ; status: _sinclair_typebox.TUnion<[_sinclair_typebox.TLiteral<"searching">, _sinclair_typebox.TLiteral<"answering">]> }>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:167

packages/@dopt/ai-assistant/definition/dist/index.d.ts:171

UserIdentifierParams

• Const UserIdentifierParams: _sinclair_typebox.TObject<{ userIdentifier: _sinclair_typebox.TString<string> ; groupIdentifier: _sinclair_typebox.TOptional<_sinclair_typebox.TString<string>> }>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:4

packages/@dopt/ai-assistant/definition/dist/index.d.ts:8

VisualContext

• Const VisualContext: _sinclair_typebox.TObject<{ type: _sinclair_typebox.TLiteral<"visual"> ; value: _sinclair_typebox.TString<string> }>

Defined in

packages/@dopt/ai-assistant/definition/dist/index.d.ts:240

packages/@dopt/ai-assistant/definition/dist/index.d.ts:244

document

• Const document: Object

Type declaration

Name	Type
`generate`	() => `Promise`<{ `type`: `"document"` ; `value`: { `url`: `string` ; `title`: `string` ; `width`: `number` ; `height`: `number` } }>

Defined in

packages/@dopt/ai-assistant/context/dist/index.d.ts:3

element

• Const element: Object

Type declaration

Name	Type
`generate`	(`__namedParameters`: { `element`: `Element` }) => `Promise`<{ `type`: `"element"` ; `value`: { `position`: { `top`: `number` ; `left`: `number` } ; `content`: `string` ; `tag`: `string` } }>

Defined in

packages/@dopt/ai-assistant/context/dist/index.d.ts:15

semantic

• Const semantic: Object

Type declaration

Name	Type
`generate`	(`__namedParameters`: { `element`: `Element` }) => `Promise`<{ `type`: `"semantic"` ; `value`: { `semanticContent`: `string` ; `neighboringSemanticContent`: `string` } }>

Defined in

packages/@dopt/ai-assistant/context/dist/index.d.ts:31

visual

• Const visual: Object

Type declaration

Name	Type
`generate`	(`__namedParameters`: { `element?`: `Element` }, `logger?`: `Logger`) => `Promise`<`null` \| { `type`: `"visual"` ; `value`: `string` }>

Defined in

packages/@dopt/ai-assistant/context/dist/index.d.ts:43

Functions

DoptAiProvider

▸ DoptAiProvider(«destructured»): Element

Parameters

Name	Type
`«destructured»`	`AiProviderProps`

Returns

Element

Defined in

packages/@dopt/ai-assistant/react/src/provider.tsx:10

useAssistant

▸ useAssistant(sid, query, errorMessage): Object

A React hook for retrieving a complete answer from an AI assistant

Example

import { useAssistant } from '@dopt/ai-assistant-react';

export function Application() {
  const assistant = useAssistant("HNWvcT78tyTwygnbzU6SW", { query, context });
}

Parameters

Name	Type	Description
`sid`	`string`	Assistant['sid']
`query`	`Object`	string, the query to be passed to the assistant
`query.query`	`undefined` \| `string`	-
`query.context`	`Object`	-
`query.context.document?`	`boolean`	-
`query.context.element?`	`Element`	-
`query.context.visual?`	`boolean`	-
`errorMessage`	`Object`	string, an optional Markdown-friendly error message in case the assistant fails to load a system default is used otherwise
`errorMessage.errorMessage?`	`string`	-

Returns

Object

an object of: answer, content, status, and documents Each value in the object maps to the current state of the assistant. As the answer streams back, content will be updated. Once the answer is completed, answer and documents will be updated. status reflects either searching or answering depending on the state of the stream.

Name	Type
`answer`	`null` \| `string`
`content`	`null` \| `string`
`documents`	`null` \| { `title`: `string` ; `url`: `string` ; `id`: `number` ; `chunks`: { text: string; chunkId: number; score: number; }[] }[]
`status`	`null` \| `"searching"` \| `"answering"`

Defined in

packages/@dopt/ai-assistant/react/src/use-assistant.ts:40

useSearch

▸ useSearch(sid, query): Object

A React hook for getting search results from an AI assistant

Example

import { useSearch } from '@dopt/ai-assistant-react';

export function Application() {
  const results = useSearch("HNWvcT78tyTwygnbzU6SW", { query, context });
}

Parameters

Name	Type	Description
`sid`	`string`	Assistant['sid']
`query`	`Object`	string, the query to be passed to the assistant
`query.query`	`undefined` \| `string`	-
`query.context`	`Object`	-
`query.context.document?`	`boolean` \| { `title`: `string` ; `url`: `string` ; `width`: `number` ; `height`: `number` }	-
`query.context.element?`	`Element` \| { `position`: { top: number; left: number; } ; `content`: `string` ; `tag`: `string` }	-
`query.context.visual?`	`string` \| `boolean`	-

Returns

Object

a collection of documents

Name	Type
`documents`	`null` \| { `title`: `string` ; `url`: `string` ; `id`: `number` ; `chunks`: { text: string; chunkId: number; score: number; }[] }[]

Defined in

packages/@dopt/ai-assistant/react/src/use-search.ts:30

@dopt/ai-assistant-react

Table of contents​

Interfaces​

Type Aliases​

Variables​

Functions​

Type Aliases​

DoptAiContext​

Type declaration​

Defined in​

AnswerChunk​

Type declaration​

Defined in​

AssistantCompletionsRequestBody​

Type declaration​

Defined in​

AssistantCompletionsResponse​

Type declaration​

Defined in​

AssistantDocumentSources​

Defined in​

AssistantQueryParams​

Type declaration​

Defined in​

AssistantRequestBody​

Type declaration​

Defined in​

AssistantRequestParams​

Type declaration​

Defined in​

AssistantSearchRequestBody​

Type declaration​

Defined in​

AssistantSearchResponse​

Defined in​

ChatStreamChunk​

Type declaration​

Defined in​

ContentStreamChunk​

Type declaration​

Defined in​

Context​

Type declaration​

Defined in​

DocumentContext​

Type declaration​

Defined in​

ElementContext​

Type declaration​

Defined in​

SemanticContext​

Type declaration​

Defined in​

StatusChunk​

Type declaration​

Defined in​

UserIdentifierParams​

Type declaration​

Defined in​

VisualContext​

Type declaration​

Defined in​

Variables​

DoptAiContext​

Defined in​

AnswerChunk​

Defined in​

AssistantCompletionsRequestBody​

Defined in​

AssistantCompletionsResponse​

Defined in​

AssistantDefaultCompletionsErrorMessage​

Defined in​

AssistantDocumentSources​

Defined in​

AssistantQueryParams​

Defined in​

AssistantRequestBody​

Defined in​

AssistantRequestParams​

Table of contents

Interfaces

Type Aliases

Variables

Functions

Type Aliases

DoptAiContext

Type declaration

Defined in

AnswerChunk

Type declaration

Defined in

AssistantCompletionsRequestBody

Type declaration

Defined in

AssistantCompletionsResponse

Type declaration

Defined in

AssistantDocumentSources

Defined in

AssistantQueryParams

Type declaration

Defined in

AssistantRequestBody

Type declaration

Defined in

AssistantRequestParams

Type declaration

Defined in

AssistantSearchRequestBody

Type declaration

Defined in

AssistantSearchResponse

Defined in

ChatStreamChunk

Type declaration

Defined in

ContentStreamChunk

Type declaration

Defined in

Context

Type declaration

Defined in

DocumentContext

Type declaration

Defined in

ElementContext

Type declaration

Defined in

SemanticContext

Type declaration

Defined in

StatusChunk

Type declaration

Defined in

UserIdentifierParams

Type declaration

Defined in

VisualContext

Type declaration

Defined in

Variables

DoptAiContext

Defined in

AnswerChunk

Defined in

AssistantCompletionsRequestBody

Defined in

AssistantCompletionsResponse

Defined in

AssistantDefaultCompletionsErrorMessage

Defined in

AssistantDocumentSources

Defined in

AssistantQueryParams

Defined in

AssistantRequestBody

Defined in

AssistantRequestParams

Defined in