Corpora

Método: corpora.create

Crea un Corpus vacío.

Extremo

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

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de Corpus.

Campos
name string

Inmutable. Es el 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 en 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 legible por humanos para Corpus. El nombre visible no debe tener más de 512 caracteres, incluidos los espacios. Ejemplo: "Documentos sobre Semantic Retriever"

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.query

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

Extremo

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

Parámetros de ruta

name string

Es obligatorio. Es 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

Es obligatorio. Es la cadena de búsqueda para realizar la búsqueda semántica.

metadataFilters[] object (MetadataFilter)

Opcional. Filtra los metadatos de Chunk y Document. Cada objeto MetadataFilter debe corresponder a una clave única. Varios objetos MetadataFilter se unen con operadores "Y" lógicos.

Ejemplo de búsqueda a nivel del documento: (año >= 2020 O año < 2010) Y (género = drama O género = acción)

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

Ejemplo de consulta a nivel de fragmento para un rango numérico de valores: (año > 2015 AND año <= 2020)

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

Nota: Los "AND" para la misma clave solo se admiten para valores numéricos. Los valores de cadena solo admiten "OR" para la misma clave.

resultsCount integer

Opcional. Es la cantidad máxima de Chunk que se devolverán. El servicio puede devolver menos objetos Chunk.

Si no se especifica, se devolverán, como máximo, 10 Chunks. La cantidad máxima de resultados especificada 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.list

Enumera todos los Corpora que posee el usuario.

Extremo

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

Parámetros de consulta

pageSize integer

Opcional. Es la cantidad máxima de Corpora que se devolverán (por página). El servicio puede devolver menos Corpora.

Si no se especifica, se devolverán, como máximo, 10 Corpora. 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 devolvió en la respuesta como argumento para la siguiente solicitud y, así, 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 por corpus.create_time ascendente.

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

Campos
corpora[] object (Corpus)

Son los corpus que se devolvieron.

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.get

Obtiene información sobre un Corpus específico.

Extremo

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

Parámetros de ruta

name string

Es 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

patch 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. Es el 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 en 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)

Es obligatorio. La lista de campos que se deben actualizar. Actualmente, solo se 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.

Campos
displayName string

Opcional. Es el nombre visible legible por humanos para Corpus. El nombre visible no debe tener más de 512 caracteres, incluidos los espacios. Ejemplo: "Documentos sobre Semantic Retriever"

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

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

Parámetros de ruta

name string

Es obligatorio. Es el nombre del recurso Corpus. Ejemplo: corpora/my-corpus-123 Toma la forma corpora/{corpora}.

Parámetros de consulta

force boolean

Opcional. Si se establece como verdadero, también se borrarán los Document y los objetos relacionados con este Corpus.

Si es falso (valor predeterminado), se mostrará un error FAILED_PRECONDITION si Corpus contiene algún 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 es un objeto JSON vacío.

Recurso de REST: corpora.permissions

Recurso: Permission

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

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

Existen tres roles concéntricos. Cada rol es un superconjunto de las operaciones permitidas del rol anterior:

  • El lector puede usar el recurso (p. ej., modelo ajustado, corpus) para la inferencia.
  • El escritor tiene permisos de lector y, además, puede editar y compartir.
  • El propietario tiene permisos de escritura y, además, puede borrar.
Campos
name string

Solo salida. Es el identificador. Es el nombre del permiso. Se generará un nombre único cuando se cree. Ejemplos: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Solo salida.

granteeType enum (GranteeType)

Opcional. Inmutable. Es el tipo de beneficiario.

emailAddress string

Opcional. Inmutable. Es la dirección de correo electrónico del usuario del grupo al que se refiere este permiso. El campo no se establece cuando el tipo de beneficiario del permiso es EVERYONE.

role enum (Role)

Es obligatorio. Es el rol que otorga este permiso.

Representación JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

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. Cuando se establece, debes proporcionar el valor de emailAddress para el usuario.
GROUP Representa un grupo. Cuando se establece, debes proporcionar el parámetro emailAddress para el grupo.
EVERYONE Representa el acceso para 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 proporcionado por el usuario para limitar la recuperación según los valores de metadatos a nivel de Chunk o Document. Ejemplo (genre = drama OR genre = action): key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

Campos
key string

Es obligatorio. Es la clave de los metadatos por los que se filtrará.

conditions[] object (Condition)

Es obligatorio. Son los Conditions de la clave determinada que activarán este filtro. Los operadores Condition múltiples se unen con operadores OR lógicos.

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

Condición

Condición de filtro aplicable a una sola clave.

Campos
operation enum (Operator)

Es obligatorio. Es el operador que se aplica al par clave-valor determinado para activar la condición.

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

Es el valor de cadena por el que se filtrarán los metadatos.

numericValue number

Es el valor numérico por el que se filtrarán los metadatos.

Representación JSON 
{
  "operation": enum (Operator),

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

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 Es compatible con números y cadenas.
GREATER_EQUAL Es compatible con valores numéricos.
GREATER Es compatible con valores numéricos.
NOT_EQUAL Es compatible con números y cadenas.
INCLUDES Solo se admite con cadenas cuando el tipo de valor CustomMetadata para la clave determinada tiene un stringListValue.
EXCLUDES Solo se admite con cadenas cuando el tipo de valor CustomMetadata para la clave determinada tiene un stringListValue.

RelevantChunk

Es la información de un fragmento relevante para una búsqueda.

Campos
chunkRelevanceScore number

Relevancia de Chunk para la búsqueda.

chunk object (Chunk)

Chunk asociado a la búsqueda.

document object (Document)

Document asociado al fragmento.

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

Recurso de REST: corpora

Recurso: Corpus

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

Campos
name string

Inmutable. Es el 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 en 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 legible por humanos para Corpus. El nombre visible no debe tener más de 512 caracteres, incluidos los espacios. Ejemplo: "Documentos sobre Semantic Retriever"

createTime string (Timestamp format)

Solo salida. Es la marca de tiempo de cuándo se creó el Corpus.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

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

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

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