@mirego/forra-react / components / ScoutChatContextType

Interface: ScoutChatContextType

Properties

allowedSkills

allowedSkills: ChatSkillOption[]

assistant

assistant: undefined | AssistantPublicResponse

assistantQueryError

assistantQueryError: null | Error

assistantQueryIsLoading

assistantQueryIsLoading: boolean

availableGlobalSkills

availableGlobalSkills: ChatSkillOption[]

chatModels

chatModels: ChatModel[]

clarification

clarification: null | { conversation: ConversationMessage[]; question: ClarificationQuestion; }

contextLimitReached

contextLimitReached: boolean

conversationId?

optional conversationId: string

conversationQuery?

optional conversationQuery: UseQueryResult\<ConversationResponse, Error>

editingMessageIndex

editingMessageIndex: null | number

error

error: string

errorRecovery

errorRecovery: null | { errorMessage: string; onEdit: () => void; onNewConversation?: () => void; onRetry: () => void; }

filesToShow?

optional filesToShow: File[]

handleEditSubmit

handleEditSubmit: OnEditSubmitType

handleMentionedAssistantSelect()

handleMentionedAssistantSelect: (assistant) => void

Parameters

assistant

null | AssistantPublicResponse

Returns

void

handleRemoveMentionedAssistant()

handleRemoveMentionedAssistant: () => void

Returns

void

handleRespondClarification

handleRespondClarification: OnRespondClarificationFn

handleRetry()

handleRetry: () => void

Returns

void

handleStreamChatCompletion()

handleStreamChatCompletion: (newMessages, conversation, functionPermissions?) => Promise\<void>

Parameters

newMessages

null | ConversationMessage[]

conversation

ConversationMessage[]

functionPermissions?

FunctionPermission[]

Returns

Promise\<void>

isAutomaticModel

isAutomaticModel: boolean

isReadOnly

isReadOnly: boolean

loading

loading: boolean

mentionAssistantEnabled

mentionAssistantEnabled: boolean

mentionedAssistantToShow

mentionedAssistantToShow: null | AssistantPublicResponse

messages

messages: ConversationMessage[]

onContextLimitNewConversation()?

optional onContextLimitNewConversation: () => void

Returns

void

onSendMessageSubmit()

onSendMessageSubmit: () => void

Returns

void

onSkillAdded()?

optional onSkillAdded: (skill) => void

Parameters

skill

ChatSkillOption

Returns

void

ownerUserName?

optional ownerUserName: null | string

prompt

prompt: string

promptInputRef

promptInputRef: RefObject\<null | HTMLTextAreaElement>

redirectToConversation()?

optional redirectToConversation: (conversationId) => void

Parameters

conversationId

string

Returns

void

selectedModelId

selectedModelId: undefined | string

sendMessage()

sendMessage: (newMessages, title?) => Promise\<void>

Parameters

newMessages

ConversationMessage[]

title?

string

Returns

Promise\<void>

sendMessageIsPending

sendMessageIsPending: boolean

setAllowedSkills()

setAllowedSkills: (skills) => void

Parameters

skills

ChatSkillOption[] | (prev) => ChatSkillOption[]

Returns

void

setAutomaticModel()?

optional setAutomaticModel: () => Promise\<void>

Returns

Promise\<void>

setEditingMessageIndex()

setEditingMessageIndex: (index) => void

Parameters

index

null | number

Returns

void

setFiles()?

optional setFiles: (files) => void

Parameters

files

File[]

Returns

void

setPrompt()

setPrompt: (newPrompt) => void

Parameters

newPrompt

string

Returns

void

setSelectedModelId()

setSelectedModelId: (selectedModelId) => Promise\<void>

Parameters

selectedModelId

undefined | string

Returns

Promise\<void>