async

package
v0.3.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 27, 2023 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Overview

Async package for processing Async conversations 

Async package for processing Async conversations

Async package for processing Async conversations 

Async package for processing Async conversations

Async package for processing Async conversations

Async package for processing Async conversations

Async package for processing Async conversations

Async package for processing Async conversations 

Async package for processing Async conversations

Async package for processing Async conversations

Index

Constants

View Source 
const (
	JobStatusInProgress string = "in_progress"
	JobStatusComplete   string = "completed"
)

Variables

View Source 
var (
	// ErrInvalidInput required input was not found
	ErrInvalidInput = errors.New("required input was not found")

	// ErrJobStatusTimeout the job status check timed out
	ErrJobStatusTimeout = errors.New("the job status check timed out")

	// ErrInvalidURIExtension couldn't find a period to indicate a file extension
	ErrInvalidURIExtension = errors.New("couldn't find a period to indicate a file extension")
)

Functions

This section is empty.

Types

type Client 

type Client struct {
	*client.RestClient
}

Context switch for processing Async functionality

func New 

func New(client *client.RestClient) *Client

New changes the context of the REST client to an Async client

func (*Client) CreateBookmark 

func (c *Client) CreateBookmark(ctx context.Context, conversationId string, request asyncinterfaces.BookmarkRequest) (*asyncinterfaces.Bookmark, error)

CreateBookmark creates a bookmark in a conversation

TODO: When exercising the API and description is blank...

HTTP Code: 400 

{
	"message":"\"description\" is not allowed to be empty"
}

func (*Client) DeleteBookmark 

func (c *Client) DeleteBookmark(ctx context.Context, conversationId, bookmarkId string) error

DeleteBookmark removes a bookmark in a conversation

func (*Client) GetActionItems 

func (c *Client) GetActionItems(ctx context.Context, conversationId string) (*asyncinterfaces.ActionItemResult, error)

GetActionItems obtains action items in a conversation

func (*Client) GetAnalytics 

func (c *Client) GetAnalytics(ctx context.Context, conversationId string) (*asyncinterfaces.AnalyticsResult, error)

GetAnalytics obtains analytics for a conversation

func (*Client) GetAudioSummaryUI 

func (c *Client) GetAudioSummaryUI(ctx context.Context, conversationId string, request asyncinterfaces.AudioSummaryRequest) (*asyncinterfaces.SummaryUIResult, error)

GetSummaryUI obtains a summary ui for an audio conversation

func (*Client) GetBookmarkById 

func (c *Client) GetBookmarkById(ctx context.Context, conversationId, bookmarkId string) (*asyncinterfaces.BookmarksResult, error)

GetBookmarkById get bookmarks by ID

func (*Client) GetBookmarks 

func (c *Client) GetBookmarks(ctx context.Context, conversationId string) (*asyncinterfaces.BookmarksResult, error)

GetBookmarks to get bookmarks of a conversation

func (*Client) GetCallScore added in v0.3.0 

func (c *Client) GetCallScore(ctx context.Context, conversationId string) (*asyncinterfaces.CallScoreResult, error)

Get Call Score

func (*Client) GetCallScoreStatusById added in v0.3.0 

func (c *Client) GetCallScoreStatusById(ctx context.Context, conversationId string) (*asyncinterfaces.CallScoreStatusResult, error)

Get Call Score Status By Id

func (*Client) GetConversation 

func (c *Client) GetConversation(ctx context.Context, conversationId string) (*asyncinterfaces.Conversation, error)

GetConversation obtains conversation details by conversation ID

func (*Client) GetConversations 

func (c *Client) GetConversations(ctx context.Context) (*asyncinterfaces.ConversationsResult, error)

GetConversations obtains a list of conversations for the account

func (*Client) GetEntities 

func (c *Client) GetEntities(ctx context.Context, conversationId string) (*asyncinterfaces.EntityResult, error)

GetEntities obtains entities in a conversation

func (*Client) GetFollowUps 

func (c *Client) GetFollowUps(ctx context.Context, conversationId string) (*asyncinterfaces.FollowUpResult, error)

GetFollowUps obtains follow ups in a conversation

func (*Client) GetInsightStatusById added in v0.3.0 

func (c *Client) GetInsightStatusById(ctx context.Context, conversationId string) (*asyncinterfaces.InsightStatusResult, error)

Get Insight Status By Id

func (*Client) GetInsightsDetailsUiURI added in v0.3.0 

func (c *Client) GetInsightsDetailsUiURI(ctx context.Context, conversationId string) (*asyncinterfaces.InsightsDetailsUiResult, error)

GetInsightsDetailsUiURI - Get insights details url for the logged in user by conversationId

func (*Client) GetInsightsListUiURI added in v0.3.0 

func (c *Client) GetInsightsListUiURI(ctx context.Context) (*asyncinterfaces.InsightsListUiResult, error)

GetInsightsListUiURI - Get insights list url for the logged in user

func (*Client) GetMembers 

func (c *Client) GetMembers(ctx context.Context, conversationId string) (*asyncinterfaces.MembersResult, error)

GetMembers obtains members in a conversation

func (*Client) GetMessages 

func (c *Client) GetMessages(ctx context.Context, conversationId string) (*asyncinterfaces.MessageResult, error)

GetMessages obtains messages in a conversation

func (*Client) GetQuestions 

func (c *Client) GetQuestions(ctx context.Context, conversationId string) (*asyncinterfaces.QuestionResult, error)

GetQuestions obtains questions in a conversation

func (*Client) GetSummary 

func (c *Client) GetSummary(ctx context.Context, conversationId string) (*asyncinterfaces.SummaryResult, error)

GetSummary obtains a summary for a conversation

