File Search Stores

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

Метод: media.uploadToFileSearchStore

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

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

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

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

    fileSearchStoreName string

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

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

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

    Поля
    displayName string

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

    customMetadata[] object ( CustomMetadata )

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

    объект chunkingConfig object ( ChunkingConfig )

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

    mimeType string

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

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

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

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

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

    post https: / /generativelanguage.googleapis.com /v1beta /fileSearchStores

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

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

    Поля
    displayName string

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

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

    В случае успеха тело ответа будет содержать вновь созданный экземпляр 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 . Максимальный размер хранилища FileSearchStores на странице составляет 20.

    string pageToken

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

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

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

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

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

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

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

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

    Поля
    fileSearchStores[] object ( FileSearchStore )

    Возвращенные rag_stores.

    string nextPageToken

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

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

    Метод: fileSearchStores.importFile

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

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

    post https: / /generativelanguage.googleapis.com /v1beta /{fileSearchStoreName=fileSearchStores /*}:importFile

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

    fileSearchStoreName string

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

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

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

    Поля
    string fileName

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

    customMetadata[] object ( 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 не указан, имя будет сгенерировано случайным образом.

    displayName string

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

    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
}