Documents

Метод: corpora.documents.create

Создает пустой Document .

Конечная точка

пост https: / /generativelanguage.googleapis.com /v1beta /{parent=corpora /*} /documents

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

parent string

Обязательно. Имя Corpus , в котором будет создан этот Document . Пример: corpora/my-corpus-123 Формат: corpora/{corpora} .

Текст запроса

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

Поля
string name

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

string displayName

Необязательно. Удобное для восприятия отображаемое имя Document . Длина отображаемого имени не должна превышать 512 символов, включая пробелы. Пример: «Документация семантического ретривера».

object ( CustomMetadata ) customMetadata[] ( CustomMetadata )

Необязательно. Пользовательские метаданные, хранящиеся в виде пар «ключ-значение», используются для запросов. Document может содержать не более 20 CustomMetadata .

Тело ответа

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

Метод: corpora.documents.query

Выполняет семантический поиск по Document .

Конечная точка

пост https: / /generativelanguage.googleapis.com /v1beta /{name=corpora /* /documents /*}:query

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

string name

Обязательно. Имя запрашиваемого Document . Пример: corpora/my-corpus-123/documents/the-doc-abc Имя имеет вид corpora/{corpora}/documents/{document} .

Текст запроса

Тело запроса содержит данные со следующей структурой:

Поля
string query

Обязательно. Строка запроса для выполнения семантического поиска.

resultsCount integer

Необязательно. Максимальное количество возвращаемых Chunk . Сервис может возвращать меньше Chunk .

Если не указано иное, будет возвращено не более 10 Chunk . Максимальное количество результатов — 100.

object ( MetadataFilter ) metadataFilters[] ( MetadataFilter )

Необязательно. Фильтр для метаданных Chunk . Каждый объект MetadataFilter должен соответствовать уникальному ключу. Несколько объектов MetadataFilter объединяются логическим «И».

Примечание: Фильтрация на уровне Document для этого запроса не поддерживается, поскольку имя Document уже указано.

Пример запроса: (год >= 2020 ИЛИ год < 2010) И (жанр = драма ИЛИ жанр = боевик)

Список объектов MetadataFilter : metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = БОЛЬШЕ_РАВНО}, {int_value = 2010, operation = МЕНЬШЕ}}, {key = "chunk.custom_metadata.genre" conditions = [{stringValue = "драма", operation = РАВНО}, {stringValue = "действие", operation = РАВНО}}]

Пример запроса для числового диапазона значений: (год > 2015 И год <= 2020)

Список объектов MetadataFilter : metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = БОЛЬШЕ}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = МЕНЬШЕ_РАВНО}]}]

Примечание: операторы «И» для одного и того же ключа поддерживаются только для числовых значений. Для строковых значений поддерживаются только операторы «ИЛИ» для одного и того же ключа.

Тело ответа

Ответ от documents.query , содержащий список соответствующих фрагментов.

В случае успеха тело ответа содержит данные со следующей структурой:

Поля
объект relevantChunks[] object ( RelevantChunk )

Возвращены соответствующие фрагменты.

JSON-представление 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Метод: corpora.documents.list

Перечисляет все Document в Corpus .

Конечная точка

получить https: / /generativelanguage.googleapis.com /v1beta /{parent=corpora /*} /documents

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

parent string

Обязательно. Имя Corpus , содержащего Document . Пример: corpora/my-corpus-123 Формат: corpora/{corpora} .

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

pageSize integer

Необязательно. Максимальное количество возвращаемых Document (на страницу). Сервис может возвращать меньшее количество Document .

Если не указано иное, будет возвращено не более 10 Document . Максимальный размер — 20 Document на страницу.

string pageToken

Необязательно. Токен страницы, полученный в результате предыдущего вызова documents.list .

Предоставьте nextPageToken возвращенный в ответе, в качестве аргумента для следующего запроса для получения следующей страницы.

При пагинации все остальные параметры, предоставленные documents.list должны соответствовать вызову, который предоставил токен страницы.

Текст запроса

Тело запроса должно быть пустым.

Тело ответа

Ответ от documents.list , содержащий постраничный список Document . Document отсортированы по возрастанию document.create_time .

В случае успеха тело ответа содержит данные со следующей структурой:

Поля
documents[] object ( Document )

Возвращенный Document s.

string nextPageToken

Токен, который можно отправить как pageToken для получения следующей страницы. Если это поле пропущено, значит, страниц больше нет.

JSON-представление 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}

Метод: corpora.documents.get

Получает информацию о конкретном Document .

Конечная точка

получить https: / /generativelanguage.googleapis.com /v1beta /{name=corpora /* /documents /*}

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

string name

Обязательно. Имя Document , который нужно получить. Пример: corpora/my-corpus-123/documents/the-doc-abc Имя имеет вид corpora/{corpora}/documents/{document} .

Текст запроса

Тело запроса должно быть пустым.

Тело ответа

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

Метод: corpora.documents.patch

Обновляет Document .

Конечная точка

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

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

string document.name

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

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

string ( FieldMask format) updateMask (формат FieldMask)

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

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

Текст запроса

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

Поля
string displayName

Необязательно. Удобное для восприятия отображаемое имя Document . Длина отображаемого имени не должна превышать 512 символов, включая пробелы. Пример: «Документация семантического ретривера».

object ( CustomMetadata ) customMetadata[] ( CustomMetadata )

Необязательно. Пользовательские метаданные, хранящиеся в виде пар «ключ-значение», используются для запросов. Document может содержать не более 20 CustomMetadata .

Тело ответа

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

Метод: corpora.documents.delete

Удаляет Document .

Конечная точка

удалить https: / /generativelanguage.googleapis.com /v1beta /{name=corpora /* /documents /*}

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

string name

Обязательно. Имя ресурса Document , который нужно удалить. Пример: corpora/my-corpus-123/documents/the-doc-abc Имя имеет вид corpora/{corpora}/documents/{document} .

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

force boolean

Необязательно. Если установлено значение true, все Chunk и объекты, связанные с этим Document также будут удалены.

Если false (по умолчанию), будет возвращена ошибка FAILED_PRECONDITION , если Document содержит какие-либо Chunk .

Текст запроса

Тело запроса должно быть пустым.

Тело ответа

В случае успеха тело ответа представляет собой пустой объект JSON.

Ресурс REST: corpora.documents

Ресурс: Документ

Document — это набор фрагментов ( Chunk ). Corpus может содержать не более 10 000 Document ).

Поля
string name

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

string displayName

Необязательно. Удобное для восприятия отображаемое имя Document . Длина отображаемого имени не должна превышать 512 символов, включая пробелы. Пример: «Документация семантического ретривера».

object ( CustomMetadata ) customMetadata[] ( CustomMetadata )

Необязательно. Пользовательские метаданные, хранящиеся в виде пар «ключ-значение», используются для запросов. Document может содержать не более 20 CustomMetadata .

строка updateTime string ( Timestamp format)

Только вывод. Отметка времени последнего обновления Document .

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

createTime string ( Timestamp format)

Только вывод. Отметка времени создания Document .

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

JSON-представление 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}

CustomMetadata

Предоставляемые пользователем метаданные хранятся в виде пар «ключ-значение».

Поля
key string

Обязательно. Ключ метаданных для хранения.

value Union type
value может быть только одним из следующих:
stringValue string

Строковое значение метаданных для хранения.

object ( StringList ) stringListValue ( StringList )

Значение StringList метаданных для хранения.

numericValue number

Числовое значение метаданных для хранения.

JSON-представление 
{
  "key": string,

  // value
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // Union type
}

StringList

Пользователь предоставил строковые значения, назначенные одному ключу метаданных.

Поля
values[] string

Строковые значения метаданных для хранения.

JSON-представление 
{
  "values": [
    string
  ]
}