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.

объект metadataFilters[] object ( MetadataFilter )

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

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

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

Список объектов MetadataFilter : MetadataFilters = [ {key = "chunk.custom_metadata.year" условия = [{int_value = 2020, Operation = GREATER_EQUAL}, {int_value = 2010, Operation = LESS}}, {key = "chunk.custom_metadata.genre" " условия = [{stringValue = "драма", операция = EQUAL}, {stringValue = "действие", операция = EQUAL}}]

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

Список объектов MetadataFilter : MetadataFilters = [ {key = "chunk.custom_metadata.year" условия = [{int_value = 2015, Operation = GREATER}]}, {key = "chunk.custom_metadata.year" условия = [{int_value = 2020, операция = LESS_EQUAL}]}]

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

Тело ответа

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

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

Поля
object ( RelevantChunk ) relevantChunks[] ( RelevantChunk )

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

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

Метод: corpora.documents.list

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

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

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

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

parent string

Необходимый. Название Corpus содержащего Document s. Пример: corpora/my-corpus-123 Он принимает форму corpora/{corpora} .

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

pageSize integer

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

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

string pageToken

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

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

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

Тело запроса

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

Тело ответа

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

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

Поля
объект documents[] object ( Document )

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

nextPageToken string PageToken

Токен, который можно отправить как 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} .

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

строка updateMask string ( FieldMask format)

Необходимый. Список полей для обновления. В настоящее время поддерживается только обновление 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 .

Тело запроса

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

Тело ответа

В случае успеха тело ответа пустое.

Ресурс REST: corpora.documents.

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

Document представляет собой коллекцию Chunk s. Corpus может содержать максимум 10 000 Document s.

Поля
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 .

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

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

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

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

Пользовательские метаданные

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

Поля
key string

Необходимый. Ключ метаданных для хранения.

value поля объединения.

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

string stringValue

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

object ( StringList ) stringListValue ( StringList )

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

numericValue number

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

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

  // Union field value can be only one of the following:
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // End of list of possible types for union field value.
}

Список строк

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

Поля
values[] string

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

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