Documentation
¶
Index ¶
- type Client
- func (c *Client) Download(transcriptID string, format string, opts ...*DownloadOptions) (string, error)
- func (c *Client) GetSnippet(transcriptID, snippetID string) (*Snippet, error)
- func (c *Client) List(options *ListOptions) (*TranscriptsPage, error)
- func (c *Client) ListSnippets(transcriptID string, options *SnippetListOptions) (*SnippetsPage, error)
- func (c *Client) UpdateSnippet(transcriptID, snippetID string, snippet *Snippet) (*Snippet, error)
- type Config
- type DownloadOptions
- type ListOptions
- type Snippet
- type SnippetListOptions
- type SnippetsPage
- type Transcript
- type TranscriptsPage
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is the transcripts API client
func (*Client) Download ¶
func (c *Client) Download(transcriptID string, format string, opts ...*DownloadOptions) (string, error)
Download downloads the transcript content in the specified format. Format should be "vtt" or "txt". Defaults to "txt" if empty. Returns the raw transcript content as a string. An optional DownloadOptions can be provided to include the meetingId parameter as returned by the Webex API in vttDownloadLink/txtDownloadLink.
func (*Client) GetSnippet ¶
GetSnippet returns a single transcript snippet
func (*Client) List ¶
func (c *Client) List(options *ListOptions) (*TranscriptsPage, error)
List returns a list of meeting transcripts. The Webex API requires the time range between 'from' and 'to' to be within 30 days. If 'from' and 'to' are not specified and no meetingId is provided, the SDK defaults to the last 30 days to ensure results are returned.
func (*Client) ListSnippets ¶
func (c *Client) ListSnippets(transcriptID string, options *SnippetListOptions) (*SnippetsPage, error)
ListSnippets returns a list of snippets for a transcript
type Config ¶
type Config struct {
}
Config holds the configuration for the Transcripts plugin
func DefaultConfig ¶
func DefaultConfig() *Config
DefaultConfig returns the default configuration for the Transcripts plugin
type DownloadOptions ¶
type DownloadOptions struct {
// MeetingID is the unique identifier of the meeting instance.
// The Webex API download links include this parameter.
MeetingID string
}
DownloadOptions contains optional parameters for downloading a transcript
type ListOptions ¶
type ListOptions struct {
MeetingID string `url:"meetingId,omitempty"`
HostEmail string `url:"hostEmail,omitempty"`
SiteURL string `url:"siteUrl,omitempty"`
From string `url:"from,omitempty"`
To string `url:"to,omitempty"`
Max int `url:"max,omitempty"`
}
ListOptions contains the options for listing transcripts
type Snippet ¶
type Snippet struct {
ID string `json:"id,omitempty"`
TranscriptID string `json:"transcriptId,omitempty"`
Text string `json:"text,omitempty"`
PersonName string `json:"personName,omitempty"`
PersonEmail string `json:"personEmail,omitempty"`
PeopleID string `json:"peopleId,omitempty"`
StartTime string `json:"startTime,omitempty"`
EndTime string `json:"endTime,omitempty"`
Duration float64 `json:"duration,omitempty"`
DurationMillisecond int `json:"durationMillisecond,omitempty"`
OffsetMillisecond int `json:"offsetMillisecond,omitempty"`
Language string `json:"language,omitempty"`
Confidence float64 `json:"confidence,omitempty"`
}
Snippet represents a short segment of a transcript spoken by a specific participant
type SnippetListOptions ¶
type SnippetListOptions struct {
Max int `url:"max,omitempty"`
PersonEmail string `url:"personEmail,omitempty"`
PeopleID string `url:"peopleId,omitempty"`
From string `url:"from,omitempty"`
To string `url:"to,omitempty"`
}
SnippetListOptions contains the options for listing transcript snippets
type SnippetsPage ¶
SnippetsPage represents a paginated list of transcript snippets
type Transcript ¶
type Transcript struct {
ID string `json:"id,omitempty"`
MeetingID string `json:"meetingId,omitempty"`
MeetingTopic string `json:"meetingTopic,omitempty"`
SiteURL string `json:"siteUrl,omitempty"`
ScheduledMeetingID string `json:"scheduledMeetingId,omitempty"`
MeetingSeriesID string `json:"meetingSeriesId,omitempty"`
HostUserID string `json:"hostUserId,omitempty"`
HostEmail string `json:"hostEmail,omitempty"`
StartTime string `json:"startTime,omitempty"`
EndTime string `json:"endTime,omitempty"`
Duration int `json:"duration,omitempty"`
Status string `json:"status,omitempty"`
VttDownloadLink string `json:"vttDownloadLink,omitempty"`
TxtDownloadLink string `json:"txtDownloadLink,omitempty"`
Created string `json:"created,omitempty"`
Updated string `json:"updated,omitempty"`
}
Transcript represents a Webex meeting transcript
type TranscriptsPage ¶
type TranscriptsPage struct {
Items []Transcript `json:"items"`
*webexsdk.Page
}
TranscriptsPage represents a paginated list of transcripts