Merge pull request #37 from seymourtang/feat/convoai

feat: Implement Interrupt and GetHistory APIs for conversational AI service

Author: seymourtang

examples/convoai/README.md

@@ -67,11 +67,11 @@ export CONVOAI_TTS_ELEVENLABS_VOICE_ID=<Your tts elevenLabs voice id>
 Run the sample project with the following command:
 
 ```bash
-go run main.go -ttsVendor=<ttsVendor> --serviceRegion=<serviceRegion>
+go run main.go --ttsVendor=<ttsVendor> --serviceRegion=<serviceRegion>
 ```
 
 `ttsVendor` represents different TTS providers. Choose the appropriate TTS provider based on your requirements.
 `serviceRegion` represents chosen service region. The currently supported service regions are:
-* `ChineseMainland`
-* `Global`
+* `1`:`ChineseMainland`
+* `2`:`Global`
 

examples/convoai/README_ZH.md

@@ -67,11 +67,11 @@ export CONVOAI_TTS_ELEVENLABS_VOICE_ID=<Your tts elevenLabs voice id>
 使用以下命令运行示例项目：
 
 ```bash
-go run main.go -ttsVendor=<ttsVendor> --serviceRegion=<serviceRegion>
+go run main.go --ttsVendor=<ttsVendor> --serviceRegion=<serviceRegion>
 ```
 
 `ttsVendor` 代表不同的 TTS 提供商。根据您的需求选择合适的 TTS 提供商。
 `serviceRegion` 代表选择的服务区域。目前支持的服务区域有：
-* `ChineseMainland`
-* `Global`
+* `1`:`ChineseMainland`
+* `2`:`Global`
 

examples/convoai/service/service.go

@@ -170,6 +170,33 @@ func (s *Service) RunWithCustomTTS(ttsVendor req.TTSVendor, ttsParam req.TTSVend
 		time.Sleep(time.Second * 3)
 	}
 
+	interruptResp, err := convoaiClient.Interrupt(ctx, agentId)
+	if err != nil {
+		log.Fatalln(err)
+	}
+
+	if interruptResp.IsSuccess() {
+		log.Printf("Interrupt success:%+v", interruptResp)
+	} else {
+		log.Printf("Interrupt failed:%+v", interruptResp)
+		return
+	}
+	time.Sleep(time.Second * 1)
+
+	historyResp, err := convoaiClient.GetHistory(ctx, agentId)
+	if err != nil {
+		log.Fatalln(err)
+	}
+
+	if historyResp.IsSuccess() {
+		log.Printf("History success:%+v", historyResp)
+	} else {
+		log.Printf("History failed:%+v", historyResp)
+		return
+	}
+
+	time.Sleep(time.Second * 1)
+
 	updateResp, err := convoaiClient.Update(ctx, agentId, &req.UpdateReqBody{
 		Token: updateToken,
 	})

services/convoai/api/history.go

@@ -0,0 +1,64 @@
+package api
+
+import (
+	"context"
+	"errors"
+	"net/http"
+
+	"github.com/AgoraIO-Community/agora-rest-client-go/agora"
+	"github.com/AgoraIO-Community/agora-rest-client-go/agora/client"
+	"github.com/AgoraIO-Community/agora-rest-client-go/agora/log"
+	"github.com/AgoraIO-Community/agora-rest-client-go/services/convoai/resp"
+)
+
+type History struct {
+	baseHandler
+}
+
+func NewHistory(module string, logger log.Logger, client client.Client, prefixPath string) *History {
+	return &History{
+		baseHandler: baseHandler{
+			module:     module,
+			logger:     logger,
+			client:     client,
+			prefixPath: prefixPath,
+		},
+	}
+}
+
+// buildPath returns the request path.
+// /api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/history
+func (h *History) buildPath(agentId string) string {
+	return h.prefixPath + "/agents/" + agentId + "/history"
+}
+
+func (h *History) Do(ctx context.Context, agentId string) (*resp.HistoryResp, error) {
+	path := h.buildPath(agentId)
+	responseData, err := h.client.DoREST(ctx, path, http.MethodGet, nil)
+	if err != nil {
+		var internalErr *agora.InternalErr
+		if !errors.As(err, &internalErr) {
+			return nil, err
+		}
+	}
+
+	var historyResp resp.HistoryResp
+
+	historyResp.BaseResponse = responseData
+
+	if responseData.HttpStatusCode == http.StatusOK {
+		var successResponse resp.HistorySuccessResp
+		if err = responseData.UnmarshalToTarget(&successResponse); err != nil {
+			return nil, err
+		}
+		historyResp.SuccessRes = successResponse
+	} else {
+		var errResponse resp.ErrResponse
+		if err = responseData.UnmarshalToTarget(&errResponse); err != nil {
+			return nil, err
+		}
+		historyResp.ErrResponse = errResponse
+	}
+
+	return &historyResp, nil
+}