func (*Client) GetSummaryOfBookmark 

func (c *Client) GetSummaryOfBookmark(ctx context.Context, conversationId, bookmarkId string) (*asyncinterfaces.BookmarkSummaryResult, error)

GetSummaryOfBookmark gets a summary of bookmarks

func (*Client) GetSummaryOfBookmarks 

func (c *Client) GetSummaryOfBookmarks(ctx context.Context, conversationId string, filters []string) (*asyncinterfaces.BookmarksSummaryResult, error)

GetSummaryOfBookmarks gets a list of bookmarks in a given conversation

func (*Client) GetSummaryUI 

func (c *Client) GetSummaryUI(ctx context.Context, conversationId string, uri string) (*asyncinterfaces.SummaryUIResult, error)

GetSummaryUI obtains a summary ui for conversation

func (*Client) GetTextSummaryUI 

func (c *Client) GetTextSummaryUI(ctx context.Context, conversationId string, request asyncinterfaces.TextSummaryRequest) (*asyncinterfaces.SummaryUIResult, error)

GetSummaryUI obtains a summary ui for a text conversation

func (*Client) GetTopics 

func (c *Client) GetTopics(ctx context.Context, conversationId string) (*asyncinterfaces.TopicResult, error)

GetTopics obtains topics in a conversation

func (*Client) GetTracker 

func (c *Client) GetTracker(ctx context.Context, conversationId string) (*asyncinterfaces.TrackerResult, error)

GetTracker obtains trackers for a conversation

func (*Client) GetTranscript 

func (c *Client) GetTranscript(ctx context.Context, conversationId string, request asyncinterfaces.TranscriptRequest) (*asyncinterfaces.TranscriptResult, error)

GetTranscript obtains transcript for a conversation

func (*Client) GetVideoSummaryUI 

func (c *Client) GetVideoSummaryUI(ctx context.Context, conversationId string, request asyncinterfaces.VideoSummaryRequest) (*asyncinterfaces.SummaryUIResult, error)

GetSummaryUI obtains a summary ui for a video conversation

func (*Client) PostAppendText 

func (c *Client) PostAppendText(ctx context.Context, conversationId string, messages []string) (*JobConversation, error)

PostAppendText appends text conversations to the platform

func (*Client) PostAppendTextWithOptions 

func (c *Client) PostAppendTextWithOptions(ctx context.Context, conversationId string, textRequest asyncinterfaces.AsyncTextRequest) (*JobConversation, error)

PostTextWithOptions appends text conversation to the platform with given options

func (*Client) PostFile 

func (c *Client) PostFile(ctx context.Context, filePath string) (*JobConversation, error)

PostFile posts a file containing a conversations to the platform

func (*Client) PostFileWithOptions 

func (c *Client) PostFileWithOptions(ctx context.Context, filePath string, ufRequest asyncinterfaces.AsyncURLFileRequest) (*JobConversation, error)

PostFileWithOptions posts a File pointing to a conversations to the platform with given options

func (*Client) PostText 

func (c *Client) PostText(ctx context.Context, messages []string) (*JobConversation, error)

PostText posts text conversations to the platform

func (*Client) PostTextWithOptions 

func (c *Client) PostTextWithOptions(ctx context.Context, textRequest asyncinterfaces.AsyncTextRequest) (*JobConversation, error)

PostTextWithOptions posts text conversation to the platform with given options

func (*Client) PostURL 

func (c *Client) PostURL(ctx context.Context, url string) (*JobConversation, error)

PostURL posts a URL pointing to a conversations to the platform

func (*Client) PostURLWithOptions 

func (c *Client) PostURLWithOptions(ctx context.Context, ufRequest asyncinterfaces.AsyncURLFileRequest) (*JobConversation, error)

PostURLWithOptions posts a URL pointing to a conversations to the platform with given options

func (*Client) UpdateBookmark 

func (c *Client) UpdateBookmark(ctx context.Context, conversationId, bookmarkId string, request asyncinterfaces.BookmarkRequest) (*asyncinterfaces.Bookmark, error)

UpdateBookmark updates an existing bookmark in a conversation

func (*Client) UpdateMediaUrlForInsightsDetailsUI added in v0.3.2 

func (c *Client) UpdateMediaUrlForInsightsDetailsUI(ctx context.Context, conversationId string, mediaUrl string) error

UpdateMediaUrlForInsightsDetailsUI updates the audio/video URL that will be played in Insights UI

func (*Client) UpdateMember 

func (c *Client) UpdateMember(ctx context.Context, conversationId string, member asyncinterfaces.Member) error

UpdateMember updates a member in a conversation

func (*Client) UpdateSpeakers 

func (c *Client) UpdateSpeakers(ctx context.Context, conversationId string, speakers asyncinterfaces.UpdateSpeakerRequest) error

UpdateSpeakers updates a speaker in a conversation

func (*Client) WaitForJobComplete 

func (c *Client) WaitForJobComplete(ctx context.Context, jobStatusOpts asyncinterfaces.WaitForJobStatusOpts) (bool, error)

WaitForJobComplete is a loop wrapping the WaitForJobCompleteOnce call

func (*Client) WaitForJobCompleteOnce 

func (c *Client) WaitForJobCompleteOnce(ctx context.Context, jobId string) (bool, error)

WaitForJobCompleteOnce is a convenience wrapper for checking if the platform is finished processing a conversation

type JobConversation 

type JobConversation struct {
	JobID          string `json:"jobId"`
	ConversationID string `json:"conversationId"`
}

JobConversation represents processing an Async API request

type JobStatus 

type JobStatus struct {
	ID     string `json:"id"`
	Status string `json:"status"`
}
Output structs for API calls

JobStatus captures the API for getting status

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.