api

Documentation

Index

• type Annotation
• type Client
  • func NewClient(baseURL string) *Client
  • func (c *Client) Acknowledge(ctx context.Context, annotationID string) error
  • func (c *Client) Dismiss(ctx context.Context, annotationID, reason string) error
  • func (c *Client) GetPending(ctx context.Context, sessionID, projectID string) (*PendingResponse, error)
  • func (c *Client) GetSession(ctx context.Context, sessionID string) (*SessionWithAnnotations, error)
  • func (c *Client) ListSessions(ctx context.Context, projectID string) ([]Session, error)
  • func (c *Client) Reply(ctx context.Context, annotationID, message string) error
  • func (c *Client) Resolve(ctx context.Context, annotationID, summary string) error
  • func (c *Client) Watch(ctx context.Context, opts WatchOptions) (*WatchOutput, error)
• type PendingResponse
• type Session
• type SessionWithAnnotations
• type ThreadMessage
• type WatchOptions
• type WatchOutput

Types

type Annotation

type Annotation struct {
	ID              string          `json:"id"`
	SessionID       string          `json:"sessionId,omitempty"`
	Comment         string          `json:"comment"`
	Element         string          `json:"element"`
	ElementPath     string          `json:"elementPath"`
	URL             string          `json:"url,omitempty"`
	Intent          string          `json:"intent,omitempty"`
	Severity        string          `json:"severity,omitempty"`
	Status          string          `json:"status,omitempty"`
	Timestamp       int64           `json:"timestamp,omitempty"`
	NearbyText      string          `json:"nearbyText,omitempty"`
	ReactComponents string          `json:"reactComponents,omitempty"`
	CreatedAt       string          `json:"createdAt,omitempty"`
	Thread          []ThreadMessage `json:"thread,omitempty"`
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(baseURL string) *Client

func (*Client) Acknowledge

func (c *Client) Acknowledge(ctx context.Context, annotationID string) error

func (*Client) Dismiss

func (c *Client) Dismiss(ctx context.Context, annotationID, reason string) error

func (*Client) GetPending

func (c *Client) GetPending(ctx context.Context, sessionID, projectID string) (*PendingResponse, error)

func (*Client) GetSession

func (c *Client) GetSession(ctx context.Context, sessionID string) (*SessionWithAnnotations, error)

func (*Client) ListSessions

func (c *Client) ListSessions(ctx context.Context, projectID string) ([]Session, error)

func (*Client) Reply

func (c *Client) Reply(ctx context.Context, annotationID, message string) error

func (*Client) Resolve

func (c *Client) Resolve(ctx context.Context, annotationID, summary string) error

func (*Client) Watch

func (c *Client) Watch(ctx context.Context, opts WatchOptions) (*WatchOutput, error)

type PendingResponse

type PendingResponse struct {
	Count       int          `json:"count"`
	Annotations []Annotation `json:"annotations"`
}

type Session

type Session struct {
	ID        string `json:"id"`
	URL       string `json:"url"`
	Status    string `json:"status"`
	CreatedAt string `json:"createdAt"`
	UpdatedAt string `json:"updatedAt,omitempty"`
	ProjectID string `json:"projectId,omitempty"`
}

type SessionWithAnnotations

type SessionWithAnnotations struct {
	Session
	Annotations []Annotation `json:"annotations"`
}

type ThreadMessage

type ThreadMessage struct {
	ID        string `json:"id"`
	Role      string `json:"role"`
	Content   string `json:"content"`
	Timestamp int64  `json:"timestamp"`
}

type WatchOptions

type WatchOptions struct {
	SessionID   string
	ProjectID   string
	BatchWindow time.Duration
	Timeout     time.Duration
}

type WatchOutput

type WatchOutput struct {
	Timeout     bool         `json:"timeout"`
	Message     string       `json:"message,omitempty"`
	Count       int          `json:"count,omitempty"`
	Sessions    []string     `json:"sessions,omitempty"`
	Annotations []Annotation `json:"annotations,omitempty"`
}