Class SendMessageRequest

java.lang.Object
com.github.copilot.rpc.SendMessageRequest
public final class SendMessageRequest extends Object
Internal request object for sending a message to a session.

This is a low-level class for JSON-RPC communication. For sending messages, use CopilotSession.send(String) or CopilotSession.sendAndWait(String).

Since:
1.0.0
See Also:

  • Constructor Details

    • SendMessageRequest

      public SendMessageRequest()

  • Method Details

    • getResponseFormat

      public Map<String,Object> getResponseFormat()
      Gets the output format. @return the provider-native format

    • setResponseFormat

      public void setResponseFormat(Map<String,Object> responseFormat)
      Sets the output format. @param responseFormat the provider-native format

    • getSessionId

      public String getSessionId()
      Gets the session ID. @return the session ID

    • setSessionId

      public void setSessionId(String sessionId)
      Sets the session ID. @param sessionId the session ID

    • getPrompt

      public String getPrompt()
      Gets the message prompt. @return the prompt text

    • setPrompt

      public void setPrompt(String prompt)
      Sets the message prompt. @param prompt the prompt text

    • getAttachments

      public List<MessageAttachment> getAttachments()
      Gets the attachments. @return the list of attachments

    • setAttachments

      public void setAttachments(List<MessageAttachment> attachments)
      Sets the attachments. @param attachments the list of attachments

    • getMode

      public String getMode()
      Gets the mode. @return the message mode

    • setMode

      public void setMode(String mode)
      Sets the mode. @param mode the message mode

    • getSource

      public MessageSource getSource()
      Gets the message source. @return the source, or null if unset

    • setSource

      public void setSource(MessageSource source)
      Sets the message source. @param source the source, or null to omit it

    • getAgentMode

      public AgentMode getAgentMode()
      Gets the per-message agent UI mode. @return the agent mode

    • setAgentMode

      public void setAgentMode(AgentMode agentMode)
      Sets the per-message agent UI mode. @param agentMode the agent mode

    • getRequestHeaders

      public Map<String,String> getRequestHeaders()
      Gets the per-turn request headers. @return the headers map

    • setRequestHeaders

      public void setRequestHeaders(Map<String,String> requestHeaders)
      Sets the per-turn request headers. @param requestHeaders the headers map

    • getDisplayPrompt

      public String getDisplayPrompt()
      Gets the display prompt. @return the display prompt

    • setDisplayPrompt

      public void setDisplayPrompt(String displayPrompt)
      Sets the display prompt shown in the timeline instead of the prompt.
      Parameters:
      displayPrompt - the display prompt