Method: projects.locations.dataStores.branches.documents.patch

Document을 업데이트합니다.

HTTP 요청

PATCH https://discoveryengine.googleapis.com/v1beta/{document.name=projects/*/locations/*/dataStores/*/branches/*/documents/*}

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

경로 매개변수

매개변수
document.name

string

변경할 수 없습니다. 문서의 전체 리소스 이름입니다. 형식은 projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}입니다.

이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 1,024자(영문 기준)입니다.

쿼리 매개변수

매개변수
allowMissing

boolean

true로 설정되어 있고 Document을 찾을 수 없는 경우 새 Document이 생성됩니다.
updateMask

string (FieldMask format)

제공된 가져온 '문서'에서 업데이트할 필드를 나타냅니다. 설정하지 않으면 기본적으로 모든 필드가 업데이트됩니다.

정규화된 필드 이름의 쉼표로 구분된 목록입니다. 예: "user.displayName,photo"

요청 본문

요청 본문에 Document의 인스턴스가 포함됩니다.

응답 본문

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

승인 범위

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

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

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

IAM 권한

name 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • discoveryengine.documents.update

자세한 내용은 IAM 문서를 참조하세요.