Docuents

Recurso de REST: corpora.documents

Recurso: Documento

Una Document es una colección de elementos Chunk. Un Corpus puede tener un máximo de 10,000 Document.

Representación JSON 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
Campos
name string

Inmutable. Identificador. Nombre del recurso de Document. El ID (nombre sin incluir el prefijo "corpora/*/documents/") 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/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName string

Opcional. Es el nombre visible del elemento Document en lenguaje natural. El nombre visible no debe superar los 512 caracteres, incluidos los espacios. Ejemplo: “Documentación sobre recuperador semántico”

customMetadata[] object (CustomMetadata)

Opcional. Metadatos personalizados proporcionados por el usuario almacenados como pares clave-valor que se usan para realizar consultas. Un elemento Document puede tener un máximo de 20 CustomMetadata.

updateTime string (Timestamp format)

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

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

createTime string (Timestamp format)

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

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.documents.create

Crea un Document vacío.

Extremo

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

Parámetros de ruta

parent string

Obligatorio. El nombre del Corpus en el que se creará este Document. Ejemplo: corpora/my-corpus-123 Toma la forma corpora/{corpora}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de Document.

Cuerpo de la respuesta

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

Método: corpora.documents.list

Muestra una lista de todos los Document de una Corpus.

Extremo

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

Parámetros de ruta

parent string

Obligatorio. Es el nombre del Corpus que contiene Document. Ejemplo: corpora/my-corpus-123 Toma la forma corpora/{corpora}.

Parámetros de consulta

pageSize integer

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

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

pageToken string

Opcional. Un token de página, recibido desde una llamada documents.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 documents.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 documents.list que contiene una lista paginada de Document. Los elementos Document se ordenan de forma ascendente por document.create_time.

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

Campos
documents[] object (Document)

Los Document que se muestran.

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 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}

Método: corpora.documents.query

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

Extremo

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

Parámetros de ruta

name string

Obligatorio. El nombre del Document que se consultará. Ejemplo: corpora/my-corpus-123/documents/the-doc-abc Toma la forma corpora/{corpora}/documents/{document}.

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

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.

metadataFilters[] object (MetadataFilter)

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

Nota: El filtro a nivel de Document no es compatible con esta solicitud porque ya se especificó un nombre Document.

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

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

Consulta de ejemplo para un rango numérico de valores: (año > 2015 Y año <= 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.

Cuerpo de la respuesta

Respuesta de documents.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 que se muestran.

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

Método: corpora.documents.get

Obtiene información sobre un Document específico.

Extremo

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

Parámetros de ruta

name string

Obligatorio. El nombre del Document que se recuperará. Ejemplo: corpora/my-corpus-123/documents/the-doc-abc Toma la forma corpora/{corpora}/documents/{document}.

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

Método: corpora.documents.patch

Actualiza un Document.

Extremo

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

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

Parámetros de ruta

document.name string

Inmutable. Identificador. Nombre del recurso de Document. El ID (nombre sin incluir el prefijo "corpora/*/documents/") 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/{corpus_id}/documents/my-awesome-doc-123a456b789c Toma la forma corpora/{corpora}/documents/{document}.

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 y customMetadata.

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

Cuerpo de la respuesta

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

Método: corpora.documents.delete

Borra un Document.

Extremo

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

Parámetros de ruta

name string

Obligatorio. El nombre del recurso del Document que se borrará. Ejemplo: corpora/my-corpus-123/documents/the-doc-abc Toma la forma corpora/{corpora}/documents/{document}.

Parámetros de consulta

force boolean

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

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

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.

CustomMetadata

Metadatos proporcionados por el usuario almacenados como pares clave-valor

Representación JSON 
{
  "key": string,

  // Union field value can be only one of the following:
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // End of list of possible types for union field value.
}
Campos
key string

Obligatorio. La clave de los metadatos que se almacenarán.

Campo de unión value.

value puede ser una de las siguientes opciones:

stringValue string

El valor de cadena de los metadatos que se almacenarán.

stringListValue object (StringList)

El valor StringList de los metadatos que se almacenará.

numericValue number

El valor numérico de los metadatos que se almacenarán.

StringList

Valores de cadena proporcionados por el usuario asignados a una sola clave de metadatos.

Representación JSON 
{
  "values": [
    string
  ]
}
Campos
values[] string

Los valores de cadena de los metadatos que se almacenarán.