Corpora

Метод: corpora.create

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

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

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

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

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

Поля
string name

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

string displayName

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

Тело ответа

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

Метод: corpora.query

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

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

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

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

string name

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

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

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

Поля
string query

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

object ( MetadataFilter ) metadataFilters[] ( MetadataFilter )

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

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

Список объектов MetadataFilter : metadataFilters = [ {key = "document.custom_metadata.year" условия = [{int_value = 2020, operation = БОЛЬШЕ_РАВНО}, {int_value = 2010, operation = МЕНЬШЕ}]}, {key = "document.custom_metadata.year" условия = [{int_value = 2020, operation = БОЛЬШЕ_РАВНО}, {int_value = 2010, operation = МЕНЬШЕ}]}, {key = "document.custom_metadata.genre" условия = [{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 = МЕНЬШЕ_РАВНО}]}]

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

resultsCount integer

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

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

Тело ответа

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

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

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

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

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

Метод: corpora.list

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

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

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

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

pageSize integer

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

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

string pageToken

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

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

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

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

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

Тело ответа

Ответ от corpora.list содержащий постраничный список Corpora . Результаты отсортированы по возрастанию corpus.create_time .

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

Поля
corpora[] object ( Corpus )

Возвращенные корпуса.

string nextPageToken

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

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

Метод: corpora.get

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

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

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

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

string name

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

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

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

Тело ответа

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

Метод: corpora.patch

Обновляет Corpus .

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

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

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

string corpus.name

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

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

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

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

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

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

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

Поля
string displayName

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

Тело ответа

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

Метод: corpora.delete

Удаляет Corpus .

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

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

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

string name

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

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

force boolean

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

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

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

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

Тело ответа

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

Ресурс REST: corpora.permissions

Ресурс: Разрешение

Ресурс разрешения предоставляет пользователю, группе или остальному миру доступ к ресурсу API PaLM (например, настроенной модели, корпусу).

Роль — это набор разрешённых операций, позволяющий пользователям выполнять определённые действия с ресурсами API PaLM. Чтобы сделать их доступными пользователям, группам или учётным записям служб, необходимо назначить роли. Назначая роль, вы предоставляете разрешения, содержащиеся в ней.

Существует три концентрические роли. Каждая роль представляет собой надмножество разрешённых операций предыдущей роли:

  • читатель может использовать ресурс (например, настроенную модель, корпус) для вывода
  • Автор имеет права читателя и может редактировать и делиться
  • владелец имеет права автора и может также удалять
Поля
string name

Только вывод. Идентификатор. Имя разрешения. Уникальное имя будет сгенерировано при создании. Примеры: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Только вывод.

перечисление granteeType enum ( GranteeType )

Необязательный. Неизменяемый. Тип получателя гранта.

string emailAddress

Необязательное. Неизменяемое. Адрес электронной почты пользователя группы, к которой относится это разрешение. Поле не заполняется, если тип получателя разрешения — «ВСЕ».

role enum ( Role )

Обязательно. Роль, предоставляемая этим разрешением.

JSON-представление 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

Определяет типы получателей данного разрешения.

Перечисления
GRANTEE_TYPE_UNSPECIFIED Значение по умолчанию. Это значение не используется.
USER Представляет пользователя. При установке необходимо указать адрес электронной почты пользователя.
GROUP Представляет группу. При установке необходимо указать адрес электронной почты группы.
EVERYONE Предоставляет доступ всем. Дополнительная информация не требуется.

Роль

Определяет роль, предоставляемую этим разрешением.

Перечисления
ROLE_UNSPECIFIED Значение по умолчанию. Это значение не используется.
OWNER Владелец может использовать, обновлять, делиться и удалять ресурс.
WRITER Автор может использовать, обновлять и делиться ресурсом.
READER Читатель может использовать ресурс.

Фильтр метаданных

Пользовательский фильтр, ограничивающий поиск на основе значений метаданных уровня Chunk или Document . Пример (жанр = драма ИЛИ жанр = боевик): ключ = "document.custom_metadata.genre" условия = [{stringValue = "драма", операция = РАВНО}, {stringValue = "действие", операция = РАВНО}]

Поля
key string

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

conditions[] object ( Condition )

Обязательно. Condition для заданного ключа, которое активирует этот фильтр. Несколько Condition объединяются логическими операторами «ИЛИ».

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

Состояние

Условие фильтра, применимое к одному ключу.

Поля
operation enum ( Operator )

Обязательно. Оператор, применяемый к заданной паре «ключ-значение» для выполнения условия.

value Union type
Тип значения должен соответствовать типу значения, определённому в поле для соответствующего ключа. Если типы значений не совпадают, результатом будет пустой набор. Если CustomMetadata имеет тип значения StringList , условие фильтрации должно использовать string_value в паре с операцией INCLUDES/EXCLUDES, в противном случае результатом также будет пустой набор. value может быть только одним из следующих:
stringValue string

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

numericValue number

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

JSON-представление 
{
  "operation": enum (Operator),

  // value
  "stringValue": string,
  "numericValue": number
  // Union type
}

Оператор

Определяет допустимые операторы, которые можно применять к паре ключ-значение.

Перечисления
OPERATOR_UNSPECIFIED Значение по умолчанию. Это значение не используется.
LESS Поддерживается числовым значением.
LESS_EQUAL Поддерживается числовым значением.
EQUAL Поддерживается числовыми и строковыми данными.
GREATER_EQUAL Поддерживается числовым значением.
GREATER Поддерживается числовым значением.
NOT_EQUAL Поддерживается числовыми и строковыми данными.
INCLUDES Поддерживается строкой только в том случае, если тип значения CustomMetadata для заданного ключа имеет stringListValue .
EXCLUDES Поддерживается строкой только в том случае, если тип значения CustomMetadata для заданного ключа имеет stringListValue .

Соответствующий фрагмент

Информация для фрагмента, относящегося к запросу.

Поля
number chunkRelevanceScore

Релевантность Chunk запросу.

объект chunk object ( Chunk )

Chunk связанный с запросом.

объект document object ( Document )

Document связанный с фрагментом.

JSON-представление 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  },
  "document": {
    object (Document)
  }
}

Ресурс REST: corpora

Ресурс: Корпус

Corpus — это набор Document . В рамках проекта может быть создано до 5 корпусов.

Поля
string name

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

string displayName

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

createTime string ( Timestamp format)

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

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

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

Использует 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,
  "createTime": string,
  "updateTime": string
}