services/convoai/api/interrupt.go

@@ -0,0 +1,65 @@
+package api
+
+import (
+	"context"
+	"errors"
+	"net/http"
+
+	"github.com/AgoraIO-Community/agora-rest-client-go/agora"
+	"github.com/AgoraIO-Community/agora-rest-client-go/agora/client"
+	"github.com/AgoraIO-Community/agora-rest-client-go/agora/log"
+	"github.com/AgoraIO-Community/agora-rest-client-go/services/convoai/resp"
+)
+
+type Interrupt struct {
+	baseHandler
+}
+
+func NewInterrupt(module string, logger log.Logger, client client.Client, prefixPath string) *Interrupt {
+	return &Interrupt{
+		baseHandler: baseHandler{
+			module:     module,
+			logger:     logger,
+			client:     client,
+			prefixPath: prefixPath,
+		},
+	}
+}
+
+// buildPath returns the request path.
+//
+// /api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/interrupt
+func (i *Interrupt) buildPath(agentId string) string {
+	return i.prefixPath + "/agents/" + agentId + "/interrupt"
+}
+
+func (i *Interrupt) Do(ctx context.Context, agentId string) (*resp.InterruptResp, error) {
+	path := i.buildPath(agentId)
+	responseData, err := i.client.DoREST(ctx, path, http.MethodPost, nil)
+	if err != nil {
+		var internalErr *agora.InternalErr
+		if !errors.As(err, &internalErr) {
+			return nil, err
+		}
+	}
+
+	var interruptResp resp.InterruptResp
+
+	interruptResp.BaseResponse = responseData
+
+	if responseData.HttpStatusCode == http.StatusOK {
+		var successResponse resp.InterruptSuccessResp
+		if err = responseData.UnmarshalToTarget(&successResponse); err != nil {
+			return nil, err
+		}
+		interruptResp.SuccessRes = successResponse
+	} else {
+		var errResponse resp.ErrResponse
+		if err = responseData.UnmarshalToTarget(&errResponse); err != nil {
+			return nil, err
+		}
+		interruptResp.ErrResponse = errResponse
+	}
+
+	return &interruptResp, nil
+}

services/convoai/api/leave.go

@@ -3,14 +3,11 @@ package api
 import (
 	"context"
 	"errors"
-	"fmt"
 	"net/http"
-	"time"
 
 	"github.com/AgoraIO-Community/agora-rest-client-go/agora"
 	"github.com/AgoraIO-Community/agora-rest-client-go/agora/client"
 	"github.com/AgoraIO-Community/agora-rest-client-go/agora/log"
-	"github.com/AgoraIO-Community/agora-rest-client-go/agora/retry"
 	"github.com/AgoraIO-Community/agora-rest-client-go/services/convoai/resp"
 )
 
