Corpora

Recurso de REST: corpora

Recurso: Corpus

Una Corpus es una colección de elementos Document. Un proyecto puede crear hasta 5 corpus.

Representación JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}
Campos
name string

Inmutable. Identificador. Nombre del recurso de Corpus. El ID (nombre sin el prefijo "corpora/") puede contener hasta 40 caracteres alfanuméricos en minúscula o guiones (-). El ID no puede comenzar ni terminar con un guion. Si el nombre está vacío durante la creación, se derivará un nombre único de displayName junto con un sufijo aleatorio de 12 caracteres. Ejemplo: corpora/my-awesome-corpora-123a456b789c

displayName string

Opcional. Es el nombre visible del elemento Corpus en lenguaje natural. El nombre visible no debe superar los 512 caracteres, incluidos los espacios. Ejemplo: "Documentos en el recuperador semántico"

createTime string (Timestamp format)

Solo salida. La marca de tiempo de cuándo se creó Corpus.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

Solo salida. La marca de tiempo de la última actualización de Corpus.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

Método: corpora.create

Crea un Corpus vacío.

Extremo

publicación https://generativelanguage.googleapis.com/v1beta/corpora

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de Corpus.

Cuerpo de la respuesta

Si el proceso se realiza de forma correcta, el cuerpo de la respuesta contiene una instancia recién creada de Corpus.

Método: corpora.list

Muestra una lista de todos los Corpora que pertenecen al usuario.

Extremo

obtener https://generativelanguage.googleapis.com/v1beta/corpora

Parámetros de consulta

pageSize integer

Opcional. La cantidad máxima de Corpora que se mostrarán (por página). Es posible que el servicio muestre menos Corpora.

Si no se especifican, se mostrarán 10 Corpora como máximo. El límite de tamaño máximo es de 20 Corpora por página.

pageToken string

Opcional. Un token de página, recibido desde una llamada corpora.list anterior.

Proporciona el nextPageToken que se muestra en la respuesta como un argumento para la siguiente solicitud a fin de recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a corpora.list deben coincidir con la llamada que proporcionó el token de la página.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Respuesta de corpora.list que contiene una lista paginada de Corpora. Los resultados se ordenan de forma ascendente por corpus.create_time.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Campos
corpora[] object (Corpus)

El corpus que se muestra.

nextPageToken string

Un token, que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo, no habrá más páginas.

Representación JSON 
{
  "corpora": [
    {
      object (Corpus)
    }
  ],
  "nextPageToken": string
}

Método: corpora.query

Realiza una búsqueda semántica en un Corpus.

Extremo

publicación https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

Parámetros de ruta

name string

Obligatorio. El nombre del Corpus que se consultará. Ejemplo: corpora/my-corpus-123 Toma la forma corpora/{corpora}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Campos
query string

Obligatorio. Cadena de consulta para realizar una búsqueda semántica

metadataFilters[] object (MetadataFilter)

Opcional. Filtra por metadatos Chunk y Document. Cada objeto MetadataFilter debe corresponder a una clave única. Varios objetos MetadataFilter se unen mediante “AND” lógicos.

Consulta de ejemplo a nivel del documento: (año >= 2020 OR año < 2010) Y (género = drama OR género = acción)

Lista de objetos MetadataFilter: metadataFilters = [ {key = "document.custom_metadata.year" condiciones = [{int_value = 2020, operations = GREATER_EQUAL}, {int_value = 2010, operations = LESS}]}, {key = "document.custom_metadata.year" condiciones = [{int_value = 2020, operación = GREATER_EQUAL}, {int_value = 2010, operations = LESS}]}, {key = "document.custom_metadata.genre" condiciones = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]}]

Consulta de ejemplo a nivel de fragmento para un rango numérico de valores: (year > 2015 AND year <= 2020)

Lista de objetos MetadataFilter: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = &quot;chunk.custom_metadata.year&quot; condiciones = [{int_value = 2020, operation = LESS_EQUAL}]}]

Nota: Los operadores “AND” para la misma clave solo se admiten en valores numéricos. Los valores de string solo admiten “OR” para la misma clave.

resultsCount integer

Opcional. La cantidad máxima de objetos Chunk que se mostrarán. Es posible que el servicio muestre menos Chunk.

Si no se especifica, se mostrarán 10 Chunk como máximo. El recuento máximo de resultados especificado es 100.

Cuerpo de la respuesta

Respuesta de corpora.query que contiene una lista de fragmentos relevantes.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Campos
relevantChunks[] object (RelevantChunk)

Los fragmentos relevantes.

Representación JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Método: corpora.get

Obtiene información sobre un Corpus específico.

Extremo

obtener https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

Parámetros de ruta

name string

Obligatorio. El nombre de Corpus. Ejemplo: corpora/my-corpus-123 Toma la forma corpora/{corpora}.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Corpus.

Método: corpora.patch

Actualiza un Corpus.

Extremo

parche https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

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

Parámetros de ruta

corpus.name string

Inmutable. Identificador. Nombre del recurso de Corpus. El ID (nombre sin el prefijo "corpora/") puede contener hasta 40 caracteres alfanuméricos en minúscula o guiones (-). El ID no puede comenzar ni terminar con un guion. Si el nombre está vacío durante la creación, se derivará un nombre único de displayName junto con un sufijo aleatorio de 12 caracteres. Ejemplo: corpora/my-awesome-corpora-123a456b789c Toma la forma corpora/{corpora}.

