Method: corpora.documents.patch

Обновляет Document .

HTTP-запрос

PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
document.name

string

Неизменный. Идентификатор. Имя ресурса Document . Идентификатор (имя, за исключением префикса «corpora/*/documents/») может содержать до 40 символов, состоящих из строчных букв, цифр или дефисов (-). Идентификатор не может начинаться или заканчиваться тире. Если при создании имя пустое, уникальное имя будет получено из displayName вместе со случайным суффиксом из 12 символов. Пример: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

Параметры запроса

Параметры
updateMask

string ( FieldMask format)

Необходимый. Список полей для обновления. В настоящее время поддерживается только обновление displayName и customMetadata .

Это разделенный запятыми список полных имен полей. Пример: "user.displayName,photo" .

Тело запроса

Тело запроса содержит экземпляр Document .

Тело ответа

В случае успеха тело ответа содержит экземпляр Document .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/generative-language.retriever

Для получения дополнительной информации см. Обзор аутентификации .