Class SessionHistoryApi

java.lang.Object

com.github.copilot.generated.rpc.SessionHistoryApi

@Generated("copilot-sdk-codegen")
public final class SessionHistoryApi
extends Object

API methods for the history namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SessionHistoryAbortManualCompactionResult>	abortManualCompaction()	Identifies the target session.
CompletableFuture<SessionHistoryCancelBackgroundCompactionResult>	cancelBackgroundCompaction()	Identifies the target session.
CompletableFuture<SessionHistoryClearContextResult>	clearContext(SessionHistoryClearContextParams params)	Parameters for clearing the conversation and seeding the window that replaces it.
CompletableFuture<SessionHistoryCompactResult>	compact()	Optional compaction parameters.
CompletableFuture<SessionHistoryCompactResult>	compact(SessionHistoryCompactParams params)	Optional compaction parameters.
CompletableFuture<SessionHistoryListRewindPointsResult>	listRewindPoints()	Identifies the target session.
CompletableFuture<SessionHistoryPreviewRewindResult>	previewRewind(SessionHistoryPreviewRewindParams params)	Event boundary to preview for conversation-and-files rewind.
CompletableFuture<SessionHistoryRewindResult>	rewind(SessionHistoryRewindParams params)	Boundary and mode for rewinding session history.
CompletableFuture<SessionHistorySummarizeForHandoffResult>	summarizeForHandoff()	Identifies the target session.
CompletableFuture<SessionHistoryTruncateResult>	truncate(SessionHistoryTruncateParams params)	Identifier of the event to truncate to; this event and all later events are removed.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

compact

@CopilotExperimental
public CompletableFuture<SessionHistoryCompactResult> compact()

Optional compaction parameters.

Invokes the method with no params, applying the runtime defaults.

Since:

1.0.0

compact

@CopilotExperimental
public CompletableFuture<SessionHistoryCompactResult> compact(SessionHistoryCompactParams params)

Optional compaction parameters.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

truncate

@CopilotExperimental
public CompletableFuture<SessionHistoryTruncateResult> truncate(SessionHistoryTruncateParams params)

Identifier of the event to truncate to; this event and all later events are removed.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

listRewindPoints

@CopilotExperimental
public CompletableFuture<SessionHistoryListRewindPointsResult> listRewindPoints()

Identifies the target session.

Since:

1.0.0

previewRewind

@CopilotExperimental
public CompletableFuture<SessionHistoryPreviewRewindResult> previewRewind(SessionHistoryPreviewRewindParams params)

Event boundary to preview for conversation-and-files rewind.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

rewind

@CopilotExperimental
public CompletableFuture<SessionHistoryRewindResult> rewind(SessionHistoryRewindParams params)

Boundary and mode for rewinding session history.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

cancelBackgroundCompaction

@CopilotExperimental
public CompletableFuture<SessionHistoryCancelBackgroundCompactionResult> cancelBackgroundCompaction()

Identifies the target session.

Since:

1.0.0

abortManualCompaction

@CopilotExperimental
public CompletableFuture<SessionHistoryAbortManualCompactionResult> abortManualCompaction()

Identifies the target session.

Since:

1.0.0

summarizeForHandoff

@CopilotExperimental
public CompletableFuture<SessionHistorySummarizeForHandoffResult> summarizeForHandoff()

Identifies the target session.

Since:

1.0.0

clearContext

@CopilotExperimental
public CompletableFuture<SessionHistoryClearContextResult> clearContext(SessionHistoryClearContextParams params)

Parameters for clearing the conversation and seeding the window that replaces it.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0