Session

@julep/sdk / Modules / managers/session / SessionsManager

Class: SessionsManager

managers/session.SessionsManager

BaseManager serves as the base class for all manager classes that interact with the Julep API. It provides common functionality needed for API interactions.

Hierarchy

• BaseManager

  ↳ SessionsManager

Table of contents

Constructors

• constructor

Properties

• apiClient

Methods

• chat

• create

• delete

• deleteHistory

• get

• history

• list

• suggestions

• update

Constructors

constructor

• new SessionsManager(apiClient): SessionsManager

Constructs a new instance of BaseManager.

Parameters

Name	Type	Description
apiClient	JulepApiClient	The JulepApiClient instance used for API interactions.

Returns

SessionsManager

Inherited from

BaseManager.constructor

Defined in

src/managers/base.ts:12

Properties

apiClient

• apiClient: JulepApiClient

The JulepApiClient instance used for API interactions.

Inherited from

BaseManager.apiClient

Defined in

src/managers/base.ts:12

Methods

chat

▸ chat(sessionId, «destructured»): Promise<ChatResponse>

Parameters

Name	Type
sessionId	string
«destructured»	ChatInput

Returns

Promise<ChatResponse>

Defined in

src/managers/session.ts:104

---

create

▸ create(«destructured»): Promise<ResourceCreatedResponse>

Parameters

Name	Type
«destructured»	CreateSessionPayload

Returns

Promise<ResourceCreatedResponse>

Defined in

src/managers/session.ts:33

---

delete

▸ delete(sessionId): Promise<void>

Parameters

Name	Type
sessionId	string

Returns

Promise<void>

Defined in

src/managers/session.ts:83

---

deleteHistory

▸ deleteHistory(sessionId): Promise<void>

Parameters

Name	Type
sessionId	string

Returns

Promise<void>

Defined in

src/managers/session.ts:188

---

get

▸ get(sessionId): Promise<Session>

Retrieves a session by its ID.

Parameters

Name	Type	Description
sessionId	string	The unique identifier of the session.

Returns

Promise<Session>

A promise that resolves with the session object.

Defined in

src/managers/session.ts:29

---

history

▸ history(sessionId, «destructured»?): Promise<ChatMLMessage[]>

Parameters

Name	Type	Default value
sessionId	string	undefined
«destructured»	Object	{}
› limit?	number	100
› offset?	number	0

Returns

Promise<ChatMLMessage[]>

Defined in

src/managers/session.ts:173

---

list

▸ list(«destructured»?): Promise<Session[]>

Parameters

Name	Type	Default value
«destructured»	Object	{}
› limit?	number	100
› metadataFilter?	Object	{}
› offset?	number	0

Returns

Promise<Session[]>

Defined in

src/managers/session.ts:63

---

suggestions

▸ suggestions(sessionId, «destructured»?): Promise<Suggestion[]>

Parameters

Name	Type	Default value
sessionId	string	undefined
«destructured»	Object	{}
› limit?	number	100
› offset?	number	0

Returns

Promise<Suggestion[]>

Defined in

src/managers/session.ts:158

---

update

▸ update(sessionId, «destructured», overwrite?): Promise<ResourceUpdatedResponse>

Parameters

Name	Type	Default value
sessionId	string	undefined
«destructured»	Object	undefined
› metadata?	any	{}
› situation	string	undefined
overwrite	boolean	false

Returns

Promise<ResourceUpdatedResponse>

Defined in

src/managers/session.ts:89