Corpora

Ресурс REST: корпус

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

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

JSON-представление
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}
Поля
string name

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

string displayName

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

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

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

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

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

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

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

Метод: corpora.create

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

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

опубликовать https://generativelanguage.googleapis.com/v1beta/corpora

Тело запроса

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

Тело ответа

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

Метод: 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.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 = GREATER_EQUAL}, {int_value = 2010, Operation = LESS}]}, {key = "document.custom_metadata. год" условия = [{int_value = 2020, операция = GREATER_EQUAL}, {int_value = 2010, операция = МЕНЬШЕ}]}, {key = "document.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}]}]

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

resultsCount integer

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

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

Тело ответа

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

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

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

Соответствующие куски.

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

Метод: 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} .

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

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

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

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

Тело запроса

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

Тело ответа

В случае успеха тело ответа содержит экземпляр 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 s.

Тело запроса

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

Тело ответа

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

Ресурс REST: corpora.permissions

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

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

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

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

  • читатель может использовать ресурс (например, настроенную модель, корпус) для вывода
  • писатель имеет права читателя и, кроме того, может редактировать и делиться
  • владелец имеет права записи и, кроме того, может удалять
JSON-представление
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}
Поля
string name

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

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

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

string emailAddress

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

перечисление role enum ( Role )

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

Тип получателя гранта

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

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

Роль

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

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

МетаданныеФильтр

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

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

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

объект conditions[] object ( Condition )

Необходимый. Condition для данного ключа, которое активирует этот фильтр. Несколько Condition соединяются логическими операторами OR.

Состояние

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

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

  // Union field value can be only one of the following:
  "stringValue": string,
  "numericValue": number
  // End of list of possible types for union field value.
}
Поля
перечисление operation enum ( Operator )

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

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

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

numericValue number

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

Оператор

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

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

РелевантныйЧанк

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

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

Соответствие Chunk запросу.

объект chunk object ( Chunk )

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