Parámetros de consulta

updateMask string (FieldMask format)

Obligatorio. La lista de campos que se deben actualizar. Actualmente, esto solo admite la actualización de displayName.

Esta es una lista separada por comas de los nombres de campos totalmente calificados. Ejemplo: "user.displayName,photo".

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de Corpus.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Corpus.

Método: corpora.delete

Borra un Corpus.

Extremo

borrar https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

Parámetros de ruta

name string

Obligatorio. El nombre del recurso de Corpus. Ejemplo: corpora/my-corpus-123 Toma la forma corpora/{corpora}.

Parámetros de consulta

force boolean

Opcional. Si se configura como verdadera, también se borrarán todos los Document y objetos relacionados con este Corpus.

Si es falso (el valor predeterminado), se mostrará un error FAILED_PRECONDITION si Corpus contiene Document.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta está vacío.

Recurso de REST: corpora.permissions

Recurso: Permission

El recurso de permiso otorga al usuario, grupo o al resto del mundo acceso al recurso de la API de PaLM (p.ej., un modelo ajustado o corpus).

Un rol es una colección de operaciones permitidas que les permite a los usuarios realizar acciones específicas en los recursos de la API de PaLM. Si quieres que estén disponibles para usuarios, grupos o cuentas de servicio, asigna roles. Cuando asignas un rol, otorgas permisos que el rol contiene.

Existen tres roles concéntricos. Cada función es un superconjunto de las operaciones permitidas de la función anterior:

  • el lector puede usar el recurso (p.ej., modelo ajustado, corpus) para la inferencia
  • escritor tiene los permisos de lectura y, además, puede editar y compartir
  • tiene permiso de escritor y, además, puede borrar
Representación JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}
Campos
name string

Solo salida. Identificador. El nombre del permiso. En el momento de la creación, se generará un nombre único. Ejemplos: tunnelModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Solo salida.

granteeType enum (GranteeType)

Opcional. Inmutable. Es el tipo de beneficiario.

emailAddress string

Opcional. Inmutable. La dirección de correo electrónico del usuario del grupo al que hace referencia este permiso. El campo no se configura cuando el tipo de beneficiario del permiso es TODOS.

role enum (Role)

Obligatorio. El rol que otorga este permiso.

GranteeType

Define los tipos de beneficiario de este permiso.

Enumeraciones
GRANTEE_TYPE_UNSPECIFIED Es el valor predeterminado. Este valor no se usa.
USER Representa a un usuario. Si la estableces, deberás proporcionar la dirección de correo electrónico del usuario.
GROUP Representa un grupo. Si se establece, debes proporcionar emailAddress para el grupo.
EVERYONE Representa el acceso de todos. No se requiere información adicional.

Rol

Define el rol que otorga este permiso.

Enumeraciones
ROLE_UNSPECIFIED Es el valor predeterminado. Este valor no se usa.
OWNER El propietario puede usar, actualizar, compartir y borrar el recurso.
WRITER El escritor puede usar, actualizar y compartir el recurso.
READER El lector puede usar el recurso.

MetadataFilter

Es un filtro que proporcionó el usuario para limitar la recuperación según los valores de metadatos de nivel Chunk o Document. Ejemplo (género = drama O género = acción): clave = "document.custom_metadata.genre" condiciones = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

Representación JSON 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}
Campos
key string

Obligatorio. La clave de los metadatos que se deben filtrar.

conditions[] object (Condition)

Obligatorio. Los Condition de la clave determinada que activarán este filtro. Varios Condition se unen con OR lógicos.

Condición

Condición del filtro aplicable a una sola clave.

Representación 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.
}
Campos
operation enum (Operator)

Obligatorio. Operador aplicado al par clave-valor determinado para activar la condición.

Campo de unión value. El tipo de valor debe ser coherente con el tipo de valor definido en el campo de la clave correspondiente. Si los tipos de valores no son coherentes, el resultado será un conjunto vacío. Cuando CustomMetadata tiene un tipo de valor StringList, la condición de filtrado debe usar string_value vinculada con una operación INCLUDES/EXCLUDES; de lo contrario, el resultado también será un conjunto vacío. value puede ser solo una de las siguientes opciones:
stringValue string

El valor de cadena para filtrar los metadatos.

numericValue number

El valor numérico para filtrar los metadatos.

Operador

Define los operadores válidos que se pueden aplicar a un par clave-valor.

Enumeraciones
OPERATOR_UNSPECIFIED Es el valor predeterminado. Este valor no se usa.
LESS Es compatible con valores numéricos.
LESS_EQUAL Es compatible con valores numéricos.
EQUAL Admitida por valores numéricos y una cadena vacía.
GREATER_EQUAL Es compatible con valores numéricos.
GREATER Es compatible con valores numéricos.
NOT_EQUAL Admitida por valores numéricos y una cadena vacía.
INCLUDES Solo es compatible con la cadena cuando el tipo de valor CustomMetadata para la clave determinada tiene un stringListValue.
EXCLUDES Solo es compatible con la cadena cuando el tipo de valor CustomMetadata para la clave determinada tiene un stringListValue.

RelevantChunk

La información de un fragmento relevante para una consulta.

Representación JSON 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  }
}
Campos
chunkRelevanceScore number

Chunk Relevancia para la búsqueda.

chunk object (Chunk)

Chunk asociado con la consulta.