@@ -38,7 +35,7 @@ func (d *Leave) buildPath(agentId string) string {
 
 func (d *Leave) Do(ctx context.Context, agentId string) (*resp.LeaveResp, error) {
 	path := d.buildPath(agentId)
-	responseData, err := d.doRESTWithRetry(ctx, path, http.MethodPost, nil)
+	responseData, err := d.client.DoREST(ctx, path, http.MethodPost, nil)
 	if err != nil {
 		var internalErr *agora.InternalErr
 		if !errors.As(err, &internalErr) {
@@ -60,51 +57,3 @@ func (d *Leave) Do(ctx context.Context, agentId string) (*resp.LeaveResp, error)
 
 	return &response, nil
 }
-
-const leaveRetryCount = 3
-
-func (d *Leave) doRESTWithRetry(ctx context.Context, path string, method string, requestBody interface{}) (*agora.BaseResponse, error) {
-	var (
-		response   *agora.BaseResponse
-		err        error
-		retryCount int
-	)
-
-	err = retry.Do(func(retryCount int) error {
-		var doErr error
-
-		response, doErr = d.client.DoREST(ctx, path, method, requestBody)
-		if doErr != nil {
-			return agora.NewRetryErr(false, doErr)
-		}
-
-		statusCode := response.HttpStatusCode
-		switch {
-		case statusCode == 200 || statusCode == 201:
-			return nil
-		case statusCode >= 400 && statusCode < 499:
-			d.logger.Debugf(ctx, d.module, "http status code is %d, no retry,http response:%s", statusCode, response.RawBody)
-			return agora.NewRetryErr(
-				false,
-				agora.NewInternalErr(fmt.Sprintf("http status code is %d, no retry,http response:%s", statusCode, response.RawBody)),
-			)
-		default:
-			d.logger.Debugf(ctx, d.module, "http status code is %d, retry,http response:%s", statusCode, response.RawBody)
-			return fmt.Errorf("http status code is %d, retry", response.RawBody)
-		}
-	}, func() bool {
-		select {
-		case <-ctx.Done():
-			return true
-		default:
-		}
-		return retryCount >= leaveRetryCount
-	}, func(i int) time.Duration {
-		return time.Second * time.Duration(i+1)
-	}, func(err error) {
-		d.logger.Debugf(ctx, d.module, "http request err:%s", err)
-		retryCount++
-	})
-
-	return response, err
-}

services/convoai/api/list.go

@@ -6,12 +6,10 @@ import (
 	"fmt"
 	"net/http"
 	"net/url"
-	"time"
 
 	"github.com/AgoraIO-Community/agora-rest-client-go/agora"
 	"github.com/AgoraIO-Community/agora-rest-client-go/agora/client"
 	"github.com/AgoraIO-Community/agora-rest-client-go/agora/log"
-	"github.com/AgoraIO-Community/agora-rest-client-go/agora/retry"
 	"github.com/AgoraIO-Community/agora-rest-client-go/services/convoai/req"
 	"github.com/AgoraIO-Community/agora-rest-client-go/services/convoai/resp"
 )
@@ -86,7 +84,7 @@ func buildQueryFields(options ...req.ListOption) map[string]any {
 func (q *List) Do(ctx context.Context, options ...req.ListOption) (*resp.ListResp, error) {
 	queryFields := buildQueryFields(options...)
 	path := q.buildPath(queryFields)
-	responseData, err := q.doRESTWithRetry(ctx, path, http.MethodGet, nil)
+	responseData, err := q.client.DoREST(ctx, path, http.MethodGet, nil)
 	if err != nil {
 		var internalErr *agora.InternalErr
 		if !errors.As(err, &internalErr) {
@@ -114,51 +112,3 @@ func (q *List) Do(ctx context.Context, options ...req.ListOption) (*resp.ListRes
 
 	return &listResp, nil
 }
-
-const listRetryCount = 3
-
-func (q *List) doRESTWithRetry(ctx context.Context, path string, method string, requestBody interface{}) (*agora.BaseResponse, error) {
-	var (
-		baseResponse *agora.BaseResponse
-		err          error
-		retryCount   int
-	)
-
-	err = retry.Do(func(retryCount int) error {
-		var doErr error
-
-		baseResponse, doErr = q.client.DoREST(ctx, path, method, requestBody)
-		if doErr != nil {
-			return agora.NewRetryErr(false, doErr)
-		}
-
-		statusCode := baseResponse.HttpStatusCode
-		switch {
-		case statusCode == 200 || statusCode == 201:
-			return nil
-		case statusCode >= 400 && statusCode < 499:
-			q.logger.Debugf(ctx, q.module, "http status code is %d, no retry,http response:%s", statusCode, baseResponse.RawBody)
-			return agora.NewRetryErr(
-				false,
-				agora.NewInternalErr(fmt.Sprintf("http status code is %d, no retry,http response:%s", statusCode, baseResponse.RawBody)),
-			)
-		default:
-			q.logger.Debugf(ctx, q.module, "http status code is %d, retry,http response:%s", statusCode, baseResponse.RawBody)
-			return fmt.Errorf("http status code is %d, retry", baseResponse.RawBody)
-		}
-	}, func() bool {
-		select {
-		case <-ctx.Done():
-			return true
-		default:
-		}
-		return retryCount >= listRetryCount
-	}, func(i int) time.Duration {
-		return time.Second * time.Duration(i+1)
-	}, func(err error) {
-		q.logger.Debugf(ctx, q.module, "http request err:%s", err)
-		retryCount++
-	})
-
-	return baseResponse, err
-}