Documents

Método: corpora.documents.create

Crea un Document vacío.

Extremo

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

Parámetros de ruta

parent string

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

Campos
name string

Inmutable. Es el identificador. Nombre del recurso de Document. El ID (nombre sin 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 en 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 legible por humanos para Document. El nombre visible no debe tener más de 512 caracteres, incluidos los espacios. Ejemplo: "Documentación de Semantic Retriever"

customMetadata[] object (CustomMetadata)

Opcional. Son los metadatos personalizados proporcionados por el usuario que se almacenan como pares clave-valor y se usan para realizar consultas. Un Document puede tener un máximo de 20 CustomMetadata.

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

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

Extremo

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

Parámetros de ruta

name string

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

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

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.

metadataFilters[] object (MetadataFilter)

Opcional. Es el filtro para los metadatos de Chunk. Cada objeto MetadataFilter debe corresponder a una clave única. Varios objetos MetadataFilter se unen con operadores "Y" lógicos.

Nota: No se admite el filtrado a nivel de Document para esta solicitud porque ya se especificó un nombre de Document.

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

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

Ejemplo de consulta 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 = "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.

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)

Son los fragmentos relevantes que se muestran.

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

Método: corpora.documents.list

Enumera todos los Document en un Corpus.

Extremo

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

Parámetros de ruta

parent string

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

Parámetros de consulta

pageSize integer

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

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

pageToken string

Opcional. Un token de página, recibido desde una llamada documents.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 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 Documents. Los objetos Document se ordenan de forma ascendente según document.create_time.

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

Campos
documents[] object (Document)

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

Método: corpora.documents.get

Obtiene información sobre un Document específico.

Extremo

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

Parámetros de ruta

name string

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

patch 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. Es el identificador. Nombre del recurso de Document. El ID (nombre sin 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 en 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)

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

Campos
displayName string

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

customMetadata[] object (CustomMetadata)

Opcional. Son los metadatos personalizados proporcionados por el usuario que se almacenan como pares clave-valor y se usan para realizar consultas. Un Document puede tener un máximo de 20 CustomMetadata.

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

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

Parámetros de ruta

name string

Es obligatorio. Es 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 establece como verdadero, también se borrarán los Chunk y los objetos relacionados con este Document.

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

Recurso de REST: corpora.documents

Recurso: Document

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

Campos
name string

Inmutable. Es el identificador. Nombre del recurso de Document. El ID (nombre sin 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 en 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 legible por humanos para Document. El nombre visible no debe tener más de 512 caracteres, incluidos los espacios. Ejemplo: "Documentación de Semantic Retriever"

customMetadata[] object (CustomMetadata)

Opcional. Son los metadatos personalizados proporcionados por el usuario que se almacenan como pares clave-valor y se usan para realizar consultas. Un Document puede tener un máximo de 20 CustomMetadata.

updateTime string (Timestamp format)

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

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

createTime string (Timestamp format)

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

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,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}

CustomMetadata

Son los metadatos proporcionados por el usuario y almacenados como pares clave-valor.

Campos
key string

Es obligatorio. Es la clave de los metadatos que se almacenarán.

value Union type
value puede ser una de las siguientes opciones:
stringValue string

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

stringListValue object (StringList)

Es el valor de StringList de los metadatos que se almacenarán.

numericValue number

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

Representación JSON 
{
  "key": string,

  // value
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // Union type
}

StringList

Son los valores de cadena proporcionados por el usuario que se asignan a una sola clave de metadatos.

Campos
values[] string

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

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