Method: projects.locations.collections.patch

단일 컬렉션의 파라미터를 업데이트합니다.

HTTP 요청

PATCH https://vectorsearch.googleapis.com/v1/{collection.name}

경로 매개변수

매개변수
collection.name

string

식별자. 리소스의 이름

쿼리 매개변수

파라미터
updateMask

string (FieldMask format)

선택사항입니다. 필드 마스크는 업데이트로 컬렉션 리소스에서 덮어쓸 필드를 지정하는 데 사용됩니다. updateMask에 지정된 필드는 전체 요청이 아닌 해당 리소스를 기준으로 합니다. 마스크에 있으면 필드를 덮어씁니다. 사용자가 마스크를 제공하지 않으면 요청에 있는 모든 필드를 덮어씁니다.

displayName, description, labels, dataSchema, vectorSchema 필드는 업데이트를 지원합니다. dataSchemavectorSchema의 경우 필드는 추가만 가능하고 삭제는 불가능하지만 vectorSchemavertexEmbeddingConfig는 추가하거나 삭제할 수 있습니다. updateMask에서 하위 필드 경로(예: dataSchema.properties.foo 또는 vectorSchema.my_vector_field)를 사용하여 dataSchemavectorSchema의 부분 업데이트도 지원됩니다.

updateMask에 *가 제공되면 전체 교체가 실행됩니다.

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

requestId

string

선택사항. 요청을 식별하는 선택적 요청 ID입니다. 요청을 다시 시도해야 하는 경우 서버가 이미 완료되었을 때 요청을 무시하도록 고유한 요청 ID를 지정합니다. 서버는 첫 번째 요청 후 최소 60분 동안 이를 보장합니다.

예를 들어 최초 요청을 수행하고 요청이 타임아웃되는 경우를 생각해 보세요. 동일한 요청 ID로 다시 요청을 수행하면 서버는 동일한 요청 ID를 가진 원래 작업이 수신되었는지 확인할 수 있으며 그럴 경우 두 번째 요청을 무시합니다. 이렇게 해서 클라이언트가 실수로 중복된 약정을 생성하지 않도록 방지합니다.

요청 ID는 유효한 UUID여야 하며, 0 UUID는 지원되지 않습니다(00000000-0000-0000-0000-000000000000).

요청 본문

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

응답 본문

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

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

IAM 권한

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

  • vectorsearch.collections.update

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