File Search Stores

API поиска файлов предоставляет размещенную службу ответов на вопросы для создания систем дополненной генерации поиска (RAG) с использованием инфраструктуры Google.

Метод: media.uploadToFileSearchStore

Загружает данные в FileSearchStore, выполняет предварительную обработку и разбивает на фрагменты перед сохранением в документе FileSearchStore.

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

  • URI загрузки для запросов на загрузку медиафайлов:
    • разместить https: / /generativelanguage.googleapis.com /upload /v1beta /{fileSearchStoreName=fileSearchStores /*}:uploadToFileSearchStore
  • URI метаданных для запросов только на метаданные:
    • пост https: / /generativelanguage.googleapis.com /v1beta /{fileSearchStoreName=fileSearchStores /*}:uploadToFileSearchStore

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

    string fileSearchStoreName

    Обязательно. Неизменяемо. Имя хранилища FileSearchStore , в которое нужно загрузить файл. Пример: fileSearchStores/my-file-search-store-123 Имя имеет вид fileSearchStores/{filesearchstore} .

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

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

    Поля
    string displayName

    Необязательно. Отображаемое имя созданного документа.

    object ( CustomMetadata ) customMetadata[] ( CustomMetadata )

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

    объект chunkingConfig object ( ChunkingConfig )

    Необязательно. Конфигурация, указывающая сервису, как разбивать данные на фрагменты. Если не указано, сервис будет использовать параметры по умолчанию.

    string mimeType

    Необязательно. MIME-тип данных. Если не указан, он будет определён на основе загруженного контента.

    Тело ответа

    Это копия google.longrunning.Operation. Нам нужно её скопировать, поскольку для взаимодействия со scotty необходимо добавить специфичное для scotty поле, которое невозможно добавить в протокол операции верхнего уровня.

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

    Поля
    string name

    Имя, назначенное сервером, уникально только в пределах той же службы, которая его изначально возвращает. Если вы используете HTTP-сопоставление по умолчанию, name должно быть именем ресурса, заканчивающимся на operations/{unique_id} .

    object metadata

    Метаданные, специфичные для сервиса, связанные с операцией. Обычно они содержат информацию о ходе выполнения и общие метаданные, такие как время создания. Некоторые сервисы могут не предоставлять такие метаданные. Любой метод, возвращающий длительную операцию, должен документировать тип метаданных, если таковой имеется.

    Объект, содержащий поля произвольного типа. Дополнительное поле "@type" содержит URI, идентифицирующий тип. Пример: { "id": 1234, "@type": "types.example.com/standard/id" } .

    done boolean

    Если значение равно false , это означает, что операция всё ещё выполняется. Если true , операция завершена и доступен либо error , либо response .

    result Union type
    Результат операции, который может быть как error , так и допустимым response . Если done == false , ни error , ни response не устанавливаются. Если done == true , может быть установлен только один из вариантов error или response . Некоторые службы могут не предоставлять результат. result может быть только одним из следующих:
    объект error object ( Status )

    Ошибочный результат операции в случае сбоя или отмены.

    object response

    Обычный, успешный ответ операции. Если исходный метод не возвращает данных об успешном выполнении, например, Delete , ответом будет google.protobuf.Empty . Если исходный метод — стандартный Get / Create / Update , ответом должен быть ресурс. Для других методов ответ должен иметь тип XxxResponse , где Xxx — имя исходного метода. Например, если имя исходного метода — TakeSnapshot() , выводимый тип ответа — TakeSnapshotResponse .

    Объект, содержащий поля произвольного типа. Дополнительное поле "@type" содержит URI, идентифицирующий тип. Пример: { "id": 1234, "@type": "types.example.com/standard/id" } .

    JSON-представление 
    {
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

    Метод: fileSearchStores.create

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

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

    пост https: / /generativelanguage.googleapis.com /v1beta /fileSearchStores

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

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

    Поля
    string displayName

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

    Тело ответа

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

    Метод: fileSearchStores.delete

    Удаляет FileSearchStore .

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

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

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

    string name

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

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

    force boolean

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

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

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

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

    Тело ответа

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

    Метод: fileSearchStores.get

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

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

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

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

    string name

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

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

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

    Тело ответа

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

    Метод: fileSearchStores.list

    Перечисляет все FileSearchStores принадлежащие пользователю.

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

    получить https: / /generativelanguage.googleapis.com /v1beta /fileSearchStores

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

    pageSize integer

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

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

    string pageToken

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

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

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

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

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

    Тело ответа

    Ответ от fileSearchStores.list , содержащий постраничный список FileSearchStores . Результаты сортируются по возрастанию fileSearchStore.create_time .

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

    Поля
    объект fileSearchStores[] object ( FileSearchStore )

    Возвращенные тряпки.

    string nextPageToken

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

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

    Метод: fileSearchStores.importFile

    Импортирует File из файловой службы в FileSearchStore .

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

    пост https: / /generativelanguage.googleapis.com /v1beta /{fileSearchStoreName=fileSearchStores /*}:importFile

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

    string fileSearchStoreName

    Обязательно. Неизменяемо. Имя хранилища FileSearchStore , в которое нужно импортировать файл. Пример: fileSearchStores/my-file-search-store-123 Имя имеет вид fileSearchStores/{filesearchstore} .

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

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

    Поля
    string fileName

    Обязательно. Имя File для импорта. Пример: files/abc-123

    object ( CustomMetadata ) customMetadata[] ( CustomMetadata )

    Пользовательские метаданные, которые будут связаны с файлом.

    объект chunkingConfig object ( ChunkingConfig )

    Необязательно. Конфигурация, указывающая службе, как разбить файл на части. Если не указано, служба будет использовать параметры по умолчанию.

    Тело ответа

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

    Ресурс REST: fileSearchStores.operations

    Ресурс: Операция

    Этот ресурс представляет собой длительную операцию, являющуюся результатом вызова сетевого API.

    Поля
    string name

    Имя, назначенное сервером, уникально только в пределах той же службы, которая его изначально возвращает. Если вы используете HTTP-сопоставление по умолчанию, name должно быть именем ресурса, заканчивающимся на operations/{unique_id} .

    object metadata

    Метаданные, специфичные для сервиса, связанные с операцией. Обычно они содержат информацию о ходе выполнения и общие метаданные, такие как время создания. Некоторые сервисы могут не предоставлять такие метаданные. Любой метод, возвращающий длительную операцию, должен документировать тип метаданных, если таковой имеется.

    Объект, содержащий поля произвольного типа. Дополнительное поле "@type" содержит URI, идентифицирующий тип. Пример: { "id": 1234, "@type": "types.example.com/standard/id" } .

    done boolean

    Если значение равно false , это означает, что операция всё ещё выполняется. Если true , операция завершена и доступен либо error , либо response .

    result Union type
    Результат операции, который может быть как error , так и допустимым response . Если done == false , ни error , ни response не устанавливаются. Если done == true , может быть установлен только один из вариантов error или response . Некоторые службы могут не предоставлять результат. result может быть только одним из следующих:
    объект error object ( Status )

    Ошибочный результат операции в случае сбоя или отмены.

    object response

    Обычный, успешный ответ операции. Если исходный метод не возвращает данных об успешном выполнении, например, Delete , ответом будет google.protobuf.Empty . Если исходный метод — стандартный Get / Create / Update , ответом должен быть ресурс. Для других методов ответ должен иметь тип XxxResponse , где Xxx — имя исходного метода. Например, если имя исходного метода — TakeSnapshot() , выводимый тип ответа — TakeSnapshotResponse .

    Объект, содержащий поля произвольного типа. Дополнительное поле "@type" содержит URI, идентифицирующий тип. Пример: { "id": 1234, "@type": "types.example.com/standard/id" } .

    JSON-представление 
    {
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

    Метод: fileSearchStores.operations.get

    Получает последнее состояние длительной операции. Клиенты могут использовать этот метод для опроса результата операции с интервалами, рекомендованными службой API.

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

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

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

    string name

    Имя ресурса операции. Имеет вид fileSearchStores/{filesearchstore}/operations/{operation} .

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

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

    Тело ответа

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

    Ресурс REST: fileSearchStores.upload.operations

    Ресурс: Операция

    Этот ресурс представляет собой длительную операцию, являющуюся результатом вызова сетевого API.

    Поля
    string name

    Имя, назначенное сервером, уникально только в пределах той же службы, которая его изначально возвращает. Если вы используете HTTP-сопоставление по умолчанию, name должно быть именем ресурса, заканчивающимся на operations/{unique_id} .

    object metadata

    Метаданные, специфичные для сервиса, связанные с операцией. Обычно они содержат информацию о ходе выполнения и общие метаданные, такие как время создания. Некоторые сервисы могут не предоставлять такие метаданные. Любой метод, возвращающий длительную операцию, должен документировать тип метаданных, если таковой имеется.

    Объект, содержащий поля произвольного типа. Дополнительное поле "@type" содержит URI, идентифицирующий тип. Пример: { "id": 1234, "@type": "types.example.com/standard/id" } .

    done boolean

    Если значение равно false , это означает, что операция всё ещё выполняется. Если true , операция завершена и доступен либо error , либо response .

    result Union type
    Результат операции, который может быть как error , так и допустимым response . Если done == false , ни error , ни response не устанавливаются. Если done == true , может быть установлен только один из вариантов error или response . Некоторые службы могут не предоставлять результат. result может быть только одним из следующих:
    объект error object ( Status )

    Ошибочный результат операции в случае сбоя или отмены.

    object response

    Обычный, успешный ответ операции. Если исходный метод не возвращает данных об успешном выполнении, например, Delete , ответом будет google.protobuf.Empty . Если исходный метод — стандартный Get / Create / Update , ответом должен быть ресурс. Для других методов ответ должен иметь тип XxxResponse , где Xxx — имя исходного метода. Например, если имя исходного метода — TakeSnapshot() , выводимый тип ответа — TakeSnapshotResponse .

    Объект, содержащий поля произвольного типа. Дополнительное поле "@type" содержит URI, идентифицирующий тип. Пример: { "id": 1234, "@type": "types.example.com/standard/id" } .

    JSON-представление 
    {
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

    Метод: fileSearchStores.upload.operations.get

    Получает последнее состояние длительной операции. Клиенты могут использовать этот метод для опроса результата операции с интервалами, рекомендованными службой API.

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

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

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

    string name

    Имя ресурса операции. Имеет вид fileSearchStores/{filesearchstore}/upload/operations/{operation} .

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

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

    Тело ответа

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

    Ресурс REST: fileSearchStores

    Ресурс: FileSearchStore

    FileSearchStore — это коллекция Document .

    Поля
    string name

    Только вывод. Неизменяемый. Идентификатор. Имя ресурса FileSearchStore . Это идентификатор (имя без префикса "fileSearchStores/"), который может содержать до 40 строчных букв, цифр или дефисов (-). Только вывод. Уникальное имя будет сформировано из displayName с добавлением 12-символьного случайного суффикса. Пример: fileSearchStores/my-awesome-file-search-store-123a456b789c Если displayName не указано, имя будет сгенерировано случайным образом.

    string displayName

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

    createTime string ( Timestamp format)

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

    Использует 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" .

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

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

    Использует 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" .

    строка activeDocumentsCount string ( int64 format)

    Только вывод. Количество документов в FileSearchStore , которые активны и готовы к извлечению.

    строка pendingDocumentsCount string ( int64 format)

    Только вывод. Количество обрабатываемых документов в FileSearchStore .

    строка failedDocumentsCount string ( int64 format)

    Только вывод. Количество документов в FileSearchStore , обработка которых завершилась неудачей.

    строка sizeBytes string ( int64 format)

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

    JSON-представление 
    {
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "activeDocumentsCount": string,
  "pendingDocumentsCount": string,
  "failedDocumentsCount": string,
  "sizeBytes": string
}