Method: tasks.list

지정된 필터와 일치하는 작업을 나열합니다.

HTTP 요청

GET https://ces.googleapis.com/tasks

URL은 gRPC 트랜스코딩 문법을 사용합니다.

쿼리 매개변수

파라미터
tenant

string

선택사항입니다. 불투명 라우팅 식별자입니다. 이 필드가 설정된 경우 에이전트 카드에서 선택한 AgentInterface의 tenant 값과 일치해야 합니다.
contextId

string

컨텍스트 ID로 작업을 필터링하여 특정 대화 또는 세션의 작업을 가져옵니다.
status

enum (TaskState)

현재 상태별로 작업을 필터링합니다.
pageToken

string

이전 tasks.list 호출에서 받은 페이지 토큰입니다. ListTasksResponse.next_page_token 후속 페이지를 검색하려면 이를 입력합니다.
statusTimestampAfter

string (Timestamp format)

ISO 8601 형식 (예: '2023-10-27T10:00:00Z')으로 제공된 타임스탬프 이후에 상태가 업데이트된 작업을 필터링합니다. 상태 타임스탬프 시간이 이 값보다 크거나 같은 작업만 반환됩니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
pageSize

integer

반환할 최대 작업 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 지정하지 않으면 최대 50개의 작업이 반환됩니다. 최솟값은 1입니다. 최댓값은 100입니다.
historyLength

integer

각 작업의 기록에 포함할 최대 메시지 수입니다.
includeArtifacts

boolean

반환된 작업에 아티팩트를 포함할지 여부입니다. 페이로드 크기를 줄이기 위해 기본값은 false입니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

작업 배열과 페이지로 나누기 정보가 포함된 tasks.list 메서드의 결과 객체입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "tasks": [
    {
      object (Task)
    }
  ],
  "nextPageToken": string,
  "pageSize": integer,
  "totalSize": integer
}
필드
tasks[]

object (Task)

필수 항목입니다. 지정된 기준과 일치하는 작업의 배열입니다.
nextPageToken

string

필수 항목입니다. 결과의 다음 페이지를 검색하는 토큰으로, 목록에 더 이상 결과가 없으면 비어 있습니다.
pageSize

integer

필수 항목입니다. 이 응답에 사용된 페이지 크기입니다.
totalSize

integer

필수 항목입니다. 사용 가능한 총 작업 수 (페이지로 나누기 전)입니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

자세한 내용은 Authentication Overview를 참조하세요.