Method: projects.locations.collections.engines.assistants.agents.suspendAgent

에이전트를 일시중지합니다. 일시중지된 에이전트는 조회는 가능하지만 사용할 수 없습니다. 에이전트의 state가 SUSPENDED로 변경됩니다. 상태가 ENABLED인 에이전트에서만 호출할 수 있으며, 그렇지 않으면 오류가 반환됩니다.

HTTP 요청

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}:suspendAgent

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

경로 매개변수

매개변수
name

string

필수 항목. 일시중지할 에이전트의 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

쿼리 매개변수

매개변수
suspensionReason

string

필수 항목. 에이전트가 일시중지된 사유입니다. 이 사유는 에이전트 사용자에게 표시됩니다.

요청 본문

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

응답 본문

성공한 경우 응답 본문에 Agent의 인스턴스가 포함됩니다.

승인 범위

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

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