Documents

API поиска файлов использует ваши исходные файлы или документы в качестве временных объектов File.

Метод: fileSearchStores.documents.delete

Удаляет Document .

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

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

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

string name

Обязательно. Имя ресурса Document для удаления. Пример: fileSearchStores/my-file-search-store-123/documents/the-doc-abc Формат: fileSearchStores/{filesearchstore}/documents/{document} .

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

force boolean

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

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

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

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

Ответный текст

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

Метод: fileSearchStores.documents.get

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

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

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

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

string name

Обязательно. Название Document для поиска. Пример: fileSearchStores/my-file-search-store-123/documents/the-doc-abc Формат: fileSearchStores/{filesearchstore}/documents/{document} .

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

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

Ответный текст

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

Метод: fileSearchStores.documents.list

Отображает список всех Document в Corpus .

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

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

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

parent string

Обязательно. Имя FileSearchStore содержащего Document . Пример: fileSearchStores/my-file-search-store-123 Формат: fileSearchStores/{filesearchstore} .

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

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
}

REST-ресурс: fileSearchStores.documents

Источник: Документ

Document представляет собой набор фрагментов кода Chunk ).

Поля
string name

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

displayName string

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

customMetadata[] object ( 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" .

перечисление state enum ( State )

Только вывод. Текущее состояние Document .

sizeBytes string ( int64 format)

Только для вывода. Размер исходных байтов, загружаемых в документ.

mimeType string

Только вывод. MIME-тип документа.

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

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

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

Поля
key string

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

value Union type
Ниже приведён список взаимоисключающих полей. В ответе будет установлено не более одного из этих полей:
stringValue string

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

объект stringListValue object ( StringList )

Значение типа StringList, содержащее метаданные для хранения.

numericValue number

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

Конец взаимоисключающих областей.
JSON-представление 
{
  "key": string,

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

StringList

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

Поля
values[] string

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

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

Состояние

Состояния жизненного цикла Document .

Перечисления
STATE_UNSPECIFIED Значение по умолчанию. Это значение используется, если состояние не указано.
STATE_PENDING В настоящее время обрабатываются некоторые Chunks Document (встраивание и векторное хранение).
STATE_ACTIVE Все Chunks Document обработаны и доступны для запросов.
STATE_FAILED Обработка некоторых Chunks Document не удалась.