Theia API Documentation v1.65.0
Eclipse Theia Website
GitHub
Preparing search index...
@theia/ai-chat
common/chat-service
ChatService
Interface ChatService
interface
ChatService
{
onSessionEvent
:
Event
<
ActiveSessionChangedEvent
|
SessionCreatedEvent
|
SessionDeletedEvent
,
>
;
cancelRequest
(
sessionId
:
string
,
requestId
:
string
)
:
Promise
<
void
>
;
createSession
(
location
?:
ChatAgentLocation
,
options
?:
SessionOptions
,
pinnedAgent
?:
ChatAgent
,
)
:
ChatSession
;
deleteChangeSet
(
sessionId
:
string
)
:
void
;
deleteChangeSetElement
(
sessionId
:
string
,
uri
:
URI
)
:
void
;
deleteSession
(
sessionId
:
string
)
:
void
;
getActiveSession
()
:
undefined
|
ChatSession
;
getAgent
(
parsedRequest
:
ParsedChatRequest
,
session
:
ChatSession
,
)
:
undefined
|
ChatAgent
;
getSession
(
id
:
string
)
:
undefined
|
ChatSession
;
getSessions
()
:
ChatSession
[]
;
sendRequest
(
sessionId
:
string
,
request
:
ChatRequest
,
)
:
Promise
<
undefined
|
ChatRequestInvocation
>
;
setActiveSession
(
sessionId
:
string
,
options
?:
SessionOptions
)
:
void
;
}
Implemented by
ChatServiceImpl
Index
Properties
on
Session
Event
Methods
cancel
Request
create
Session
delete
Change
Set
delete
Change
Set
Element
delete
Session
get
Active
Session
get
Agent
get
Session
get
Sessions
send
Request
set
Active
Session
Properties
on
Session
Event
onSessionEvent
:
Event
<
ActiveSessionChangedEvent
|
SessionCreatedEvent
|
SessionDeletedEvent
,
>
Methods
cancel
Request
cancelRequest
(
sessionId
:
string
,
requestId
:
string
)
:
Promise
<
void
>
Parameters
sessionId
:
string
requestId
:
string
Returns
Promise
<
void
>
create
Session
createSession
(
location
?:
ChatAgentLocation
,
options
?:
SessionOptions
,
pinnedAgent
?:
ChatAgent
,
)
:
ChatSession
Parameters
Optional
location
:
ChatAgentLocation
Optional
options
:
SessionOptions
Optional
pinnedAgent
:
ChatAgent
Returns
ChatSession
delete
Change
Set
deleteChangeSet
(
sessionId
:
string
)
:
void
Parameters
sessionId
:
string
Returns
void
delete
Change
Set
Element
deleteChangeSetElement
(
sessionId
:
string
,
uri
:
URI
)
:
void
Parameters
sessionId
:
string
uri
:
URI
Returns
void
delete
Session
deleteSession
(
sessionId
:
string
)
:
void
Parameters
sessionId
:
string
Returns
void
get
Active
Session
getActiveSession
()
:
undefined
|
ChatSession
Returns
undefined
|
ChatSession
get
Agent
getAgent
(
parsedRequest
:
ParsedChatRequest
,
session
:
ChatSession
,
)
:
undefined
|
ChatAgent
Parameters
parsedRequest
:
ParsedChatRequest
session
:
ChatSession
Returns
undefined
|
ChatAgent
get
Session
getSession
(
id
:
string
)
:
undefined
|
ChatSession
Parameters
id
:
string
Returns
undefined
|
ChatSession
get
Sessions
getSessions
()
:
ChatSession
[]
Returns
ChatSession
[]
send
Request
sendRequest
(
sessionId
:
string
,
request
:
ChatRequest
,
)
:
Promise
<
undefined
|
ChatRequestInvocation
>
Parameters
sessionId
:
string
request
:
ChatRequest
Returns
Promise
<
undefined
|
ChatRequestInvocation
>
set
Active
Session
setActiveSession
(
sessionId
:
string
,
options
?:
SessionOptions
)
:
void
Parameters
sessionId
:
string
Optional
options
:
SessionOptions
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
on
Session
Event
Methods
cancel
Request
create
Session
delete
Change
Set
delete
Change
Set
Element
delete
Session
get
Active
Session
get
Agent
get
Session
get
Sessions
send
Request
set
Active
Session
Eclipse Theia Website
GitHub
Theia API Documentation v1.65.0
Loading...